Configuration options
Below set of configuration options governs general the general behavior, such as opening or locking the CMi6160. It also includes a function to revert its settings to factory default.
Table 65. Elvaco OTC configuration options: Device
Name |
Possible values |
Default value (battery) |
Locked device & correct PAK or open device |
Locked device & no PAK |
Description |
---|---|---|---|---|---|
Power mode |
Inactive, Stand-by, Active |
Inactive |
RW |
R |
Activation status of the module. If set to stand-by, the module will be automatically activated upon water flow. The automatic activation feature is available in FW >=1.3.2. |
Configuration Lock |
Open, Locked |
Open |
RW |
R |
Locks the module to prevent unauthorized access. |
Synchronize meter time |
Time of mobile phone |
N/A |
W |
N/A |
Time of mobile phone used to synchronize meter clock. |
UTC offset |
-720 - 720 |
N/A |
RW |
R |
UTC offset of the meter (in minutes). |
Max meter retries |
0-255 |
255 |
RW |
R |
Maximum amount of quick retries when failing communicating with a meter. |
Power source |
0: Not supported (by meter FW to be read), 1: Unknown, 2: PSU / Mains 3: Battery |
3 |
RW |
R |
Detection and correction of the power source of the meter. |
Factory reset |
N/A |
N/A |
E |
N/A |
Resets the CMi6160 to factory settings (default setting for power mode is Active). |
Below settings are related to the connection to a LwM2M server.
Table 66. Elvaco OTC configuration options: LwM2M
Name |
Possible values |
Default value (battery) |
Locked device & correct PAK or open device |
Locked device & no PAK |
Description |
---|---|---|---|---|---|
Bootstrap IP |
A valid Bootstrap IP |
84.19.147. 226 (Elvaco Bootstrap server) |
RW |
R |
IP address of the bootstrap server the module will connect to upon activation. |
BS host |
|||||
Bootstrap port |
A valid Bootstrap port |
5694 |
RW |
R |
Port of the bootstrap server the module will connect to upon activation. |
Bootstrap security |
DTLS, No security |
DTLS |
RW |
R |
Sets the way data sent from the module is encrypted. |
LwM2M queue mode |
Enabled, Disabled |
For battery operated devices, it is strongly recommended to have LwM2M queue mode enabled. |
|||
CoAP ack timeout |
1..240 |
60 |
RW |
R |
LwM2M CoAP timeout value in seconds, See LwM2M specification for more info |
CoAP max retransmit |
1..6 |
1 |
RW |
R |
LwM2M max retransmit value. See LwM2M specification for more info |
DTLS min timeout |
1..3600 |
60 |
RW |
R |
The first timeout in seconds used when transmitting packets via DTLS for LwM2M. |
DTLS max timeout |
1..3600 |
90 |
RW |
R |
The last timeout in seconds used when transmitting packets via DTLS for LwM2M. |
Communication retry count |
0..10 |
1 |
RW |
R |
Number of connection attempts to a LwM2M server before marking a connection failed. |
Communication retry delay |
1..3600 |
3600 |
RW |
R |
Delay in seconds between connection attempts to LwM2M servers |
Sequence retry count |
1..10 |
2 |
RW |
R |
Number of connection sequence attempts to LwM2M servers. |
Sequence retry delay |
1..86400 |
86400 |
RW |
R |
Delay in seconds between connection sequence attempts to LwM2M servers. |
Sequence back-off |
Must be formatted as min-max, min-max,.. |
0-5,60-120,1300-1600,1300-1600,1300-1600,1300-1600 |
RW |
R |
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. |
The settings available on the NB-IoT tab allows tweaking how the device should behave in relation to the network. Typically, these settings should not be changed.
Table 67. Elvaco OTC configuration options: NB-IoT
Name |
Possible values |
Default value (battery) |
Locked device & correct PAK or open device |
Locked device & no PAK |
Description |
---|---|---|---|---|---|
APN mode |
Auto, Manual |
Auto |
RW |
R |
Sets how APN settings is implemented in the module. |
PLMN |
0..999999 |
PLMN of the network provider set by the user. Comprises of MCC and MNC codes (e.g. MCC = 240 and MNC = 01 results in a PLMN code of 24001. PLMN is also referred to as Home Network Identity (HNI). |
|||
APN |
Name of APN |
N/A |
RW |
R |
APN to use if APN mode is manual |
Radio frequency band |
0,3,8,20 Several bands can be chosen by e.g. typing 0,3,8 |
0 |
RW |
R |
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. |
Power saving mode |
Disabled, eDRX, PSM, eDRX+PSM |
eDRX+PSM |
RW |
R |
Setting for power save mode. |
T3324 timer |
1..11160 |
120 |
RW |
R |
LTE Active Timer. This setting controls how long (in seconds) the modem will wait for network activity before entering power saving mode. |
T3412 timer |
1..35712000 |
252000 |
RW |
R |
LTE Extended TAU timer. This setting controls how long (in seconds) the modem will be in power saving mode before waking up. |
eDRX mode |
Automatic, Manual |
Manual |
RW |
R |
|
eDRX value |
0..255 |
19 |
RW |
R |
eDRX controls how often the device can be contacted when not in power saving mode. |
Time sync source |
Network, Manual |
Network |
RW |
R |
Source for setting meter clock. |
Brown out delay |
1..64800 |
21600 |
RW |
R |
The maximum delay in seconds before reconnecting after a power outage. |
Search period |
180..57600 |
21600 |
RW |
R |
Maximum network search period in seconds. After this period, the device will enter deep sleep until next connection attempt. |
RAI |
Disabled, MDM RAI enable, DM RAI enable, DM+MDM RAI enable |
The settings within this block determines the behavior of the meter data sent from the CMi6160. Chosen message format determines what data that are sent, and the MDM upload protocol the protocol used for data transmission. There are also parameters for controlling how often the meter is read, and how of often it is sent (transmitted) to a receiving server over the NB-IoT network.
Table 68. Elvaco OTC configuration options: Communication
Name |
Possible values |
Default value (battery) |
Locked device & correct PAK or open device |
Locked device & no PAK |
Description |
---|---|---|---|---|---|
Message format |
Standard, Tariff |
Standard |
RW |
R |
Sets the payload of the data message from the module. |
Message encoding |
M-Bus, JSON, SenML/CBOR |
SenML/CBOR |
RW |
R |
Sets the encoding of the payload. |
Readout interval |
1..1440 |
60 |
RW |
R |
Placeholder for future use, currently not implemented. |
Report interval |
1..1440 |
60 |
RW |
R |
Number of minutes between each meter data readout. |
Transmit interval |
1..1440 |
1440 |
RW |
R |
Number of minutes between each data transmission. |
Transmit offset |
1..1440 |
30 |
RW |
R |
Time before transmit window starts from transmit interval (in seconds). |
Transmit delay |
1..1440 |
240 |
RW |
R |
Time period were the transmission while be randomized (in minutes). |
Max uploads per transmission |
1..168 |
4 |
RW |
R |
The number of max packages / transmissions. This will effect the time to recover when communication link has been down. |
MDM upload protocol |
MQTT-SN Publish, LwM2M Send |
MQTT-SN Publish |
RW |
R |
Transport protocol used for meter data transfer |
MQTT-SN Connection |
Optimized, Compliant |
Optimized |
RW |
R |
Connection type used when publishing messages to the MQTT-SN broker. |
MQTT-SN Topic |
Valid MQTT-SN topic |
elvaco/#P/#E/#T/#D |
RW |
R |
Topic used when publishing messages to the MQTT-SN broker. |
Auto-upload max. age |
0..99999999 |
10080 |
RW |
R |
Maximum age of the resent data (in minutes). |
Auto-upload order |
Oldest first, Latest first (FiFoLiFo) |
RW |
R |
Start with oldest or newest data when resending data. |
|
Restart back-off |
min-max,min-max,.. |
0-5,5-15,15-60,60-360,360-1440,1300-1600 |
RW |
R |
Delay range in minutes between restarting the modem on failures. |
Below settings governs how the CMi6160 should behave in cases where delivery of meter data does not succeed.
Table 69. Elvaco OTC configuration options: MDM
Parameter |
Possible values |
Default value (battery) |
Locked device & correct PAK or open device |
Locked device & no PAK |
Description |
---|---|---|---|---|---|
Communication timeout |
1-600 |
92 |
RW |
R |
MQTT-SN timeout in seconds when communication actions. E. g. timeout when publishing without DTLS |
Communication attempts |
0-255 |
2 |
RW |
R |
MQTT-SN max number of retries before considering operation failed. |
Max communication failures |
0-255 |
RW |
R |
Maximum number of operation failures before considering connection lost. |
|
DTLS min timeout |
1-3600 |
60 |
RW |
R |
The first timeout in seconds used when transmitting packets via DTLS for MDM packages. |
DTLS max timeout |
1-3600 |
90 |
RW |
R |
The last timeout in seconds used when transmitting packets via DTLS for MDM packages. |
Reconnect back-off |
min-max,min-max,.. |
0-5, 5-15, 15-60, 60-360, 360-1440, 1300-1600 |
RW |
R |
Delay ranges in minutes between restarting modern on failures. |
CMi6160 has two different message formats, Standard and Tariff, defining what data records are sent from the module. Below, the content of the message formats are listed in detail.
Table 70. Meter registers, standard message [0x38]
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 |
10 |
INT64 |
(Enhanced) Identification e.g. 0779xxxxxxxxxxxxxxxx Enhanced Meter Address for Diehl SHARKY |
Energy |
6-7 |
INT32 |
Energy consumption (Wh, J) e.g. 0406xxxxxxxx = xxxxxxxx * 0.001 MWh (kWh) |
Volume |
6 |
INT32 |
Volume (m3) e.g. 0413xxxxxxxx = xxxxxxxx * 0.001 m3 |
Power |
4 |
INT16 |
Power (W) e.g. 022Bxxxxxx = xxxxxx * 0.001 kW (W) |
Flow |
4 |
INT16 |
Flow (m3/h) e.g. 023Bxxxxxx = xxxxxx * 0.001 m3/h |
Fw temp |
4 |
INT16 |
Forward temperature (°C) e.g. 025Axxxx = xxxx * 0.1 °C |
Rt temp |
4 |
INT16 |
Return temperature (°C) e.g. 025Exxxx = xxxx * 0.1 °C |
Alarm codes |
4 |
INT8 |
Alarm codes e.g. 01FD17xx Error Codes for Diehl SHARKY 775 |
Table 71. Meter register, tariff message [0x39]
Field |
Size |
Data typ |
Description |
---|---|---|---|
Date and Time |
6 |
INT32 |
Date and Time (Type F), e.g. 046Dxxxxxxxx M-Bus Format F for Date & Time |
Meter ID |
10 |
INT64 |
(Enhanced) Identification e.g. 0779xxxxxxxxxxxxxxxx Enhanced Meter Address for Diehl SHARKY |
Fw temp |
4 |
INT16 |
Forward temperature (°C) e.g. 025Axxxx = xxxx * 0.1 °C |
Rt temp |
4 |
INT16 |
Return temperature (°C) e.g. 025Exxxx = xxxx * 0.1 °C |
Flow |
4 |
INT16 |
Flow (m3/h) e.g. 023Bxxxxxx = xxxxxx * 0.001 m3/h |
Volume |
6 |
INT32 |
Volume (m3) e.g. 0413xxxxxxxx = xxxxxxxx * 0.001 m3 |
Tariff 1 Energy |
6-7? |
INT32 |
Tariff register 1 or cooling energy in combined meters |
Tariff 2 Energy |
6-7? |
INT32 |
Tariff register 2 or heat energy in combined meters |
Alarm codes |
4 |
INT8 |
Alarm codes e.g. 01FD17xx Error Codes for Diehl SHARKY 775 |
Comments (0 comments)