Digi Device Cloud Smart Energy ConnectPort X2e and ERT Documentation

Table Of Contents

ConnectPort X2e for Smart Energy, IPD Router Details

This ConnectPort X2e for Smart Energy is built on a ZigBee router and implements an In-Premise Display. 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 0x5E, Smart Energy In-Premise Display Endpoint

Endpoint 0x5E is a Smart Energy endpoint implementing the In-Premise Display device type and contains the following clusters with their attributes.

Server Clusters

  • Cluster 0x0000, Basic Cluster (See ZCL_BasicCluster_server)

    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 the framework code used by the local device. The high four bits indicate the major revision and the low four bits indicate the minor revision. For example, 0x13 would indicate version 1.3

    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. Defaults to: Digi International

    Model Identifier

    0x0005

    0x42

    R

    The string description of the local device, up to 32 characters. Defaults to: ConnectPort X2 for Smart Energy

    Power Source

    0x0007

    0x30

    R

    Enumeration of where the local device is getting power. This attribute is set to specify that the power source is unknown by default.

    Local Description

    0x0010

    0x42

    RW

    A user-settable string describing the location of the local device, up to 16 characters. Defaults to an empty string.

    Physical Environment

    0x0011

    0x30

    RW

    A user-settable, profile-specific enumeration describing the environment of the local device.

  • Cluster 0x0003, Identify Cluster (See ZCL_IdentifyCluster_server)

    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 0x0019, ZigBee OTA Upgrade Cluster (See OTA_Cluster_Server)

  • Cluster 0x0800, Key Establishment Cluster (See SE_KeyEstablishmentCluster_server)

    Attributes:

    Name

    ID

    Type

    R/W

    Description

    KeyEstablishmentSuite

    0x0000

    0x31

    R

    Speficies supported cryptographic schemes for key establishment on the device.

Client Clusters

  • Cluster 0x0000, Basic Cluster (See ZCL_BasicCluster_client)

  • Cluster 0x0003, Identify Cluster (See ZCL_IdentifyCluster_client)

  • Cluster 0x000A, Time Cluster (See ZCL_TimeCluster_client)

  • Cluster 0x0700, Price Cluster (See SE_PriceCluster_client)

  • Cluster 0x0701, DRLC Cluster (See SE_DemandResponseLoadControlCluster_client)

    Attributes:

    Name

    ID

    Type

    R/W

    Description

    Utility Enrollment Group

    0x0000

    0x20

    RW

    The current utility enrollment group of this client, or 0x00 for no group.

    Start Randomize Minutes

    0x0001

    0x20

    RW

    The client will wait a random number of minutes (up to this many) before taking action after a DRLC event starts. The client currently does not take action on DRLC events so this attribute has no effect.

    Stop Randomize Minutes

    0x0002

    0x20

    RW

    The client will wait a random number of minutes (up to this many) before taking action after a DRLC event ends. The client currently does not take action on DRLC events so this attribute has no effect.

    Device Class

    0x0003

    0x21

    R

    Bitmap representing DRLC device classes that this client corresponds to. Defaults to 0x0000, or no device classes.

  • Cluster 0x0702, Metering Cluster

    See SE_SimpleMeteringCluster_client.

  • Cluster 0x0703, Messaging Cluster

    See SE_MessageCluster_client.

  • Cluster 0x0800, Key Establishment Cluster (See SE_KeyEstablishmentCluster_client)

    Attributes:

    Name

    ID

    Type

    R/W

    Description

    KeyEstablishmentSuite

    0x0000

    0x31

    R

    Speficies supported cryptographic schemes for key establishment on the device.