Device Cloud Smart Energy ConnectPort X2e and ERT Documentation
Device Cloud Smart Energy ConnectPort X2e and ERT Documentation
This specification is intended for use on devices that present data from an ERT (encoder receiver/transmitter) meter (water, gas or electric) using the ZigBee Smart Energy Simple Metering cluster. Data sent from an ERT meter is referred to as a Standard Consumption Message (SCM). The specification defines additional manufacturer-specific attributes for the Simple Metering cluster to describe the ERT meter associated with that endpoint. It also defines commands on a manufacturer-specific cluster for configuring which ERT meters the gateway will read. Published details on ERT are limited, and this specification includes as much information as possible for ERT-specific details.
ERT meters hosted on an ERT gateway or bridge product are presented as a Smart Energy Simple Metering server. A Metering Device endpoint with a Simple Metering server exists for each configured ERT meter on the device.
In addition to meeting all requirements of the Smart Energy Profile’s Simple Metering Cluster specification, the Multiplier (0x0301) and Divisor (0x0302) attributes are mandatory. The ReadingSnapshotTime (0x0007) attribute is recommended for ERT meters on an ERT Gateway.
This attributes indicates the last time that an SCM was received from a configured ERT Meter and updated the CurrentSummationDelivered (0x0000) attribute. ReadingSnapshotTime will be updated even if the new SCM indicated no additional usage.
The gateway publishes the following manufacturer-specific attributes (using Digi’s manufacturer ID of 0x101E) on the Simple Metering Server Cluster (0x0702) in addition to the standard attributes.
| Attribute Identifier | Name | Type | Range | Access | Default | Mandatory/Optional |
|---|---|---|---|---|---|---|
| 0x0000 | ERT_Type | Unsigned 8-bit integer | 0x00-0xFF | Read only | n/a | M |
| 0x0001 | ERT_ID | Unsigned 32-bit integer | 0x00000001-0xFFFFFFFF | Read only | n/a | M |
For SCM30 meters, all 8 bits are used. For SCM, the upper 4 bits must be zero.
For SCM30 meters, all 32 bits are used. For SCM, the upper 6 bits must be zero. The ERT ID cannot be zero.
The ERT Configuration Cluster is defined in Digi International’s Manufacturer Specific Profile (MSP). The ERT Configuration Cluster is used by ERT Gateway and Bridge products to support configuration of ERT meters for which consumption data will be retrieved. Commands sent to and from this cluster require APS encryption and should be sent as manufacturer specific, using Digi’s manufacturer ID of 0x101E.
This cluster does not have any attributes.
The server side of the ERT Cluster is capable of receiving the following commands:
| Command Identifier | Description | Mandatory/Optional |
|---|---|---|
| 0x00 | Configure ERT Meter Request | M |
| 0x01 | Find ERT Meter Request | M |
| 0x02 | Remove ERT Meter Request | M |
| 0x03 | Remove All ERT Meters | M |
This command adds an ERT meter or updates an existing ERT meter configuration on the gateway. Note that although Multiplier and Divisor are optional for the Simple Metering Cluster, they are required by the ERT Cluster.
| Data Type | Field Name | Description |
|---|---|---|
| uint8_t | ERT_Type | value for mfg 0x101E attribute 0x0000 of Simple Meter cluster |
| uint32_t | ERT_ID | value for mfg 0x101E attribute 0x0001 of Simple Meter cluster |
| uint8_t | UnitOfMeasure | value for attribute 0x0300 of Simple Meter cluster |
| uint24_t | Multiplier | value for attribute 0x0301 of Simple Meter cluster |
| uint24_t | Divisor | value for attribute 0x0302 of Simple Meter cluster |
| uint8_t | SummationFormatting | value for attribute 0x0303 of Simple Meter cluster |
| uint8_t | MeteringDeviceType | value for attribute 0x0306 of Simple Meter cluster |
On receipt of this command, the device shall either update the endpoint for the ERT meter with the given ERT_Type and ERT_ID, or add a new endpoint for said meter. On success, the device should send an ERT Endpoint Response. In the case of adding a meter, the new endpoint should start responding to requests and appear in ZDP responses as a valid endpoint. On failure, the device should send a Default Response, which could use (but is not limited to) the following Status values from Table 2.16 of the ZCL spec.
| Enumerated Status | Description |
|---|---|
| INSUFFICIENT_SPACE | Gateway is unable to add any more ERT meters. |
| MALFORMED_COMMAND | Payload length is not valid. |
This command identifies the endpoint corresponding to a given ERT meter.
| Data Type | Field Name | Description |
|---|---|---|
| uint8_t | ERT_Type | ERT meter’s type |
| uint32_t | ERT_ID | ERT meter’s ID |
On receipt of this command, the device shall look up the endpoint for the ERT meter with the given ERT_Type and ERT_ID. The device should send an ERT Endpoint Response if the meter was found or a Default Response with a status of NOT_FOUND if it is not configured to monitor the ERT meter from the request.
This command removes an ERT meter from the gateway.
| Data Type | Field Name | Description |
|---|---|---|
| uint8_t | ERT_Type | ERT meter’s type |
| uint32_t | ERT_ID | ERT meter’s ID |
On receipt of this command, the device shall remove the endpoint for the ERT meter with the given ERT_Type and ERT_ID. The device should send a Default Response with a status of SUCCESS if the meter was removed or NOT_FOUND if it is not configured to monitor the ERT meter from the request. The endpoint corresponding to the removed meter should stop responding to requests and should not appear in ZDP responses as a valid endpoint.
This command removes all ERT meters.
There are no fields for this command.
On receipt of this command, the device shall remove all ERT meter endpoints. The device should send a Default Response with a status of SUCCESS if the meters were removed or FAILURE (or another non-success status) if it was unable to delete the endpoints. The endpoints corresponding to the removed meters should stop responding to requests and should not appear in ZDP responses as valid endpoints.
The client side of the ERT Cluster is capable of receiving the following commands:
| Command Identifier | Description | Mandatory/Optional |
|---|---|---|
| 0x00 | ERT Endpoint Response | M |
Response sent to Configure ERT and Find ERT commands.
| Data Type | Field Name | Description |
|---|---|---|
| uint8_t | ERT_Type | ERT meter’s type |
| uint32_t | ERT_ID | ERT meter’s ID |
| uint8_t | Endpoint | ERT meter’s endpoint |
Values 1-240 indicate that the Simple Meter Device on the given endpoint is reading the ERT meter with the requested ERT_Type and ERT_ID. All other values are invalid and should not be sent.
Copies of the fields sent in the Configure ERT or Find ERT requests.
On receipt of this command, the device is informed of the endpoint (if any) corresponding to a requested ERT meter’s type and ID.
You can determine whether a Simple Meter endpoint on the network corresponds to an ERT meter by sending a Read Attributes command for the ERT_Type and ERT_ID manufacturer-specific attributes on the cluster. You can find ERT Gateways on a network by sending a ZDP request for the ERT Cluster of the Smart Energy Profile. It will be necessary to confirm it is the ERT Cluster (and not some other manufacturer-specific cluster using the same cluster ID) by reading an invalid attribute (using Digi’s manufacturer ID) to see if it gets a Read Attributes Response (indicating the presence of the cluster) or a Default Response (indicating that the cluster does not exist on that endpoint).
2011-2014, Digi International Inc. All rights reserved.