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#
Prepare a GP notification command buffer.
Prepare a GP pairing search command buffer.
Prepare a GP tunneling stop command buffer.
Prepare a GP commissioning notification command buffer.
Prepare a GP translation table update command buffer.
Prepare a GP pairing configuration command buffer.
Prepare a GP sink table request command buffer.
Prepare a GP notification response command buffer.
Prepare a GP pairing command buffer.
Prepare a GP proxy commissioning mode command buffer.
Prepare a GP response command buffer.
Prepare a GP proxy table request command buffer.
Compare two GP Addresses.
Prepare a GP proxy commissioning mode command buffer.
Prepare a GP sink table response command buffer.
To provide GPD Command Translation Table content.
Enumerations#
new enum for enum.h
enum: sl_zigbee_af_gp_gpd_device_id_t
Macros#
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.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint16_t | N/A | options | Options Ver.: always |
uint32_t | N/A | gpdSrcId | GPD Source Id Ver.: always |
uint8_t * | N/A | gpdIeee | GPD IEEE address Ver.: always |
uint8_t | N/A | gpdEndpoint | GPD endpoint Ver.: always |
uint32_t | N/A | gpdSecurityFrameCounter | GPD security frame counter Ver.: always |
uint8_t | N/A | gpdCommandId | GPD command Id Ver.: always |
uint8_t | N/A | gpdCommandPayloadLength | Command payload length Ver.: always |
const uint8_t * | N/A | gpdCommandPayload | GPD command payload Ver.: always |
uint16_t | N/A | gppShortAddress | GP Proxy short address Ver.: always |
uint8_t | N/A | gppDistance | 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.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint16_t | N/A | options | Options Ver.: always |
uint32_t | N/A | gpdSrcId | GPD Source Id Ver.: always |
uint8_t * | N/A | gpdIeee | GPD IEEE address Ver.: always |
uint8_t | N/A | gpdEndpoint | 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.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t | N/A | options | Options Ver.: always |
uint32_t | N/A | gpdSrcId | GPD Source Id Ver.: always |
uint8_t * | N/A | gpdIeee | GPD IEEE address Ver.: always |
uint8_t | N/A | gpdEndpoint | GPD endpoint Ver.: always |
uint32_t | N/A | gpdSecurityFrameCounter | GPD security frame counter Ver.: always |
uint16_t | N/A | gppShortAddress | GP Proxy short address Ver.: always |
int8_t | N/A | gppDistance | 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.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint16_t | N/A | options | Options Ver.: always |
uint32_t | N/A | gpdSrcId | GPD Source Id Ver.: always |
uint8_t * | N/A | gpdIeee | GPD IEEE address Ver.: always |
uint8_t | N/A | gpdEndpoint | GPD endpoint Ver.: always |
uint8_t | N/A | sequenceNumber | MAC Sequence to be used in security counter field for GPD security level 0 Ver.: always |
sl_zigbee_gp_security_level_t | N/A | gpdfSecurityLevel | GPD security level Ver.: always |
sl_zigbee_gp_security_frame_counter_t | N/A | gpdSecurityFrameCounter | GPD security frame counter Ver.: always |
uint8_t | N/A | gpdCommandId | GPD command Id Ver.: always |
uint8_t | N/A | gpdCommandPayloadLength | Command payload length Ver.: always |
const uint8_t * | N/A | gpdCommandPayload | GPD command payload Ver.: always |
sl_802154_short_addr_t | N/A | gppShortAddress | GP Proxy short address Ver.: always |
uint8_t | N/A | gppLink | GPD-GP Proxy link Ver.: always |
sl_zigbee_gp_mic_t | N/A | mic | 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.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint16_t | N/A | options | Options Ver.: always |
uint32_t | N/A | gpdSrcId | GPD Source Id Ver.: always |
uint8_t * | N/A | gpdIeee | GPD IEEE address Ver.: always |
uint8_t | N/A | gpdEndpoint | GPD endpoint Ver.: always |
uint8_t | N/A | translationsLength | Length of the translations packet Ver.: always |
sl_zigbee_zcl_gp_translation_table_update_translation_t * | N/A | translations | On or more number of translations Ver.: always |
sl_zigbee_gp_translation_table_additional_info_block_option_record_field_t * | N/A | additionnalInfoBlock | 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.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t | N/A | actions | GP Pairing actions field Ver.: always |
uint16_t | N/A | options | Options Ver.: always |
uint32_t | N/A | gpdSrcId | GPD Source Id Ver.: always |
uint8_t * | N/A | gpdIeee | GPD IEEE address Ver.: always |
uint8_t | N/A | gpdEndpoint | GPD endpoint Ver.: always |
uint8_t | N/A | gpdDeviceId | GPD Device Id Ver.: always |
uint8_t | N/A | groupListCount | Group list count Ver.: always |
uint8_t * | N/A | groupList | Group list Ver.: always |
uint16_t | N/A | gpdAssignedAlias | GPD assigned alias Ver.: always |
uint8_t | N/A | groupcastRadius | Group cast radius Ver.: always |
uint8_t | N/A | securityOptions | Security options Ver.: always |
uint32_t | N/A | gpdSecurityFrameCounter | Security frame counter Ver.: always |
uint8_t * | N/A | gpdSecurityKey | Security key Ver.: always |
uint8_t | N/A | numberOfPairedEndpoints | Number of paired endpoints Ver.: always |
uint8_t * | N/A | pairedEndpoints | Paired endpoint list Ver.: always |
uint8_t | N/A | applicationInformation | Application information field Ver.: always |
uint16_t | N/A | manufacturerId | GPD Manufacture Id Ver.: always |
uint16_t | N/A | modeId | GPD Model Id Ver.: always |
uint8_t | N/A | numberOfGpdCommands | Number of GPD commands Ver.: always |
uint8_t * | N/A | gpdCommandIdList | GPD commands list Ver.: always |
uint8_t | N/A | clusterIdListCount | Cluster List count Ver.: always |
uint16_t * | N/A | clusterListServer | Server cluster list Ver.: always |
uint16_t * | N/A | clusterListClient | Client cluster list Ver.: always |
uint8_t | N/A | switchInformationLength | Generic switch information length Ver.: always |
uint8_t | N/A | genericSwitchConfiguration | GGeneric switch configuration Ver.: always |
uint8_t | N/A | currentContactStatus | Current contact status Ver.: always |
uint8_t | N/A | totalNumberOfReports | Total number of reports configured Ver.: always |
uint8_t | N/A | numberOfReports | Number of reports in the report present in descriptor Ver.: always |
uint8_t * | N/A | reportDescriptor | 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.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t | N/A | options | Options Ver.: always |
uint32_t | N/A | gpdSrcId | GPD Source Id Ver.: always |
uint8_t * | N/A | gpdIeee | GPD IEEE address Ver.: always |
uint8_t | N/A | gpdEndpoint | GPD endpoint Ver.: always |
uint8_t | N/A | index | 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.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t | N/A | options | Options Ver.: always |
uint32_t | N/A | gpdSrcId | GPD Source Id Ver.: always |
uint8_t * | N/A | gpdIeee | GPD IEEE address Ver.: always |
uint8_t | N/A | gpdEndpoint | GPD endpoint Ver.: always |
uint32_t | N/A | gpdSecurityFrameCounter | 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.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint32_t | N/A | options | Options Ver.: always |
uint32_t | N/A | gpdSrcId | GPD Source Id Ver.: always |
uint8_t * | N/A | gpdIeee | GPD IEEE address Ver.: always |
uint8_t | N/A | gpdEndpoint | GPD endpoint Ver.: always |
uint8_t * | N/A | sinkIeeeAddress | Sink IEEE address Ver.: always |
uint16_t | N/A | sinkNwkAddress | Sink network address Ver.: always |
uint16_t | N/A | sinkGroupId | Sink group Id Ver.: always |
uint8_t | N/A | deviceId | GPD Device Id Ver.: always |
uint32_t | N/A | gpdSecurityFrameCounter | GPD security frame counter Ver.: always |
uint8_t * | N/A | gpdKey | GPD security key Ver.: always |
uint16_t | N/A | assignedAlias | GPD assigned alias Ver.: always |
uint8_t | N/A | groupcastRadius | 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.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t | N/A | options | Options Ver.: always |
uint16_t | N/A | commissioningWindow | Commissioning window in seconds Ver.: always |
uint8_t | N/A | channel | 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.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t | N/A | options | Options Ver.: always |
uint16_t | N/A | tempMasterShortAddress | Proxy Temp Master short address Ver.: always |
uint8_t | N/A | tempMasterTxChannel | Proxy Temp Master transmit channel Ver.: always |
uint32_t | N/A | gpdSrcId | GPD Source Id Ver.: always |
uint8_t * | N/A | gpdIeee | GPD IEEE address Ver.: always |
uint8_t | N/A | gpdEndpoint | GPD endpoint Ver.: always |
uint8_t | N/A | gpdCommandId | GPD command id Ver.: always |
uint8_t | N/A | gpdCommandPayloadLength | GPD command length Ver.: always |
uint8_t * | N/A | gpdCommandPayload | 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.
Type | Direction | Argument Name | Description |
---|---|---|---|
uint8_t | N/A | options | Options Ver.: always |
uint32_t | N/A | gpdSrcId | GPD Source Id Ver.: always |
uint8_t * | N/A | gpdIeee | GPD IEEE address Ver.: always |
uint8_t | N/A | gpdEndpoint | GPD endpoint Ver.: always |
uint8_t | N/A | index | 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.
Type | Direction | Argument Name | Description |
---|---|---|---|
const sl_zigbee_gp_address_t * | N/A | a1 | First address to compare Ver.: always |
const sl_zigbee_gp_address_t * | N/A | a2 | 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 |