Bluetooth Mesh Scene Client Model#
Bluetooth Mesh Scene Client Model.
Bluetooth Mesh Scene Client model functionality to send and receive messages to/from the Scene Server and Scene Setup Server models.
Throughout the API, the client model that is used is identified by its element address and model ID, while the server model responding to the client model requests is identified by its element address and model ID.
The API has functions for querying server model states and requesting server model state changes.
Modules#
sl_btmesh_evt_scene_client_status
sl_btmesh_evt_scene_client_register_status
Functions#
Macros#
Function Documentation#
sl_btmesh_scene_client_init#
sl_status_t sl_btmesh_scene_client_init (uint16_t elem_index)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | elem_index | Index of the client element. |
Initialize the Scene Client model. The Scene Client does not have any internal configuration. It only activates the model in the mesh stack.
Returns
SL_STATUS_OK if successful. Error code otherwise.
sl_btmesh_scene_client_get#
sl_status_t sl_btmesh_scene_client_get (uint16_t server_address, uint16_t elem_index, uint16_t appkey_index)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | server_address | Device to be queried. The address 0x0000 can be used to publish the message according to model configuration |
| uint16_t | [in] | elem_index | Index of the client element. |
| uint16_t | [in] | appkey_index | Appkey used by server_address. |
Scene Get command.
Returns
SL_STATUS_OK if successful. Error code otherwise.
Events
sl_btmesh_scene_client_get_register#
sl_status_t sl_btmesh_scene_client_get_register (uint16_t server_address, uint16_t elem_index, uint16_t appkey_index)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | server_address | Destination server model address. The address 0x0000 can be used to publish the message according to model configuration |
| uint16_t | [in] | elem_index | Client model element index |
| uint16_t | [in] | appkey_index | The application key index to use. |
Scene Register Get command
Returns
SL_STATUS_OK if successful. Error code otherwise.
Events
sl_btmesh_scene_client_recall#
sl_status_t sl_btmesh_scene_client_recall (uint16_t server_address, uint16_t elem_index, uint16_t selected_scene, uint16_t appkey_index, uint8_t flags, uint8_t tid, uint32_t transition_time_ms, uint16_t delay_ms)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | server_address | Destination server model address. The address 0x0000 can be used to publish the message according to model configuration |
| uint16_t | [in] | elem_index | Index of the client element. |
| uint16_t | [in] | selected_scene | Scene of interest |
| uint16_t | [in] | appkey_index | Appkey used by server_address. |
| uint8_t | [in] | flags | Bit 1 (0x02) defines whether response is required. If set to 1, SET PROPERTY message will be sent, zero will send SET PROPERTY UNACKNOWLEDGED |
| uint8_t | [in] | tid | Transaction ID |
| uint32_t | [in] | transition_time_ms | Amount of time (in milliseconds) allotted for the transition to take place. Value of 0xFFFFFFFF will cause this parameter as well as the "delay" parameter to be omitted. The transition will be immediate if both the transition time and the delay are zero. |
| uint16_t | [in] | delay_ms | Message execution delay in milliseconds. If the "transition_time" is 0xFFFFFFFF, this parameter is ignored. If both the transition time and the delay are zero, the transition is immediate. Valid range: 0-1275. |
Recall a scene.
Returns
SL_STATUS_OK if successful. Error code otherwise.
Events
sl_btmesh_scene_client_store#
sl_status_t sl_btmesh_scene_client_store (uint16_t server_address, uint16_t elem_index, uint16_t selected_scene, uint16_t appkey_index, uint8_t flags)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | server_address | Destination server model address. The address 0x0000 can be used to publish the message according to the model configuration. |
| uint16_t | [in] | elem_index | Client model element index |
| uint16_t | [in] | selected_scene | Scene of interest |
| uint16_t | [in] | appkey_index | The application key index to use. |
| uint8_t | [in] | flags | Bit 1 (0x02) defines whether response is required. If set to 1, SET PROPERTY message will be sent. Zero will send SET PROPERTY UNACKNOWLEDGED. |
Store a scene.
Returns
SL_STATUS_OK if successful. Error code otherwise.
Events
sl_btmesh_scene_client_delete#
sl_status_t sl_btmesh_scene_client_delete (uint16_t server_address, uint16_t elem_index, uint16_t selected_scene, uint16_t appkey_index, uint8_t flags)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | server_address | Destination server model address. The address 0x0000 can be used to publish the message according to the model configuration. |
| uint16_t | [in] | elem_index | Client model element index |
| uint16_t | [in] | selected_scene | Scene of interest |
| uint16_t | [in] | appkey_index | The application key index to use. |
| uint8_t | [in] | flags | Bit 1 (0x02) defines whether response is required. If set to 1, SET PROPERTY message will be sent. Zero will send SET PROPERTY UNACKNOWLEDGED. |
Delete a scene.
Returns
SL_STATUS_OK if successful. Error code otherwise.
Events
sl_btmesh_scene_client_deinit#
sl_status_t sl_btmesh_scene_client_deinit (uint16_t elem_index)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint16_t | [in] | elem_index | Index of the client element. |
Deinitialize the Scene Client model. This deactivates the model in the mesh stack.
Returns
SL_STATUS_OK if successful. Error code otherwise.