Green Power Common#

API and Callbacks for the Green Power Common Component.

A component that provides common functionalities between client and server sides of the Green Power components.

API#

uint16_t
sl_zigbee_af(uint16_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint32_t gpdSecurityFrameCounter, uint8_t gpdCommandId, uint8_t gpdCommandPayloadLength, const uint8_t *gpdCommandPayload, uint16_t gppShortAddress, uint8_t gppDistance)

Prepare a GP notification command buffer.

uint16_t
sl_zigbee_af_fill_command_green_power_cluster_gp_pairing_search_smart(uint16_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint)

Prepare a GP pairing search command buffer.

uint16_t
sl_zigbee_af_fill_command_green_power_cluster_gp_tunneling_stop_smart(uint8_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint32_t gpdSecurityFrameCounter, uint16_t gppShortAddress, int8_t gppDistance)

Prepare a GP tunneling stop command buffer.

uint16_t
sl_zigbee_af_fill_command_green_power_cluster_gp_commissioning_notification_smart(uint16_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint8_t sequenceNumber, sl_zigbee_gp_security_level_t gpdfSecurityLevel, sl_zigbee_gp_security_frame_counter_t gpdSecurityFrameCounter, uint8_t gpdCommandId, uint8_t gpdCommandPayloadLength, const uint8_t *gpdCommandPayload, sl_802154_short_addr_t gppShortAddress, uint8_t gppLink, sl_zigbee_gp_mic_t mic)

Prepare a GP commissioning notification command buffer.

uint16_t
sl_zigbee_af_fill_command_green_power_cluster_gp_translation_table_update_smart(uint16_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint8_t translationsLength, sl_zigbee_zcl_gp_translation_table_update_translation_t *translations, sl_zigbee_gp_translation_table_additional_info_block_option_record_field_t *additionnalInfoBlock)

Prepare a GP translation table update command buffer.

uint16_t
sl_zigbee_af_fill_command_green_power_cluster_gp_pairing_configuration_smart(uint8_t actions, uint16_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint8_t gpdDeviceId, uint8_t groupListCount, uint8_t *groupList, uint16_t gpdAssignedAlias, uint8_t groupcastRadius, uint8_t securityOptions, uint32_t gpdSecurityFrameCounter, uint8_t *gpdSecurityKey, uint8_t numberOfPairedEndpoints, uint8_t *pairedEndpoints, uint8_t applicationInformation, uint16_t manufacturerId, uint16_t modeId, uint8_t numberOfGpdCommands, uint8_t *gpdCommandIdList, uint8_t clusterIdListCount, uint16_t *clusterListServer, uint16_t *clusterListClient, uint8_t switchInformationLength, uint8_t genericSwitchConfiguration, uint8_t currentContactStatus, uint8_t totalNumberOfReports, uint8_t numberOfReports, uint8_t *reportDescriptor)

Prepare a GP pairing configuration command buffer.

uint16_t
sl_zigbee_af_fill_command_green_power_cluster_gp_sink_table_request_smart(uint8_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint8_t index)

Prepare a GP sink table request command buffer.

uint32_t
sl_zigbee_af_fill_command_green_power_cluster_gp_notification_response_smart(uint8_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint32_t gpdSecurityFrameCounter)

Prepare a GP notification response command buffer.

uint16_t
sl_zigbee_af_fill_command_green_power_cluster_gp_pairing_smart(uint32_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint8_t *sinkIeeeAddress, uint16_t sinkNwkAddress, uint16_t sinkGroupId, uint8_t deviceId, uint32_t gpdSecurityFrameCounter, uint8_t *gpdKey, uint16_t assignedAlias, uint8_t groupcastRadius)

Prepare a GP pairing command buffer.

uint16_t
sl_zigbee_af_fill_command_green_power_cluster_gp_proxy_commissioning_mode_smart(uint8_t options, uint16_t commissioningWindow, uint8_t channel)

Prepare a GP proxy commissioning mode command buffer.

uint16_t
sl_zigbee_af_fill_command_green_power_cluster_gp_response_smart(uint8_t options, uint16_t tempMasterShortAddress, uint8_t tempMasterTxChannel, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint8_t gpdCommandId, uint8_t gpdCommandPayloadLength, uint8_t *gpdCommandPayload)

Prepare a GP response command buffer.

uint16_t
sl_zigbee_af_fill_command_green_power_cluster_gp_proxy_table_request_smart(uint8_t options, uint32_t gpdSrcId, uint8_t *gpdIeee, uint8_t gpdEndpoint, uint8_t index)

Prepare a GP proxy table request command buffer.

bool
sl_zigbee_af_green_power_common_gp_addr_compare(const sl_zigbee_gp_address_t *a1, const sl_zigbee_gp_address_t *a2)

Compare two GP Addresses.

#define
sl_zigbee_af_fill_command_green_power_cluster_gp_proxy_table_response_smart (status, totalNumberOfNonEmptyProxyTableEntries, startIndex, entriesCount)

Prepare a GP proxy commissioning mode command buffer.

#define
sl_zigbee_af_fill_command_green_power_cluster_gp_sink_table_response_smart (status, totalNumberofNonEmptySinkTableEntries, startIndex, sinkTableEntriesCount)

Prepare a GP sink table response command buffer.

#define
sl_zigbee_af_fill_command_green_power_cluster_gp_translation_table_response_smart (status, options, totalNumberOfEntries, startIndex, entriesCount, translationTableList, translationTableListLen)

To provide GPD Command Translation Table content.

Enumerations#

enum
SL_ZIGBEE_ZCL_GP_GPD_GPP_LINK_QUALITY_POOR = 0x00
SL_ZIGBEE_ZCL_GP_GPD_GPP_LINK_QUALITY_MODERATE = 0x01
SL_ZIGBEE_ZCL_GP_GPD_GPP_LINK_QUALITY_HIGH = 0x02
SL_ZIGBEE_ZCL_GP_GPD_GPP_LINK_QUALITY_EXCELLENT = 0x03
}
enum
SL_ZIGBEE_ZCL_GP_UNKNOWN_SWITCH_TYPE = 0x00
SL_ZIGBEE_ZCL_GP_BUTTON_SWITCH_TYPE = 0x01
SL_ZIGBEE_ZCL_GP_ROCKER_SWITCH_TYPE = 0x02
SL_ZIGBEE_ZCL_GP_RESERVED_SWITCH_TYPE = 0x03
}

new enum for enum.h

enum
SL_ZIGBEE_GP_DEVICE_ID_GPD_SIMPLE_GENERIC_ONE_STATE_SWITCH = 0x00
SL_ZIGBEE_GP_DEVICE_ID_GPD_SIMPLE_GENERIC_TWO_STATE_SWITCH = 0x01
SL_ZIGBEE_GP_DEVICE_ID_GPD_ON_OFF_SWITCH = 0x02
SL_ZIGBEE_GP_DEVICE_ID_GPD_LEVEL_CONTROL_SWITCH = 0x03
SL_ZIGBEE_GP_DEVICE_ID_GPD_SIMPLE_SENSOR_SWITCH = 0x04
SL_ZIGBEE_GP_DEVICE_ID_GPD_ADVANCED_GENERIC_ONE_STATE_SWITCH = 0x05
SL_ZIGBEE_GP_DEVICE_ID_GPD_ADVANCED_GENERIC_TWO_STATE_SWITCH = 0x06
SL_ZIGBEE_GP_DEVICE_ID_GPD_GENERIC_SWITCH = 0x07
SL_ZIGBEE_GP_DEVICE_ID_GPD_COLOR_DIMMER_SWITCH = 0x10
SL_ZIGBEE_GP_DEVICE_ID_GPD_LIGHT_SENSOR_SWITCH = 0x11
SL_ZIGBEE_GP_DEVICE_ID_GPD_OCCUPANCY_SENSOR_SWITCH = 0x12
SL_ZIGBEE_GP_DEVICE_ID_GPD_DOOR_LOCK_CONTROLLER_SWITCH = 0x20
SL_ZIGBEE_GP_DEVICE_ID_GPD_TEMPERATURE_SENSOR_SWITCH = 0x30
SL_ZIGBEE_GP_DEVICE_ID_GPD_PRESSURE_SENSOR_SWITCH = 0x31
SL_ZIGBEE_GP_DEVICE_ID_GPD_FLOW_SENSOR_SWITCH = 0x32
SL_ZIGBEE_GP_DEVICE_ID_GPD_INDOOR_ENVIRONMENT_SENSOR = 0x33
SL_ZIGBEE_GP_DEVICE_ID_GPD_SCENCES = 0xFE
SL_ZIGBEE_GP_DEVICE_ID_GPD_UNDEFINED = 0xFE
}

enum: sl_zigbee_af_gp_gpd_device_id_t

Macros#

#define
GREEN_POWER_SERVER_NO_PAIRED_ENDPOINTS 0x00
#define
GREEN_POWER_SERVER_RAW_GPD_PROCESS_IN_APP_ENDPOINTS 0xFD
#define
GREEN_POWER_SERVER_RESERVED_ENDPOINTS 0xFD
#define
GREEN_POWER_SERVER_SINK_DERIVES_ENDPOINTS 0xFE
#define
GREEN_POWER_SERVER_ALL_SINK_ENDPOINTS 0xFF
#define
GREEN_POWER_SERVER_MIN_VALID_APP_ENDPOINT 1
#define
GREEN_POWER_SERVER_MAX_VALID_APP_ENDPOINT 240
#define
SL_ZIGBEE_AF_GP_GPD_CHANNEL_REQUEST_CHANNEL_TOGGLING_BEHAVIOR_RX_CHANNEL_NEXT_ATTEMPT (0x0F)
#define
SL_ZIGBEE_AF_GP_GPD_CHANNEL_REQUEST_CHANNEL_TOGGLING_BEHAVIOR_RX_CHANNEL_SECOND_NEXT_ATTEMPT (0xF0)
#define
SL_ZIGBEE_AF_GP_GPD_CHANNEL_REQUEST_CHANNEL_TOGGLING_BEHAVIOR_RX_CHANNEL_SECOND_NEXT_ATTEMPT_OFFSET (4)
#define
SL_ZIGBEE_AF_GP_GPD_APPLICATION_DESCRIPTION_COMMAND_REPORT_OPTIONS_TIMEOUT_PERIOD_PRESENT (0x01)
#define
SL_ZIGBEE_AF_GP_TRANSLATION_TABLE_ZB_ENDPOINT_PASS_FRAME_TO_APLLICATION (0xFC)
#define
SL_ZIGBEE_AF_GP_SINK_TABLE_ENTRY_OPTIONS_MASK (0x03FF)
#define
GP_TRANSLATION_TABLE_SCAN_LEVEL_GPD_ID (0x01)
#define
GP_TRANSLATION_TABLE_SCAN_LEVEL_GPD_CMD_ID (0x02)
#define
GP_TRANSLATION_TABLE_SCAN_LEVEL_GPD_PAYLOAD (0x04)
#define
GP_TRANSLATION_TABLE_SCAN_LEVEL_ZB_ENDPOINT (0x08)
#define
GP_TRANSLATION_TABLE_SCAN_LEVEL_ADDITIONAL_INFO_BLOCK (0x10)
#define
SL_ZIGBEE_GP_NOTIFICATION_COMMISSIONED_GROUPCAST_SEQUENCE_NUMBER_OFFSET (9)
#define
SL_ZIGBEE_GP_NOTIFICATION_COMMISSIONED_GROUPCAST_SEQUENCE_NUMBER_OFFSET (9)
#define
SL_ZIGBEE_AF_GP_GPP_GPD_LINK_RSSI (0x3F)
#define
SL_ZIGBEE_AF_GP_GPP_GPD_LINK_LINK_QUALITY (0xC0)
#define
SL_ZIGBEE_AF_GP_GPP_GPD_LINK_LINK_QUALITY_OFFSET (6)
#define
SL_ZIGBEE_AF_GP_PAIRING_CONFIGURATION_ACTIONS_MASK (0x0F)
#define
SL_ZIGBEE_AF_GP_PAIRING_CONFIGURATION_OPTION_MASK (0x07FF)
#define
SL_ZIGBEE_AF_GP_PAIRING_CONFIGURATION_OPTION_MASK (0x07FF)
#define
SL_ZIGBEE_AF_GP_APPLICATION_INFORMATION_CLUSTER_LIST_NUMBER_OF_SERVER_CLUSTER_MASK (0x0F)
#define
SL_ZIGBEE_AF_GP_APPLICATION_INFORMATION_CLUSTER_LIST_NUMBER_OF_CLIENT_CLUSTER_MASK (0xF0)
#define
SL_ZIGBEE_AF_GP_APPLICATION_INFORMATION_CLUSTER_LIST_NUMBER_OF_CLIENT_CLUSTER_MASK_OFFSET (4)
#define
SL_ZIGBEE_AF_GP_APPLICATION_INFORMATION_GPD_APPLICATION_DESCRIPTION_COMMAND_FOLLOWS (0x20)
#define
SL_ZIGBEE_AF_GP_APPLICATION_INFORMATION_GPD_APPLICATION_DESCRIPTION_COMMAND_FOLLOWS_OFFSET (5)
#define
SL_ZIGBEE_AF_GP_APPLICATION_INFORMATION_SWITCH_INFORMATION_CONFIGURATION_NB_OF_CONTACT (0x0F)
#define
SL_ZIGBEE_AF_GP_APPLICATION_INFORMATION_SWITCH_INFORMATION_CONFIGURATION_SWITCH_TYPE (0x30)
#define
SL_ZIGBEE_AF_GP_APPLICATION_INFORMATION_SWITCH_INFORMATION_CONFIGURATION_SWITCH_TYPE_OFFSET (4)
#define
GP_COMMISSIONING_SECURITY_LEVEL_TO_OPTIONS_SHIFT (4)
#define
GP_COMMISSIONING_SECURITY_KEY_TYPE_TO_OPTIONS_SHIFT (6)
#define
SL_ZIGBEE_GP_COMMISSIONING_NOTIFICATION_SEQUENCE_NUMBER_OFFSET (12)
#define
SL_ZIGBEE_AF_GREEN_POWER_SERVER_GPDF_SCENE_DERIVED_GROUP_ID (0xFFFF)
#define
GP_DEVICE_ANNOUNCE_SPOOF_MSG_SIZE 12
#define
IS_RESERVED_GPD_SRC_ID (srcId)
#define
IS_GPD_SRC_ID_ZERO (appId, srcId)
#define
sl_zigbee_af_green_power_t_t_get_additional_info_block_present (options)
#define
sl_zigbee_af_green_power_t_t_update_get_additional_info_block_present (options)
#define
sl_zigbee_af_green_power_pairing_config_get_application_info_present (options)
#define
sl_zigbee_af_green_power_pairing_options_get_comm_mode (options)
#define
sl_zigbee_af_green_power_pairing_options_get_add_sink (options)
#define
sl_zigbee_af_green_power_get_application_id (options)
#define
sl_zigbee_af_green_power_gpd_seq_num_cap (entry)
#define
sl_zigbee_af_green_power_security_level (entry)
#define
sl_zigbee_af_green_power_fixed_during_operation (options)
#define
sl_zigbee_af_green_power_mobile_cap (options)
#define
sl_zigbee_af_green_power_portable_cap (options)
#define
sl_zigbee_af_green_power_security_key_type (options)
#define
sl_zigbee_af_green_power_check_return_of_put_data_in_response (ret)

API Documentation#

sl_zigbee_af#

uint16_t sl_zigbee_af (uint16_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint32_t gpdSecurityFrameCounter, uint8_t gpdCommandId, uint8_t gpdCommandPayloadLength, const uint8_t * gpdCommandPayload, uint16_t gppShortAddress, uint8_t gppDistance)

Prepare a GP notification command buffer.

Parameters
TypeDirectionArgument NameDescription
uint16_tN/Aoptions

Options Ver.: always

uint32_tN/AgpdSrcId

GPD Source Id Ver.: always

uint8_t *N/AgpdIeee

GPD IEEE address Ver.: always

uint8_tN/AgpdEndpoint

GPD endpoint Ver.: always

uint32_tN/AgpdSecurityFrameCounter

GPD security frame counter Ver.: always

uint8_tN/AgpdCommandId

GPD command Id Ver.: always

uint8_tN/AgpdCommandPayloadLength

Command payload length Ver.: always

const uint8_t *N/AgpdCommandPayload

GPD command payload Ver.: always

uint16_tN/AgppShortAddress

GP Proxy short address Ver.: always

uint8_tN/AgppDistance

GP Proxy distance Ver.: always

This function prepares an application framework ZCL command buffer for the GP notification command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


sl_zigbee_af_fill_command_green_power_cluster_gp_pairing_search_smart#

uint16_t sl_zigbee_af_fill_command_green_power_cluster_gp_pairing_search_smart (uint16_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint)

Prepare a GP pairing search command buffer.

Parameters
TypeDirectionArgument NameDescription
uint16_tN/Aoptions

Options Ver.: always

uint32_tN/AgpdSrcId

GPD Source Id Ver.: always

uint8_t *N/AgpdIeee

GPD IEEE address Ver.: always

uint8_tN/AgpdEndpoint

GPD endpoint Ver.: always

This function prepares an application framework ZCL command buffer for the GP pairing search command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


sl_zigbee_af_fill_command_green_power_cluster_gp_tunneling_stop_smart#

uint16_t sl_zigbee_af_fill_command_green_power_cluster_gp_tunneling_stop_smart (uint8_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint32_t gpdSecurityFrameCounter, uint16_t gppShortAddress, int8_t gppDistance)

Prepare a GP tunneling stop command buffer.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aoptions

Options Ver.: always

uint32_tN/AgpdSrcId

GPD Source Id Ver.: always

uint8_t *N/AgpdIeee

GPD IEEE address Ver.: always

uint8_tN/AgpdEndpoint

GPD endpoint Ver.: always

uint32_tN/AgpdSecurityFrameCounter

GPD security frame counter Ver.: always

uint16_tN/AgppShortAddress

GP Proxy short address Ver.: always

int8_tN/AgppDistance

GP Proxy distance Ver.: always

This function prepares an application framework ZCL command buffer for the GP tunneling stop command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


sl_zigbee_af_fill_command_green_power_cluster_gp_commissioning_notification_smart#

uint16_t sl_zigbee_af_fill_command_green_power_cluster_gp_commissioning_notification_smart (uint16_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t sequenceNumber, sl_zigbee_gp_security_level_t gpdfSecurityLevel, sl_zigbee_gp_security_frame_counter_t gpdSecurityFrameCounter, uint8_t gpdCommandId, uint8_t gpdCommandPayloadLength, const uint8_t * gpdCommandPayload, sl_802154_short_addr_t gppShortAddress, uint8_t gppLink, sl_zigbee_gp_mic_t mic)

Prepare a GP commissioning notification command buffer.

Parameters
TypeDirectionArgument NameDescription
uint16_tN/Aoptions

Options Ver.: always

uint32_tN/AgpdSrcId

GPD Source Id Ver.: always

uint8_t *N/AgpdIeee

GPD IEEE address Ver.: always

uint8_tN/AgpdEndpoint

GPD endpoint Ver.: always

uint8_tN/AsequenceNumber

MAC Sequence to be used in security counter field for GPD security level 0 Ver.: always

sl_zigbee_gp_security_level_tN/AgpdfSecurityLevel

GPD security level Ver.: always

sl_zigbee_gp_security_frame_counter_tN/AgpdSecurityFrameCounter

GPD security frame counter Ver.: always

uint8_tN/AgpdCommandId

GPD command Id Ver.: always

uint8_tN/AgpdCommandPayloadLength

Command payload length Ver.: always

const uint8_t *N/AgpdCommandPayload

GPD command payload Ver.: always

sl_802154_short_addr_tN/AgppShortAddress

GP Proxy short address Ver.: always

uint8_tN/AgppLink

GPD-GP Proxy link Ver.: always

sl_zigbee_gp_mic_tN/Amic

Message Integrity Code when security level is 2 or 3 Ver.: always

This function prepares an application framework ZCL command buffer for the GP commissioning notification command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


sl_zigbee_af_fill_command_green_power_cluster_gp_translation_table_update_smart#

uint16_t sl_zigbee_af_fill_command_green_power_cluster_gp_translation_table_update_smart (uint16_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t translationsLength, sl_zigbee_zcl_gp_translation_table_update_translation_t * translations, sl_zigbee_gp_translation_table_additional_info_block_option_record_field_t * additionnalInfoBlock)

Prepare a GP translation table update command buffer.

Parameters
TypeDirectionArgument NameDescription
uint16_tN/Aoptions

Options Ver.: always

uint32_tN/AgpdSrcId

GPD Source Id Ver.: always

uint8_t *N/AgpdIeee

GPD IEEE address Ver.: always

uint8_tN/AgpdEndpoint

GPD endpoint Ver.: always

uint8_tN/AtranslationsLength

Length of the translations packet Ver.: always

sl_zigbee_zcl_gp_translation_table_update_translation_t *N/Atranslations

On or more number of translations Ver.: always

sl_zigbee_gp_translation_table_additional_info_block_option_record_field_t *N/AadditionnalInfoBlock

Additional Information block used along with the translations Ver.: always

This function prepares an application framework ZCL command buffer for the GP translation table update command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


sl_zigbee_af_fill_command_green_power_cluster_gp_pairing_configuration_smart#

uint16_t sl_zigbee_af_fill_command_green_power_cluster_gp_pairing_configuration_smart (uint8_t actions, uint16_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t gpdDeviceId, uint8_t groupListCount, uint8_t * groupList, uint16_t gpdAssignedAlias, uint8_t groupcastRadius, uint8_t securityOptions, uint32_t gpdSecurityFrameCounter, uint8_t * gpdSecurityKey, uint8_t numberOfPairedEndpoints, uint8_t * pairedEndpoints, uint8_t applicationInformation, uint16_t manufacturerId, uint16_t modeId, uint8_t numberOfGpdCommands, uint8_t * gpdCommandIdList, uint8_t clusterIdListCount, uint16_t * clusterListServer, uint16_t * clusterListClient, uint8_t switchInformationLength, uint8_t genericSwitchConfiguration, uint8_t currentContactStatus, uint8_t totalNumberOfReports, uint8_t numberOfReports, uint8_t * reportDescriptor)

Prepare a GP pairing configuration command buffer.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aactions

GP Pairing actions field Ver.: always

uint16_tN/Aoptions

Options Ver.: always

uint32_tN/AgpdSrcId

GPD Source Id Ver.: always

uint8_t *N/AgpdIeee

GPD IEEE address Ver.: always

uint8_tN/AgpdEndpoint

GPD endpoint Ver.: always

uint8_tN/AgpdDeviceId

GPD Device Id Ver.: always

uint8_tN/AgroupListCount

Group list count Ver.: always

uint8_t *N/AgroupList

Group list Ver.: always

uint16_tN/AgpdAssignedAlias

GPD assigned alias Ver.: always

uint8_tN/AgroupcastRadius

Group cast radius Ver.: always

uint8_tN/AsecurityOptions

Security options Ver.: always

uint32_tN/AgpdSecurityFrameCounter

Security frame counter Ver.: always

uint8_t *N/AgpdSecurityKey

Security key Ver.: always

uint8_tN/AnumberOfPairedEndpoints

Number of paired endpoints Ver.: always

uint8_t *N/ApairedEndpoints

Paired endpoint list Ver.: always

uint8_tN/AapplicationInformation

Application information field Ver.: always

uint16_tN/AmanufacturerId

GPD Manufacture Id Ver.: always

uint16_tN/AmodeId

GPD Model Id Ver.: always

uint8_tN/AnumberOfGpdCommands

Number of GPD commands Ver.: always

uint8_t *N/AgpdCommandIdList

GPD commands list Ver.: always

uint8_tN/AclusterIdListCount

Cluster List count Ver.: always

uint16_t *N/AclusterListServer

Server cluster list Ver.: always

uint16_t *N/AclusterListClient

Client cluster list Ver.: always

uint8_tN/AswitchInformationLength

Generic switch information length Ver.: always

uint8_tN/AgenericSwitchConfiguration

GGeneric switch configuration Ver.: always

uint8_tN/AcurrentContactStatus

Current contact status Ver.: always

uint8_tN/AtotalNumberOfReports

Total number of reports configured Ver.: always

uint8_tN/AnumberOfReports

Number of reports in the report present in descriptor Ver.: always

uint8_t *N/AreportDescriptor

Report descriptors list Ver.: always

This function prepares an application framework ZCL command buffer for the GP pairing configuration command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


sl_zigbee_af_fill_command_green_power_cluster_gp_sink_table_request_smart#

uint16_t sl_zigbee_af_fill_command_green_power_cluster_gp_sink_table_request_smart (uint8_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t index)

Prepare a GP sink table request command buffer.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aoptions

Options Ver.: always

uint32_tN/AgpdSrcId

GPD Source Id Ver.: always

uint8_t *N/AgpdIeee

GPD IEEE address Ver.: always

uint8_tN/AgpdEndpoint

GPD endpoint Ver.: always

uint8_tN/Aindex

Requested table index to start Ver.: always

This function prepares an application framework ZCL command buffer for the GP sink table request command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


sl_zigbee_af_fill_command_green_power_cluster_gp_notification_response_smart#

uint32_t sl_zigbee_af_fill_command_green_power_cluster_gp_notification_response_smart (uint8_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint32_t gpdSecurityFrameCounter)

Prepare a GP notification response command buffer.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aoptions

Options Ver.: always

uint32_tN/AgpdSrcId

GPD Source Id Ver.: always

uint8_t *N/AgpdIeee

GPD IEEE address Ver.: always

uint8_tN/AgpdEndpoint

GPD endpoint Ver.: always

uint32_tN/AgpdSecurityFrameCounter

GPD security frame counter Ver.: always

This function prepares an application framework ZCL command buffer for the GP notification response command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


sl_zigbee_af_fill_command_green_power_cluster_gp_pairing_smart#

uint16_t sl_zigbee_af_fill_command_green_power_cluster_gp_pairing_smart (uint32_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t * sinkIeeeAddress, uint16_t sinkNwkAddress, uint16_t sinkGroupId, uint8_t deviceId, uint32_t gpdSecurityFrameCounter, uint8_t * gpdKey, uint16_t assignedAlias, uint8_t groupcastRadius)

Prepare a GP pairing command buffer.

Parameters
TypeDirectionArgument NameDescription
uint32_tN/Aoptions

Options Ver.: always

uint32_tN/AgpdSrcId

GPD Source Id Ver.: always

uint8_t *N/AgpdIeee

GPD IEEE address Ver.: always

uint8_tN/AgpdEndpoint

GPD endpoint Ver.: always

uint8_t *N/AsinkIeeeAddress

Sink IEEE address Ver.: always

uint16_tN/AsinkNwkAddress

Sink network address Ver.: always

uint16_tN/AsinkGroupId

Sink group Id Ver.: always

uint8_tN/AdeviceId

GPD Device Id Ver.: always

uint32_tN/AgpdSecurityFrameCounter

GPD security frame counter Ver.: always

uint8_t *N/AgpdKey

GPD security key Ver.: always

uint16_tN/AassignedAlias

GPD assigned alias Ver.: always

uint8_tN/AgroupcastRadius

Group cast radius of this message Ver.: always

This function prepares an application framework ZCL command buffer for the GP pairing command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


sl_zigbee_af_fill_command_green_power_cluster_gp_proxy_commissioning_mode_smart#

uint16_t sl_zigbee_af_fill_command_green_power_cluster_gp_proxy_commissioning_mode_smart (uint8_t options, uint16_t commissioningWindow, uint8_t channel)

Prepare a GP proxy commissioning mode command buffer.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aoptions

Options Ver.: always

uint16_tN/AcommissioningWindow

Commissioning window in seconds Ver.: always

uint8_tN/Achannel

Proxy channel field Ver.: always

This function prepares an application framework ZCL command buffer for the GP proxy commissioning mode command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


sl_zigbee_af_fill_command_green_power_cluster_gp_response_smart#

uint16_t sl_zigbee_af_fill_command_green_power_cluster_gp_response_smart (uint8_t options, uint16_t tempMasterShortAddress, uint8_t tempMasterTxChannel, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t gpdCommandId, uint8_t gpdCommandPayloadLength, uint8_t * gpdCommandPayload)

Prepare a GP response command buffer.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aoptions

Options Ver.: always

uint16_tN/AtempMasterShortAddress

Proxy Temp Master short address Ver.: always

uint8_tN/AtempMasterTxChannel

Proxy Temp Master transmit channel Ver.: always

uint32_tN/AgpdSrcId

GPD Source Id Ver.: always

uint8_t *N/AgpdIeee

GPD IEEE address Ver.: always

uint8_tN/AgpdEndpoint

GPD endpoint Ver.: always

uint8_tN/AgpdCommandId

GPD command id Ver.: always

uint8_tN/AgpdCommandPayloadLength

GPD command length Ver.: always

uint8_t *N/AgpdCommandPayload

GPD command payload Ver.: always

This function prepares an application framework ZCL command buffer for the GP response command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


sl_zigbee_af_fill_command_green_power_cluster_gp_proxy_table_request_smart#

uint16_t sl_zigbee_af_fill_command_green_power_cluster_gp_proxy_table_request_smart (uint8_t options, uint32_t gpdSrcId, uint8_t * gpdIeee, uint8_t gpdEndpoint, uint8_t index)

Prepare a GP proxy table request command buffer.

Parameters
TypeDirectionArgument NameDescription
uint8_tN/Aoptions

Options Ver.: always

uint32_tN/AgpdSrcId

GPD Source Id Ver.: always

uint8_t *N/AgpdIeee

GPD IEEE address Ver.: always

uint8_tN/AgpdEndpoint

GPD endpoint Ver.: always

uint8_tN/Aindex

Requested table index to start Ver.: always

This function prepares an application framework ZCL command buffer for the GP proxy table request command with supplied arguments and returns the buffer length.

Returns

  • Length of the constructed command buffer


sl_zigbee_af_green_power_common_gp_addr_compare#

bool sl_zigbee_af_green_power_common_gp_addr_compare (const sl_zigbee_gp_address_t * a1, const sl_zigbee_gp_address_t * a2)

Compare two GP Addresses.

Parameters
TypeDirectionArgument NameDescription
const sl_zigbee_gp_address_t *N/Aa1

First address to compare Ver.: always

const sl_zigbee_gp_address_t *N/Aa2

Second address to compare Ver.: always

This function compares two GP Addresses and returns true if they are the same.

Returns

  • True if the address are same


Enumeration Documentation#

sl_zigbee_af_g_p_gpd_gpp_link_quality_t#

sl_zigbee_af_g_p_gpd_gpp_link_quality_t
Enumerator
SL_ZIGBEE_ZCL_GP_GPD_GPP_LINK_QUALITY_POOR
SL_ZIGBEE_ZCL_GP_GPD_GPP_LINK_QUALITY_MODERATE
SL_ZIGBEE_ZCL_GP_GPD_GPP_LINK_QUALITY_HIGH
SL_ZIGBEE_ZCL_GP_GPD_GPP_LINK_QUALITY_EXCELLENT

sl_zigbee_af_g_p_generic_sw_switch_type_t#

sl_zigbee_af_g_p_generic_sw_switch_type_t

new enum for enum.h

Enumerator
SL_ZIGBEE_ZCL_GP_UNKNOWN_SWITCH_TYPE
SL_ZIGBEE_ZCL_GP_BUTTON_SWITCH_TYPE
SL_ZIGBEE_ZCL_GP_ROCKER_SWITCH_TYPE
SL_ZIGBEE_ZCL_GP_RESERVED_SWITCH_TYPE

sl_zigbee_af_gp_device_id_gpd_t#

sl_zigbee_af_gp_device_id_gpd_t

enum: sl_zigbee_af_gp_gpd_device_id_t

Enumerator
SL_ZIGBEE_GP_DEVICE_ID_GPD_SIMPLE_GENERIC_ONE_STATE_SWITCH
SL_ZIGBEE_GP_DEVICE_ID_GPD_SIMPLE_GENERIC_TWO_STATE_SWITCH
SL_ZIGBEE_GP_DEVICE_ID_GPD_ON_OFF_SWITCH
SL_ZIGBEE_GP_DEVICE_ID_GPD_LEVEL_CONTROL_SWITCH
SL_ZIGBEE_GP_DEVICE_ID_GPD_SIMPLE_SENSOR_SWITCH
SL_ZIGBEE_GP_DEVICE_ID_GPD_ADVANCED_GENERIC_ONE_STATE_SWITCH
SL_ZIGBEE_GP_DEVICE_ID_GPD_ADVANCED_GENERIC_TWO_STATE_SWITCH
SL_ZIGBEE_GP_DEVICE_ID_GPD_GENERIC_SWITCH
SL_ZIGBEE_GP_DEVICE_ID_GPD_COLOR_DIMMER_SWITCH
SL_ZIGBEE_GP_DEVICE_ID_GPD_LIGHT_SENSOR_SWITCH
SL_ZIGBEE_GP_DEVICE_ID_GPD_OCCUPANCY_SENSOR_SWITCH
SL_ZIGBEE_GP_DEVICE_ID_GPD_DOOR_LOCK_CONTROLLER_SWITCH
SL_ZIGBEE_GP_DEVICE_ID_GPD_TEMPERATURE_SENSOR_SWITCH
SL_ZIGBEE_GP_DEVICE_ID_GPD_PRESSURE_SENSOR_SWITCH
SL_ZIGBEE_GP_DEVICE_ID_GPD_FLOW_SENSOR_SWITCH
SL_ZIGBEE_GP_DEVICE_ID_GPD_INDOOR_ENVIRONMENT_SENSOR
SL_ZIGBEE_GP_DEVICE_ID_GPD_SCENCES
SL_ZIGBEE_GP_DEVICE_ID_GPD_UNDEFINED