Configuration options

Introduction

The module 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.

Configuration options via Elvaco OTC App

Using the Elvaco OTC App for configuration is an efficient way of commissioning and configuring an Elvaco communication module. 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 assigned.

Elvaco OTC configuration options: Device

Below set of configuration options governs general the general behavior, such as opening or locking the CMi6140. It also includes a function to revert its settings to factory default.

Table 73. 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, Active	Inactive	RW	R	Activation status of the module. If not active, no actions will be taken by the module.
Configuration Lock	Open, Locked	Open	RW	R	Locks the module to prevent unauthorized access.
Auto Lock Enable	Enabled, Disabled	Disabled	RW	R	Enables or disables the automatic NFC lock.
Auto Lock Enable Timeout	1-14400	15 min	RW	R	Time in minutes before the automatic NFC lock triggers (if enabled).
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	Battery, PSU	Battery	RW	R	Detection and correction of the power source of the meter. Only used if hardware does not support power source detection.
Factory reset	N/A	N/A	E	N/A	Resets the to factory settings (default factory setting for power mode is Active).
Meter identification source	Serial ID, Customer Number	Customer Number	RW	R	Selects whether the customer number or the serial number of the meter should be used for identification.

Elvaco OTC configuration options: LwM2M

Below settings are related to the connection to a LwM2M server.

Table 74. Elvaco OTC configuration options: LwM2M

Name	Possible values	Default value (battery)	Locked device & correct PAK or open device	Locked device & no PAK	Description
BS URI	A valid Bootstrap URI	coaps://84.19.147.226:5694	RW	R	Bootstrap URI of the bootstrap server the module will connect to upon activation.
LwM2M Trigger Reg update	N/A	N/A	E	N/A	Requests the device to perform a registration update with the LwM2M device management server.
Force bootstrap	N/A	N/A	E	N/A	Forces the device to reboot and make a bootstrap. Note Forcing a bootstrap will erase all LwM2M server URIs.
LwM2M queue mode	Enabled, Disabled	Enabled	RW	R	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	7200	RW	R	Delay in seconds between connection sequence attempts to LwM2M servers.
Sequence back-off	Must be formatted as min-max, min-max,..	30-60,60-120	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.

Elvaco OTC configuration options: Cellular

The settings available on the Cellular tab allows tweaking how the device should behave in relation to the NB-IoT network. Typically, these settings should not be changed.

Table 75. Elvaco OTC configuration options: Cellular

Name	Possible values	Default value	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.
APN	Name of APN	N/A	RW	R	APN to use if APN mode is manual
PLMN	[[MCC][MNC]]	0 (automatic PLMN)	RW	R	Possibility to manually set a a specific PLMN. Comprised by MCC and MNC codes (e.g. MCC = 240 and MNC = 01 results in an PLMN code of 24001).
Radio frequency band	0,3,8,20 Several bands can be chosen by e.g. typing 0,3,8	3,8,20	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	144000	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.
Restart backoff	min-max,min-max,..,	0-5,720-1440	RW	R	Delay in ranges of minutes to wait between restarting the modem on failures.
RAI	RAI disable, MQTT-SN RAI, LwM2M RAI, MQTT-SN & LwM2M RAI	MQTT-SN RAI	RW	R	Release Assist Indicator (RAI) enables earlier release of network resources that are no longer needed by the device. Turning this feature on can significantly reduce the load on a network with many deployed devices.

Elvaco OTC configuration options: Communication

The settings within this block determines the behavior of the meter data sent from the CMi6140. 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 76. 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, Standard extended, Combined heating/cooling, Pulse	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	125	RW	R	Time before transmit window starts from transmit interval (in seconds).
Transmit delay	1..1440	45	RW	R	Time period were the transmission while be randomized (in minutes).
Max uploads per transmission	1..168	8	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	20160	RW	R	Maximum age of the resent data (in minutes).
Auto-upload order	Oldest first, Latest first (FiFo/LiFo)	Latest first	RW	R	Start with oldest or newest data when resending data.

Elvaco OTC configuration options: MDM

Below settings governs how the CMi6140 are related to detailed control over how meter data is transferred. It also contains the settings needed to control the System log.

Table 77. 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	60	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	2	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-0, 60-60, 360-360, 1380-1380	RW	R	Delay ranges in minutes between restarting modern on failures.
Syslog level	Info, Notice, Warning, Error, Critical, Off	Info	RW	R	Sets what log entries to store in the module.
Syslog Auto Upload Level	Info, Notice, Warning, Error, Critical, Off	Notice	RW	R	Sets what log entries should be sent by the module, based on their log level. Note that the sending can be turned off, and then instead requested using LwM2M device management.
Syslog Auto Upload Age Limit	0-1051200	20160	RW	R	Age limit of system log entries for auto upload (in minutes).

Elvaco OTC configuration options: Meter alarm monitor

Below settings control the meter alarm monitor in the device. Depending on the use case, it can be configured to be highly responsive or less responsive and thus more battery friendly.

Table 78. Elvaco OTC configuration options: Meter alarm monitor

Parameter	Possible values	Default value	Locked device & correct PAK or open device	Locked device & no PAK	Description
Alarm hysteresis	0-65535	0	RW	R	Sets the hysteresis in minutes. Controls how responsive the alarm monitor will be.
Enable meter alarms	List of all alarms available to monitor.	None	RW	R	From the drop-down list, individually activate the alarms of interest.
Enable alarms auto-reset	List of all alarms available to monitor.	None	RW	R	From the drop-down list, individually activate what alarms that should be automatically reset.
Alarm mask reset period	1-65535	0 (Off)	RW	R	Sets a period reset of meter alarms.
Manual alarm reset	N/A	N/A	E	N/A	Manually reset the alarm mask.
Alarm TX Delay Max	0-65535	5	RW	R	Maximum delay in minutes before a triggered alarm is sent from the module.

Remote device management via LwM2M

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.

The module 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.

OMA defined LwM2M objects

The following section list what OMA defined LwM2M objects that are supported by the module. For a complete and detailed description of each object and their resources, see Open Mobile Alliance - LwM2M Registry.

LwM2M object OMA Device

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 79. 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 80. 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 ("CMi61X0")
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

LwM2M object OMA Connectivity Monitoring

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 81. Object definition: OMA Connectivity Monitoring

Name	Value	Description
Name	Connectivity Monitoring	The name of the object
Object ID	4	The Object ID
LwM2M version	1.3	The LwM2M Version used
Object version		The version of this object definition

Table 82. Resource definition: Connectivity Monitoring resources (Elvaco implementation)

ID	Name	Op	Instances	Mandatory	Type	Range enumerations	Units	Description
0	Network Bearer	R	Multiple	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)
4	IP Addresses	R	Multiple	Yes	Str			The IP addresses assigned to the connectivity interface. (e.g. IPv4, IPv6, etc.)
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

LwM2M object OMA Firmware Update

This LwM2M Object enables management of firmware which is to be updated. The firmware update will require to reboot the device.

Table 83. 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 84. Resource definition: Firmware update resources (Elvaco implementation)

ID	Name	Op	Instances	Mandatory	Type	Range enumerations	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

LwM2M object OMA LwM2M Cellular Connectivity

Table 85. 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 86. 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

LwM2M object OMA LwM2M APN Connection Profile

Table 87. 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 88. Resource definition: LwM2M APN Connection Profile (Elvaco implementation)

ID	Name	Op	Instances	Mandatory	Type	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

Elvaco product specific LwM2M objects

This section list Elvaco specific LwM2M objects and resources.

LwM2M object Elvaco MCM Config

Table 89. 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.14	The version of this object definition

Table 90. 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			42 = CMi6110_Standard 43 = CMi6110_Extended
3	Eco mode enabled	RW	Single	No	Bool
4	NFC Enabled	RW	Single	No	Bool
5	NFC Config-locked	RW	Single	No	Bool			When configuration lock is enabled, the device can only be configured via NFC using an account with access to the product-specific Product Access Key
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
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 keeplive 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
61	Alarm functionality enable bitmask	RW	Single	Yes	Int			Select which meter info the module should monitor and react to. Ex: "0x000f" would enable alarms 0, 1, 2 and 3. All other are disabled.
62	Manual alarm reset bitmask	E	Single	No				Select which meter info to manually reset. Ex: "0x10" would reset alarm bit 4
63	Alarm mask reset period	RW	Single	No	Int	0..4294967295	min	Time period in minutes for periodic reset of alarm mask, 0 = disable periodic reset.
64	Alarm auto-reset bitmask	RW	Single	No	Int			If enabled, an alarm message will be sent for every meter info triggered. Bit mask used to select which alarm mask bit(s) to auto-reset.
65	Alarm hysteresis period	RW	Single	No	Int	0..65535	min	Hysteresis in minutes. Defines how long a meter info must be present in the meter before the module sends an alarm message. The same hysteresis applies for resetting an alarm.
66	Alarm transmit max delay	RW	Single	No	Int	0..255	min	Maximum delay before triggered alarm is transmitted: 0 = instantly transmit.
67	Alarm Topic	RW	Single	No	Str			Alarm MQTT-SN topic
69	Bootstrap URI	RW	Single	No	Str			URI of bootstrap server, e.g. coaps://1.2.3.4:5684
70	Force bootstrap	E	Single	No				Force device to reboot and bootstrap; n.b. this will erase all LwM2M server URIs
71	NFC Auto Lock enable	RW	Single	No	Bool			If enabled, NFC configuration will be locked after a timeout. PAK is required to enable configuration again. Remote configuration is still possible
72	NFC Auto Lock enable timeout	RW	Single	No	Int	2..14400	min	Time in minutes after which NFC configuration will be locked automatically
75	Low battery voltage	RW	Single	No	Int	0..5000		Voltage threshold for battery operated devices for triggering low battery alarm.

LwM2M object Elvaco MDM Server

Table 91. 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 92. Resource definition: Elvaco MDM Server resources

ID	Name	Op	Multiplicity	Mandatory	Type	Range enumerations	Description
0	URI	RW	Single	Yes	Str	0	URI to the meter data server
1	Protocol	RW	Single	Yes	Int	0..	0 = MQTT-SN
2	Transport Security Mode	RW	Single	Yes	Int	0..3	0 = PSK mode 3 = No security
5	Transport Secret Key	W	Single	Yes	Opa	0	Key to use with the selected security mode
10	Connection config	RW	Single	No	Int	0..1	0 = Optimized 1 = Compliant
11	Topic	RW	Single	No	Str	0	MQTT-SN topic

LwM2M object Elvaco Meter Data

Table 93. 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 94. Resource definition: Elvaco Meter Data resources

ID	Name	Op	Multiplicity	Mandatory	Type
0	Message type	R	Single	Yes	Int
1	Message encoding	R	Single	Yes	Int
2	Message data	R	Single	Yes	Opaque

LwM2M object Elvaco Meter Info

Table 95. 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.4	The version of this object definition

Table 96. Resource definition: Elvaco Meter Info resources

ID	Name	Op	Multiplicity	Mandatory	Type	Range enumerations	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	Opaque		Error codes/Status bytes from meter
4	Extended Error codes	R	Single	No	Int		Extended Error Codes from meter. Interpret as a bit mask

LwM2M object Elvaco NB-IoT Info

Table 97. 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.6	The version of this object definition

Table 98. Resource definition: Elvaco NB-IoT Info resources

ID	Name	Op	Multiplicity	Mandatory	Type	Range enumerations	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
3	Last registration duration	R	Single	Yes	Int		Duration in seconds
4	Modem model	R	Single	Yes	Str
5	Modem firmware	R	Single	Yes	Str
6	Registration uptime	R	Single	Yes	Int		Last network registration uptime in seconds
7	Modem firmware update	E	Single	Yes			Trigger modem FOTA. Parameter 0='<url>'
8	Modem firmware update result	R	Single	Yes	Int	0..3	Result of modem FOTA. 0: Initial value. 1: Modem Firmware updated successfully. 2: Error during download. 3: Error during update.
9	IMEI	R	Single	Yes	String		IMEI

LwM2M object Elvaco NB-IoT Status

Table 99. 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.4	The version of this object definition

Table 100. Resource definition: Elvaco NB-IoT Status resources

ID	Name	Op	Multiplicity	Mandatory	Type	Range enumerations	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
12	Current Access Technology	R	Single	No	Int	0..1	0: LTE-M, 1: NB-IoT

LwM2M object Elvaco Syslog config

Table 101. Object definition: Elvaco Syslog config

Name	Value	Description
Name	Elvaco Syslog config	The name of the object
Object ID	33918	The Object ID
Object description	Configuration of syslog functionality for device
LwM2M version	1.1	The LwM2M Version used
Object version	1.0	The version of this object definition

Table 102. Resource definition: Elvaco Syslog config

ID	Name	Op	Multiplicity	Mandatory	Type	Range enumerations	Description
0	Syslog MQTT-SN topic	RW	Single	Yes	Str		Syslog MQTT-SN topic
1	Syslog storage level	RW	Single	Yes	Int	0..6	Minimum log level for storing entry (0..5, indicates DEBUG..CRITICAL), 6=OFF
2	Syslog auto-upload level	RW	Single	Yes	Int	0..6	Minimum log level for auto-uploading an entry (0..5, indicates DEBUG..CRITICAL), 6=OFF
3	Syslog auto-upload age limit	RW	Single	Yes	Int	0..1051200	Maximum age limit in minutes for auto-uploading log entry

LwM2M object Elvaco Transaction statistics

Table 103. 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 104. Resource definition: Elvaco Transaction statistics resources

ID	Name	Op	Multiplicity	Mandatory	Type	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

Changing APN via LwM2M

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.

Message formats

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.

Standard

Table 105. 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"}

Extended

Table 106. 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"}

Combined

Message format Combined is useful in combined meters, where both heating and cooling energy might be present.

Table 107. 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
Forward temperature	4	INT16	Example: 0258xxxx = xxxx * 0.001 °C
Return temperature	4	INT16	Example: 025Cxxxx = xxxx * 0.001 °C
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

Note

Forward and return temperature was added in FW 1.5.0.

Pulse

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 108. 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"

Kamstrup MC403, MC603, MC803 error codes

The following table lists error codes, or info codes, for Kamstrup MC403/603/803. It is a verbatim copy from Kamstrup document “Kamstrup Meter Protocol” version AB1, section 6.4. The same information is publicly available on Kamstrup’s website

Table 109. Kamstrup error codes (info codes)

Bit	Display	Description	403	603	803
0	10000000	Power off	✓	✓	✓
1	20000000	Low battery	✓	✓	✓
2	90000000	External alarm (i.e. via KMP)	✓	✓	✓
3	01000000	t1 above range or disconnected	✓	✓	✓
4	00100000	t2 above range or disconnected	✓	✓	✓
5	02000000	t1 below range or short circuited	✓	✓	✓
6	00200000	t2 below range or short circuited	✓	✓	✓
7	09900000	Wrong dt (t1-t2)	✓	✓	✓
8	00003000	V1 air	✓	✓	✓
9	00004000	V1 reverse	✓	✓	✓
10	00005000	V1 low signal	✓	✓	✓
11	00006000	V1 > qs for more than 1 hour	✓	✓	✓
12	00000080	InA water system leak	✓	✓	✓
13	00000008	InB water system leak	✓	✓	✓
14	00000090	InA external alarm	✓	✓	✓
15	00000009	InB external alarm	✓	✓	✓
16	00001000	V1 com. error	x	✓	✓
17	00002000	V1 pulse error	x	✓	✓
18	00000070	InA2 water system leak	x	✓	✓
19	00000007	InB2 water system leak	x	✓	✓
20	00010000	t3 or t4 above range or disconnected	x	✓	✓
21	00020000	t3 or t4 below range or short circuit	x	✓	✓
22	00000100	V2 com. error	x	✓	✓
23	00000200	V2 pulse error	x	✓	✓
24	00000300	V2 air	x	✓	✓
25	00000400	V2 reverse	x	✓	✓
26	00000500	V2 low signal	x	✓	✓
27	00000600	V2 > qs for more than 1 hour	x	✓	✓
28	00007000	V1V2 Burst Out	x	✓	✓
29	00000700	V1V2 Burst In	x	✓	✓
30	00008000	V1V2 Leak Out	x	✓	✓
31	00000800	V1V2 Leak In	x	✓	✓
>=32	????????	Reserved	x	x	x

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Articles in this section

Comments (0 comments)

Article is closed for comments.