ZGP Sink Command API

Zigbee Green Power Sink (ZGPS) commands related APIs for ESP Zigbee SDK.

API Reference

Header File

• components/esp-zigbee-lib/include/zgp/esp_zigbee_zgps.h

Functions

void esp_zb_zgps_set_security_level(uint8_t level)

Set the security level for ZGP sink.

Parameters

level – [in] Security level

void esp_zb_zgps_set_mapping_table(const esp_zb_zgps_mapping_entry_t **table, uint16_t *table_size)

Set the mapping table for ZGP sink.

Parameters

• table – [in] The pointer of mapping entry of table, refer to esp_zb_zgps_mapping_entry_t

• table_size – [in] The pointer of table size

void esp_zb_zgps_set_communication_mode(esp_zb_zgp_communication_mode_t mode)

Set the communication mode for ZGP sink.

Parameters

mode – [in] The commission mode, refer to esp_zb_zgp_communication_mode_t

void esp_zb_zgps_set_commissioning_exit_mode(esp_zgp_commissioning_exit_mode_t mode)

Set the ZGP sink commissioning exit mode.

Parameters

mode – [in] The exit mode, refer to esp_zgp_commissioning_exit_mode_t

void esp_zb_zgps_set_commissioning_window(uint16_t timeout)

Set the ZGP sink commissioning window timeout.

Parameters

timeout – [in] The timeout of commissioning window

void esp_zb_zgps_set_functionality(uint32_t functionality, uint32_t active_functionality)

Set the ZGP sink functionality.

Parameters

• functionality – [in] Functionality, refer to esp_zgp_gps_functionality_t

• active_functionality – [in] Active functionality indicates which bits of functionality are active.

void esp_zb_zgps_start_commissioning_on_endpoint(uint8_t endpoint, uint32_t timeout)

Start the commissioning for ZGP sink on endpoint.

Parameters

• endpoint – [in] The endpoint identifier for ZGP sink commissioning

• timeout – [in] The timeout for commissioning

void esp_zb_zgps_stop_commissioning()

Stop commissioning for ZGP sink.

void esp_zb_zgps_accept_commissioning(bool accepted)

Accept commissioning setting.

Parameters

accepted – [in] Whether accept the commissioning