Configuration options
Table 37. All device configuration options
|
Parameters |
Description |
Configurable values |
Default value (battery) |
Locked device & correct PAK or open device |
Locked device & no PAK |
|---|---|---|---|---|---|
|
Meter ID |
Meter identification |
N/A |
N/A |
Readable |
Readable |
|
Power mode |
Activation status of the module |
Passive, Active |
Passive |
Readable/ Writeable |
Readable |
|
Configuration lock |
Locks the module to prevent unauthorized access. |
Open, Locked |
Open |
Readable/ Writeable |
Readable |
|
Synchronize meter time |
Used in OTC via NFC to use time of the mobile phone to synchronize meter clock. |
Used via App |
N/A |
Writeable |
Readable |
|
UTC offset |
UTC offset of the meter (in minutes) |
-720 - 720 |
0 |
Readable/ Writeable |
Readable |
|
Max meter retries |
Maximum amount of quick retries when failing communicating with a meter |
0-255 |
255 |
Readable/ Writeable |
Readable |
|
Factory reset |
Resets the module to factory settings (default setting for power mode is Active) |
N/A |
N/A |
Writeable |
N/A |
Table 38. All LwM2M configuration options
|
Parameters |
Description |
Configurable values |
Default value (battery) |
Locked device & correct PAK or open device |
Locked device & no PAK |
|---|---|---|---|---|---|
|
Bootstrap IP |
IP address pf the bootstrap server the module will connect to upon activation. |
N/A |
84.19.147. 226 (Elvaco Bootstrap server) |
Readable/ Writeable |
Readable |
|
Bootstrap port |
Port of the bootstrap server the module will connect to upon activation. |
N/A |
5694 |
Readable/ Writeable |
Readable |
|
Bootstrap security |
Sets the way data sent from the module is encrypted. |
DTLS / no security |
DTLS |
Readable/ Writeable |
Readable |
|
CoAP ack timeout |
LWM2M CoAP timeout value. |
See LWM2M specification for more info. |
60 |
Readable/ Writeable |
Readable |
|
CoAP max retransmit |
LWM2M max retransmit value. |
See LWM2M specification for more info. |
1 |
Readable/ Writeable |
Readable |
|
DTLS min timeout |
The first timeout in seconds used when transmitting packets via DTLS for LWM2M. |
60 |
Readable/ Writeable |
Readable |
|
|
DTLS max timeout |
The last timeout in seconds used when transmitting packets via DTLS for LWM2M. |
90 |
Readable/ Writeable |
Readable |
|
|
Communication retry count |
Number of connection attempts to a LWM2M server before marking a connection failed. |
0.. |
1 |
Readable/ Writeable |
Readable |
|
Communication retry delay |
Delay in seconds between connection attempts to LWM2M servers. |
1.. |
3600 |
Readable/ Writeable |
Readable |
|
Sequence retry count |
Number of connection sequence attempts to LWM2M servers. |
1.. |
2 |
Readable/ Writeable |
Readable |
|
Sequence retry delay |
Delay in seconds between connection sequence attempts to LWM2M servers. |
1.. |
86400 |
Readable/ Writeable |
Readable |
|
Sequence backoff |
Delay ranges in minutes to wait between full LWM2M sequence connection attempts. I.e. If both bootstrapping and connection to device management fails consecutively, delay progressively until connectivity can be restored. |
N/A |
0-5,60- 120,1300- 1600,1300- 1600,1300- 1600,1300- 1600 |
Readable/ Writeable |
Readable |
Table 39. All NB-IoT configuration options
|
Parameter |
Description |
Configurable values |
Default value (battery) |
Locked device & correct PAK or open device |
Locked device & no PAK |
|---|---|---|---|---|---|
|
APN mode |
Sets how APN settings is implemented in the module. |
Auto, Manual |
Auto |
Readable/ Writeable |
Readable |
|
APN |
APN to use if APN mode is manual. |
Name of APN |
N/A |
Readable/ Writeable |
Readable |
|
Radio frequency band |
Which NB-IoT frequency band to use. Setting this will make the modem skip scanning all bands and just use the supplied one if possible. If this fails, the modem will scan all bands. 0 means all bands. |
0,3,8,20 |
0 |
Readable/ Writeable |
Readable |
|
Power saving mode |
Setting for power save mode. |
Disabled, eDRX, PSM, eDRX+PSM |
eDRX+PSM |
Readable/ Writeable |
Readable |
|
T3324 timer |
LTE Active Timer. This setting controls how long (in seconds) the modem will wait for network activity before entering power saving mode. |
0-… |
120 |
Readable/ Writeable |
Readable |
|
T3412 timer |
LTE Extended TAU timer. This setting controls how long (in seconds) the modem will be in power saving mode before waking up. |
0-… |
252000 |
Readable/ Writeable |
Readable |
|
eDRX mode |
Automatic / Manual |
Manual |
Readable/ Writeable |
Readable |
|
|
eDRX value |
eDRX controls how often the device can be contacted when not in power saving mode. |
0-… |
19 |
Readable/ Writeable |
Readable |
|
Time sync source |
Source for setting meter clock |
Network/Manual |
Network |
Readable/ Writeable |
Readable |
|
Brown out delay |
The maximum delay in seconds before reconnecting after a power outage. |
0-… |
21600 |
Readable/ Writeable |
Readable |
|
Search period |
Maximum network search period in seconds. After this period, the device will enter deep sleep until next connection attempt |
0-… |
21600 |
Readable/ Writeable |
Readable |
Table 40. All payload setup configuration options
|
Parameter |
Description |
Configurable values |
Default value (battery) |
Locked device & correct PAK or open device |
Locked device & no PAK |
|---|---|---|---|---|---|
|
Message format |
Sets the payload of the data message from the module. |
Standard, Extended, Combined, Pulse. |
Standard |
Readable / Writeable |
Readable |
|
Message encoding |
Sets the encoding of the payload. |
M-Bus, JSON, SenML/CBOR |
SenML/CB OR |
Readable / Writeable |
Readable |
|
Readout interval |
Number of minutes between each meter data readout. |
5-1440 |
60 |
Readable / Writeable |
Readable |
|
Report interval |
Number of minutes between each meter data readout. |
5-1440 |
60 |
Readable / Writeable |
Readable |
|
Transmit interval |
Number of minutes between each data transmission. |
5-1440 |
1440 |
Readable / Writeable |
Readable |
|
Transmit offset |
Time before transmit window starts from transmit interval (in seconds). |
1.. |
30 |
Readable / Writeable |
Readable |
|
Transmit delay |
Time period were the transmission while be randomized (in minutes). |
1.. |
240 |
Readable / Writeable |
Readable |
|
Max uploads per transmission |
The number of max packages / transmissions. This will effect the time to recover when communication link has been down. |
1.. |
4 |
Readable/ Writeable |
Readable |
|
MQTT/SN Connection |
Connection type used when publishing messages to the MQTT-SN broker. |
Optimized / Compliant |
Optimized |
Readable/ Writeable |
Readable |
|
MQTT/SN Topic |
Topic used when publishing messages to the MQTT-SN broker. |
N/A |
Readable/ Writeable |
Readable |
|
|
Auto-upload max. age |
Maximum age of the resent data (in minutes) |
1.. |
10080 |
Readable/ Writeable |
Readable |
|
Auto-upload order |
Start with oldest or newest data when resending data. |
Oldest first/ Latest first (FiFo/LiFo). |
Latest first (LiFo) |
Readable/ Writeable |
Readable |
|
Restart backoff |
Delay range in minutes between restarting the modem on failures. |
N/A |
0-5,5- 15,15- 60,60- 360,360- 1440,1300- 1600 |
Readable/ Writeable |
Readable |
Table 41. All MDM (MQTT-SN) configuration options
|
Parameter |
Description |
Configurable values |
Default value (battery) |
Locked device & correct PAK or open device |
Locked device & no PAK |
|---|---|---|---|---|---|
|
Communication timeout |
MQTT-SN timeout when communication actions. E. g. timeout when publishing without DTLS. |
1.. |
92 |
Readable/ Writeable |
Readable |
|
Communication attempts |
MQTT-SN max number of retries before considering operation failed. |
1.. |
2 |
Readable/ Writeable |
Readable |
|
DTLS min timeout |
The first timeout in seconds used when transmitting packets via DTLS for MDM packages. |
1.. |
60 |
Readable/ Writeable |
Readable |
|
DTLS max timeout |
The last timeout in seconds used when transmitting packets via DTLS for MDM packages. |
1.. |
90 |
Readable/ Writeable |
Readable |
|
Reconnect backoff |
Delay range in minutes between restarting the modem on failures. |
N/A |
0-5,5- 15,15- 60,60- 360,360- 1440,1300- 1600 |
Readable/ Writeable |
Readable |
CMi6140 has four different message formats, Standard, Extended, Combined and Pulse.
By selecting message format, the user can configure what meter registers that will be included in the telegram. In message formatExtended both the meter registers of message format Standard and message format Extended will be included in the telegram.
Table 42. Message format Standard [0x66]
|
Field |
Size |
Data type |
Description |
|---|---|---|---|
|
Date and Time |
6 |
INT32 |
Date and Time (Type F), Example: 046Dxxxxxxxx M-Bus Format F for Date & Time |
|
Meter ID |
6 |
BCD8 |
According to M-Bus EN13757-3 identification field e.g. 0C78xxxxxxxx |
|
Energy |
6-7 |
INT32 |
Example: 0406xxxxxxxx, 040Fxxxxxxxx |
|
Volume |
6 |
INT32 |
Example: 0413xxxxxxxx |
|
Power |
4 |
INT16 |
Example: 022Bxxxx |
|
Flow |
4 |
INT16 |
Example: 023Bxxxx |
|
Fw temp |
4 |
INT16 |
Example: 025Axxxx |
|
Rt temp |
4 |
INT16 |
Example: 025Exxxx |
|
Info codes |
7 |
INT32 |
Error and warning flags Example: 04FD17xxxx Note that this field is always 32 bits, even when using MultiCal 403 which only reports 16 bits. |
Example 7. JSON
{"TS":"2022-07-01T13:40:10Z","ID":72591526,"E":0,"U":"kWh","V":0,"VU":"l","P":0,"PU":"W","F":0,"FU":"l/h", "FT":26.11,"TU":"C","RT":26.43,"RU":"C","EF":"0x00000100"}
Table 43. Message format Extended [0x67]
|
Field |
Size |
Data type |
Description |
|---|---|---|---|
|
Date and Time |
6 |
INT32 |
Date and Time (Type F), e.g. 046Dxxxxxxxx M-Bus Format F for Date & Time |
|
Meter ID |
6 |
BCD8 |
According to M-Bus EN13757-3 identification field e.g. 0C78xxxxxxxx |
|
Energy |
6-7 |
INT32 |
Example: 0406xxxxxxxx, 040Fxxxxxxxx |
|
Volume |
6 |
INT32 |
Example: 0413xxxxxxxx |
|
Tariff 2 Energy |
8 |
INT32 |
Example: 842003xxxxxxxx |
|
Tariff 3 Energy |
8 |
INT32 |
Example: 843003xxxxxxxx |
|
Power |
4 |
INT16 |
Example: 022Bxxxx |
|
Flow |
4 |
INT16 |
Example: 023Bxxxx |
|
Fw temp |
4 |
INT16 |
Example: 025Axxxx |
|
Rt temp |
4 |
INT16 |
Example: 025Exxxx |
|
Info codes |
7 |
INT32 |
Error and warning flags Example: 04FD17xxxx Note that this field is always 32 bits, even when using MultiCal 403 which only reports 16 bits.Error and warning flags Example: 04FD17xxxx Note that this field is always 32 bits, even when using MultiCal 403 which only reports 16 bits. |
Example 8. JSON
{"TS":"2022-07-01T14:17:36Z","ID":72591526,"E":0,"U":"kWh","V":0,"VU":"l", "T2":0,"U2":"kWh","T3":0,"U3":"kWh","P":0,"PU":"W","F":0,"FU":"l/h", "FT":26.25,"TU":"C","RT":26.50,"RU":"C","EF":"0x00000100"}
Table 44. Message format Combined [0x68]
|
Field |
Size |
Data type |
Description |
|---|---|---|---|
|
Date and Time |
6 |
INT32 |
Date and Time (Type F), e.g. 046Dxxxxxxxx M-Bus Format F for Date & Time |
|
Meter ID |
6 |
BCD8 |
According to M-Bus EN13757-3 identification field e.g. 0C78xxxxxxxx |
|
Energy E1 |
6-7 |
INT32 |
Heat energy Example: 0406xxxxxxxx, 040Fxxxxxxxx |
|
Energy E3 |
6-7 |
INT32 |
Cooling energy Example: 0483FF02xxxxxxxx = xxxxxxxx Wh |
|
Energy E8 |
7 |
INT32 |
Energy (m3 * °C) Example: 04FF07xxxxxxxx = xxxxxxxx m3 * °C |
|
Energy E9 |
7 |
INT32 |
Energy (m3 * °C) Example: 04FF08xxxxxxxx = xxxxxxxx m3 * °C |
|
Volume |
6 |
INT32 |
Example: 0413xxxxxxxx |
|
Info codes |
7 |
INT32 |
Error and warning flags Example: 04FD17xxxx Note that this field is always 32 bits, even when using MultiCal 403 which only reports 16 bits. Kamstrup MCxx3 Heat Meters Info Codes |
The pulse inputs on the module are connected to the meter via the connector. The meter holds the pulse inputs in registers 84 and 85 (In A and In B in slot 1) and registers 224 and 225 for In A and In B in slot 2). The module shall use the registers corresponding to the slot it is installed in, i.e., the values sent are always for the inputs on the module itself, irrespective of slot used.
Note
The field Operating hours was introduced in FW 1.3.0. Previous FW will not have that record included in the payload.
Table 45. Payload, message format Pulse [0x69]
|
Field |
KMP register |
Size (bytes) |
Data type |
Description |
|---|---|---|---|---|
|
Date and Time |
6 |
INT32 |
Date and Time (M-Bus formatType F) Example: 046Dxxxxxxxx |
|
|
Meter ID |
6 |
BCD8 |
According to M-Bus EN13757-3 identification field Example: 0C78xxxxxxxx |
|
|
Energy |
6-7 |
INT32 |
Example: 0406xxxxxxxx, 040Fxxxxxxxx |
|
|
Volume |
6 |
INT32 |
Example: 0413xxxxxxxx |
|
|
Pulse In A |
84 or 224 |
7 |
INT32 |
Reads the registers corresponding to the In A connector on the module. Sub-unit 1 is used in DIFE for In A Examples: Volume: 844014B1EB0100 = 1258.73 m³ Energy: 84400725120000 = 46450 kWh |
|
Pulse In B |
85 or 225 |
8 |
INT32 |
Reads the registers corresponding to the In B connector on the module. Sub-unit 2 is used in DIFE for In B Example: Volume: 848040144E1E0100 = 732.94 m³ Energy: 8480400601230000 = 8961 kWh |
|
Operating hours |
1004 |
6 |
INT32 |
Examples: 042238220000 = 8 760h (~1 year) 042280230200 = 140 160h (~16 years) |
|
Power |
4 |
INT16 |
Example: 022Bxxxx |
|
|
Flow |
4 |
INT16 |
Example: 023Bxxxx |
|
|
Fw temp |
4 |
INT16 |
Example: 025Axxxx |
|
|
Rt temp |
4 |
INT16 |
Example: 025Exxxx |
|
|
Info codes |
7 |
INT32 |
Error and warning flags Example: 04FD17xxxx Note that this field is always 32 bits, even when using MultiCal 403 which only reports 16 bits. |
Example 9. JSON
Example when In-A measure volume (“VA” and “UA”), and In-B measure Energy (“EB” and “UB”).
{"TS":"2021-12-02T13:14:15Z","ID":12345678,"E":1,"U":"Wh","V":5,"VU":"l","VA":3,"UA":"l", "EB":2,"UB":"Wh","P":6,"PU":"W","F":7,"FU":"l/h","FT":8.1,"TU":"C","RT":-9.2,"RU":"C","EF":"0x12345678"
Comments (0 comments)