Configuration options
CMi6160 is a versatile product that can be configured for a wide range of use cases and implementations. Configuration can be made either remotely, via a device management system using LwM2M, or via the Elvaco OTC App, using the NFC interface of the device. Below sections list all settings and operations possible for the different configuration interfaces.
Using the Elvaco OTC App for configuration is an efficient way of commissioning a CMi6160. For repeated commission of devices with the same set of settings, it is recommended storing a profile holding those settings. Utilizing stored profiles will speed up the commissioning phase and reduce the risk of faulty settings.
Note
Make sure to have the latest version of the Elvaco OTC App installed before starting the process. To be able to apply changes to a locked device, the user must be logged in to the Elvaco EVO account to which the device has been appointed.
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 57. 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 58. 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 59. 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 60. 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 |
45 |
RW |
R |
Time before transmit window starts from transmit interval (in seconds). |
|
Transmit delay |
1..1440 |
125 |
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 61. 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. |
Note
This section is mainly targeted to system integrators with the ambition to integrate the device into their own device management system. Making practical use of the LwM2M device management possibilities presented below require having a LwM2M server up and running.
CMi6160 supports remote device management using LwM2M. This e.g. includes monitoring the device, making setting changes, and updating the firmware over the air. Below sections specify what LwM2M objects and related resources that are supported by the device.
The following section list what OMA defined LwM2M objects that are supported by the CMi6160. For a complete and detailed description of each object and their resources, see Open Mobile Alliance - LwM2M Registry.
This LwM2M Object provides a range of device related information which can be queried by the LwM2M Server, and a device reboot and factory reset function.
Table 62. Object definition: OMA Device
|
Name |
Value |
Description |
|---|---|---|
|
Name |
Device |
The name of the object |
|
Object ID |
3 |
The Object ID |
|
LwM2M version |
1.1 |
The LwM2M Version used |
|
Object version |
1.1 |
The version of this object definition |
Table 63. Resource definition: Device Resources (Elvaco implementation)
|
ID |
Name |
Op |
Instances |
Mandatory |
Type |
Range enumerations |
Units |
Description |
|---|---|---|---|---|---|---|---|---|
|
0 |
Manufacturer |
R |
Single |
No |
Str |
Manufacturer ("Elvaco") |
||
|
1 |
Model Number |
R |
Single |
No |
Str |
Product model ("CMi6160") |
||
|
2 |
Serial Number |
R |
Single |
No |
Str |
DevEUI |
||
|
3 |
Firmware Version |
R |
Single |
No |
Str |
Firmware version |
||
|
4 |
Reboot |
E |
Single |
Yes |
Reboot the LwM2M Device to restore the Device from unexpected firmware failure. |
|||
|
6 |
Available Power Sources |
R |
Multiple |
No |
Int |
0..7 |
Power source 1: Internal battery 2: External battery 6: AC (Mains) power |
|
|
7 |
Power Source Voltage |
R |
Multiple |
No |
Int |
Present voltage for each Available Power Sources Resource Instance. The unit used for this resource is in mV. |
||
|
9 |
Battery Level |
R |
Single |
No |
Int |
0..100 |
% |
Battery level (in %) |
|
11 |
Error Code |
R |
Multiple |
No |
Int |
0..100 |
Error codes, according to LwM2M 1.1 |
|
|
13 |
Current Time |
RW |
Single |
Yes |
Int |
0..8 |
Current time |
|
|
14 |
UTC Offset |
RW |
Single |
No |
Time |
UTC Offset UTC+X (ISO 8601) |
||
|
18 |
Hardware Version |
R |
Single |
No |
Str |
Hardware version |
This LwM2M Object enables monitoring of parameters related to network connectivity. In this general connectivity Object, the Resources are limited to the most general cases common to most network bearers. It is recommended to read the description, which refers to relevant standard development organizations (e.g. 3GPP, IEEE). The goal of the Connectivity Monitoring Object is to carry information reflecting the more up to date values of the current connection for monitoring purposes. Resources such as Link Quality, Radio Signal Strength, Cell ID are retrieved during connected mode at least for cellular networks.
Table 64. Object definition: OMA Connectivity Monitoring
|
Name |
Value |
Description |
|---|---|---|
|
Name |
Connectivity Monitoring |
The name of the object |
|
Object ID |
3 |
The Object ID |
|
LwM2M version |
1.1 |
The LwM2M Version used |
|
Object version |
The version of this object definition |
Table 65. Resource definition: Connectivity Monitoring resources (Elvaco implementation)
|
ID |
Name |
Op |
Instances |
Mandatory |
Type |
Range enumerations |
Units |
Description |
|---|---|---|---|---|---|---|---|---|
|
0 |
Network Bearer |
R |
Single |
Yes |
Int |
0-50 |
7 = NB-IoT |
|
|
1 |
Available Network Bearer |
R |
Multiple |
Yes |
Int |
0-50 |
7 = NB-IoT |
|
|
2 |
Radio Signal Strength |
R |
Single |
Yes |
Int |
dBm |
RSRP (NRSRP) |
|
|
7 |
APN |
R |
Multiple |
No |
Str |
APN |
||
|
8 |
Cell ID |
R |
Single |
No |
Int |
Cell ID |
||
|
9 |
SMNC |
R |
Single |
No |
Int |
0-999 |
% |
MNC PLMN = SMNC + SMCC |
|
10 |
SMCC |
R |
Single |
No |
Int |
0-999 |
MCC PLMN = SMNC + SMCC |
This LwM2M Object enables management of firmware which is to be updated. The firmware update will require to reboot the device.
Table 66. Object definition: OMA Firmware Update
|
Name |
Value |
Description |
|---|---|---|
|
Name |
Firmware Update |
The name of the object |
|
Object ID |
5 |
The Object ID |
|
LwM2M version |
1.1 |
The LwM2M Version used |
|
Object version |
1.1 |
The version of this object definition |
Table 67. Resource definition: Firmware update resources (Elvaco implementation)
|
ID |
Name |
Op |
Instances |
Mandatory |
Type |
Range enumerations |
Units |
Description |
|---|---|---|---|---|---|---|---|---|
|
5 |
Update Result |
R |
Single |
Yes |
Int |
0..11 |
Firmware Update Resul |
|
|
8 |
Firmware Update Protocol Support |
R |
Multiple |
No |
Int |
0..5 |
0 = CoAP |
|
|
9 |
Firmware Update Delivery Method |
R |
Single |
Yes |
Int |
0..2 |
0 = Pull only |
Table 68. Object definition: OMA LwM2M Cellular Connectivity
|
Name |
Value |
Description |
|---|---|---|
|
Name |
LwM2M Cellular Connectivity |
The name of the object |
|
Object ID |
10 |
The Object ID |
|
LwM2M version |
1.1 |
The LwM2M Version used |
|
Object version |
1.1 |
The version of this object definition |
Table 69. Resource definition: LwM2M Cellular Connectivity (Elvaco implementation)
|
ID |
Name |
Op |
Instances |
Mandatory |
Type |
Range enumerations |
Units |
Description |
|---|---|---|---|---|---|---|---|---|
|
4 |
PSM Timer |
RW |
Single |
No |
Int |
s |
NB-IoT T3412. |
|
|
5 |
Active Timer |
RW |
Single |
No |
Int |
s |
NB-IoT T3324. |
|
|
9 |
eDRX parameters for NB-S1 mode |
RW |
Single |
No |
Opa |
0..255 |
NB-IoT eDRX |
|
|
11 |
Activated Profile Names |
R |
Multiple |
Yes |
ObjLink |
Link to APN Connection Profile object |
Table 70. Object definition: OMA LwM2M APN Connection Profile
|
Name |
Value |
Description |
|---|---|---|
|
Name |
LwM2M APN Connection Profile |
The name of the object |
|
Object ID |
11 |
The Object ID |
|
LwM2M version |
1.1 |
The LwM2M Version used |
|
Object version |
1.1 |
The version of this object definition |
Table 71. Resource definition: LwM2M APN Connection Profile (Elvaco implementation)
|
ID |
Name |
Op |
Instances |
Mandatory |
Type |
Range enumerations |
Units |
Description |
|---|---|---|---|---|---|---|---|---|
|
0 |
Profile name |
RW |
Single |
Yes |
Str |
Human-readable identifier. Multiple connection profiles can share the same APN value but e.g. have different credentials. |
||
|
1 |
APN |
RW |
Single |
No |
Str |
Manual APN Writable in object resource 1. |
||
|
2 |
Auto select APN by device |
RW |
Single |
No |
Bool |
Auto APN Mode Writable in object resource 1. |
||
|
4 |
Authentication Type |
RW |
Single |
Yes |
Int |
3 = None Writing currently not supported |
This section list Elvaco specific LwM2M objects and resources.
Table 72. Object definition: Elvaco MCM Config
|
Name |
Value |
Description |
|---|---|---|
|
Name |
Elvaco MCM Config |
The name of the object |
|
Object ID |
33906 |
The Object ID |
|
Object description |
Configuration of the meter device specifics |
|
|
LwM2M version |
1.1 |
The LwM2M Version used |
|
Object version |
2.8 |
The version of this object definition |
Table 73. Resource definition: Elvaco MCM Config resources
|
ID |
Name |
Op |
Multiplicity |
Mandatory |
Type |
Range enumerations |
Units |
Description |
|---|---|---|---|---|---|---|---|---|
|
0 |
Meter Readout Interval |
RW |
Single |
Yes |
Int |
Interval in minutes |
||
|
1 |
Report data encoding |
RW |
Single |
Yes |
Int |
0 = SenML/CBOR 1 = JSON 2 = MBus |
||
|
2 |
Report frame type |
RW |
Single |
Yes |
Int |
56 = CMi6160_Standard 57 = CMi6160_Tariff |
||
|
3 |
Eco mode enabled |
RW |
Single |
No |
Bool |
|||
|
4 |
NFC Enabled |
RW |
Single |
No |
Bool |
|||
|
5 |
NFC Config-locked |
RW |
Single |
No |
Bool |
|||
|
6 |
Adjust time |
W |
Single |
Yes |
Int |
Adjustment in seconds |
||
|
10 |
Instantaneous readout trigger |
E |
Single |
Yes |
Trigger a meter readout. |
|||
|
13 |
Historic resend trigger |
E |
Single |
No |
Trigger upload of all historic data |
|||
|
14 |
Historic resend status |
R |
Single |
No |
Int |
Number of messages in uplink queue |
||
|
15 |
Apply APN staging profile |
E |
Single |
Yes |
Apply APN staging profile. |
|||
|
16 |
Config write status |
R |
Single |
Yes |
Bool |
Result of last config write to flash |
||
|
17 |
Meter Report Interval |
RW |
Single |
Yes |
Int |
Interval in minutes |
||
|
18 |
Meter Transmit Interval |
RW |
Single |
Yes |
Int |
Interval in minutes |
||
|
19 |
Meter Transmit Offset |
RW |
Single |
Yes |
Int |
Offset in minutes |
||
|
20 |
Meter Transmit Delay |
RW |
Single |
Yes |
Int |
Delay in minutes |
||
|
21 |
Meter Uploads Per Tx |
RW |
Single |
Yes |
Int |
Max number of messages per tx interval |
||
|
22 |
DTLS Min Timeout |
RW |
Single |
Yes |
Int |
Timeout in seconds |
||
|
23 |
DTLS Max Timeout |
RW |
Single |
Yes |
Int |
Timeout in seconds |
||
|
24 |
MQTT-SN Communication Timeout |
RW |
Single |
Yes |
Int |
Timeout in seconds |
||
|
25 |
MQTT-SN Communication Attempts |
RW |
Single |
Yes |
Int |
Total number of attempts |
||
|
26 |
MQTT-SN Register Timeout |
RW |
Single |
Yes |
Int |
OBSOLETE! Timeout in seconds |
||
|
27 |
MQTT-SN Register Attempts |
RW |
Single |
Yes |
Int |
OBSOLETE! Total number of attempts |
||
|
28 |
MQTT-SN Publish Timeout |
RW |
Single |
Yes |
Int |
OBSOLETE! Timeout in seconds |
||
|
29 |
MQTT-SN Publish Attempts |
RW |
Single |
Yes |
Int |
OBSOLETE! Total number of attempts |
||
|
30 |
CoAP ACK Timeout |
RW |
Single |
Yes |
Int |
Timeout in seconds |
||
|
31 |
CoAP Max Retransmit |
RW |
Single |
Yes |
Int |
Number of retransmissions |
||
|
32 |
IOWA DTLS Min Timeout |
RW |
Single |
Yes |
Int |
Timeout in seconds |
||
|
33 |
IOWA DTLS Max Timeout |
RW |
Single |
Yes |
Int |
Timeout in seconds |
||
|
34 |
IOWA Communication Retry Count |
RW |
Single |
Yes |
Int |
Number of retries |
||
|
35 |
IOWA Communication Retry Delay |
RW |
Single |
Yes |
Int |
Delay in seconds |
||
|
36 |
IOWA Communication Sequence Retry Count |
RW |
Single |
Yes |
Int |
Number of retries |
||
|
37 |
IOWA Communication Sequence Retry Delay |
RW |
Single |
Yes |
Int |
Delay in seconds |
||
|
38 |
Network Connection Maximum Hold-off |
RW |
Single |
Yes |
Int |
Delay in seconds |
||
|
39 |
Network Search Period |
RW |
Single |
Yes |
Int |
Period in seconds |
||
|
40 |
Modem Restart Back-off Intervals |
RW |
Single |
Yes |
Str |
min0-max0,min1-max1,... in minutes |
||
|
41 |
MDM Re-connect Back-off Intervals |
RW |
Single |
Yes |
Str |
min0-max0,min1-max1,... in minutes |
||
|
42 |
LwM2M Resume Back-off Intervals |
RW |
Single |
Yes |
Str |
min0-max0,min1-max1,... in minutes |
||
|
43 |
Meter Max Retry Count |
RW |
Single |
Yes |
Int |
Max number of retries when meter communication fails |
||
|
44 |
Auto Upload Age Limit |
RW |
Single |
Yes |
Int |
Max age in minutes of unsent measurements to upload |
||
|
45 |
Auto Upload Order |
RW |
Single |
Yes |
Int |
In what order should unsent measurements be uploaded. 0 = FIFO, 1 = LIFO. |
||
|
46 |
Time Sync Source |
RW |
Single |
Yes |
Int |
Which source to use for time synchronization. 0 = Manual, 1 = Network. |
||
|
47 |
MDM Communication Failures |
RW |
Single |
Yes |
Int |
Maximum number of failures before connection is considered broken. |
||
|
48 |
Upload Protocol |
RW |
Single |
Yes |
Int |
0..1 |
Protocol to use for meter data upload 0 = MQTT-SN 1 = LwM2M |
|
|
49 |
Use PSM |
RW |
Single |
Yes |
Int |
0..3 |
Power saving mode: 0 = Disabled, 1 = eDRX, 2 = PSM, 3 = PSM + eDRX |
|
|
50 |
eDRX Mode |
RW |
Single |
Yes |
Int |
0..1 |
eDRX mode: 0 = Automatic, 1 = Manual |
|
|
51 |
Enable RAI |
RW |
Single |
Yes |
Int |
0..3 |
RAI flag value(0|1|2|3): 0 - Disabled, 1 - Enabled for MQTT-SN, 2 - Enabled for LwM2M, 3 - Enabled for MQTT-SN and LwM2M |
|
|
52 |
Power Source |
RW |
Single |
Yes |
Int |
0..1 |
Configuration value for power source. Used when hardware unit cannot determine source. 0 = Battery, 1 = PSU |
|
|
53 |
NB-IoT Radio Bands |
RW |
Single |
Yes |
Str |
NB-IoT Radio Bands to use: band0,band1,... |
||
|
54 |
Meter Identification source |
RW |
Single |
Yes |
Int |
0..1 |
Use Fabrication number (aka Serial number) or Customer number as identification. 0 = Fabrication nbr, 1 = Customer nbr |
|
|
55 |
MQTT Keepalive Timeout |
RW |
Single |
Yes |
Int |
5..1092 |
Min |
MQTT Keepalive timeout for compliant mode in minutes. |
|
56 |
Device reboot is required |
R |
Single |
Yes |
Bool |
The device requires a reboot to apply the latest configuration changes. |
||
|
57 |
LwM2M device queue mode |
RW |
Single |
Yes |
Int |
0..2 |
Forced queue mode selection: 0 = automatic queue mode (as configured by the BS server), 1 = always enabled, 2 = always disabled(needs PSM turned off and/or private APN) |
|
|
58 |
Additional Meter log enable |
RW |
Single |
No |
Bool |
Enable additional meter log, only some meters are supported |
||
|
59 |
Roaming Home PLMN search |
RW |
Single |
No |
Int |
0..3 |
Search value (0|1|2|3): bit 0 hpPlmnSearch, bit 1 overrideLrplmnsi |
|
|
60 |
DTLS handshake max rewinds |
RW |
Single |
Yes |
Int |
0..255 |
Maximum number of DTLS handshake step rewinds: 0 = disabled - infinite, x = non zero number of rewinds allowed during DTLS handshake |
Table 74. Object definition: Elvaco MDM Server
|
Name |
Value |
Description |
|---|---|---|
|
Name |
Elvaco MDM Server |
The name of the object |
|
Object ID |
33905 |
The Object ID |
|
Object description |
||
|
LwM2M version |
1.1 |
The LwM2M Version used |
|
Object version |
2.2 |
The version of this object definition |
Table 75. Resource definition: Elvaco MDM Server resources
|
ID |
Name |
Op |
Multiplicity |
Mandatory |
Type |
Range enumerations |
Units |
Description |
|---|---|---|---|---|---|---|---|---|
|
0 |
URI |
RW |
Single |
Yes |
Str |
0 |
0 |
URI to the meter data server |
|
1 |
Protocol |
RW |
Single |
Yes |
Int |
0.. |
0 |
0 = MQTT-SN |
|
2 |
Transport Security Mode |
RW |
Single |
Yes |
Int |
0..3 |
0 |
0 = PSK mode 3 = No security |
|
5 |
Transport Secret Key |
W |
Single |
Yes |
Opa |
0 |
0 |
Key to use with the selected security mode |
|
10 |
Connection config |
RW |
Single |
No |
Int |
0..1 |
0 |
0 = Optimized 1 = Compliant |
|
11 |
Topic |
RW |
Single |
No |
Str |
0 |
0 |
MQTT-SN topic |
Table 76. Object definition: Elvaco Meter Data
|
Name |
Value |
Description |
|---|---|---|
|
Name |
Elvaco Meter Data |
The name of the object |
|
Object ID |
33911 |
The Object ID |
|
Object description |
||
|
LwM2M version |
1.1 |
The LwM2M Version used |
|
Object version |
2.0 |
The version of this object definition |
Table 77. Resource definition: Elvaco MDM Server resources
|
ID |
Name |
Op |
Multiplicity |
Mandatory |
Type |
Range enumerations |
Units |
Description |
|---|---|---|---|---|---|---|---|---|
|
0 |
URI |
RW |
Single |
Yes |
Str |
0 |
0 |
URI to the meter data server |
|
1 |
Protocol |
RW |
Single |
Yes |
Int |
0.. |
0 |
0 = MQTT-SN |
|
2 |
Transport Security Mode |
RW |
Single |
Yes |
Int |
0..3 |
0 |
0 = PSK mode 3 = No security |
|
5 |
Transport Secret Key |
W |
Single |
Yes |
Opa |
0 |
0 |
Key to use with the selected security mode |
|
10 |
Connection config |
RW |
Single |
No |
Int |
0..1 |
0 |
0 = Optimized 1 = Compliant |
|
11 |
Topic |
RW |
Single |
No |
Str |
0 |
0 |
MQTT-SN topic |
Table 78. Object definition: Elvaco Meter Info
|
Name |
Value |
Description |
|---|---|---|
|
Name |
Elvaco Meter Info |
The name of the object |
|
Object ID |
33908 |
The Object ID |
|
Object description |
||
|
LwM2M version |
1.1 |
The LwM2M Version used |
|
Object version |
2.0 |
The version of this object definition |
Table 79. Resource definition: Elvaco Meter Info resources
|
ID |
Name |
Op |
Multiplicity |
Mandatory |
Type |
Range enumerations |
Units |
Description |
|---|---|---|---|---|---|---|---|---|
|
0 |
Meter Model |
R |
Single |
Yes |
Str |
User-friendly string |
||
|
1 |
Meter ID |
R |
Single |
Yes |
Int |
|||
|
2 |
Communication status |
R |
Single |
Yes |
Int |
0..2 |
0 = OK 1 = No meter detected 2 = Error |
|
|
3 |
Error flags |
R |
Single |
No |
Opa |
Table 80. Object definition: Elvaco NB-IoT Info
|
Name |
Value |
Description |
|---|---|---|
|
Name |
Elvaco NB-IoT Info |
The name of the object |
|
Object ID |
33909 |
The Object ID |
|
Object description |
||
|
LwM2M version |
1.1 |
The LwM2M Version used |
|
Object version |
2.2 |
The version of this object definition |
Table 81. Resource definition: Elvaco NB-IoT Info resources
|
ID |
Name |
Op |
Multiplicity |
Mandatory |
Type |
Range enumerations |
Units |
Description |
|---|---|---|---|---|---|---|---|---|
|
0 |
IMSI |
R |
Single |
Yes |
Int |
International mobile subscriber identity |
||
|
1 |
ICCID |
R |
Single |
Yes |
Str |
Integrated circuit card identifier |
||
|
2 |
Registrations |
R |
Single |
Yes |
Int |
Number of network registrations done |
Table 82. Object definition: Elvaco NB-IoT Status
|
Name |
Value |
Description |
|---|---|---|
|
Name |
Elvaco NB-IoT Status |
The name of the object |
|
Object ID |
33907 |
The Object ID |
|
Object description |
||
|
LwM2M version |
1.1 |
The LwM2M Version used |
|
Object version |
2.0 |
The version of this object definition |
Table 83. Resource definition: Elvaco NB-IoT Status resources
|
ID |
Name |
Op |
Multiplicity |
Mandatory |
Type |
Range enumerations |
Units |
Description |
|---|---|---|---|---|---|---|---|---|
|
0 |
Uptime |
R |
Single |
Yes |
Int |
Uptime in seconds |
||
|
1 |
Average current consumption |
R |
Single |
No |
Int |
Consumption in uA (micro-amps) |
||
|
2 |
Network classification |
R |
Single |
No |
Int |
0 = Excellent 1 = Good 2 = Fair 3 = Poor |
||
|
3 |
ECL |
R |
Single |
Yes |
Int |
0..2 |
||
|
4 |
RSSI |
R |
Single |
Yes |
Int |
In tenths of dBm |
||
|
5 |
SNR |
R |
Single |
Yes |
Int |
In tenths of dB |
||
|
10 |
MDM connection status |
R |
Single |
No |
Int |
0..7 |
0 = OK 1 = Connecting 2 = No credentials 3 = DTLS failed 4 = Communication failed 6 = Socket failed 7 = Idle |
|
|
11 |
Current radio band |
R |
Single |
Yes |
Int |
0..85 |
Current radio band id |
Table 84. Object definition: Elvaco Transaction statistics
|
Name |
Value |
Description |
|---|---|---|
|
Name |
Elvaco Transaction statistics |
The name of the object |
|
Object ID |
33910 |
The Object ID |
|
Object description |
||
|
LwM2M version |
1.1 |
The LwM2M Version used |
|
Object version |
2.0 |
The version of this object definition |
Table 85. Resource definition: Elvaco Transaction statistics resources
|
ID |
Name |
Op |
Multiplicity |
Mandatory |
Type |
Range enumerations |
Units |
Description |
|---|---|---|---|---|---|---|---|---|
|
0 |
Reset statistics |
E |
Single |
Yes |
Resets statistics for what this object instance is tracking. |
|||
|
1 |
Transactions |
R |
Single |
Yes |
Int |
Number of transactions. |
||
|
2 |
Retransmissions |
R |
Single |
Yes |
Int |
Number of retransmissions. |
||
|
3 |
Lost transactions |
R |
Single |
Yes |
Int |
Number of lost transactions. |
||
|
4 |
Average response time |
R |
Single |
No |
Int |
|||
|
5 |
Minimum response time |
R |
Single |
No |
Int |
|||
|
6 |
Maximum response time |
R |
Single |
No |
Int |
Since changing APN is a potentially hazardous operation that may render the device disconnected from the mobile network, there is a rollback functionality in place when changing the APN.
To change APN, write the APN to the resource /10/1/1 and set APN mode to manual in /10/1/2. Once done, stage the changes by executing /33906/0/15. When executed, the device will reset and try to use the new APN. If the device manages a successful bootstrapping, the new APN will be saved as the default. If a successful bootstrapping has not happened for some time, the device will roll back to the old APN and reset again.
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 86. 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 87. 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 |
The error codes transported from an MCM is the status byte of the M-Bus header. Bits 71:64 of M-Bus header.
Meaning of Error Codes
The following information is from the documentation received from Diehl Metering. It has only been enhanced by formatting, content is as-is straight from the document. For latest error description please use the latest documentation available from Diehl Metering. Table 88, “Diehl error codes” corresponds to Table 7 of EN 13757-3:2013 for M-Bus.
Table 88. Diehl error codes
|
Bit |
Description |
Usage |
|---|---|---|
|
0 |
Reserved |
- |
|
1 |
Any application error |
- |
|
2 |
Power low |
E-8, E-9 |
|
3 |
Permanent error |
C-1, E-4 |
|
4 |
Temporary error |
E-1, E-3, E-6, E-7, leak error |
|
5 |
Manufacturer specific |
|
|
6 |
manufacturer specific |
|
|
7 |
manufacturer specific |
Table 89, “Error code positioning” explains the position of error codes from the User’s Manual of the meter.
Table 89. Error code positioning
|
Error |
C-1 |
E-8 |
E-4 |
E-1 |
E-7 |
E-9 |
E-3 |
E-6 |
Leak error |
E-5 |
|---|---|---|---|---|---|---|---|---|---|---|
|
M-bus status Byte |
0x08 |
0x04 |
0x28 |
0x50 |
0x70 |
0x84 |
0xB0 |
0xD0 |
0xF0 |
0x10 |
|
Prio |
Highest |
Lowest |
The table below lists existing meter error codes that, if present, are displayed on the meter along with their corresponding explanations
Table 90. Meter error interpretation
|
Error meter display |
Error description |
|---|---|
|
C-1 |
Basic parameter error in flash or RAM |
|
E-8 |
No primary voltage (only if mains unit used) Powered by back-up battery |
|
E-4 |
Hardware error in ultrasonic measurement Short-circuit in ultrasonic transducer Ultrasonic transducer defective |
|
E-1 |
Temperature measurement error Sensor break Sensor short-circuit Temperature range exceeded [-9.9 °C … 190 °C] |
|
E-7 |
No meaningful ultrasonic receive signal Air in the measuring path |
|
E-9 |
Warning: battery nearly exhausted |
|
E-3** |
Temperature sensors reversed in hot and cold lines |
|
E-6** |
Wrong direction of flow Flow sensor incorrectly installed |
|
E-B* |
Leakage: leakage detected in energy meter |
|
E-C* |
Leakage: leakage pulse input 1 |
|
E-D* |
Leakage: leakage pulse input 2 |
|
E-A* |
Leakage: pipe break detected |
|
E-5 |
Reading too frequently M-Bus communication not possible for short time |
* Optional
** application-dependent
Comments (0 comments)