engelmann Lora Module Cmmunication Modules From MWA Instruction Manual
- July 30, 2024
- engelmann
Table of Contents
engelmann Lora Module Cmmunication Modules From MWA
Product Information
Specifications:
- Product: LoRa Module
- Compatibility: Meter-compatible
- Communication: LoRa technology
- LED Indicators: Yes
Product Usage Instructions
Getting Started:
To begin using the LoRa Module, follow these steps:
- Purpose: Understand the purpose of the module.
- Product Specification: Review the specifications to ensure compatibility.
- Mounting and Start-up: Follow the detailed instructions for mounting, network preparation, LED indications, and rebooting.
Mounting and Start-up the Device:
Follow these steps to mount and start up the device:
- Mounting: Securely mount the LoRa Module in a suitable location.
- Network Preparation: Prepare the network for device connectivity.
- Activation and LED Indications: Activate the module and observe LED indications for status.
- Reboot/Switch off Module: Properly reboot or switch off the module when needed.
FAQ
- Q: How do I know if the module is successfully connected to the network?
- A: The LED indicators will show a specific pattern when the module is successfully connected to the network. Refer to the user manual for details on LED indications.
- Q: Can the LoRa Module be used with any type of meter?
- A: The LoRa Module is compatible with meters specified in the product features section of the user manual. Ensure compatibility before use.
Document notes
All information in this manual, including product data, diagrams, charts, etc. represents information on products at the time of publication and is subject to change without prior notice due to product improvements or other reasons. It is recommended that customers contact Engelmann Sensor GmbH for the latest product information before purchasing a control and monitoring interface product. The documentation and product are provided on an “as is” basis only and may contain deficiencies or inadequacies. Engelmann Sensor GmbH takes no responsibility for damages, liabilities, or other losses by using this product.
Copyright and trademark
All rights reserved. No part of the contents of this manual may be transmitted or reproduced in any form by any means without the written permission of Engelmann Sensor GmbH.
Contacts
Engelmann Sensor GmbH Rudolf-Diesel-Straße 24-28 69168 Wiesloch-Baiertal
Germany
- Phone: +49 6222 98 00 0
- E-Mail: info@engelmann.de
- Internet: http://www.engelmann.de
Important usage and safety information
The following safety precautions must be observed during all phases of the operation, usage, service or repair of any control and monitoring interface product. Users of the product are advised to convey the information to users and operating personnel and to incorporate these guidelines into all manuals supplied with the product. Failure to comply with these precautions violates safety standards of design, manufacture and intended use of the product. Engelmann Sensor GmbH assumes no liability for customer’s failure to comply with these precautions. The LoRa Module receives and transmits radio frequency energy while switched on. Remember that interference can occur if the product is used close to TV sets, radios, computers, or inadequately shielded equipment. Follow any special regulations and always switch off the product wherever forbidden, or when you suspect that it may cause interference or danger.
Using this manual
Purpose and audience
This manual provides all the information needed to mount, deploy, and configure the LoRa Module and target installers and system integrators.
Online resources
To download the latest version of this user’s manual, or to find information in other languages, please contact info@engelmann.de.
Symbols
The following symbols are used throughout the manual to emphasize important information and useful tips:
- The Note symbol is used to mark information that is important to take into consideration for safety reasons or to assure the correct operation of the meter connectivity module.
- The Tip symbol is used to mark information intended to help you get the most out of your product. It might for example be used to highlight a possible customization option related to the current section.
Table 1 provides information on how the product should be used
Introduction
Purpose
This chapter provides a general description of the LoRa Module. In the next- coming sections you will learn more about possible applications for the product and how the LoRa Module can be combined with other products to build versatile solutions.
Application description
The LoRa Module is a meter connectivity module for an Engelmann SensoStar S3/S3C heating/cooling meter to deliver meter data to a receiving (application) server over a LoRaWAN network. Meter data is securely transmitted, using LoRaWAN end-to-end security scheme.
Product features
The LoRa Module offers a combination of battery operation with long lifetime and a versatile application through its many configuration options. Key features of the module include:
-
Extensive battery lifetime
The module’s EcoMode feature enables the module to achieve a battery lifetime of 6+1 or 10+1 years with a new internal meter battery (“+1” refer to 1 year of storage) -
Easy start-up
As soon as the meter connectivity module is mounted in the meter and activated, it will join the LoRaWAN network. -
Easy and secure commissioning
With Elvaco’s One-Touch Commissioning (OTC), deployment, configuration and key transferring can be performed in a secure and flexible way. -
Unique and flexible message formats
The LoRa Module has several different message formats, which makes it easy to customize the payload to the unique demands of each application.
Meter Compatibility
The LoRa Module is compatible with Engelmann SensoStar meters with a compatible firmware version. If the LoRa Module is mounted in an incompatible meter, this is indicated in the OTC App. Table 2 shows the minimum firmware versions required. The meter’s firmware version can be shown in the meter’s display, for further information please refer to the meter’s manual.
Meter | Minimum firmware version |
---|---|
Engelmann SensoStar S3 | 1.03/0.14 |
Engelmann SensoStar S3C | 1.00/0.05 |
Getting started
Purpose
This chapter provides instructions on how to get started with the LoRa Module. After reading and carefully following each step of this chapter, your meter connectivity module should be mounted and connected to the LoRaWAN network.
Product specification
- Green LED
- Red LED
- Interface Connector
- Push Button
- Pulse Input
- LoRaWAN Antenna
Note: The NFC antenna is integrated in the edge of the PCB.
Mount and start-up the device
Mounting
Mount the LoRa Module in the module slot of Engelmann, see Figure 2 below.
- Please make sure that the module’s push button (2) is facing upwards.
- Please make sure that Interface connector of the meter (1) fits the Interface connector of the module (3).
Network preparation
For the module to connect to the LoRaWAN network, it needs to be registered in the network server. The following information needs to be added in the network server, depending on activation type: Over-the-air activation (OTAA): Device EUI, Application key and Join EUI Activation by personality (ABP): Application Session key, Network Session key and Device address Engelmann Sensor strongly recommends using Over-the-air activation (OTAA) to facilitate deployment and minimize the risk of duplicated keys.
Activation and LED indications
Module activation
By default, the LoRa Module is set to passive mode, which means no messages will be transmitted from the module until it is activated. The module can be activated in one of the following ways:
- a) By using the Elvaco OTC App: Open the Elvaco OTC app, which is available in Google Play.
- Scan the module, make sure NFC is activated on the phone.
- In Elvaco OTC App, go to the “APPLY” tab,
- Set “Power mode” to “Active”
- Click “APPLY” in the bottom of the screen
- Scan the module to apply new settings.
To verify that the module has been activated, go to the “INSPECT” tab, scan
the module, and make sure that “Power mode” is set to “Active”.
Note that it is possible to create a configuration profile to apply a
preconfigured setting to multiple devices, for further information please
refer to the OTC app documentation, available on the Elvaco website.
- b) By using the module push button: Press down the push button of the module for at least five seconds until the green LED lights up.
- c) By using the Engelmann optical interface configuration tool “Device Monitor”. For further information please refer to Engelmann documentation.
- d) By using the meter menu. For further information please refer to Engelmann documentation.
Network join
When activated, the LoRa Module will attempt to join the LoRaWAN network by the following sequence:
- Red LED – One flash
- Green and Red LED – Lights simultaneously up for 1 second
- Green LED – Several flashes while trying to connect to the LoRaWAN network
- Green LED – Lights up for 8 seconds when module succeeds in joining the LoRaWAN network
The network join sequence is illustrated in Figure 3.
The time for the LoRa Module to join the LoRaWAN network join may differ depending on network conditions. If the module fails to join the LoRaWAN network, it will retry until it succeeds. The time between each attempt will increase successively, to a minimum of once every day. A new join attempt cycle can be manually started at any time by rebooting the module (see section 5.3.4 Reboot/Switch off module) or by deactivating and activating the module using the Elvaco OTC App. Once the module has joined the LoRaWAN network, meter data will initially be transmitted from the module every minute (regardless of transmit interval settings) to set the right data rate. After three minutes of calibration, the module will start to deliver meter data using its configured settings. Follow below steps to verify that the module is communicating with the meter and is connected to the
LoRaWAN network:
- Open the Elvaco OTC App and go to “INSPECT” tab
- Scan the module
- Check if “Meter com” is set to “OK” and “Network joined” is set to “Yes”
Reboot/Switch off module
Reboot
Press and hold the push button (2) for 5-15 seconds. Release the button when the green LED is lit.
Switch Off
Press and hold the push button (2) for 15-20 seconds. Make sure to release the button when the red LED is lit. If releasing the push button after more than 20 seconds, the module will not switch off.
Administration reference
Purpose
This chapter contains detailed information about configuring options and the different message formats of the LoRa Module.
Security and access control
The LoRa Module has a “configuration lock” feature, which prevents unauthorized access to the module. When “configuration lock” has been enabled, a Product Access Key will be needed to configure the device. For more information about security and access control, please refer to the One-touch commissioning (OTC) documentation, available on the Elvaco website.
Configuration options
The LoRa Module is configured via the Elvaco OTC app. It uses NFC to transfer settings to the module. Downlink may also be used to for some configurations, see section 6.3.1 Downlink for more information. The LoRa Module can also be configured using Engelmann optical interface configuration tool “Device Monitor”, for further information please refer to Engelmann documentation. Please note that the Elvaco OTC App is compatible with Android phones with Android 5.0 or later.
Table 3 provides a summary of all LoRa Module parameters and settings
| Field name
(Abbr.)
| Description| Default value| Elvaco
OTC App
| Elvaco
OTC App
| Downlink
---|---|---|---|---|---|---
| | | Locked device &| No Product|
| | | correct Product| Access Key|
| | | Access Key| |
| | | or
Open device
| |
Device Settings
Meter ID| Meter identification number| N/A| Readable| Readable| N/A
| of the meter. Not| | | |
| configurable.| | | |
Power mode| Used to activate/deactivate| Passive| Readable /| Readable| N/A
| the module.| | Writeable| |
EcoMode| When activated, a minimum| 10 years| Readable /| Readable| Writeable
| battery-life of 6+1 or 10+1| | Writeable| |
| years depending on the| | | |
| configuration) can be| | | |
| achieved by the module.| | | |
Message format| The message format determines the meter data included in the
telegram from
the module.
| 0x24
(Standard)
| Readable / Writeable| Readable| Writeable
Transmit| Sets the number of minutes| 60 minutes| Readable /| Readable|
Writeable
interval| between each transmission| | Writeable| |
| from the module.| | | |
Date & Time| Date and time of the meter.| N/A| Readable /| Readable| N/A
| | | Writeable| |
Set Time| Adjusts the time of the meter| N/A| N/A| N/A| Writeable
Relative| relative to the current time.| | | |
Set absolute| Sets the time of the meter| Writeable| N/A| N/A| N/A
time| | | | |
Configuration| Locks the module to prevent| Open| Readable /| Readable|
Writeable
Lock| unauthorized access.| | Writeable| |
Pulse input selection| Select which of the three pulse
inputs to include when using the Engelmann message format. One or more can be selected.
| 0x00 (None)| Readable / Writeable| Readable| Writeable
LoRaWAN Settings
Device EUI| Unique module identification| Device-unique 64-| Readable|
Readable| N/A
| number. Not configurable.| bit number| | |
Activation| Sets the way the device joins| OTAA| Readable /| Readable|
Writeable
type| the LoRaWAN network.| | Writeable| |
| | | | |
---|---|---|---|---|---
Network join| Used to display whether the module has joined the LoRaWAN
network| N/A| Readable| Readable| N/A
Join EUI| Application identifier that determines where data ends up.|
94193A030C000001| Readable / Writeable| Readable| Writeable
Device address| 32-bit address used by the device to identify itself on the
LoRaWAN network.| N/A| Readable / Writeable| Readable| Writeable
Current data rate| The current data rate used for the module.| N/A| Readable|
Readable| N/A
Downlink
The LoRa Module supports configuration via downlink, i.e. sending commands to an end-device via the LoRaWAN network. Note that this feature should only be used sparingly due to bandwidth consideration. Communication via downlink can only be made in a short window after an uplink transmission from module to server. Therefore, time-critical communication should not be performed over downlink. Downlink are sent on port 2, structured according to the following format: “0x00” “TLV” “Number of bytes in configuration” “Configuration”. For a complete description of all available downlink commands,
Field name| TLV| Number of bytes in configuration|
Configuration| Example
---|---|---|---|---
Configuration lock| 0x05| 0x01| 0x00 = Locked 0x01
= Open
| 0x00050101
(Enables configuration lock)
Transmit interval| 0x06| 0x02| 0xNumber of minutes between transmission (lsByte -> msByte)| 0x0006021E00
(Sets the Tx interval to 30
minutes)
Message format| 0x07| 0x01| 0x24 = Standard 0x25 = Compact 0x26 = JSON
0x27 = Scheduled-daily redundant
0x28 = Scheduled – Extended
0x29 = Combined heat/cooling
0x2C = Engelmann
| 0x0007010XX
(Sets the message format to compact)
EcoMode| 0x0F| 0x01| 0x00 = Disable EcoMode 0x01 = Enable EcoMode, 10 years
0x02 = Enable EcoMode, 6 years
| 0x000F0100
(Disables EcoMode)
Set Time Relative| 0x13| 0x02| 0xNumber of minutes* (lsByte
-> msByte)
| 0x0013020F00
(Adds 15 minutes to the current time)
---|---|---|---|---
| | | *Negative numbers
supported.
|
0x0013020F80
(Subtracts 15 minutes from the current time)
UTC offset| 0x17| 0x02| 0xNumber of minutes* (lsByte
-> msByte)
*Negative numbers supported.
| 0x0017023C00 (Sets the UTC offset to +60 minutes)
0x0017023C80 (Sets the UTC offset to -60 minutes)
Reboot| 0x22| 0x02| 0x9E75 is used to reboot device| 0x0022029E75
(Reboots the device)
Pulse input selection| 0x1D| 0x01| Bit flags for selecting which pulse inputs are to be included in the Engelmann
message format.
| 0x001D0101
(Only input 1)
| | | | 0x001D0107
(Input 1, 2 & 3)
| | | 0 = disabled, 1 = enabled
Bit 0: Input 1
Bit 1: Input 2
Bit 2: Input 3
Bits 3-7 are reserved and
shall be set to 0.
|
Adaptive data rate (ADR)
The LoRa Module uses Adaptive Data Rate (ADR), part of the LoRaWAN standard, where the network server determines the optimal rate of communication for the module based on current signal conditions. In best case, the module will use its highest data rate (DR5) in order to be as energy efficient as possible. When signal conditions are poor, the network server will incrementally lower the data rate until it is able to receive the message. When the data rate is low, the energy consumption per telegram will increase.
Transmit interval
The transmit interval is used to set how frequently the module should transmit data on the LoRaWAN network. The parameter can be set to a value between 5 and 1440 minutes (i.e. 5-minute to daily values).
EcoMode
When EcoMode is active, the module has a battery lifetime of 6+1 or 10+1 years, depending on what EcoMode alternative is set. EcoMode setting is ignored when PSU (external power supply Engelmann) is connected. The module can achieve battery life of 6+1 or 10+1 years by using a table of allowed transmit intervals settings for each data rate. When radio conditions are poor (and data rate is low), the module will send data less frequently to conserve battery-life. When signal conditions are good, the module will send data more frequently. When EcoMode is enabled, the module will continuously check if the set transmit interval is “allowed” by the EcoMode table. If a lower transmit interval is needed for the specific data rate to achieve 6+1 or 10+1 years of battery life, the module will adjust the parameter accordingly. See Table 5 and Table 6 for the transmit interval allowed in each data rate.
Please note that anticipated battery lifetime cannot be assured if:
- EcoMode is disabled (Even if EcoMode is activated later)
- Changing from 6+1 to 10+1 years battery lifetime in EcoMode
When using the “Engelmann” message format the transmit interval is doubled to compensate for the additional telegrams transmitted in this message format, with the exception of DR0 in 10+1 year EcoMode where the transmit interval is capped at 1440 minutes (corresponding to once every 24 hours).
Data rate| Transmit interval (minutes)| Transmit interval,
Engelmann message format (minutes)
---|---|---
DR0| 180| 360
DR1| 120| 240
DR2| 60| 120
DR3| 30| 60
DR4| 15| 30
DR5| 15| 30
Table 5: EcoMode transmit interval settings, EcoMode (6+1 years)
Data rate| Transmit interval (minutes)| Transmit interval,
Engelmann message format (minutes)
---|---|---
DR0| 1440| 1440
DR1| 360| 720
DR2| 180| 360
DR3| 120| 240
DR4| 90| 180
DR5| 60| 120
Table 6: EcoMode transmit interval settings, EcoMode (10+1 years)
Message formats
The LoRa Module has several different message formats. Each one will be described in detail in this section.
Message structure
Message formats Standard, Compact, Scheduled – Daily redundant, Scheduled Extended, Combined heat/cooling and Engelmann are encoded in M-Bus format (M-Bus standard EN 13757-3:2013). Message format JSON is encoded in JSON format. All messages begin with one byte specifying the message format used. All M-Bus encoded messages begin with one byte specifying the message format used. Then follows a sequence of data information blocks (DIBs), each one containing a data information field (DIF), a value information field (VIF) and a data field (DATA). The structure of the telegram is illustrated in Figure 5.
For message type JSON, the data is presented as plain text
Field | Size | Description |
---|---|---|
Message format | 1 byte | 0x24 = Standard 0x25 = Compact 0x26 = JSON |
0x27 = Scheduled – daily redundant 0x28 = Scheduled – Extended
0x29 = Combined heat/cooling
0x2C = Engelmann telegram 1 0x2D = Engelmann telegram 2*
*Engelmann telegram 2 cannot be selected as a telegram type. It is the ID of the second telegram when using message format Engelmann.
Structure and payload
In this section, a detailed description of each message format payload is provided. All numbers in the payload are given in hexadecimal unless otherwise stated.
Standard
Table 8 provides a detailed description of the payload of message format Standard
DIB | Field | Size | Data type | Description |
---|---|---|---|---|
0 | Message format | 1 byte | – | 0x24 (= Standard) |
1 | Energy | 6-7 bytes | INT32 | Energy consumption (Wh, J, Cal, MBTU) |
0400xxxxxxxx = xxxxxxxx,xxx Wh 0401xxxxxxxx = xxxxxxxx,xx Wh 0402xxxxxxxx = xxxxxxxx,x Wh 0403xxxxxxxx = xxxxxxxx Wh 0404xxxxxxxx = xxxxxxxx 10 Wh 0405xxxxxxxx = xxxxxxxx 100 Wh 0406xxxxxxxx = xxxxxxxx kWh 0407xxxxxxxx = xxxxxxxx 10 kWh 040Exxxxxxxx = xxxxxxxx MJ 040Fxxxxxxxx = xxxxxxxx 10 MJ
04FB0Dxxxxxxxx = xxxxxxxx MCal
| | | | 04FB0Exxxxxxxx = xxxxxxxx 10 MCal 04FB0Fxxxxxxxx = xxxxxxxx 100
MCal
---|---|---|---|---
2| Volume| 6 bytes| INT32| Volume (m3)
0411xxxxxxxx = xxxxxxxx 0.00001 m³ 0412xxxxxxxx = xxxxxxxx 0.0001 m³ 0413xxxxxxxx = xxxxxxxx 0.001 m³ 0414xxxxxxxx = xxxxxxxx 0.01 m³ 0415xxxxxxxx = xxxxxxxx * 0.1 m³ 0416xxxxxxxx = xxxxxxxx m³
0417xxxxxxxx = xxxxxxxx * 10 m³
3| Power| 4 bytes| INT16| Power (W)
022Bxxxx = xxxx W 022Cxxxx = xxxx 10 W 022Dxxxx = xxxx 100 W 022Exxxx = xxxx kW 022Fxxxx = xxxx * 10 kW
4| Flow| 4 bytes| INT16| Flow (m3/h)
023Bxxxx = xxxx 0.001 m³/h 023Cxxxx = xxxx 0.01 m³/h 023Dxxxx = xxxx 0.1 m³/h 023Exxxx = xxxx m³/h 023Fxxxx = xxxx 10 m³/h
5| Fw temp| 4 bytes| INT16| Forward temperature (°C)
0258xxxx = xxxx 0.001 °C 0259xxxx = xxxx 0.01 °C 025Axxxx = xxxx * 0.1 °C 025Bxxxx = xxxx °C
6| Rt temp| 4 bytes| INT16| Return temperature (°C)
025Cxxxx = xxxx 0.001 °C 025Dxxxx = xxxx 0.01 °C 025Exxxx = xxxx * 0.1 °C 025Fxxxx = xxxx °C
7| Meter ID| 6 bytes| According to M- Bus EN13757-3
identification field
| Meter ID
0C78xxxxxxxx
8| Error flags| 4 bytes| INT8| Error and warning flags
01FD17xx
Compact
Table 9 provides a detailed description of message format Compact.
DIB | Field | Size | Data type | Description |
---|---|---|---|---|
0 | Message format | 1 byte | – | 0x25 (= Compact) |
1 | Energy | 6-7 bytes | INT32 | Energy consumption (Wh, J, Cal, MBTU) |
0400xxxxxxxx = xxxxxxxx,xxx Wh 0401xxxxxxxx = xxxxxxxx,xx Wh 0402xxxxxxxx = xxxxxxxx,x Wh 0403xxxxxxxx = xxxxxxxx Wh 0404xxxxxxxx = xxxxxxxx 10 Wh 0405xxxxxxxx = xxxxxxxx 100 Wh 0406xxxxxxxx = xxxxxxxx kWh 0407xxxxxxxx = xxxxxxxx 10 kWh 040Exxxxxxxx = xxxxxxxx MJ 040Fxxxxxxxx = xxxxxxxx 10 MJ 04FB0Dxxxxxxxx = xxxxxxxx MCal
04FB0Exxxxxxxx = xxxxxxxx 10 MCal 04FB0Fxxxxxxxx = xxxxxxxx 100 MCal
---|---|---|---|---
2| Meter ID| 6 bytes| According to M- Bus EN13757-3
identification
field
| Meter ID
0C78xxxxxxxx
3| Error flags| 4 bytes| INT8| Error and warning flags
01FD17xx
JSON
In message format JSON, data is presented on a plain text format. Table 10 provides a description of all fields included in the telegram.
Field | Description |
---|---|
Energy | Energy consumption (Wh, J, Cal) |
Unit | Unit of energy consumption |
Meter ID | Identification number of the meter in which the module is mounted. |
In Figure 6, an example of a telegram for message format JSON is presented.
Scheduled mode
For message formats of type “Scheduled” (Scheduled – Daily redundant and Scheduled – Extended), two types of messages will be transmitted from the module – a clock message and a data message. The difference between the two is described in Table 11. A detailed description of the payload of the clock message is provided
Message | Time interval | Description |
---|---|---|
Clock message | Once per day | The clock message presents the current time of |
the meter. It can be used to verify that the clock is correct and has not
drifted more than accepted.
Data message| Determined by transmit interval settings.| The actual meter data
collected from the meter. For more information.
DIB| Field| Size| Data type| Description
---|---|---|---|---
0| Message
format identifier
| 1 byte| –| 0xFA (=Clock message)
1| Date/time| 6 bytes| 32 bit binary integer M-Bus type F| 046Dxxxxxxxx =
Valid date/time message 346Dxxxxxxxx = Invalid date/time message
The clock message will be transmitted once every day and the data message at least (regulated by the transmit interval parameter) once every day. The transmit interval can only be set the values listed in Table 10. Note that although the meter readout will occur on top-of-the-hour, the data message will not necessarily be transmitted at that exact time. The LoRa transmission will occur after a random delay of 1- 30 minutes. The meter readout for the clock message occurs at a random hour (00:00-23:00) at a random minute in the 35-45 interval. The clock message will be transmitted immediately after readout. When using message format Scheduled, the transmit interval cannot not be set to higher than 1440 minutes (24 hours).
Parameter | Values | Unit |
---|---|---|
Transmit interval | 60, 120, 180, 240, 360, |
480, 720, 1440
| Minutes
Daily redundant
The data message of Scheduled mode – Daily redundant contains an accumulated daily energy field, which is updated at 24:00 each day. Depending on transmit interval settings and data rate, the field will be included in between 1-24 data messages per day. This will increase the probability of the value being received. For example, if the transmit interval is set to “12”, the accumulated energy read at 24:00 will be transmitted 12 times during the 24 next coming hours.
Table 14 provides a detailed description of message format Scheduled – Daily redundant.
| DIB| Field| Size| Data type| Description
---|---|---|---|---|---
0| Message
format
| 1 byte| –| 0x27 (= Scheduled – Daily redundant)
1| Heat energy
E1 / Cooling energy E3
| 6-7 bytes| INT32| Energy consumption (Wh, J, Cal, MBTU)
0400xxxxxxxx = xxxxxxxx,xxx Wh 0401xxxxxxxx = xxxxxxxx,xx Wh 0402xxxxxxxx = xxxxxxxx,x Wh 0403xxxxxxxx = xxxxxxxx Wh 0404xxxxxxxx = xxxxxxxx 10 Wh 0405xxxxxxxx = xxxxxxxx 100 Wh 0406xxxxxxxx = xxxxxxxx kWh 0407xxxxxxxx = xxxxxxxx 10 kWh 040Exxxxxxxx = xxxxxxxx MJ 040Fxxxxxxxx = xxxxxxxx 10 MJ 04FB0Dxxxxxxxx = xxxxxxxx MCal 04FB0Exxxxxxxx = xxxxxxxx * 10 MCal
04FB0Fxxxxxxxx = xxxxxxxx * 100 MCal
2| Volume| 6 bytes| INT32| Volume (m3)
0411xxxxxxxx = xxxxxxxx 0.00001 m³ 0412xxxxxxxx = xxxxxxxx 0.0001 m³ 0413xxxxxxxx = xxxxxxxx 0.001 m³ 0414xxxxxxxx = xxxxxxxx 0.01 m³
| | | | 0415xxxxxxxx = xxxxxxxx 0.1 m³ 0416xxxxxxxx = xxxxxxxx m³
0417xxxxxxxx = xxxxxxxx 10 m³
---|---|---|---|---
3| Meter ID| 6 bytes| According to M- Bus EN13757-3
identification field
| Meter ID
0C78xxxxxxxx
4| Error flags| 4 bytes| INT8| Error and warning flags
01FD17xx
5| Meter date/time| 6 bytes| INT32| Meter date and time (YY-MM-DD HH:MM) 046Dxxxxxxxx
Bit 31-28 = Year-high* Bit 27-24 = Month
Bit 23-21 = Year-low* Bit 20-16 = Day
Bit 15 = Summer time flag** Bit 14-13 = Century
Bit 12-8 = Hour Bit 7 = Error flag
Bit 6 = Reserved for future use*** Bit 5-0 = Minute
*The year is read by combining the year-high and year- low field. For example, year-high = 0010 and year-low
= 010 => year = 0010010
**0 = standard time, 1= daylight-saving time
*0 = timestamp is valid, 1 = timestamp is not** valid
6| Accumulated energy at 24:00| 6-7 bytes| INT32| Energy consumption (Wh, J)
4406xxxxxxxx = MWh, 3 decimals = kWh 440Exxxxxxxx = GJ, 3 decimals 44FB0Dxxxxxxxx = Gcal, 3 decimals 44863Dxxxxxxxx = MMBTU, 3 decimals
Note: Before a midnight reading has been performed the Function field of the DIF is set to “value during error state” to indicate that the value is not valid.
Example:
The following table contains a detailed description of the payload of message format Scheduled – Daily redundant
Scheduled – Extended
The data message of Scheduled mode – Extended contains all the data fields from message format Standard with an additional meter timestamp. Like all Scheduled message formats, the meter is read at full hour. A detailed description of the payload in the message format is presented in Table 15.
DIB | Field | Size | Data type | Description |
---|---|---|---|---|
0 | Message |
format identifier
| 1 byte| –| 0x28 (Scheduled – Extended)
1| Heat energy E1 / Cooling energy E3| 6-7 bytes| INT32| Energy consumption
(Wh, J, Cal, MBTU)
0400xxxxxxxx = xxxxxxxx,xxx Wh 0401xxxxxxxx = xxxxxxxx,xx Wh 0402xxxxxxxx = xxxxxxxx,x Wh 0403xxxxxxxx = xxxxxxxx Wh 0404xxxxxxxx = xxxxxxxx 10 Wh 0405xxxxxxxx = xxxxxxxx 100 Wh 0406xxxxxxxx = xxxxxxxx kWh 0407xxxxxxxx = xxxxxxxx 10 kWh 040Exxxxxxxx = xxxxxxxx MJ 040Fxxxxxxxx = xxxxxxxx 10 MJ 04FB0Dxxxxxxxx = xxxxxxxx MCal 04FB0Exxxxxxxx = xxxxxxxx 10 MCal 04FB0Fxxxxxxxx = xxxxxxxx 100 MCal
2| Volume| 6 bytes| INT32| Volume (m3)
0411xxxxxxxx = xxxxxxxx 0.00001 m³ 0412xxxxxxxx = xxxxxxxx 0.0001 m³ 0413xxxxxxxx = xxxxxxxx 0.001 m³ 0414xxxxxxxx = xxxxxxxx 0.01 m³ 0415xxxxxxxx = xxxxxxxx * 0.1 m³ 0416xxxxxxxx = xxxxxxxx m³
0417xxxxxxxx = xxxxxxxx * 10 m³
3| Power /Flow / Fw temp / Rt temp| 12 bytes| INT64| Byte 0-2 = DIF/VIF codes, 0x07FFA0 Byte 3 = Scaling of Power/Flow
-Bit 6.4 (n), 10n-3 W, n = 0..7
-Bit 2..0 (m), 10m-3 m3/h, m = 0..7
Byte 4-5 = Fw temp (lsByte -> msByte), °C, 2 decimals Byte 6-7 = Rt temp (lsByte -> msByte), °C, 2 decimals Byte 8-9 = Flow (lsByte -> msByte), 10m-6 m3/h
Byte 10-11 = Power (lsByte -> msByte), 10n-3 W
4| Meter ID /| 9 bytes| INT48| 06FF21xxxxyyyyyyyy
| Info bits| | |
| | | | xxxx = Info bits (lsByte -> msByte)
| | | | yyyyyyyy = Meter ID (lsByte -> msByte)
| | | | Sent in binary format
5| Meter date/time| 6 bytes| INT32| Meter date and time (YY-MM-DD HH:MM)
---|---|---|---|---
| | | | 046Dxxxxxxxx
| | | | Bit 31-28 = Year-high* Bit 27-24 = Month
Bit 23-21 = Year-low* Bit 20-16 = Day
Bit 15 = Summertime flag** Bit 12-8 = Hour
Bit 7 = Error flag***
Bit 6 = Reserved for future use*** Bit 5-0 = Minute
| | | | The year is read by combining the year-high and year- low field. For
example, year-high = 0010 and year-low = 010 => year = 0010010
| | | | 0 = standard time, 1= daylight-saving time
| | | | 0 = timestamp is valid, 1 = timestamp is not valid
Combined heat/cooling
Message format Combined heat/cooling is made to be used in meters that measure both heating and cooling energy.
Table 13 lists the indexes included in this message format.
DIB | Field | Size | Data type | Description |
---|---|---|---|---|
0 | Message format | 1 byte | – | 0x29 (Combined heat/cooling) |
1 | Heat Energy E1 | 6-7 bytes | INT32 | Energy consumption (Wh, J, Cal, MBTU) |
Energy consumption (Wh, J, Cal) 0400xxxxxxxx = xxxxxxxx,xxx Wh 0401xxxxxxxx = xxxxxxxx,xx Wh 0402xxxxxxxx = xxxxxxxx,x Wh 0403xxxxxxxx = xxxxxxxx Wh 0404xxxxxxxx = xxxxxxxx 10 Wh 0405xxxxxxxx = xxxxxxxx 100 Wh 0406xxxxxxxx = xxxxxxxx kWh 0407xxxxxxxx = xxxxxxxx 10 kWh 040Exxxxxxxx = xxxxxxxx MJ 040Fxxxxxxxx = xxxxxxxx 10 MJ 04FB0Dxxxxxxxx = xxxxxxxx MCal
04FB0Exxxxxxxx = xxxxxxxx 10 MCal 04FB0Fxxxxxxxx = xxxxxxxx 100 MCal
2| Cooling Energy E3| 7-8 bytes| INT32| Energy consumption (Wh, J, Cal, MBTU)
841006xxxxxxxx = MWh, 3 decimals = kWh 84100Exxxxxxxx = GJ, 3 decimals 8410FB0Dxxxxxxxx = Gcal, 3 decimals
8410863Dxxxxxxxx = MMBTu, 3 decimals
3| Volume| 6 bytes| INT32| Volume (m3)
0411xxxxxxxx = xxxxxxxx 0.00001 m³ 0412xxxxxxxx = xxxxxxxx 0.0001 m³ 0413xxxxxxxx = xxxxxxxx 0.001 m³ 0414xxxxxxxx = xxxxxxxx 0.01 m³ 0415xxxxxxxx = xxxxxxxx * 0.1 m³ 0416xxxxxxxx = xxxxxxxx m³
0417xxxxxxxx = xxxxxxxx * 10 m³
---|---|---|---|---
4| Fw temp| 4 bytes| INT16| Forward temperature (°C)
0258xxxx = xxxx 0.001 °C 0259xxxx = xxxx 0.01 °C 025Axxxx = xxxx * 0.1 °C
025Bxxxx = xxxx °C
5| Rt temp| 4 bytes| INT16| Return temperature (°C)
025Cxxxx = xxxx 0.001 °C 025Dxxxx = xxxx 0.01 °C 025Exxxx = xxxx * 0.1 °C 025Fxxxx = xxxx °C
6| Meter ID| 6 bytes| According to M-Bus EN13757-3
identification field
| Meter ID 0C78xxxxxxxx
7| Error flags| 4 bytes| INT8| Error and warning flags 01FD17xx
Engelmann
In message format Engelmann, two types of telegrams are transmitted from the module; the first contain information collected from the SensoStar meter and the second information collected from meters connected via the module’s pulse inputs. Note that telegram 2 is only transmitted from the module if the pulse inputs are used. When using the Engelmann message format the transmit interval (see section 6.5) is doubled to compensate for the additional telegrams transmitted in this message format, even if pulse inputs are not used and telegram 2 is not transmitted. The module configuration parameter “Pulse input configuration” specifies which of the three pulse inputs are connected and whose data shall be read and transmitted by the module. Only the values configured to be included are sent. If no inputs are selected, telegram 2 is not sent. Note: in case of errors in reading the data from the meter the function field in the DIF is set to indicate “value during error state” (M-Bus standard EN 13757-3:2013). In such cases the VIF and data part should be ignored. Since the unit of the input can be unknown in such cases it is set to dimensionless in the VIF, e.g., B440FD3A00000000 = pulse counter 1, no unit, with “value during error state”.
Table 17 and Table 18 list the indexes the information of both telegrams of this message format.
DIB | Field | Size | Data type | Description |
---|---|---|---|---|
0 | Message format | 1 byte | – | 0x2C (Engelmann, telegram 1) |
1 | Heat energy E1 / Cooling energy E3 | 6-7 bytes | INT32 | Energy consumption |
(Wh, J, Cal)
0400xxxxxxxx = xxxxxxxx,xxx Wh 0401xxxxxxxx = xxxxxxxx,xx Wh 0402xxxxxxxx = xxxxxxxx,x Wh 0403xxxxxxxx = xxxxxxxx Wh 0404xxxxxxxx = xxxxxxxx 10 Wh 0405xxxxxxxx = xxxxxxxx 100 Wh 0406xxxxxxxx = xxxxxxxx kWh 0407xxxxxxxx = xxxxxxxx 10 kWh 040Exxxxxxxx = xxxxxxxx MJ 040Fxxxxxxxx = xxxxxxxx 10 MJ 04FB0Dxxxxxxxx = xxxxxxxx MCal 04FB0Exxxxxxxx = xxxxxxxx * 10 MCal
04FB0Fxxxxxxxx = xxxxxxxx * 100 MCal
2| Cooling energy E3*| 7-8 bytes| INT32| Energy consumption (Wh, J, Cal, MBTU)
841006xxxxxxxx = MWh, 3 decimals = kWh 84100Exxxxxxxx = GJ, 3 decimals 8410FB0Dxxxxxxxx = Gcal, 3 decimals
8410863Dxxxxxxxx = MMBTu, 3 decimals
3| Volume| 6 bytes| INT32| Volume (m3)
0411xxxxxxxx = xxxxxxxx 0.00001 m³ 0412xxxxxxxx = xxxxxxxx 0.0001 m³ 0413xxxxxxxx = xxxxxxxx 0.001 m³ 0414xxxxxxxx = xxxxxxxx 0.01 m³ 0415xxxxxxxx = xxxxxxxx * 0.1 m³ 0416xxxxxxxx = xxxxxxxx m³
0417xxxxxxxx = xxxxxxxx * 10 m³
4| Meter date / time| 6 bytes| INT32| Meter date and time (YY-MM-DD HH:MM)
046Dxxxxxxxx
| | | | Bit 31-28 = Year-high* Bit 27-24 = Month
Bit 23-21 = Year-low* Bit 20-16 = Day
Bit 15 = Summer time flag** Bit 14-13 = Century
Bit 12-8 = Hour Bit 7 = Error flag
Bit 6 = Reserved for future use*** Bit 5-0 = Minute
| | | | The year is read by combining the year-high and year- low field. For
example, year-high = 0010 and year-low = 010 => year = 0010010
| | | | 0 = standard time, 1= daylight-saving time
| | | | 0 = timestamp is valid, 1 = timestamp is not valid
5| Meter ID| 6 bytes| According to M-Bus EN13757-3
identification field
| Meter ID 0C78xxxxxxxx
---|---|---|---|---
6| Error flags| 4 bytes| INT8| Error and warning flags 01FD17xx
Cooling energy E3 field is only valid in a combined heat/cooling meter for message format Engelmann. Else the function field of the DIF is set to “value during error state” to indicate that the value is not valid.
DIB | Field | Size | Data type | Description |
---|---|---|---|---|
0 | Message format | 1 byte | – | 0x2D (Engelmann, telegram 2) |
1 | Pulse input 1 | 7-8 bytes | INT32 | 844013xxxxxxxx = m3, 3 decimals |
844014xxxxxxxx = m3, 2 decimals 844015xxxxxxxx = m3, 1 decimal 844006xxxxxxxx = MWh, 3 decimals 844007xxxxxxxx = MWh, 2 decimals
8440FD3Axxxxxxxx = No unit
2| Pulse input 2| 8-9 bytes| INT32| 84804013xxxxxxxx = m3, 3 decimals 84804014xxxxxxxx = m3, 2 decimals 84804015xxxxxxxx = m3, 1 decimal 84804006xxxxxxxx = MWh, 3 decimals
84804007xxxxxxxx = MWh, 2 decimals 848040FD3Axxxxxxxx = No unit
3| Pulse input 3| 8-9 bytes| INT32| 84C04013xxxxxxxx = m3, 3 decimals 84C04014xxxxxxxx = m3, 2 decimals 84C04015xxxxxxxx = m3, 1 decimal 84C04006xxxxxxxx = MWh, 3 decimals 84C04007xxxxxxxx = MWh, 2 decimals
84C040FD3Axxxxxxxx = No unit
4| Meter date / time| 6 bytes| INT32| Meter date and time (YY-MM-DD HH:MM)
046Dxxxxxxxx
| | | | Bit 31-28 = Year-high* Bit 27-24 = Month
Bit 23-21 = Year-low* Bit 20-16 = Day
Bit 15 = Summer time flag** Bit 14-13 = Century
Bit 12-8 = Hour Bit 7 = Error flag
Bit 6 = Reserved for future use*** Bit 5-0 = Minute
| | | | *The year is read by combining the year-high and year- low field. For
example, year-high = 0010 and year-low = 010 => year = 0010010
| | | | **0 = standard time, 1= daylight-saving time
| | | |
*0 = timestamp is valid, 1 = timestamp is not** valid
---|---|---|---|---
5| Meter ID| 6 bytes| According to M-Bus EN13757-3
identification field
| Meter ID 0C78xxxxxxxx
Table 18: Message format Engelmann, pulse input telegram
Meter communication error message
The payloads using M-Bus encoded data uses the Function field of the DIF to indicate errors. In this case, it is set to “value during error state” (M-Bus standard EN 13757-3:2013) and the value sent should not be used. A typical case for this is when the module is unable to communicate with the meter and retrieve meter values, in which case all the fields in the payload have the DIF indicating “value during error state”. In case of erroneous data or if the module is unable to communicate with meter, bit 4-5 of the bit of the DIF code (first byte of each index field) will be set to 11b. For example, a DIF code of 0x02 will be set to 0x32 in case of error. (This applies to all message format except JSON.) For message format JSON, the actual value will be replaced with “null” in case of error state. If no meter communication is possible at all, all fields have this error indication set.
Technical specifications
Type | Value | Unit | Comments |
---|
Mechanics
Dimensions (w x h x d)| 29 x 56 x 12| mm|
Weight| 9| g|
Mounting| In module slot of Engelmann SensoStar S3/S3C| –|
Electrical connections
Supply voltage| Internal meter battery or PSU
(Engelmann External Power Supply)
| –|
Electrical characteristics
Nominal voltage| 3.0| VDC|
Power consumption (max)| 50| mA|
Power consumption (sleep mode)| 2.5| µA|
Environmental specifications
Operating temperature| 5 – 55| ºC|
Operating humidity| 0 – 93| % RH| No condensation
Operating altitude (max)| 2000| m|
Usage environment| Indoors| –|
Storage temperature| -20 to +60| ºC|
Radio characteristics
Frequency| 868| MHz|
Output power| 14| dBm|
Receiver sensitivity| -135| dBm|
LoRaWAN characteristics
Device class| Class A| –| Bi-directional
LoRa version| 1.0.2 Rev B| –|
Activation| OTAA or ABP| –|
Data rate| DR0 – DR5| –| 250 – 5470 bit/s
User interface
Green LED & Red LED| Indication for start-up / reboot / switch-off| |
Push button| Start-up / reboot / switch off module| |
Configuration| Elvaco OTC app, Downlink or Engelmann optical
configuration tool “Device Monitor”
| –|
Type approvals
The LoRa Module is designed to comply with the directives and standards listed below.
Approval | Description |
---|---|
EMC | EN 301 489-1, EN 309 489-3 |
LoRa Alliance® | LoRaWAN® Certified |
Document history
Versions
Version | Date | Description |
---|---|---|
V1.0 | 2020-10 | Commercial release v1.0 |
V1.1 | 2024-02 | Adjustments M-Bus decoding |
References
Terms and abbreviations
Abbreviation | Description |
---|---|
DIB | Data Information Block |
DIF | Data Information Field |
VIF | Value Information Field |
MCM | Meter Connectivity Module |
Number representation
- Decimal numbers are represented as normal number, i.e. 10 (ten).
- Hexadecimal numbers are represented with prefix 0x, i.e. 0x0A (ten)
- Binary numbers are represented with prefix 0b, i.e. 0b00001010 (ten)
- Payload data follows the M-Bus Standard with the least significant byte (LSB) first
European Standards
[1] M-Bus standard EN 13757-3:2013 Communication systems for and remote reading of meters – Part 3: Dedicated application layer
EU Declaration of Conformity
Documents / Resources
|
engelmann Lora Module Cmmunication Modules From
MWA
[pdf] Instruction Manual
Lora Module Cmmunication Modules From MWA, Lora Module, Cmmunication Modules
From MWA, Modules From MWA, From MWA, MWA
---|---
Read User Manual Online (PDF format)
Read User Manual Online (PDF format) >>