ERT Records

These records correspond to specification of the ERT Meter Configuration and are used by methods in the ERT Meter Configuration Interface. Refer to those specifications for further information about record parameters.

ERTConfigurationRecord

Specifies the configuration of an ERT Meter for which consumption data will be received and presented as a Metering Device on the Smart Energy network.

Note

The unit_of_measure, multiplier, divisor, summation_formatting, and metering_device_type parameters correspond to Attributes of the Smart Energy Simple Metering cluster. See the Smart Energy specification for more details on the configuration options available.

Parameters

Parameter	Type	Description
ert_type	int	Type of the ERT Meter.
ert_id	int	ID of the ERT Meter. Often represented as a 12 digit decimal number.
unit_of_measure	int	8-bit identifier specifying the unit of measure (kwH, cubic feet, etc) for consumption tracked by the ERT meter.
multiplier	int	32-bit unsigned integer specifying a value to scale the raw consumption value provided by the ERT meter into the unit of measure.
divisor	int	32-bit unsigned integer specifying a value to scale the raw consumption value provided by the ERT meter into the unit of measure.
summation_formatting	int	8-bit bitmap indicating the number of significant digits valid when displaying scaled consumption data.
metering_device_type	int	8-bit enumeration indicating the type of Metering Device on the Smart Energy network (Water, Gas, etc).

Example

This record represents a Gas ERT Meter.

<record type="ERTConfigurationRecord">
   <ert_type type="int">12</ert_type>
   <ert_id type="int">12345678</ert_id>
   <unit_of_measure type="int">0x2</unit_of_measure>
   <divisor type="int">0x1</divisor>
   <summation_formatting type="int">0xB0</summation_formatting>
   <multiplier type="int">0x2</multiplier>
   <metering_device_type type="int">0x1</metering_device_type>
</record>

ERTAddressRecord

Specifies the ERT Type and ERT ID of an ERT meter.

Parameters

Parameter	Type	Description
ert_type	int	Type of the ERT Meter.
ert_id	int	ID of the ERT Meter. Often represented as a 12 digit decimal number.

Example

This record represents a Gas ERT Meter.

<record type="ERTAddressRecord">
  <ert_type type="int">12</ert_type>
  <ert_id type="int">12345678</ert_id>
</record>​

ERTEndpointResponseRecord

Specifies the ERT Type and ERT ID of an ERT meter along with the ZigBee Endpoint it is hosted on.

Parameters

Parameter	Type	Description
ert_type	int	Type of the ERT Meter.
ert_id	int	ID of the ERT Meter. Often represented as a 12 digit decimal number.
endpoint_id	int	Endpoint ID hosting the ERT Meter.

Example

This record represents a Gas ERT Meter on Endpoint 1.

<record type="ERTEndpointResponseRecord">
  <ert_type type="int">12</ert_type>
  <ert_id type="int">12345678</ert_id>
  <endpoint_id type="int">1</endpoint_id>
</record>

ERTDeviceRecord

This record contains the extended address, endpoint containing ERT Configuration Cluster server, and configuration and formatting attributes for all hosted ERT Meters.​

Parameters

Parameter	Type	Description
addr_extended	MAC	The 64-bit extended address of the device.
ert_config_endpoint	int	Endpoint on device containing an ERT Configuration Cluster server.
ert_meters	dict	Dictionary of ERTConfigurationRecord for hosted ERT Meter endpoints of the device. Keys have the format endpoint_0xXX, where XX is the 8-bit endpoint identifier in hexadecimal.

Example

This record represents a device with two Gas ERT Meters on Endpoints 1 and 2 configured through Endpoint 0x5E.

<record type="ERTDeviceRecord">
  <addr_extended type="MAC">00:00:00:00:00:00:00:01</addr_extended>
  <ert_config_endpoint type="int">0x5E</ert_config_endpoint>
  <ert_meters type="dict">
    <endpoint_0x02 type="ERTConfigurationRecord">
      <ert_id type="int">0x165EC15</ert_id>
      <unit_of_measure type="int">0x2</unit_of_measure>
      <divisor type="int">0x1</divisor>
      <ert_type type="int">0xC</ert_type>
      <summation_formatting type="int">0xB0</summation_formatting>
      <multiplier type="int">0x4</multiplier>
      <metering_device_type type="int">0x1</metering_device_type>
    </endpoint_0x02>
    <endpoint_0x01 type="ERTConfigurationRecord">
      <ert_id type="int">0xBC614E</ert_id>
      <unit_of_measure type="int">0x2</unit_of_measure>
      <divisor type="int">0x1</divisor>
      <ert_type type="int">0xC</ert_type>
      <summation_formatting type="int">0xB0</summation_formatting>
      <multiplier type="int">0x2</multiplier>
      <metering_device_type type="int">0x1</metering_device_type>
    </endpoint_0x01>
  </ert_meters>
</record>