ZCL Green Power

Zigbee Cluster Library (ZCL) green power cluster usage definition for ESP Zigbee SDK.

Header File

components/esp-zigbee-lib/include/zcl/esp_zigbee_zcl_green_power.h

Type Definitions

typedef enum esp_zgp_gp_attr_e esp_zgp_gp_attr_t: The enumeration for attributes of the Zigbee Green Power cluster.

typedef enum esp_zgp_server_commands_e esp_zgp_server_commands_t: Green power server command.

typedef enum esp_zgp_client_commands_e esp_zgp_client_commands_t: Green power client command.

typedef enum esp_zgp_pairing_config_action_e esp_zgp_pairing_config_action_t: The Action sub-field of the zgp pairing configuration.

Enumerations

enum esp_zgp_gp_attr_e

The enumeration for attributes of the Zigbee Green Power cluster.

Values:

enumerator ESP_ZB_ZCL_ATTR_GPS_MAX_SINK_TABLE_ENTRIES_ID: Maximum number of Sink Table entries supported by this device

enumerator ESP_ZB_ZCL_ATTR_GPS_SINK_TABLE_ID: Sink Table, holding information about local bindings between a particular GPD and target‘s local endpoints

enumerator ESP_ZB_ZCL_ATTR_GPS_COMMUNICATION_MODE_ID: Default communication mode requested by this GPS

enumerator ESP_ZB_ZCL_ATTR_GPS_COMMISSIONING_EXIT_MODE_ID: Conditions for the GPS to exit the commissioning mode

enumerator ESP_ZB_ZCL_ATTR_GPS_COMMISSIONING_WINDOW_ID: Default duration of the Commissioning window duration, in seconds, as re- quested by this GPS

enumerator ESP_ZB_ZCL_ATTR_GPS_SECURITY_LEVEL_ID: The minimum required security level to be supported by the paired GPDs

enumerator ESP_ZB_ZCL_ATTR_GPS_FUNCTIONALITY_ID: The optional GP functionality supported by this GPS

enumerator ESP_ZB_ZCL_ATTR_GPS_ACTIVE_FUNCTIONALITY_ID: The optional GP functionality supported by this GPS that is active

enumerator ESP_ZB_ZCL_ATTR_GPP_MAX_PROXY_TABLE_ENTRIES_ID: Maximum number of Proxy Table entries supported by this device

enumerator ESP_ZB_ZCL_ATTR_GPP_PROXY_TABLE_ID: Proxy Table, holding information about pairings between a particular GPD ID and GPSs in the network

enumerator ESP_ZB_ZCL_ATTR_GPP_NOTIFICATION_RETRY_NUMBER_ID: Number of unicast GP Notification retries on lack of GP Notification Response

enumerator ESP_ZB_ZCL_ATTR_GPP_NOTIFICATION_RETRY_TIMER_ID: Time in ms between unicast GP Notification retries on lack of GP Notification Response

enumerator ESP_ZB_ZCL_ATTR_GPP_MAX_SEARCH_COUNTER_ID: The frequency of sink re-discovery for inactive Proxy Table entries

enumerator ESP_ZB_ZCL_ATTR_GPP_BLOCKED_GPDID_ID: A list holding information about blocked GPD IDs

enumerator ESP_ZB_ZCL_ATTR_GPP_FUNCTIONALITY_ID: The optional GP functionality supported by this GPP

enumerator ESP_ZB_ZCL_ATTR_GPP_ACTIVE_FUNCTIONALITY_ID: The optional GP functionality supported by this GPP that is active

enumerator ESP_ZB_ZCL_ATTR_GP_SHARED_SECURITY_KEY_TYPE_ID: The security key type to be used for the communication with all paired 0b11 GPD in this network

enumerator ESP_ZB_ZCL_ATTR_GP_SHARED_SECURITY_KEY_ID: The security key to be used for the communication with all paired GPD in this network

enumerator ESP_ZB_ZCL_ATTR_GP_LINK_KEY_ID: The security key to be used to encrypt the key exchanged with the GPD

enum esp_zgp_server_commands_e

Green power server command.

Values:

enumerator ESP_ZGP_SERVER_CMD_GP_NOTIFICATION

enumerator ESP_ZGP_SERVER_CMD_GP_PAIRING_SEARCH

enumerator ESP_ZGP_SERVER_CMD_GP_TUNNELING_STOP

enumerator ESP_ZGP_SERVER_CMD_GP_COMMISSIONING_NOTIFICATION

enumerator ESP_ZGP_SERVER_CMD_GP_SINK_COMMISSIONING_MODE

enumerator ESP_ZGP_SERVER_CMD_GP_TRANSLATION_TABLE_UPDATE_COMMAND

enumerator ESP_ZGP_SERVER_CMD_GP_TRANSLATION_TABLE_REQUEST

enumerator ESP_ZGP_SERVER_CMD_GP_PAIRING_CONFIGURATION

enumerator ESP_ZGP_SERVER_CMD_GP_SINK_TABLE_REQUEST

enumerator ESP_ZGP_SERVER_CMD_GP_PROXY_TABLE_RESPONSE

enum esp_zgp_client_commands_e

Green power client command.

Values:

enumerator ESP_ZGP_CLIENT_CMD_GP_NOTIFICATION_RESPONSE

enumerator ESP_ZGP_CLIENT_CMD_GP_PAIRING

enumerator ESP_ZGP_CLIENT_CMD_GP_PROXY_COMMISSIONING_MODE

enumerator ESP_ZGP_CLIENT_CMD_GP_RESPONSE

enumerator ESP_ZGP_CLIENT_CMD_GP_SINK_TABLE_RESPONSE

enumerator ESP_ZGP_CLIENT_CMD_GP_PROXY_TABLE_REQUEST

enum esp_zgp_pairing_config_action_e

The Action sub-field of the zgp pairing configuration.

Values:

enumerator ESP_ZGP_PAIRING_CONFIG_NO_ACTION: No action

enumerator ESP_ZGP_PAIRING_CONFIG_EXTEND_SINK_TABLE_ENTRY: Extend Sink Table entry

enumerator ESP_ZGP_PAIRING_CONFIG_REPLACE_SINK_TABLE_ENTRY: Replace Sink Table entry

enumerator ESP_ZGP_PAIRING_CONFIG_REMOVE_A_PAIRING: Remove a pairing

enumerator ESP_ZGP_PAIRING_CONFIG_REMOVE_GPD: Remove GPD