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 the general behavior, such as opening or locking the CMi6110. It also includes a function to revert its settings to factory default.

Table 15. Elvaco OTC configuration options: Device

Name

Possible values

Default value

Locked device & correct PAK or open device

Locked device & no PAK

Description

Power mode

Inactive, Active, Standby

Inactive

RW

R

Activation status of the module. If not active, no actions will be taken by the module.

If using Standby, the module will be activated based on sufficient water flowing through the meter.

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

RW

R

Timeout in minutes for the auto lock feature.

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 module to factory settings (default factory setting for power mode is Active).


Elvaco OTC configuration options: LwM2M

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

Table 16. 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

Request the device to perform a registration update with the LwM2M Device Management Server.

Force Bootstrap

N/A

N/A

E

N/A

Force the device to reboot and bootstrap. NB! This will erase all LwM2M Server URIs.

LwM2M queue mode

Enabled, Disabled

Disabled

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 17. 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

Valid PLMN

0 (automatic)

RW

R

A valid PLMN comprised by MCC and MNC codes. E.g. MCC = 240 and MNC = 01, results in a 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, NTP, Manual

Network

RW

R

Source for setting meter clock.

Brownout 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 in minutes to wait between restarting the modem on failures.

RAI

Disabled, MDM RAI enable, DM RAI enable, DM+MDM RAI enable

MDM RAI Enable

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 CMi6110. 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 often it is sent (transmitted) to a receiving server over the NB-IoT network.

Table 18. Elvaco OTC configuration options: Communication

Name

Possible values

Default value

Locked device & correct PAK or open device

Locked device & no PAK

Description

Message format

Standard, Standard extended

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.

Measurement mode

Preset, Custom

Preset

RW

R

Defines if the device should use a predefined message format, or rely on a custom message format defined by the user.

Custom message registers

Toggle input over available meter registers.

Replica of message format Standard.

RW

R

Selection of meter registers to transmit from the module if the Measurement mode Custom is enabled.

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 where the transmission will be randomized (in minutes).

Max uploads per transmission

1..168

8

RW

R

The number of max packages / transmissions. This will affect 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

The below settings govern how the CMi6110 are related to detailed control over how meter data is transferred. It also contains the settings needed to control the System log.

Table 19. Elvaco OTC configuration options: MDM

Parameter

Possible values

Default value

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

Time in minutes.


Elvaco OTC configuration options: Meter alarm monitor

Below settings governs how the CMi6110 are related to detailed control over how the meter alarm monitor will behave.

Table 20. 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

10

RW

R

Hysteresis in minutes. Defines how long a meter info must be present in the meter before the device sends an alarm. The same hysteresis applies for resetting an alarm.

Enable meter alarms

Toggle input over available meter registers.

All alarms disabled

RW

R

Selection of alarms to transmit from the module if the alarm conditions are met.

Enable alarms auto-reset

Enable, Disable

Disable

RW

R

Setting to enable or disable automatic reset of triggered alarms.

Manual alarm reset

N/A

N/A

E

N/A

Manually reset of the alarm mask.

Alarm TX Delay Max (minutes)

0-255

0

RW

R

Maximum (randomized) delay in minutes before a triggered alarm is transmitted. 0 = instantly transmit.

Back flow threshold (%)

-10000-0

-3

RW

R

Threshold value (in negative percent) of meter measurement range after which a back flow alarm is set.

Max flow threshold (%)

0-10000

200

RW

R

Threshold value (in percent) of meter measurement range after which a maximum flow alarm is triggered.

Low battery threshold (mV)

2000-6000

2300

RW

R

Threshold value (in mV) for where the low battery alarm should be set.


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 21. 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 22. 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 23. 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 24. 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 25. 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 26. 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


LwM2M object OMA LwM2M Cellular Connectivity

Table 27. 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 28. 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 29. 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 30. 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


Elvaco product specific LwM2M objects

This section lists all Elvaco product specific LwM2M objects.

Object definition: Elvaco MCM Config

Table 31. 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.16

The version of this object definition


Table 32. Resource definition: Elvaco MCM Config resources

ID

Name

Op

Multiplicity

Mandatory

Type

Range Enum

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

68

Measurement mode

RW

Single

No

Int

0..2

Measurement mode of the device. 0 = Preset mode - default operating mode, device reads a pre-defined set of data points in the meter and the choice of message format sets what data to be sent. 1 = Transparent mode - module reads a meter-defined telegram. The telegram is sent complete, as received from the meter. Forces SenML/CBOR encoding. 2 = Custom mode - device reads a module-defined telegram that is configured using 'Custom format transmit fields'. Encoding is done in the module, using information read from meter. Forces SenML/CBOR encoding.

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

73

Max flow percent

RW

Single

No

Int

0..10000

Maximum flow percent which will trigger a max flow alarm - 0 for disabled (UH50 meter only)

74

Back flow percent

RW

Single

No

Int

-10000..0

Back flow percent which will trigger a back flow alarm - 0 for disabled (UH50 meter only)

75

Low battery voltage

RW

Single

No

Int

0..5000

mV

Voltage threshold for battery operated devices for triggering low battery alarm.

76

Custom format transmit fields

RW

Single

No

Opaque

Bitmask defining which data fields are included in payload of measurement mode custom. The bitmask is encoded as a little-endian byte array; byte 0 contains bits 0–7, byte 1 contains bits 8–15, and so on.


Object definition: Elvaco MDM Server

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

ID

Name

Op

Multiplicity

Mandatory

Type

Range Enum

Units

Description

0

URI

RW

Single

Yes

Str

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

Opaque

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

MQTT-SN topic


Object definition: Elvaco Meter Data

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

ID

Name

Op

Multiplicity

Mandatory

Type

Range Enum

Units

Description

0

Message Type

R

Single

Yes

Int

1

Message Encoding

R

Single

Yes

Int

2

Message Data

R

Single

Yes

Opaque


Object definition: Elvaco Meter Info

Table 37. 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 38. Resource definition: Elvaco Meter Info resources

ID

Name

Op

Multiplicity

Mandatory

Type

Range Enum

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..3

0 = OK 1 = No meter detected 2 = Error 3 = Encryption unsupported

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


Object definition: Elvaco NB-IoT info

Table 39. 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 40. Resource definition: Elvaco NB-IoT info resources

ID

Name

Op

Multiplicity

Mandatory

Type

Range Enum

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

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

Str

IMEI

10

Power Stats

R

Multiple

No

Opaque

CBOR:{{psmInd(0):{nAct,tAct},cscon(1):{nAct,tAct}},...}


Object definition: Elvaco NB-IoT status

Table 41. 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 42. Resource definition: Elvaco NB-IoT status resources

ID

Name

Op

Multiplicity

Mandatory

Type

Range Enum

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

12

Current Access Technology

R

Single

No

Int

0..1

0: LTE-M, 1: NB-IoT


Object definition: Elvaco syslog config

Table 43. 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.2

The version of this object definition


Table 44. Resource definition: Elvaco syslog config resources

ID

Name

Op

Multiplicity

Mandatory

Type

Range Enum

Units

Description

0

Syslog MQTT-SN topic

RW

Single

Yes

Str

0..64

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

4

Historical syslog readout trigger

E

Single

No

Trigger historical syslog readout. Execute arguments: 0=<from unix timestamp>, 1=<to unix timestamp>, 2=<minimum log level (0..6)>.


Object definition: Elvaco Transaction statistics

Table 45. 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

Statistics access module. Instance 0 = DM statistics Instance 1 = MDM statistics.

LwM2M Version

1.1

The LwM2M Version used

Object Version

2.0

The version of this object definition


Table 46. Resource definition: Elvaco Transaction statistics resources

ID

Name

Op

Multiplicity

Mandatory

Type

Range Enum

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


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

The message format defines which meter data records are included in the transmitted meter data payload. The available message format options depend on the selected measurement mode.

When using Preset mode, the payload is defined by one of the predefined message formats: Standard or Extended. When using Custom mode, the payload is defined by the Custom format transmit fields configuration. This makes it possible to select which supported meter registers are included in the transmitted payload.

Preset message formats

CMi6110 has two different message formats, Standard and Extended. By selecting message format, the user can decide what meter registers that will be included in the message sent from the module. Extended includes all Standard registers plus Tariff 1–3 and Missing time

Standard

Table 47. Meter registers, message format Standard [0x2A]

Field

Description

Energy

Energy consumption (kWh)

Mapped to OBIS 6.8

Volume

Volume (m3)

Mapped to OBIS 6.26

Power

Power (kW)

Mapped to OBIS 6.4

Flow

Flow (m3/h)

Mapped to OBIS 6.27

Fw temp

Forward temperature (°C)

Mapped to OBIS 6.29

Rt temp

Return temperature (°C)

Mapped to OBIS 6.28

Meter ID

Identification number of the meter in which the module is installed

Error flags

Error and warning flags  16-bit hexadecimal value

Meter

date/time

Date/time of the meter at time of readout


Extended

Table 48. Meter registers, message format Extended [0x2B]

Field

Description

Tariff 1

Energy consumption (kWh)

Mapped to OBIS 6.8.1

Tariff register 1 or cooling energy (in combined heat/cooling meters)

Tariff 2

Energy consumption (kWh)

Mapped to OBIS 6.8.2

Tariff register 2 or heating energy (in combined heat/cooling meters)

Tariff 3

Energy consumption (kWh)

Mapped to OBIS 6.8.3 

Tariff register 3

Missing time

Accumulated downtime


Custom message format

When using Custom mode, the transmitted payload is based on a configurable selection of meter registers. Each selectable meter register is mapped to a bit in the Custom format transmit fields bitmask. By setting the corresponding bits, the user defines which meter registers are included in the transmitted payload.

Configuring the Custom message format

The Custom message format is configured using the Custom format transmit fields bitmask. Each bit in the bitmask corresponds to one selectable meter register. A register is included in the transmitted payload when its corresponding bit is set to 1. A register is excluded when its corresponding bit is set to 0.

The bitmask is encoded as a little-endian byte array. This means that byte 0 contains bits 0–7, byte 1 contains bits 8–15, byte 2 contains bits 16–23, and so on.

At least one meter identification field must be selected. This means that either Fabrication number, Customer number, or both must be selected in the Custom format transmit fields bitmask. If neither of them are selected, Fabrication number will be included.

Date and time are always included in the SenML/CBOR package. If System date and time is selected in the Custom format transmit fields bitmask, date and time are also included in the M-Bus payload.

Payload example Custom message format

The example below shows a measurement payload using Custom mode and Custom format transmit fields set to F9010800. The bitmask is encoded as a little-endian byte array, where:

Byte

Byte value

Set meter register bits

Meter registers

0

F9

0, 3, 4, 5, 6, 7

Fabrication number, Energy, Volume, Power, Flow, Forward temp

1

01

8

Return temp

2

08

19

Error flags

3

00

None

None

  1. Raw payload (using the example with bitmask F9010800):

    82A200615602190400A222C11A6A22AC300858270C7838266966040659AD05000414B5392000022B0000023BFBFF025B0000025F000002FD170401

  2. Decode raw payload (e.g. using https://cbor.me/):

    [{0: "V", 2: 1024}, {-3: 1(1780657200), 8: h'0C7838266966040659AD05000414B5392000022B0000023BFBFF025B0000025F000002FD170401'}]

    Tip

    Note that the encoder type is set to 1024 (0x0400), which indicates that the received data uses the Custom message format (see SenML/CBOR for details).

  3. Identify the data record in the package:

    0C7838266966040659AD05000414B5392000022B0000023BFBFF025B0000025F000002FD170401

  4. Parse the M-Bus application data

    M-Bus data record

    DIF/VIF

    Custom bit

    Meter register

    0C7838266966

    0C 78

    0

    Fabrication number

    040659AD0500

    04 06

    3

    Energy

    0414B5392000

    04 14

    4

    Volume

    022B0000

    02 2B

    5

    Power

    023BFBFF

    02 3B

    6

    Flow

    025B0000

    02 5B

    7

    Forward temp

    025F0000

    02 5F

    8

    Return temp

    02FD170401

    02 FD 17

    19

    Error flags

Note

The above example is the custom way of representing the existing preset message format standard.

Available meter registers

Table 49. Available meter registers

Bit

Register Information

Register Comment

OBIS code

DIF/VIF

Payload size max bytes

0

Fabrication number

At least one of bit 0 and 1 must be selected.

9.20

0C 78 + 4 data bytes. ST0, tariff 0, sub-unit 0, function instant.

6

1

Customer number

MeterID according to standard format.

9.21

0C 79 + 4 data bytes. ST0, tariff 0, sub-unit 0, function instant.

6

2

System date and time

Date and time are included in CBOR packet even if not included in M-Bus payload.

9.36

04 6D + 4 data bytes. ST0, tariff 0, sub-unit 0, function instant. Type F date/time.

6

3

Energy

Energy

6.8

04 06 example, VIF follows energy scaler. ST0, tariff 0, sub-unit 0, function instant.

7

4

Volume

Volume

6.26

04 14 example, VIF follows volume scaler. ST0, tariff 0, sub-unit 0, function instant.

6

5

Power

Power

6.4

02 2B/02 2D example, VIF follows power scaler. ST0, tariff 0, sub-unit 0, function instant.

4

6

Flow

Flow

6.27

02 3B example, VIF follows flow scaler. ST0, tariff 0, sub-unit 0, function instant.

4

7

Forward temp

Forward temperature

6.29

02 5A/02 5B. ST0, tariff 0, sub-unit 0, function instant.

4

8

Return temp

Return temperature

6.28

02 5E/02 5F. ST0, tariff 0, sub-unit 0, function instant.

4

9

Energy Tariff 1

Energy Tariff 1

6.8.1

84 10 06 example. ST0, tariff 1, sub-unit 0, function instant.

8

10

Energy Tariff 2

Energy Tariff 2

6.8.4

84 20 06 example. ST0, tariff 2, sub-unit 0, function instant.

8

11

Energy Tariff 3

Energy Tariff 3

6.8.5

84 30 06 example. ST0, tariff 3, sub-unit 0, function instant.

8

12

Max power

Max power of previous month

9.36.1*xx

92 02 2B/92 02 2D example. ST4, tariff 0, sub-unit 0, function maximum (01b, DIF +0x10).

5

13

Max power TS

Max power timestamp from previous month

9.36.1*xx

82 02 6C + 2 data bytes. ST4, tariff 0, sub-unit 0, function instant. Type G date of max power.

5

14

Max flow

Max flow of previous month

6.33*xx

D2 01 3B example. ST3, tariff 0, sub-unit 0, function maximum (01b, DIF +0x10)

5

15

Max flow TS

Max flow timestamp from previous month

6.6*xx

C2 01 6C + 2 data bytes. ST3, tariff 0, sub-unit 0, function instant. Type G date

5

16

Due date

Monthly register due date

9.36.6*xx

82 01 6C + 2 data bytes. ST2, tariff 0, sub-unit 0, function instant. Type G monthly due date.

5

17

Energy previous month

Energy at previous month due date

6.8*xx

84 01 06 example. ST2, tariff 0, sub-unit 0, function instant.

8

18

Volume previous month

Volume at previous month due date

6.26*xx

84 01 14 example. ST2, tariff 0, sub-unit 0, function instant.

7

19

Error flags

Error flags from meter

02 FD 17 + 2 data bytes. ST0, tariff 0, sub-unit 0, function instant.

5

20

Extended Info

Meter error flags extended with module specific error flags.

04 FD 18 + 4 data bytes. ST0, tariff 0, sub-unit 0, function instant.

7

21

Downtime

Downtime

6.32

34 22 example. ST0, tariff 0, sub-unit 0, function error state (11b, DIF +0x30). Missing/downtime as on-time hours.

6

22

Measurement range

Measurement range

9.24

02 BB FF 04 + 2 data bytes. ST0, tariff 0, sub-unit 0, function instant. Flow/range VIF with manufacturer-specific VIFE FF 04.

4

23

Device configuration

Meter firmware version

9.1

0D FD 0F + LVAR/data. ST0, tariff 0, sub-unit 0, function instant. Software/firmware version string.

11


L+G UH50 error codes

Note

Make sure to double check error codes identifier and explanation with latest meter specification.

Table 50. L+G meter specific error codes

Bit-No

Identifier

Explanation

0

F0

Error during flow metering (e.g. Air in measuring pipe)

1

F1

Interruption of flow temperature sensor

2

F2

Interruption of return temperature sensor

3

F3

Electronic for temperature evaluation defective

4

F41

Meter battery empty

5

F5

Short-circuit flow temperature sensor

6

F6

Short-circuit return temperature sensor

7

F7

Fault in the internal memory (CRC)

8

F8

Error F1, F2, F5 or F6 pending for longer than 8h.

9

F9

Error in the electronics

10

F0V

Prewarning for soiling of the measurement tube

11

F7V2

Correctable error in the internal memory EEPROM 2


Was this article helpful?

0 out of 0 found this helpful
Have more questions? Submit a request

Comments (0 comments)

Article is closed for comments.