MQTT Report Templates

Report template 4001

Report format

This report contains value data in M-Bus raw format used when installation of a new meter is completed. This information can be useful to add meters when installation process is completed.

The report publishes meter data as an MQTT message to a topic on an MQTT broker. When executed, the device connects to the broker and sends a message for each meter and timestamp, containing all values. Any client subscribed to the topic will then immediately receive the meter data.

Topic

The report data is published to the MQTT broker using the following topic format:

<Base_topic>/ecmXv1.0/CMe3100/<report template>/<serial number>/<meter ID>

Where <Base_topic> is an optional configuration in the CMe3100:

  1. To set the base topic, go to Configuration > Push reports > MQTT settings.

  2. Set your Base topic.

Below is an example of an MQTT message from a device with serial number 0006123456, reporting data from a connected meter (serial number 50855417) using report template 4001, under the base topic "Company A".

Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Note

The MQTT topic acts as the routing key for message delivery. Subscribers receive messages based on topic matching.

Payload

The payload contains rows. Each row contains the origin of the value and the actual value for a specific time.

Table 328. Column header description

Column index (0 = first column)

Column contents

Description

0

<serial-number>

Product serial number

1

<device-identification>

The device (meter) secondary address

2

<created>

The date/time of this value. Format: YYYY-MM-DD hh:mm:ss

3

<value-data-count>

The M-Bus telegram number from which this record is taken

4

<mbus-raw>

M-Bus raw data, starting with M-Bus CField. Stop character and checksum of the M-Bus telegram is excluded.

Example of payload contents

serial-number;device-identification;created;value-data-count;mbus-raw-value 00000161;05047168;2009-12-17 00:00:00;00;08147268710405ac484103470000000c1480769604046dba092e1a426c 2a194c140000000042ec7e3f1c0fc010010c

Report template 4005

Report format

This report contains event information sent from the product. Example of events are firmware updates and reboots.

The report publishes meter data as an MQTT message to a topic on an MQTT broker. When executed, the device connects to the broker and sends a message for each meter and timestamp, containing all values. Any client subscribed to the topic will then immediately receive the meter data.

Topic

The report data is published to the MQTT broker using the following topic format:

<Base_topic>/ecmXv1.0/CMe3100/<report template>/<serial number>/<meter ID>

Where <Base_topic> is an optional configuration in the CMe3100:

  1. To set the base topic, go to Configuration > Push reports > MQTT settings.

  2. Set your Base topic.

Below is an example of an MQTT message from a device with serial number 0006123456, reporting data from a connected meter (serial number 50855417) using report template 4001, under the base topic "Company A".

Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Note

The MQTT topic acts as the routing key for message delivery. Subscribers receive messages based on topic matching.

Payload contents

The payload contains a column header line and key value pairs of information.

Table 329. Column header description

Column index

(0 = first column)

Column contents

Description

0

#

Fixed value indicating column information line.

1

key

Fixed value

2

value

Fixed value

Table 330. Value line definition

Column index

(0 = first column)

Column contents

Description

0

<key>

Key name

Can be one of the following:

time

serial-number

event

module-revision

sw-version

prepaid-infoavailable

prepaid-credits

prepaid-currency

prepaid-expiredate

1

<value>

Value

Example of body contents for firmware update event

#key;value time;2010-09-01 00:01:02 serial-number;0016123456 event;fwupdate module-revision;1.100

Report template 4006

Report format

This report contains log information sent from the product.

The report publishes meter data as an MQTT message to a topic on an MQTT broker. When executed, the device connects to the broker and sends a message for each meter and timestamp, containing all values. Any client subscribed to the topic will then immediately receive the meter data.

Topic

The report data is published to the MQTT broker using the following topic format:

<Base_topic>/ecmXv1.0/CMe3100/<report template>/<serial number>/<meter ID>

Where <Base_topic> is an optional configuration in the CMe3100:

  1. To set the base topic, go to Configuration > Push reports > MQTT settings.

  2. Set your Base topic.

Below is an example of an MQTT message from a device with serial number 0006123456, reporting data from a connected meter (serial number 50855417) using report template 4001, under the base topic "Company A".

Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Note

The MQTT topic acts as the routing key for message delivery. Subscribers receive messages based on topic matching.

Payload contents

The payload contains a column header line and log information lines.

The log level can be changed in CMe3100 web interface using System > System log > Severity or using configuration key common.syslog.level.

Table 331. Column header description

Column index

(0 = first column)

Column contents

Description

0

#

Fixed value indicating column information line.

1

serial-number

Fixed value

2

created

Fixed value

3

level

Fixed value

4

message

Fixed value

Table 332. Value line definition

Column index

(0 = first column)

Column contents

Description

0

<serial-number>

Serial number of the product

1

<created>

The date/time for this log information line. Format: YYYY-MM-DD hh:mm:ss

2

<level>

The level of this log line.

Available levels are:

-2 = Debug

-1 = Unknown

0 = Info

1 = Warning

2 = Error

3 = Critical

4 = Fatal

5 = Unhandled exception

6 = Event

7 = Network event

3

<message>

Log information message in clear text.

Example of body contents

#serial-number;created;level;message 0016123456;2010-09-01 00:00:00;0;[CMAppl] Starting application 0016123456;2010-09-01 00:00:02;0;[Event] event=boot 0006123456;2010-09-01 00:00:03;0;[storevalue] Storevalue completed successfully

Report template 4007

Report format

This report contains status information sent from the product. Example of status information is cell information, signal quality etc.

The report publishes meter data as an MQTT message to a topic on an MQTT broker. When executed, the device connects to the broker and sends a message for each meter and timestamp, containing all values. Any client subscribed to the topic will then immediately receive the meter data.

Topic

The report data is published to the MQTT broker using the following topic format:

<Base_topic>/ecmXv1.0/CMe3100/<report template>/<serial number>/<meter ID>

Where <Base_topic> is an optional configuration in the CMe3100:

  1. To set the base topic, go to Configuration > Push reports > MQTT settings.

  2. Set your Base topic.

Below is an example of an MQTT message from a device with serial number 0006123456, reporting data from a connected meter (serial number 50855417) using report template 4001, under the base topic "Company A".

Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Note

The MQTT topic acts as the routing key for message delivery. Subscribers receive messages based on topic matching.

Payload contents

The payload contains a column header line and key value pairs of information.

Table 333. Column header description

Column index

(0 = first column)

Column contents

Description

0

#

Fixed value indicating column information line.

1

key

Fixed value

2

value

Fixed value

Table 334. Value line definition

Column index

(0 = first column)

Column contents

Description

0

<key>

Key name

Can be one of the following:

time

serial-number

name

part-number

imei

imsi

hw-version

sw-version

boot-time

internal-temperature

internal-voltage

rssi

gprs-available

operator

cell

apn

ip

simid

prepaid-infoavailable

prepaid-credits

prepaid-currency

prepaid-expiredate

1

<value>

Value

Example of file contents

#key;value time;2010-09-28 08:34:52 serial-number;0012000848 name; part-number;CMi2110 imei;353234020692347 imsi;240016002844890 hw-version;R4A sw-version;1.1.4 boot-time;2010-09-27 12:03:42 internal-temperature;28 °C internal-voltage;4074 mV rssi;-75 dBm gprs-available;2 operator;TELIA S cell;AB7C apn;online.telia.se ip;90.237.26.36 simid;89460100090806021242 prepaid-infoavailable;true prepaid-credits;92,30 prepaid-currency;SEK prepaid-expiredate;2011-09-29 00:00:00

Report template 4101

Report format

This report contains value data in decoded format, i.e. the data is sent in clear text and no knowledge of how to decode M-Bus information is needed.

The report publishes meter data as an MQTT message to a topic on an MQTT broker. When executed, the device connects to the broker and sends a message for each meter and timestamp, containing all values. Any client subscribed to the topic will then immediately receive the meter data.

Topic

The report data is published to the MQTT broker using the following topic format:

<Base_topic>/ecmXv1.0/CMe3100/<report template>/<serial number>/<meter ID>

Where <Base_topic> is an optional configuration in the CMe3100:

  1. To set the base topic, go to Configuration > Push reports > MQTT settings.

  2. Set your Base topic.

Below is an example of an MQTT message from a device with serial number 0006123456, reporting data from a connected meter (serial number 50855417) using report template 4001, under the base topic "Company A".

Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Note

The MQTT topic acts as the routing key for message delivery. Subscribers receive messages based on topic matching.

Payload contents

The payload contains one column header line, followed by one value data lines. The column header line describes the contents of the following value data line.

Table 335. Column header description

Column index

(0 = first column)

Column contents

Description

0

serial-number

Fixed field

1

device-identification

Fixed field

2

created

Fixed field

3

value-data-count

Fixed field

4

Manufacturer

Fixed field

5..n

<value-description>

Value description information. This information describes the exact contents of this column. Depending on meter, one or more value description columns are added.

The value description contains 6 fields delimited with comma. These fields provide the exact meaning of the contents of this column.

The 6 fields are:

Description

Unit

Function

Tariff

Sub unit

Storage number

Please see Report Template Reference Information for complete description of these fields.

Example of payload contents

serial-number;device-identification;created;value-datacount;manufacturer;parameter-set-id no-error,,instvalue,0,0,0;datetime no-error,,inst-value,0,0,0;on-time noerror,hour(s),inst-value,0,0,0;energy no-error,Wh,instvalue,1,0,0;energy no-error,Wh,inst-value,2,0,0;energy noerror,Wh,inst-value,1,2,0;energy no-error,Wh,instvalue,2,2,0;manufacturer-specific,,inst-value,0,0,0;power manufacturer-specific,W,inst-value,0,0,0;power manufacturerspecific,W,inst-value,0,0,0;power manufacturer-specific,W,instvalue,0,0,0;power manufacturer-specific,W,inst-value,0,2,0;power manufacturer-specific,W,inst-value,0,2,0;power manufacturerspecific,W,inst-value,0,2,0;power no-error,W,max-value,1,0,0;power noerror,W,max-value,2,0,0;voltage manufacturer-specific,V,instvalue,0,0,0;voltage manufacturer-specific,V,inst-value,0,0,0;voltage manufacturer-specific,V,inst-value,0,0,0;current manufacturerspecific,A,inst-value,0,0,0;current manufacturer-specific,A,instvalue,0,0,0;current manufacturer-specific,A,instvalue,0,0,0;manufacturer-specific,,inst-value,0,0,0;manufacturerspecific,,inst-value,0,0,0;manufacturer-specific,,instvalue,0,0,0;manufacturer-specific,,inst-value,0,0,0;reset-counter noerror,,inst-value,0,0,0;error-flags-dev-spec no-error,,instvalue,0,0,0;datetime no-error,,inst-value,0,0,0 06000885;00902947;2010-04-19 00:00:00;00;1048543;353506619;420;104730;50;1420;80;1;0;0;0;0;0;0;5550 ;220;239;239;239;0,00;0,00;0,00;498;0;0;0;9;0;352718348

Report template 4102

Report format

This report contains value data in M-Bus raw format.

The report publishes meter data as an MQTT message to a topic on an MQTT broker. When executed, the device connects to the broker and sends a message for each meter and timestamp, containing all values. Any client subscribed to the topic will then immediately receive the meter data.

Topic

The report data is published to the MQTT broker using the following topic format:

<Base_topic>/ecmXv1.0/CMe3100/<report template>/<serial number>/<meter ID>

Where <Base_topic> is an optional configuration in the CMe3100:

  1. To set the base topic, go to Configuration > Push reports > MQTT settings.

  2. Set your Base topic.

Below is an example of an MQTT message from a device with serial number 0006123456, reporting data from a connected meter (serial number 50855417) using report template 4001, under the base topic "Company A".

Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Note

The MQTT topic acts as the routing key for message delivery. Subscribers receive messages based on topic matching.

Payload contents

The payload contains rows.

Table 336. Column header description

Column index

(0 = first column)

Column contents

Description

0

<serial-number>

Product serial number

1

<device-identification

The device (meter) secondary address

2

<created>

The date/time of this value. Format: YYYY-MM-DD hh:mm:ss

3

<value-data-count

The M-Bus telegram number from which this record is taken

4

<mbus-raw>

M-Bus raw data, starting with M-Bus C-Field. Stop character and checksum of the M-Bus telegram is excluded.

Example of body contents

serial-number;device-identification;created;value-data-count;mbus-raw-value 00000161;05047168;2009-12-17 00:00:00;00;08147268710405ac484103470000000c1480769604046dba092e1a426c

Report template 4105

Report format

This report contains value data in decoded format, i.e. the data is sent in clear text and no knowledge of how to decode M-Bus information is needed.

The report publishes meter data as an MQTT message to a topic on an MQTT broker. When executed, the device connects to the broker and sends a message for each meter and timestamp, containing all values. Any client subscribed to the topic will then immediately receive the meter data.

Topic

The report data is published to the MQTT broker using the following topic format:

<Base_topic>/ecmXv1.0/CMe3100/<report template>/<serial number>/<meter ID>

Where <Base_topic> is an optional configuration in the CMe3100:

  1. To set the base topic, go to Configuration > Push reports > MQTT settings.

  2. Set your Base topic.

Below is an example of an MQTT message from a device with serial number 0006123456, reporting data from a connected meter (serial number 50855417) using report template 4001, under the base topic "Company A".

Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Note

The MQTT topic acts as the routing key for message delivery. Subscribers receive messages based on topic matching.

Payload contents

The payload contains one column header line and one value data line. Each column header in the first line of a file describes the contents of the value data lines.

Table 337. Column header description

Column index

(0 = first column)

Column contents

Description

0

#

Fixed field indicating column header information line.

1

serial-number

Fixed field

2

device-identification

Fixed field

3

created

Fixed field

4

value-data-count

Fixed field

5..n

<value-description

Value description information. This information describes the exact contents of this column. Depending on meter, one or more value description columns are added.

The value description contains 6 fields delimited with comma. These fields provide the exact meaning of the contents of this column.

The 6 fields are:

Description

Unit

Function

Tariff

Sub unit

Storage number

Please see Report Template Reference Information for complete description of these fields.

Example of first line in payload with column headers

#serial-number;device-identification;created;value-datacount;parameter-set-id no-error,,inst-value,0,0,0;datetime noerror,,inst-value,0,0,0;on-time no-error,hour(s),instvalue,0,0,0;energy no-error,Wh,inst-value,1,0,0;energy noerror,Wh,inst-value,2,0,0;energy no-error,Wh,inst-value,1,2,0;energy no-error,Wh,inst-value,2,2,0;manufacturer-specific,,instvalue,0,0,0;power manufacturer-specific,W,inst-value,0,0,0;power manufacturer-specific,W,inst-value,0,0,0;power manufacturerspecific,W,inst-value,0,0,0;power manufacturer-specific,W,instvalue,0,2,0;power manufacturer-specific,W,inst-value,0,2,0;power manufacturer-specific,W,inst-value,0,2,0;power no-error,W,maxvalue,1,0,0;power no-error,W,max-value,2,0,0;voltage manufacturerspecific,V,inst-value,0,0,0;voltage manufacturer-specific,V,instvalue,0,0,0;voltage manufacturer-specific,V,inst-value,0,0,0;current manufacturer-specific,A,inst-value,0,0,0;current manufacturer-specific,A,inst-value,0,0,0;current manufacturer-specific,A,instvalue,0,0,0;manufacturer-specific,,inst-value,0,0,0;manufacturerspecific,,inst-value,0,0,0;manufacturer-specific,,instvalue,0,0,0;manufacturer-specific,,inst-value,0,0,0;reset-counter noerror,,inst-value,0,0,0;error-flags-dev-spec no-error,,instvalue,0,0,0;datetime no-error,,inst-value,0,0,0

Example of value data lines

06000885;00902947;2010-04-19 00:00:00;00;1048543;353506619;420;104730;50;1420;80;1;0;0;0;0;0;0;5550 ;220;239;239;239;0,00;0,00;0,00;498;0;0;0;9;0;352718348

Example of payload with all contents

#serial-number;device-identification;created;value-datacount;parameter-set-id no-error,,inst-value,0,0,0;datetime noerror,,inst-value,0,0,0;on-time no-error,hour(s),instvalue,0,0,0;energy no-error,Wh,inst-value,1,0,0;energy noerror,Wh,inst-value,2,0,0;energy no-error,Wh,inst-value,1,2,0;energy no-error,Wh,inst-value,2,2,0;manufacturer-specific,,instvalue,0,0,0;power manufacturer-specific,W,inst-value,0,0,0;power manufacturer-specific,W,inst-value,0,0,0;power manufacturerspecific,W,inst-value,0,0,0;power manufacturer-specific,W,instvalue,0,2,0;power manufacturer-specific,W,inst-value,0,2,0;power manufacturer-specific,W,inst-value,0,2,0;power no-error,W,maxvalue,1,0,0;power no-error,W,max-value,2,0,0;voltage manufacturerspecific,V,inst-value,0,0,0;voltage manufacturer-specific,V,instvalue,0,0,0;voltage manufacturer-specific,V,inst-value,0,0,0;current manufacturer-specific,A,inst-value,0,0,0;current manufacturerspecific,A,inst-value,0,0,0;current manufacturer-specific,A,instvalue,0,0,0;manufacturer-specific,,inst-value,0,0,0;manufacturerspecific,,inst-value,0,0,0;manufacturer-specific,,instvalue,0,0,0;manufacturer-specific,,inst-value,0,0,0;reset-counter noerror,,inst-value,0,0,0;error-flags-dev-spec no-error,,instvalue,0,0,0;datetime no-error,,inst-value,0,0,0 06000885;00902947;2010-04-19 00:00:00;00;1048543;353506619;420;104730;50;1420;80;1;0;0;0;0;0;0;5550 ;220;239;239;239;0,00;0,00;0,00;498;0;0;0;9;0;352718348

Report template 4106

Report format

This report contains value data in M-Bus raw format.

The report publishes meter data as an MQTT message to a topic on an MQTT broker. When executed, the device connects to the broker and sends a message for each meter and timestamp, containing all values. Any client subscribed to the topic will then immediately receive the meter data.

Topic

The report data is published to the MQTT broker using the following topic format:

<Base_topic>/ecmXv1.0/CMe3100/<report template>/<serial number>/<meter ID>

Where <Base_topic> is an optional configuration in the CMe3100:

  1. To set the base topic, go to Configuration > Push reports > MQTT settings.

  2. Set your Base topic.

Below is an example of an MQTT message from a device with serial number 0006123456, reporting data from a connected meter (serial number 50855417) using report template 4001, under the base topic "Company A".

Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Note

The MQTT topic acts as the routing key for message delivery. Subscribers receive messages based on topic matching.

Payload contents

The payload contains one column header line, followed by one value data lines.

Table 338. Column header description

Column index

(0 = first column)

Column contents

Description

0

#

Fixed field indicating column header information line.

1

serial-number

Fixed field. Data row contains the CMe/CMi product serial number.

2

device-identification

Fixed field. Data row contains the M-Bus device secondary address.

3

created

Fixed field. Data row contains the date/time of the data row.

4

value-data-count

Fixed field. Data row contains the M-Bus telegram number. 0 = first telegram, 1 = second telegram etc.

5

mbus-raw-value

M-Bus raw data, starting with M-Bus C-Field. Stop character and checksum of the M-Bus telegram is excluded.

Example of first line in body with column headers

#serial-number;device-identification;created;value-data-count;mbus-raw-value

Example of value data lines

0016018102;82000019;2024-07-11 12:00:00;00;082b721900008296155a1b590000000c78244100620275000001fd71200265 0d0902fb1a6d02027c03324f43000202fd46610e0f

Example of body with all contents

#serial-number;device-identification;created;value-data-count;mbus-raw-value 0016018102;82000019;2024-07-11 12:00:00;00;082b721900008296155a1b590000000c78244100620275000001fd71

Report template 4109

Report format

This report contains value data in decoded format, i.e. the data is sent in clear text and no knowledge of how to decode M-Bus information is needed.

The report publishes meter data as an MQTT message to a topic on an MQTT broker. When executed, the device connects to the broker and sends a message for each meter and timestamp, containing all values. Any client subscribed to the topic will then immediately receive the meter data.

Topic

The report data is published to the MQTT broker using the following topic format:

<Base_topic>/ecmXv1.0/CMe3100/<report template>/<serial number>/<meter ID>

Where <Base_topic> is an optional configuration in the CMe3100:

  1. To set the base topic, go to Configuration > Push reports > MQTT settings.

  2. Set your Base topic.

Below is an example of an MQTT message from a device with serial number 0006123456, reporting data from a connected meter (serial number 50855417) using report template 4001, under the base topic "Company A".

Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Note

The MQTT topic acts as the routing key for message delivery. Subscribers receive messages based on topic matching.

Payload contents

The payload contains one column header line, followed by one value data lines.

Table 339. Column header description

Column index

(0 = first column)

Column contents

Description

0

#

Fixed field indicating column header information line.

1

serial-number

Fixed field. Data row contains the CMe/CMi product serial number.

2

device-identification

Fixed field. Data row contains the M-Bus device secondary address.

3

created

Fixed field. Data row contains the date/time of the data row.

4

value-data-count

Fixed field. Data row contains the M-Bus telegram number. 0 = first telegram, 1 = second telegram etc.

5

manufacturer

Fixed field. Data row contains the M-Bus device three letter manufacturer code.

6

version

Fixed field. Data row contains the M-Bus device version.

7

device-type

Fixed field. Data row contains the M-Bus device type as string.

8

access-number

Fixed field. Data row contains the M-Bus device access number which is increased by one on every request to the meter. This field can be used to verify that no other M-Bus master has read the device.

9

status

Fixed field. Data row contains the M-Bus device status field.

10

signature

Fixed field. Data row contains the the M-Bus device signature field.

11..n

<value-description>

Value description information. This information describes the exact contents of this column. Depending on meter, one or more value description columns are added.

The value description contains 6 fields delimited with comma. These fields provide the exact meaning of the contents of this column.

The 6 fields are:

Description

Unit

Function

Tariff

Sub unit

Storage number

Please see Report Template Reference Information for complete description of these fields.

Example of first line in payload with column headers

#serial-number;device-identification;created;value-datacount;manufacturer;version;device-type;accessnumber;status;signature;fabrication-no,,inst-value,0,0,0;actduration,minute(s),inst-value,0,0,0;rf-level,dBm,instvalue,0,0,0;manufacturer-specific-ff-20,,instvalue,0,0,0;volume,m3,inst-value,0,0,0;volume,m3,inst-value,0,0,1

Example of value data lines

0012041178;63666289;2015-06-01 00:00:00;00;KAM;27;cold water;156;0;0;64000535;1;-88;0;22,700;19,731

Example of payload with all contents

#serial-number;device-identification;created;value-datacount;manufacturer;version;device-type;accessnumber;status;signature;fabrication-no,,inst-value,0,0,0;actduration,minute(s),inst-value,0,0,0;rf-level,dBm,instvalue,0,0,0;manufacturer-specific-ff-20,,instvalue,0,0,0;volume,m3,inst-value,0,0,0;volume,m3,inst-value,0,0,1 0012041178;63666289;2015-06-01 00:00:00;00;KAM;27;cold water;156;0;0;64000535;1;-88;0;22,700;19,731 0012041178;63666289;2015-06-01 01:00:00;00;KAM;27;cold water;157;0;0;64000535;1;-90;0;22,700;22,700

Report template 4111

Report format

This report contains value data in M-Bus raw format used when installation of a new meter is completed. This information can be useful to add meters when installation process is completed.

The report publishes meter data as an MQTT message to a topic on an MQTT broker. When executed, the device connects to the broker and sends a message for each meter and timestamp, containing all values. Any client subscribed to the topic will then immediately receive the meter data.

Topic

The report data is published to the MQTT broker using the following topic format:

<Base_topic>/ecmXv1.0/CMe3100/<report template>/<serial number>/<meter ID>

Where <Base_topic> is an optional configuration in the CMe3100:

  1. To set the base topic, go to Configuration > Push reports > MQTT settings.

  2. Set your Base topic.

Below is an example of an MQTT message from a device with serial number 0006123456, reporting data from a connected meter (serial number 50855417) using report template 4001, under the base topic "Company A".

Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Note

The MQTT topic acts as the routing key for message delivery. Subscribers receive messages based on topic matching.

Payload contents

The payload contains one column header line, followed by one value data lines.

Table 340. Column header description

Column index

(0 = first column)

Column contents

Description

0

#

Fixed field indicating column header information line.

1

serial-number

Fixed field. Data row contains the CMe/CMi product serial number.

2

device-identification

Fixed field. Data row contains the M-Bus device secondary address.

3

created

Fixed field. Data row contains the date/time of the data row.

4

value-data-count

Fixed field. Data row contains the M-Bus telegram number. 0 = first telegram, 1 = second telegram etc.

5

manufacturer

Fixed field. Data row contains the M-Bus device three letter manufacturer code.

6

version

Fixed field. Data row contains the M-Bus device version.

7

device-type

Fixed field. Data row contains the M-Bus device type as string.

8

access-number

Fixed field. Data row contains the M-Bus device access number which is increased by one on every request to the meter. This field can be used to verify that no other M-Bus master has read the device.

9

status

Fixed field. Data row contains the M-Bus device status field.

10

signature

Fixed field. Data row contains the the M-Bus device signature field.

11..n

<value-description>

Value description information. This information describes the exact contents of this column. Depending on meter, one or more value description columns are added.

The value description contains 8 fields delimited with comma. These fields provide the exact meaning of the contents of this column.

The 8 fields are:

Dif

Vif

Unit

Description

Kind

Tariff

Sub unit

Storage number

Please see Report Template Reference Information for complete description of these fields.

Example of first line in body with column headers

#serial-number;device-identification;created;value-datacount;manufacturer;version;device-type;accessnumber;status;signature;0c,78,fabrication-no,instvalue,0,0,0;02,75,minutes(s),act-duration,instvalue,0,0,0;01,fd71,dBm,rf-level,inst-value,0,0,0;02,65,°C,exttemp,inst-value,0,0,0;42,65,°C,ext-temp,instvalue,0,0,1;8201,65,°C,ext-temp,inst-value,0,0,2;22,65,°C,exttemp,min-value,0,0,0;12,65,°C,ext-temp,max-value,0,0,0;62,65,°C,exttemp,min-value,0,0,1;52,65,°C,ext-temp,maxvalue,0,0,1;02,fb1a,%,relative-humidity,instvalue,0,0,0;42,fb1a,%,relative-humidity,instvalue,0,0,1;8201,fb1a,%,relative-humidity,instvalue,0,0,2;22,fb1a,%,relative-humidity,minvalue,0,0,0;12,fb1a,%,relative-humidity,maxvalue,0,0,0;62,fb1a,%,relative-humidity,minvalue,0,0,1;52,fb1a,%,relative-humidity,maxvalue,0,0,1;02,fd1b,digital-input,inst-value,0,0,0; 0d,fd0f,other-swversion,inst-value,0,0,0;0f,manufacturer-specific,inst-value,0,0,0

Example of value data lines

0016002874;61000134;2018-11-29 00:00:00;00;ELV;1;room sensor;51;4;0;62001253;3;- 66;25,060;24,800;24,590;24,660;25,060;23,660;25,740;25,200;25,100;23,7 00;25,100;25,200;20,800;26,200;17248;1.0.0

Example of body with all contents

#serial-number;device-identification;created;value-datacount;manufacturer;version;device-type;accessnumber;status;signature;0c,78,fabrication-no,instvalue,0,0,0;02,75,minutes(s),act-duration,instvalue,0,0,0;01,fd71,dBm,rf-level,inst-value,0,0,0;02,65,°C,exttemp,inst-value,0,0,0;42,65,°C,ext-temp,instvalue,0,0,1;8201,65,°C,ext-temp,inst-value,0,0,2;22,65,°C,exttemp,min-value,0,0,0;12,65,°C,ext-temp,max-value,0,0,0;62,65,°C,exttemp,min-value,0,0,1;52,65,°C,ext-temp,maxvalue,0,0,1;02,fb1a,%,relative-humidity,instvalue,0,0,0;42,fb1a,%,relative-humidity,instvalue,0,0,1;8201,fb1a,%,relative-humidity,instvalue,0,0,2;22,fb1a,%,relative-humidity,minvalue,0,0,0;12,fb1a,%,relative-humidity,maxvalue,0,0,0;62,fb1a,%,relative-humidity,minvalue,0,0,1;52,fb1a,%,relative-humidity,maxvalue,0,0,1;02,fd1b,digital-input,inst-value,0,0,0; 0d,fd0f,other-swversion,inst-value,0,0,0;0f,manufacturer-specific,inst-value,0,0,0 0016002874;61000134;2018-11-29 00:00:00;00;ELV;1;room sensor;51;4;0;62001253;3;- 66;25,060;24,800;24,590;24,660;25,060;23,660;25,740;25,200;25,100;23,7 00;25,100;25,200;20,800;26,200;17248;1.0.0

Report template 4112

Report format

This report contains value data in decoded format, i.e. the data is sent in clear text and no knowledge of how to decode M-Bus information is needed.

The report publishes meter data as an MQTT message to a topic on an MQTT broker. When executed, the device connects to the broker and sends a message for each meter and timestamp, containing all values. Any client subscribed to the topic will then immediately receive the meter data.

Topic

The report data is published to the MQTT broker using the following topic format:

<Base_topic>/ecmXv1.0/CMe3100/<report template>/<serial number>/<meter ID>

Where <Base_topic> is an optional configuration in the CMe3100:

  1. To set the base topic, go to Configuration > Push reports > MQTT settings.

  2. Set your Base topic.

Below is an example of an MQTT message from a device with serial number 0006123456, reporting data from a connected meter (serial number 50855417) using report template 4001, under the base topic "Company A".

Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Note

The MQTT topic acts as the routing key for message delivery. Subscribers receive messages based on topic matching.

Payload contents

The payload contains one column header line, followed by one value data lines.

Table 341. Column header description

Column index

(0 = first column)

Column contents

Description

0

#

Fixed field indicating column header information line.

1

serial-number

Fixed field. Data row contains the CMe/CMi product serial number.

2

device-position

Fixed field. Data row contains a field that describes location or other information for identifying the meter (MOID).

3

device-identification

Fixed field. Data row contains the M-Bus device secondary address.

4

created

Fixed field. Data row contains the date/time of the data row.

5

value-data-count

Fixed field. Data row contains the M-Bus telegram number. 0 = first telegram, 1 = second telegram etc.

6

manufacturer

Fixed field. Data row contains the M-Bus device three letter manufacturer code.

7

version

Fixed field. Data row contains the M-Bus device version.

8

device-type

Fixed field. Data row contains the M-Bus device type as string.

9

access-number

Fixed field. Data row contains the M-Bus device access number which is increased by one on every request to the meter. This field can be used to verify that no other M-Bus master has read the device.

10

status

Fixed field. Data row contains the M-Bus device status field.

11

signature

Fixed field. Data row contains the M-Bus device signature field.

12..n

<value-description>

Value description information. This information describes the exact contents of this column. Depending on meter, one or more value description columns are added.

The value description contains 6 fields delimited with comma. These fields provide the exact meaning of the contents of this column.

These 6 fields are:

Unit

Description

Kind

Tariff

Sub unit

Storage number

Please see Report Template Reference Information for complete description of these fields.

Example of first line in payload with column headers

#serial-number;device-position;device-identification;created;valuedata-count;manufacturer;version;device-type;accessnumber;status;signature;fabrication-no,,inst-value,0,0,0;actduration,minute(s),inst-value,0,0,0;rf-level,dBm,inst-value,0,0,0

Example of value data lines

0016002609;;14000170;2023-10-24 10:30:00;00;HYD;100;bus/system component;10;0;0;62001327;0;-80

Example of payload with all contents

#serial-number;device-position;device-identification;created;valuedata-count;manufacturer;version;device-type;accessnumber;status;signature;fabrication-no,,inst-value,0,0,0;actduration,minute(s),inst-value,0,0,0;rf-level,dBm,inst-value,0,0,0 0016002609;;14000170;2023-10-24 10:30:00;00;HYD;100;bus/system component;10;0;0;62001327;0;-80

Report template 4113

Report format

This report contains value data in decoded format, i.e. the data is sent in clear text and no knowledge of how to decode M-Bus information is needed.

The report publishes meter data as an MQTT message to a topic on an MQTT broker. When executed, the device connects to the broker and sends a message for each meter and timestamp, containing all values. Any client subscribed to the topic will then immediately receive the meter data.

Topic

The report data is published to the MQTT broker using the following topic format:

<Base_topic>/ecmXv1.0/CMe3100/<report template>/<serial number>/<meter ID>

Where <Base_topic> is an optional configuration in the CMe3100:

  1. To set the base topic, go to Configuration > Push reports > MQTT settings.

  2. Set your Base topic.

Below is an example of an MQTT message from a device with serial number 0006123456, reporting data from a connected meter (serial number 50855417) using report template 4001, under the base topic "Company A".

Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Note

The MQTT topic acts as the routing key for message delivery. Subscribers receive messages based on topic matching.

Payload contents

The payload contains one column header line, followed by one value data line.

Table 342. Column header description

Column index

(0 = first column)

Column contents

Description

0

#

Fixed field indicating column header information line.

1

serial-number

Fixed field. Data row contains the CMe/CMi product serial number.

2

device-identification

Fixed field. Data row contains the M-Bus device secondary address.

3

created

Fixed field. Data row contains the date/time of the data row.

4

value-data-count

Fixed field. Data row contains the M-Bus telegram number. 0 = first telegram, 1 = second telegram etc.

5

manufacturer

Fixed field. Data row contains the M-Bus device three letter manufacturer code.

6

version

Fixed field. Data row contains the M-Bus device version.

7

device-type

Fixed field. Data row contains the M-Bus device type as string.

8

access-number

Fixed field. Data row contains the M-Bus device access number which is increased by one on every request to the meter. This field can be used to verify that no other M-Bus master has read the device.

9

status

Fixed field. Data row contains the M-Bus device status field.

10

signature

Fixed field. Data row contains the M-Bus device signature field.

11..n

<value-description>

Value description information. This information describes the exact contents of this column. Depending on meter, one or more value description columns are added.

The value description contains 6 fields delimited with comma. These fields provide the exact meaning of the contents of this column.

These 6 fields are:

Unit

Description

Kind

Tariff

Sub unit

Storage number

Please see Report Template Reference Information for complete description of these fields.

Example of first line in payload with column headers

#serial-number;device-identification;created;value-datacount;manufacturer;version;device-type;accessnumber;status;signature;dif=0c,vif=78,description=fabricationno,kind=instvalue,tariff=0,subunit=0,storagenumber=0;dif=02,vif=75,unit=minute(s), description=act-duration,kind=instvalue,tariff=0,subunit=0,storagenumber=0;dif=01,vif=fd71,unit=dBm,desc ription=rf-level,kind=inst-value,tariff=0,subunit=0,storagenumber=0

Example of value data lines

ELV000016002609;HYD14000170;2023-10-24 10:30:00;00;HYD;100;bus/system component;10;0;0;62001327;0;-80

Example of payload with all contents

#serial-number;device-identification;created;value-datacount;manufacturer;version;device-type;accessnumber;status;signature;dif=0c,vif=78,description=fabricationno,kind=instvalue,tariff=0,subunit=0,storagenumber=0;dif=02,vif=75,unit=minute(s), description=act-duration,kind=instvalue,tariff=0,subunit=0,storagenumber=0;dif=01,vif=fd71,unit=dBm,desc ription=rf-level,kind=inst-value,tariff=0,subunit=0,storagenumber=0 ELV000016002609;HYD14000170;2023-10-24 10:30:00;00;HYD;100;bus/system component;10;0;0;62001327;0;-80 ELV000016002609;HYD14000170;2023-10-24 10:35:00;00;HYD;100;bus/system component;11;0;0;62001327;0;-82

Report template 4114

Report format

This report contains value data in decoded format, i.e. the data is sent in clear text and no knowledge of how to decode M-Bus information is needed.

The report publishes meter data as an MQTT message to a topic on an MQTT broker. When executed, the device connects to the broker and sends a message for each meter and timestamp, containing all values. Any client subscribed to the topic will then immediately receive the meter data.

Topic

The report data is published to the MQTT broker using the following topic format:

<Base_topic>/ecmXv1.0/CMe3100/<report template>/<serial number>/<meter ID>

Where <Base_topic> is an optional configuration in the CMe3100:

  1. To set the base topic, go to Configuration > Push reports > MQTT settings.

  2. Set your Base topic.

Below is an example of an MQTT message from a device with serial number 0006123456, reporting data from a connected meter (serial number 50855417) using report template 4001, under the base topic "Company A".

Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Note

The MQTT topic acts as the routing key for message delivery. Subscribers receive messages based on topic matching.

Payload contents

The payload contains one column header line, followed by one value data line.

Table 343. Column header description

Column index

(0 = first column)

Column contents

Description

0

#

Fixed field indicating column header information line.

1

serial-number

Fixed field. Data row contains the CMe/CMi product serial number.

2

device-position

Fixed field. Data row contains a field that describes location or other information for identifying the meter (MOID).

3

device-identification

Fixed field. Data row contains the M-Bus device secondary address.

4

created

Fixed field. Data row contains the date/time of the data row.

5

value-data-count

Fixed field. Data row contains the M-Bus telegram number. 0 = first telegram, 1 = second telegram etc.

6

manufacturer

Fixed field. Data row contains the M-Bus device three letter manufacturer code.

7

version

Fixed field. Data row contains the M-Bus device version.

8

device-type

Fixed field. Data row contains the M-Bus device type as string.

9

access-number

Fixed field. Data row contains the M-Bus device access number which is increased by one on every request to the meter. This field can be used to verify that no other M-Bus master has read the device.

10

status

Fixed field. Data row contains the M-Bus device status field.

11

signature

Fixed field. Data row contains the M-Bus device signature field.

12..n

<value-description>

Value description information. This information describes the exact contents of this column. Depending on meter, one or more value description columns are added.

The value description contains 6 fields delimited with comma. These fields provide the exact meaning of the contents of this column.

These 6 fields are:

Unit

Description

Kind

Tariff

Sub unit

Storage number

Please see Report Template Reference Information for complete description of these fields.

Example of first line in body with column headers

#serial-number;device-position;device-identification;created;valuedata-count;manufacturer;version;device-type;accessnumber;status;signature;fabrication-no,,inst-value,0,0,0;actduration,minute(s),inst-value,0,0,0;rf-level,dBm,inst-value,0,0,0

Example of value data lines

ELV000016002609;;HYD14000170;2023-10-24 10:30:00;00;HYD;100;bus/system component;10;0;0;62001327;0;-80

Example of body with all contents

#serial-number;device-position;device-identification;created;valuedata-count;manufacturer;version;device-type;accessnumber;status;signature;fabrication-no,,inst-value,0,0,0;actduration,minute(s),inst-value,0,0,0;rf-level,dBm,inst-value,0,0,0 ELV000016002609;;HYD14000170;2023-10-24 10:30:00;00;HYD;100;bus/system component;10;0;0;62001327;0;-80

Report template 4115

Report format

This report contains value data in decoded format, i.e. the data is sent in clear text and no knowledge of how to decode M-Bus information is needed.

The report publishes meter data as an MQTT message to a topic on an MQTT broker. When executed, the device connects to the broker and sends a message for each meter and timestamp, containing all values. Any client subscribed to the topic will then immediately receive the meter data.

Topic

The report data is published to the MQTT broker using the following topic format:

<Base_topic>/ecmXv1.0/CMe3100/<report template>/<serial number>/<meter ID>

Where <Base_topic> is an optional configuration in the CMe3100:

  1. To set the base topic, go to Configuration > Push reports > MQTT settings.

  2. Set your Base topic.

Below is an example of an MQTT message from a device with serial number 0006123456, reporting data from a connected meter (serial number 50855417) using report template 4001, under the base topic "Company A".

Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Note

The MQTT topic acts as the routing key for message delivery. Subscribers receive messages based on topic matching.

Payload contents

The body contains one column header line, followed by one value data line.

Table 344. Column header description

Column index

(0 = first column)

Column contents

Description

0

#

Fixed field indicating column header information line.

1

serial-number

Fixed field. Data row contains the CMe/CMi product serial number.

2

device-position

Fixed field. Data row contains a field that describes location or other information for identifying the meter (MOID).

3

primary-address

Fixed field. Data row contains the primary address of the M-Bus device.

4

device-identification

Fixed field. Data row contains the M-Bus device secondary address.

5

created

Fixed field. Data row contains the date/time of the data row.

6

value-data-count

Fixed field. Data row contains the M-Bus telegram number. 0 = first telegram, 1 = second telegram etc.

7

manufacturer

Fixed field. Data row contains the M-Bus device three letter manufacturer code.

8

version

Fixed field. Data row contains the M-Bus device version.

9

device-type

Fixed field. Data row contains the M-Bus device type as string.

10

access-number

Fixed field. Data row contains the M-Bus device access number which is increased by one on every request to the meter. This field can be used to verify that no other M-Bus master has read the device.

11

status

Fixed field. Data row contains the M-Bus device status field.

12

signature

Fixed field. Data row contains the M-Bus device signature field.

13..n

<value-description>

Value description information. This information describes the exact contents of this column. Depending on meter, one or more value description columns are added.

The value description contains 6 fields delimited with comma. These fields provide the exact meaning of the contents of this column.

These 6 fields are:

Unit

Description

Kind

Tariff

Sub unit

Storage number

Please see Report Template Reference Information for complete description of these fields.

Example of first line in body with column headers

#serial-number;device-position;primary-address;deviceidentification;created;value-data-count;manufacturer;version;devicetype;access-number;status;signature;fabrication-no,,instvalue,0,0,0;act-duration,minute(s),inst-value,0,0,0;rf-level,dBm,instvalue,0,0,0

Example of value data lines

0016002609;;11;14000170;2023-10-24 10:30:00;00;HYD;100;bus/system component;10;0;0;62001327;0;-80

Example of body with all contents

serial-number;device-position;primary-address;deviceidentification;created;value-data-count;manufacturer;version;devicetype;access-number;status;signature;fabrication-no,,instvalue,0,0,0;act-duration,minute(s),inst-value,0,0,0;rf-level,dBm,instvalue,0,0,0 0016002609;;11;14000170;2023-10-24 10:30:00;00;HYD;100;bus/system component;10;0;0;62001327;0;-80

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.