Bluetooth Mesh Scene Server Model#

Bluetooth Mesh Scene Server Model.

Bluetooth Mesh Scene model Server functionality.

Modules#

sl_btmesh_evt_scene_server_get

sl_btmesh_evt_scene_server_register_get

sl_btmesh_evt_scene_server_recall

sl_btmesh_evt_scene_server_publish

sl_btmesh_evt_scene_server_compact_recall

Functions#

sl_status_t
sl_btmesh_scene_server_init(uint16_t elem_index)
sl_status_t
sl_btmesh_scene_server_deinit(uint16_t elem_index)
sl_status_t
sl_btmesh_scene_server_reset_register(uint16_t elem_index)

Macros#

#define
sl_btmesh_cmd_scene_server_init_id 0x00500028
#define
sl_btmesh_cmd_scene_server_deinit_id 0x01500028
#define
sl_btmesh_cmd_scene_server_reset_register_id 0x02500028
#define
sl_btmesh_cmd_scene_server_enable_compact_recall_events_id 0x03500028
#define
sl_btmesh_rsp_scene_server_init_id 0x00500028
#define
sl_btmesh_rsp_scene_server_deinit_id 0x01500028
#define
sl_btmesh_rsp_scene_server_reset_register_id 0x02500028
#define
sl_btmesh_rsp_scene_server_enable_compact_recall_events_id 0x03500028

Function Documentation#

sl_btmesh_scene_server_init#

sl_status_t sl_btmesh_scene_server_init (uint16_t elem_index)
Parameters
[in]elem_index

Index of the element.

Initialize the Scene Server model. Server does not have any internal configurations. The command only activates the model in the mesh stack.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 14836 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_scene_server_deinit#

sl_status_t sl_btmesh_scene_server_deinit (uint16_t elem_index)
Parameters
[in]elem_index

Index of the element.

De-initializes the Scene Server model.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 14847 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_scene_server_reset_register#

sl_status_t sl_btmesh_scene_server_reset_register (uint16_t elem_index)
Parameters
[in]elem_index

Index of the element. This can be either element of the updated model or the element of the scene model responsible for controlling the scene of the updated model.

Reset register value. This command should be invoked if state of a model has been modified in such a manner that it can't be in the scene, which is indicated by the scene register.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 14862 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h

sl_btmesh_scene_server_enable_compact_recall_events#

sl_status_t sl_btmesh_scene_server_enable_compact_recall_events ()

Switch to compact reporting for recalled states. Compact state reduces amount buffering memory needed by the scene recall and is recommended for devices with big amount of models or for devices in environment with lots of bluetooth advertisement traffic.

When compact mode is active sl_btmesh_evt_scene_server_compact_recall is generated instead of several sl_btmesh_evt_generic_server_state_recall events.

Returns

  • SL_STATUS_OK if successful. Error code otherwise.


Definition at line 14879 of file /mnt/raid/workspaces/ws.wDIAeKYhQ/overlay/gsdk/protocol/bluetooth/build/native/mesh_app/inc/sl_btmesh_api.h