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
emberAfPluginScenesClientParseAddSceneResponse(const EmberAfClusterCommand *cmd, uint8_t status, uint16_t groupId, uint8_t sceneId)
Add scenes response.
bool
emberAfPluginScenesClientParseViewSceneResponse(const EmberAfClusterCommand *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#
emberAfPluginScenesClientParseAddSceneResponse#
bool emberAfPluginScenesClientParseAddSceneResponse (const EmberAfClusterCommand * cmd, uint8_t status, uint16_t groupId, uint8_t sceneId)
Add scenes response.
Parameters
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| const EmberAfClusterCommand * | N/A | cmd | Cluster command Ver.: always |
| uint8_t | N/A | status | Ver.: always |
| uint16_t | N/A | groupId | Ver.: always |
| uint8_t | N/A | sceneId | Ver.: always |
Returns
bool true is success
emberAfPluginScenesClientParseViewSceneResponse#
bool emberAfPluginScenesClientParseViewSceneResponse (const EmberAfClusterCommand * 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
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| const EmberAfClusterCommand * | N/A | cmd | cluster command Ver.: always |
| uint8_t | N/A | status | Ver.: always |
| uint16_t | N/A | groupId | Ver.: always |
| uint8_t | N/A | sceneId | Ver.: always |
| uint16_t | N/A | transitionTime | Ver.: always |
| const uint8_t * | N/A | sceneName | Ver.: always |
| const uint8_t * | N/A | extensionFieldSets | Ver.: always |
| N/A | bool | true is success |