Endpoint Reference

This section documents the standard endpoint classes which may be instantiated. See add_endpoint for help on instantiating new endpoints.

The default profile ID, device type (profile-specific) and standard clusters of each endpoint class are listed.

Note

If any Smart Energy endpoint class is instantiated with endpoint identifier 0x5E, it will add cluster stubs for the SE Key Establishment server and client clusters. The XBee radio is responsible for Key Establishment and implements these clusters internally on endpoint 0x5E. However, the XBee does not respond to match descriptor requests, meaning the endpoint class instantiated on 0x5E must indicate that it supports the Key Establishment cluster.

Endpoint

Does not support a specific protocol. The Endpoint class is mainly used to support generic ZigBee pass-through behavior (see send_zigbee and received_zigbee*).

Profile: Unspecified

Device Type: Unspecified

APS Encryption: As of 1.6.0: False.

Standard Clusters: None

ZCL_Endpoint

Supports the ZCL protocol. The ZCL_Endpoint class is normally used to support profiles other than the SE profile, or to provide additional endpoints with custom selections of ZCL and SE clusters.

Profile: Unspecified

Device Type: Unspecified

APS Encryption: As of 1.6.0: False.

Standard Clusters: None

SE_Endpoint

This ZCL endpoint class is for a generic Smart Energy endpoint with no corresponding device type.

Profile: 0x0109

Device Type: Unspecified

APS Encryption: As of 1.6.0: True.

Standard Clusters:

• Basic cluster server
• Basic cluster client
• Identify cluster server
• Identify cluster client

SE_RangeExtender

The SE Range Extender is the most generic of SE device types, and can be used either for literal range extenders or device types which are not defined by the specification. This is a ZCL endpoint class.

Profile: 0x0109

Device Type: 0x0008

APS Encryption: As of 1.6.0: True.

Standard Clusters:

• Basic cluster server
• Basic cluster client
• Identify cluster server
• Identify cluster client

SE_EnergyServicePortal

This endpoint class provides the clusters for an SE Energy Service Portal (ESP), also called an Energy Service Interface (ESI). This is a ZCL endpoint class. Refer to SE Server Interface for RPC commands typically associated with this endpoint.

Profile: 0x0109

Device Type: 0x0500

APS Encryption: As of 1.6.0: True.

Standard Clusters:

• Basic cluster server
• Basic cluster client
• Identify cluster server
• Identify cluster client
• Time cluster server
• Price cluster server
• DRLC cluster server
• Messaging cluster server
• Metering cluster client

SE_InPremiseDisplay

This endpoint class provides the clusters for an SE In-Premise Display (IPD), also called an In-Home Display (IHD). This is a ZCL endpoint class. Refer to SE Client Interface for RPC commands typically associated with this endpoint class.

Profile: 0x0109

Device Type: 0x0502

APS Encryption: As of 1.6.0: True.

Standard Clusters:

• Basic cluster server
• Basic cluster client
• Identify cluster server
• Identify cluster client
• Time cluster client
• Price cluster client
• DRLC cluster client
• Messaging cluster client
• Metering cluster client

Note that the “display” represented by this endpoint is virtual, with the intention that the same behavior as a physical display can be simulated using the RPC interface. For example, a web page that has the appearance of an In-Premise Display could be made to interact with this endpoint through RPC commands.