Scenes Server#

sl_zigbee_af_scenes_server_entries_in_use#

uint8_t sl_zigbee_af_scenes_server_entries_in_use

sl_zigbee_af_scenes_server_scene_table#

sl_zigbee_af_scene_table_entry_t sl_zigbee_af_scenes_server_scene_table[]

sl_zigbee_af_scenes_set_scene_count_attribute#

sl_zigbee_af_status_t sl_zigbee_af_scenes_set_scene_count_attribute (uint8_t endpoint, uint8_t newCount)

sl_zigbee_af_scenes_make_valid#

sl_zigbee_af_status_t sl_zigbee_af_scenes_make_valid (uint8_t endpoint, uint8_t sceneId, uint16_t groupId)

sl_zigbee_af_scenes_server_parse_add_scene#

bool sl_zigbee_af_scenes_server_parse_add_scene (const sl_zigbee_af_cluster_command_t * cmd, uint16_t groupId, uint8_t sceneId, uint16_t transitionTime, uint8_t * sceneName, uint8_t * extensionFieldSets)

sl_zigbee_af_scenes_server_parse_view_scene#

bool sl_zigbee_af_scenes_server_parse_view_scene (const sl_zigbee_af_cluster_command_t * cmd, uint16_t groupId, uint8_t sceneId)

sl_zigbee_af_scenes_server_custom_recall_scene_cb#

bool sl_zigbee_af_scenes_server_custom_recall_scene_cb (const sl_zigbee_af_scene_table_entry_t *const sceneEntry, uint16_t transitionTimeDs, sl_zigbee_af_status_t *const status)

Scenes Server Custom Recall Scene.

Customize the implementation of the Scenes cluster RecallScene command for desired behavior when gradually transitioning to the specified scene over the specified transition time interval.

Upon entry to this callback, the presented scene table entry has been verified to be valid for the endpoint, group ID, and scene ID referenced in the received ZCL Scenes cluster RecallScene command.

NOTE: If this callback is implemented, the expectation is that it will INITIATE the scene transition behavior and return promptly with prospective success or failure status, rather than execute through the full duration of the transition time before returning.

NOTE: The scene table entry pointer, and the information in the scene table entry, are available only during the execution of this callback function. The scene table entry information (NOT the pointer) must be copied and saved before returning from this callback function if it will need to be referenced at other times to perform the desired transition behavior (for example, by a timer-based periodic handler launched by this callback).

If the value of transitionTimeDs is 0xFFFF, the transition time information configured in the scene table entry should be used.

Upon arriving at the target scene configuration, the custom implementation should set the Scenes cluster attributes CurrentScene and CurrentGroup to the scene ID and group ID values contained in the sceneEntry, and set the SceneValid attribute to true.

Returns true if a customization of this callback HAS been IMPLEMENTED. This REQUIRES that a valid sl_zigbee_af_status_t value has been written to the status argument. Status will be SL_ZIGBEE_ZCL_STATUS_SUCCESS if the scene transition has been initiated successfully, even though the transition time has not fully elapsed and the full effect of the scene transition over the transition time has not yet completed. Otherwise, a suitable error status value should be returned in the status argument.

Returns false if a customization of this callback HAS NOT been implemented. In this case, the Scenes plugin will perform default handling (apply target scene settings immediately without regard for the specified transition time).

Returns

• true if custom callback is implemented false if custom callback is not implemented (apply default handling)

sl_zigbee_af_scenes_make_invalid#

#define sl_zigbee_af_scenes_make_invalid

sl_zigbee_af_scenes_cluster_make_invalid_cb

sl_zigbee_af_scenes_server_retrieve_scene_entry#

#define sl_zigbee_af_scenes_server_retrieve_scene_entry

(entry, i)

sl_zigbee_af_scenes_server_save_scene_entry#

#define sl_zigbee_af_scenes_server_save_scene_entry

(entry, i)

sl_zigbee_af_scenes_server_num_scene_entries_in_use#

#define sl_zigbee_af_scenes_server_num_scene_entries_in_use

()

sl_zigbee_af_scenes_server_set_num_scene_entries_in_use#

#define sl_zigbee_af_scenes_server_set_num_scene_entries_in_use

(x)

sl_zigbee_af_scenes_server_incr_num_scene_entries_in_use#

#define sl_zigbee_af_scenes_server_incr_num_scene_entries_in_use

()

sl_zigbee_af_scenes_server_decr_num_scene_entries_in_use#

#define sl_zigbee_af_scenes_server_decr_num_scene_entries_in_use

()