Scenes Client#

API and Callbacks for the Scenes Cluster Client Component.

Silicon Labs implementation of the Scenes client cluster. The component is only intended to assist with debugging, as the implemented callbacks simply parse responses from the Scenes server and print the results. Before production, this component should be replaced with code that acts on the responses in an appropriate way.

API#

sl_zigbee_af_scenes_client_parse_add_scene_response(const sl_zigbee_af_cluster_command_t *cmd, uint8_t status, uint16_t groupId, uint8_t sceneId)

Add scenes response.

sl_zigbee_af_scenes_client_parse_view_scene_response(const sl_zigbee_af_cluster_command_t *cmd, uint8_t status, uint16_t groupId, uint8_t sceneId, uint16_t transitionTime, const uint8_t *sceneName, const uint8_t *extensionFieldSets)

View scenes response.

API Documentation#

sl_zigbee_af_scenes_client_parse_add_scene_response#

sl_zigbee_af_zcl_request_status_t sl_zigbee_af_scenes_client_parse_add_scene_response (const sl_zigbee_af_cluster_command_t * cmd, uint8_t status, uint16_t groupId, uint8_t sceneId)

Add scenes response.

Parameters
TypeDirectionArgument NameDescription
const sl_zigbee_af_cluster_command_t *N/Acmd

Cluster command Ver.: always

uint8_tN/Astatus

Ver.: always

uint16_tN/AgroupId

Ver.: always

uint8_tN/AsceneId

Ver.: always

Returns

  • sl_zigbee_af_zcl_request_status_t SL_ZIGBEE_ZCL_STATUS_SUCCESS is success


sl_zigbee_af_scenes_client_parse_view_scene_response#

sl_zigbee_af_zcl_request_status_t sl_zigbee_af_scenes_client_parse_view_scene_response (const sl_zigbee_af_cluster_command_t * cmd, uint8_t status, uint16_t groupId, uint8_t sceneId, uint16_t transitionTime, const uint8_t * sceneName, const uint8_t * extensionFieldSets, sl_zigbee_af_zcl_request_status_t)

View scenes response.

Parameters
TypeDirectionArgument NameDescription
const sl_zigbee_af_cluster_command_t *N/Acmd

cluster command Ver.: always

uint8_tN/Astatus

Ver.: always

uint16_tN/AgroupId

Ver.: always

uint8_tN/AsceneId

Ver.: always

uint16_tN/AtransitionTime

Ver.: always

const uint8_t *N/AsceneName

Ver.: always

const uint8_t *N/AextensionFieldSets

Ver.: always

N/Asl_zigbee_af_zcl_request_status_t

SL_ZIGBEE_ZCL_STATUS_SUCCESS is success