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#

bool
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.

bool
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#

bool 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
N/Acmd

Cluster command Ver.: always

N/Astatus

Ver.: always

N/AgroupId

Ver.: always

N/AsceneId

Ver.: always

Returns

  • bool true is success


Definition at line 50 of file app/framework/plugin/scenes-client/scenes-client.h

sl_zigbee_af_scenes_client_parse_view_scene_response#

bool 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, bool)

View scenes response.

Parameters
N/Acmd

cluster command Ver.: always

N/Astatus

Ver.: always

N/AgroupId

Ver.: always

N/AsceneId

Ver.: always

N/AtransitionTime

Ver.: always

N/AsceneName

Ver.: always

N/AextensionFieldSets

Ver.: always

N/Abool

true is success


Definition at line 68 of file app/framework/plugin/scenes-client/scenes-client.h