ERT/SE Bridge Details¶
The ERT/SE Bridge is built on a ZigBee router and implements a Range Extender device. When configured it will also implement one or more Metering devices. A listing of all clusters, endpoints, and attributes is given below.
Endpoint 0x00, ZDO Endpoint¶
Endpoint 0x00 is a non-ZCL endpoint and provides access to network management and discovery functionality. Supported clusters are commands and do not include attributes.
Request Clusters
| Name | ID | Description |
|---|---|---|
| NWK_addr_req | 0x0000 | Find 16-bit address of a remote device based on its EUI64. |
| IEEE_addr_req | 0x0001 | Find EUI64 of a remote device based on its 16-bit address. |
| Node_Desc_req | 0x0002 | Retrieve the node descriptor from a remote device based on its 16-bit address. |
| Power_Desc_req | 0x0003 | Retrieve the power descriptor from a remote device based on its 16-bit address. |
| Simple_Desc_req | 0x0004 | Retrieve a simple descriptor from a remote device based on its 16-bit address and desired endpoint. |
| Active_EP_req | 0x0005 | Retrieve a list of active endpoints (not include Endpoint 0x00) from a remote device based on its 16-bit address. |
| Match_Desc_req | 0x0006 | Find a list of endpoints from a remote device or devices based on specified search criteria. |
| Bind_req | 0x0021 | Bind to an endpoint on a remote device. |
| Unbind_req | 0x0022 | Unbind from an endpoint on a remote device. |
| Mgmt_Lqi_req | 0x0031 | Retrieve the neighbor list and associated LQI values from a remote device. |
| Mgmt_Leave_req | 0x0034 | Request that a remote device leave the network with various options. |
| Mgmt_Permit_Joining_req | 0x0036 | Enable or disable joining on a remote device. |
Response Clusters
| Name | ID | Description |
|---|---|---|
| NWK_addr_rsp | 0x8000 | Response to NWK_addr_req indicating 16-bit address. |
| IEEE_addr_rsp | 0x8001 | Response to IEEE_addr_req indicating EUI64. |
| Node_Desc_rsp | 0x8002 | Response to Node_Desc_req returning a node descriptor. |
| Power_Desc_rsp | 0x8003 | Response to Power_Desc_req returning a power descriptor. |
| Simple_Desc_rsp | 0x8004 | Response to a Simple_Desc_req returning a simple descriptor for the requested endpoint. |
| Active_EP_rsp | 0x8005 | Response to a Active_EP request returning a list of active endpoints. |
| Match_Desc_rsp | 0x8006 | Response to Match_Desc_req returning a list of endpoints from a remote device matching specified search criteria. |
| Device_Annce | 0x8013 | Sent when a device joins or rejoins a network to announce its presence and capabilities. |
| Mgmt_LQI_rsp | 0x8031 | Response to a Mgmt_Lqi_req returning the neighbor list and associated LQI values. |
| Mgmt_Leave_rsp | 0x8034 | Response to Mgmt_Leave_req indicating status of the request or impending action. |
| Mgmt_Permit_Joining_rsp | 0x0036 | Response to a Mgmt_Permit_Joining_req indicating status of the request. |
Endpoint 0x01-0x0A, Metering Endpoint¶
Depending on configuration one or more Metering endpoints may be present
Server Clusters¶
- Cluster 0x0000, Basic Cluster
Attributes:
Name ID Type R/W Description ZCL Version 0x0000 0x20 R The ZCL version that the local device conforms to. Application Version 0x0001 0x20 R The version of application code used by the local device. Stack Version 0x0002 0x20 R The low eight bits of the local XBee radio’s firmware version. For example, if the XBee is running 3326 firmware, this value will be 0x26. Manufacturer Name 0x0004 0x42 R The string description of the local device’s manufacturer, up to 32 characters. Model Identifier 0x0005 0x42 R The string description of the local device, up to 32 characters. Date Code 0x0006 0x42 R Build time of the application code used by the local device. Power Source 0x0007 0x30 R Enumeration of where the local device is getting power.
- Cluster 0x0003, Identify Cluster
Attributes:
Name ID Type R/W Description Identify Time 0x0000 0x21 RW The remaining number of seconds for which the local device will identify itself. Writing to this value is equivalent to sending an Identify command.
- Cluster 0x0702, Metering Cluster (See ERT Meter Configuration)
Note
Some attributes are Digi extensions related to ERT configuration and accessed with the 0x101E manufacturer code.
Attributes:
Name ID Manufacturer Code Type R/W Description CurrentSummationDelivered 0x0000 NA 0x25 R Most recent consumption value received from the underlying ERT meter. ReadingSnapshotTime 0x0007 NA 0xE2 R Last update time of CurrentSummationDelivered based on reading from underlying ERT meter even if no change from previous value. Status 0x0200 NA 0x18 R Indicates possible error conditions. Currently unused. UnitofMeasure 0x0300 NA 0x30 R Unit label for type of consumption measured by the underlying ERT meter such as kW, cubic feat, BTU, etc. Multiplier 0x0301 NA 0x22 R Value to be multipled against raw conumption for formatting. Divisor 0x0302 NA 0x22 R Value to be divided against raw consumption for formatting. SummationFormatting 0x0303 NA 0x18 R Defines number of digits and placement of decimal point in converted consumption. MeteringDeviceType, 0x0306, NA, 0x18, R, Label for type of of the underlying ERT meter such as Energy, Gas, Water, etc. ERT_Type 0x0000 0x101E 0x20 R Type of underlying ERT meter within the ERT protocol. ERT_ID 0x0001 0x101E 0x23 R Unique identifier of underlying ERT meter within the ERT protocl.
Client Clusters¶
None
Endpoint 0x5E, Smart Energy Range Extender Endpoint¶
Server Clusters¶
- Cluster 0x0000, Basic Cluster
Attributes:
Name ID Type R/W Description ZCL Version 0x0000 0x20 R The ZCL version that the local device conforms to. Application Version 0x0001 0x20 R The version of application code used by the local device. Stack Version 0x0002 0x20 R The low eight bits of the local XBee radio’s firmware version. For example, if the XBee is running 3326 firmware, this value will be 0x26. Manufacturer Name 0x0004 0x42 R The string description of the local device’s manufacturer, up to 32 characters. Model Identifier 0x0005 0x42 R The string description of the local device, up to 32 characters. Date Code 0x0006 0x42 R Build time of the application code used by the local device. Power Source 0x0007 0x30 R Enumeration of where the local device is getting power.
- Cluster 0x0003, Identify Cluster
Attributes:
Name ID Type R/W Description Identify Time 0x0000 0x21 RW The remaining number of seconds for which the local device will identify itself. Writing to this value is equivalent to sending an Identify command.
- Cluster 0x0800, Key Establishment Cluster
Attributes:
Name ID Type R/W Description KeyEstablishmentSuite 0x0000 0x31 R Speficies supported cryptographic schemes for key establishment on the device.
Cluster 0xFE5E, ERT Configuration Cluster (See ERT Meter Configuration)
Client Clusters¶
Cluster 0x000A, Time Cluster
- Cluster 0x0800, Key Establishment Cluster
Attributes:
Name ID Type R/W Description KeyEstablishmentSuite 0x0000 0x31 R Speficies supported cryptographic schemes for key establishment on the device.
Endpoint 0xE8, Digi Data Endpoint¶
Endpoint 0xE8 is a non-ZCL Endpoint implementing Digi International specific functionality. On the ERT/SE Bridge this endpoint allows OTA upgrade of application firmware but not the underlying XBee firmware.
Clusters
| Name | ID | Description |
|---|---|---|
| Programmable XBee OTA Application Update Cluster | 0x1000 | Initiate a firmware update. |
| Transparent Serial | 0x0011 | Virtual serial line to transfer firmware image. |