[en] MQTT Report Templates

[en] Report template 4001

[en] Report format

[en] 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.

[en] 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.

[en] Topic

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

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

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

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

  2. [en] Set your Base topic.

[en] 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".

[en] Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Notera

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

[en] Payload

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

Tabell 328. [en] Column header description

[en] Column index (0 = first column)

[en] Column contents

[en] Description

0

[en] <serial-number>

[en] Product serial number

1

[en] <device-identification>

[en] The device (meter) secondary address

2

[en] <created>

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

3

[en] <value-data-count>

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

4

[en] <mbus-raw>

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

[en] Example of payload contents

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

[en] Report template 4005

[en] Report format

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

[en] 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.

[en] Topic

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

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

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

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

  2. [en] Set your Base topic.

[en] 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".

[en] Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Notera

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

[en] Payload contents

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

Tabell 329. [en] Column header description

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

#

[en] Fixed value indicating column information line.

1

[en] key

[en] Fixed value

2

[en] value

[en] Fixed value

Tabell 330. [en] Value line definition

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

[en] <key>

[en] Key name

[en] Can be one of the following:

[en] time

[en] serial-number

[en] event

[en] module-revision

[en] sw-version

[en] prepaid-infoavailable

[en] prepaid-credits

[en] prepaid-currency

[en] prepaid-expiredate

1

[en] <value>

[en] Value

[en] Example of body contents for firmware update event

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

[en] Report template 4006

[en] Report format

[en] This report contains log information sent from the product.

[en] 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.

[en] Topic

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

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

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

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

  2. [en] Set your Base topic.

[en] 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".

[en] Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Notera

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

[en] Payload contents

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

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

Tabell 331. [en] Column header description

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

#

[en] Fixed value indicating column information line.

1

[en] serial-number

[en] Fixed value

2

[en] created

[en] Fixed value

3

[en] level

[en] Fixed value

4

[en] message

[en] Fixed value

Tabell 332. [en] Value line definition

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

[en] <serial-number>

[en] Serial number of the product

1

[en] <created>

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

2

[en] <level>

[en] The level of this log line.

[en] Available levels are:

[en] -2 = Debug

[en] -1 = Unknown

[en] 0 = Info

[en] 1 = Warning

[en] 2 = Error

[en] 3 = Critical

[en] 4 = Fatal

[en] 5 = Unhandled exception

[en] 6 = Event

[en] 7 = Network event

3

[en] <message>

[en] Log information message in clear text.

[en] Example of body contents

[en] #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

[en] Report template 4007

[en] Report format

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

[en] 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.

[en] Topic

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

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

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

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

  2. [en] Set your Base topic.

[en] 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".

[en] Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Notera

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

[en] Payload contents

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

Tabell 333. [en] Column header description

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

#

[en] Fixed value indicating column information line.

1

[en] key

[en] Fixed value

2

[en] value

[en] Fixed value

Tabell 334. [en] Value line definition

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

[en] <key>

[en] Key name

[en] Can be one of the following:

[en] time

[en] serial-number

[en] name

[en] part-number

[en] imei

[en] imsi

[en] hw-version

[en] sw-version

[en] boot-time

[en] internal-temperature

[en] internal-voltage

[en] rssi

[en] gprs-available

[en] operator

[en] cell

[en] apn

[en] ip

[en] simid

[en] prepaid-infoavailable

[en] prepaid-credits

[en] prepaid-currency

[en] prepaid-expiredate

1

[en] <value>

[en] Value

[en] Example of file contents

[en] #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

[en] Report template 4101

[en] Report format

[en] 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.

[en] 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.

[en] Topic

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

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

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

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

  2. [en] Set your Base topic.

[en] 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".

[en] Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Notera

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

[en] Payload contents

[en] 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.

Tabell 335. [en] Column header description

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

[en] serial-number

[en] Fixed field

1

[en] device-identification

[en] Fixed field

2

[en] created

[en] Fixed field

3

[en] value-data-count

[en] Fixed field

4

[en] Manufacturer

[en] Fixed field

[en] 5..n

[en] <value-description>

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

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

[en] The 6 fields are:

[en] Description

[en] Unit

[en] Function

[en] Tariff

[en] Sub unit

[en] Storage number

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

[en] Example of payload contents

[en] 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

[en] Report template 4102

[en] Report format

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

[en] 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.

[en] Topic

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

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

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

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

  2. [en] Set your Base topic.

[en] 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".

[en] Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Notera

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

[en] Payload contents

[en] The payload contains rows.

Tabell 336. [en] Column header description

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

[en] <serial-number>

[en] Product serial number

1

[en] <device-identification

[en] The device (meter) secondary address

2

[en] <created>

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

3

[en] <value-data-count

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

4

[en] <mbus-raw>

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

[en] Example of body contents

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

[en] Report template 4105

[en] Report format

[en] 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.

[en] 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.

[en] Topic

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

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

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

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

  2. [en] Set your Base topic.

[en] 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".

[en] Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Notera

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

[en] Payload contents

[en] 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.

Tabell 337. [en] Column header description

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

#

[en] Fixed field indicating column header information line.

1

[en] serial-number

[en] Fixed field

2

[en] device-identification

[en] Fixed field

3

[en] created

[en] Fixed field

4

[en] value-data-count

[en] Fixed field

[en] 5..n

[en] <value-description

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

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

[en] The 6 fields are:

[en] Description

[en] Unit

[en] Function

[en] Tariff

[en] Sub unit

[en] Storage number

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

[en] Example of first line in payload with column headers

[en] #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

[en] Example of value data lines

[en] 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

[en] Example of payload with all contents

[en] #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

[en] Report template 4106

[en] Report format

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

[en] 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.

[en] Topic

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

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

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

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

  2. [en] Set your Base topic.

[en] 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".

[en] Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Notera

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

[en] Payload contents

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

Tabell 338. [en] Column header description

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

#

[en] Fixed field indicating column header information line.

1

[en] serial-number

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

2

[en] device-identification

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

3

[en] created

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

4

[en] value-data-count

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

5

[en] mbus-raw-value

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

[en] Example of first line in body with column headers

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

[en] Example of value data lines

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

[en] Example of body with all contents

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

[en] Report template 4109

[en] Report format

[en] 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.

[en] 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.

[en] Topic

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

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

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

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

  2. [en] Set your Base topic.

[en] 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".

[en] Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Notera

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

[en] Payload contents

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

Tabell 339. [en] Column header description

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

#

[en] Fixed field indicating column header information line.

1

[en] serial-number

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

2

[en] device-identification

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

3

[en] created

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

4

[en] value-data-count

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

5

[en] manufacturer

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

6

[en] version

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

7

[en] device-type

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

8

[en] access-number

[en] 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

[en] status

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

10

[en] signature

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

[en] 11..n

[en] <value-description>

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

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

[en] The 6 fields are:

[en] Description

[en] Unit

[en] Function

[en] Tariff

[en] Sub unit

[en] Storage number

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

[en] Example of first line in payload with column headers

[en] #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

[en] Example of value data lines

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

[en] Example of payload with all contents

[en] #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

[en] Report template 4111

[en] Report format

[en] 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.

[en] 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.

[en] Topic

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

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

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

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

  2. [en] Set your Base topic.

[en] 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".

[en] Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Notera

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

[en] Payload contents

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

Tabell 340. [en] Column header description

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

#

[en] Fixed field indicating column header information line.

1

[en] serial-number

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

2

[en] device-identification

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

3

[en] created

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

4

[en] value-data-count

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

5

[en] manufacturer

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

6

[en] version

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

7

[en] device-type

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

8

[en] access-number

[en] 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

[en] status

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

10

[en] signature

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

[en] 11..n

[en] <value-description>

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

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

[en] The 8 fields are:

[en] Dif

[en] Vif

[en] Unit

[en] Description

[en] Kind

[en] Tariff

[en] Sub unit

[en] Storage number

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

[en] Example of first line in body with column headers

[en] #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

[en] Example of value data lines

[en] 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

[en] Example of body with all contents

[en] #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

[en] Report template 4112

[en] Report format

[en] 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.

[en] 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.

[en] Topic

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

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

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

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

  2. [en] Set your Base topic.

[en] 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".

[en] Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Notera

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

[en] Payload contents

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

Tabell 341. [en] Column header description

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

#

[en] Fixed field indicating column header information line.

1

[en] serial-number

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

2

[en] device-position

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

3

[en] device-identification

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

4

[en] created

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

5

[en] value-data-count

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

6

[en] manufacturer

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

7

[en] version

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

8

[en] device-type

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

9

[en] access-number

[en] 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

[en] status

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

11

[en] signature

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

[en] 12..n

[en] <value-description>

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

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

[en] These 6 fields are:

[en] Unit

[en] Description

[en] Kind

[en] Tariff

[en] Sub unit

[en] Storage number

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

[en] Example of first line in payload with column headers

[en] #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

[en] Example of value data lines

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

[en] Example of payload with all contents

[en] #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

[en] Report template 4113

[en] Report format

[en] 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.

[en] 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.

[en] Topic

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

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

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

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

  2. [en] Set your Base topic.

[en] 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".

[en] Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Notera

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

[en] Payload contents

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

Tabell 342. [en] Column header description

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

#

[en] Fixed field indicating column header information line.

1

[en] serial-number

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

2

[en] device-identification

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

3

[en] created

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

4

[en] value-data-count

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

5

[en] manufacturer

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

6

[en] version

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

7

[en] device-type

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

8

[en] access-number

[en] 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

[en] status

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

10

[en] signature

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

[en] 11..n

[en] <value-description>

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

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

[en] These 6 fields are:

[en] Unit

[en] Description

[en] Kind

[en] Tariff

[en] Sub unit

[en] Storage number

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

[en] Example of first line in payload with column headers

[en] #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

[en] Example of value data lines

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

[en] Example of payload with all contents

[en] #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

[en] Report template 4114

[en] Report format

[en] 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.

[en] 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.

[en] Topic

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

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

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

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

  2. [en] Set your Base topic.

[en] 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".

[en] Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Notera

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

[en] Payload contents

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

Tabell 343. [en] Column header description

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

#

[en] Fixed field indicating column header information line.

1

[en] serial-number

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

2

[en] device-position

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

3

[en] device-identification

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

4

[en] created

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

5

[en] value-data-count

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

6

[en] manufacturer

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

7

[en] version

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

8

[en] device-type

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

9

[en] access-number

[en] 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

[en] status

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

11

[en] signature

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

[en] 12..n

[en] <value-description>

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

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

[en] These 6 fields are:

[en] Unit

[en] Description

[en] Kind

[en] Tariff

[en] Sub unit

[en] Storage number

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

[en] Example of first line in body with column headers

[en] #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

[en] Example of value data lines

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

[en] Example of body with all contents

[en] #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

[en] Report template 4115

[en] Report format

[en] 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.

[en] 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.

[en] Topic

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

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

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

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

  2. [en] Set your Base topic.

[en] 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".

[en] Company A/ecmXv1.0/CMe3100/4001/0016123456/50855417

Notera

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

[en] Payload contents

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

Tabell 344. [en] Column header description

[en] Column index

[en] (0 = first column)

[en] Column contents

[en] Description

0

#

[en] Fixed field indicating column header information line.

1

[en] serial-number

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

2

[en] device-position

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

3

[en] primary-address

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

4

[en] device-identification

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

5

[en] created

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

6

[en] value-data-count

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

7

[en] manufacturer

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

8

[en] version

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

9

[en] device-type

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

10

[en] access-number

[en] 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

[en] status

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

12

[en] signature

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

[en] 13..n

[en] <value-description>

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

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

[en] These 6 fields are:

[en] Unit

[en] Description

[en] Kind

[en] Tariff

[en] Sub unit

[en] Storage number

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

[en] Example of first line in body with column headers

[en] #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

[en] Example of value data lines

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

[en] Example of body with all contents

[en] 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

Var denna artikel till hjälp?

0 av 0 tyckte detta var till hjälp
Har du fler frågor? Skicka en förfrågan

Artiklar i detta avsnitt

Kommentarer (0 kommentarer)

Artikeln är stängd för kommentarer.