Green Power Client#

API and Callbacks for the Green Power Cluster Client Component.

A component implementing the client-side functionality of the Green Power cluster.

Modules#

sl_zigbee_af_green_power_client_commissioning_state_t

sl_zigbee_af_green_power_duplicate_filter_t

Green Power Client

API#

void

sl_zigbee_af_green_power_client_clear_proxy_table(void)

Clear the proxy table.

Enumerations#

enum

sl_zigbee_gp_gpd_mac_seq_num_cap_t {

SL_ZIGBEE_GP_GPD_MAC_SEQ_NUM_CAP_SEQUENTIAL = 0x00

SL_ZIGBEE_GP_GPD_MAC_SEQ_NUM_CAP_RANDOM = 0x01

}

Options for MAC Sequence Number Capability.

enum

sl_zigbee_af_green_power_client_commissioning_exit_mode_t {

SL_ZIGBEE_AF_GPC_COMMISSIONING_EXIT_ON_COMMISSIONING_WINDOW_EXP = 0x1

SL_ZIGBEE_AF_GPC_COMMISSIONING_EXIT_ON_FIRST_PAIRING_SUCCESS = 0x2

SL_ZIGBEE_AF_GPC_COMMISSIONING_EXIT_ON_GP_PROXY_COMMISSIONING_MODE_EXIT = 0x4

SL_ZIGBEE_AF_GPC_COMMISSIONING_EXIT_MODE_MAX = 0xFF

}

GP Client Commissioning Mode exit flags.

Macros#

#define

GP_CLIENT_ON_TRANSMIT_CHANNEL_MASK BIT(0)

Shows if we are on transmit channel (1) or on operational channel (0)

#define

GP_CLIENT_TRANSMIT_SAME_AS_OPERATIONAL_CHANNEL_MASK BIT(1)

Shows if operational channel is same as transmit channel.

#define

GP_CLIENT_ADDITIONAL_CHANNEL_REQUEST_PENDING BIT(2)

Shows if there is a channel request pending.

API Documentation#

sl_zigbee_af_green_power_client_clear_proxy_table#

void sl_zigbee_af_green_power_client_clear_proxy_table (void )

Clear the proxy table.

Parameters

Type	Direction	Argument Name	Description
void	N/A

This function clears the proxy table.

Enumeration Documentation#

sl_zigbee_gp_gpd_mac_seq_num_cap_t#

sl_zigbee_gp_gpd_mac_seq_num_cap_t

Options for MAC Sequence Number Capability.

Enumerator
SL_ZIGBEE_GP_GPD_MAC_SEQ_NUM_CAP_SEQUENTIAL	Sequence Number is sequential
SL_ZIGBEE_GP_GPD_MAC_SEQ_NUM_CAP_RANDOM	Sequence Number is random

sl_zigbee_af_green_power_client_commissioning_exit_mode_t#

sl_zigbee_af_green_power_client_commissioning_exit_mode_t

GP Client Commissioning Mode exit flags.

Enumerator
SL_ZIGBEE_AF_GPC_COMMISSIONING_EXIT_ON_COMMISSIONING_WINDOW_EXP	On Commissioning Window expiration
SL_ZIGBEE_AF_GPC_COMMISSIONING_EXIT_ON_FIRST_PAIRING_SUCCESS	On first Pairing success
SL_ZIGBEE_AF_GPC_COMMISSIONING_EXIT_ON_GP_PROXY_COMMISSIONING_MODE_EXIT	On GP Proxy Commissioning Mode (exit)
SL_ZIGBEE_AF_GPC_COMMISSIONING_EXIT_MODE_MAX	Upper bound for exit mode mask; not used as an actual exit condition