nRF Connect SDK API 0.1.0
Loading...
Searching...
No Matches

◆ bt_mesh_scene_cli_store()

int bt_mesh_scene_cli_store ( struct bt_mesh_scene_cli cli,
struct bt_mesh_msg_ctx *  ctx,
uint16_t  scene,
struct bt_mesh_scene_register rsp 
)

#include <include/bluetooth/mesh/scene_cli.h>

Store the current state as a scene.

This call is blocking if the rsp buffer is non-NULL. The response will always be passed to the bt_mesh_scene_cli::scene_register callback.

Parameters
[in]cliScene client model.
[in]ctxMessage context to send with, or NULL to use the configured publication parameters.
[in]sceneScene number to store. Cannot be BT_MESH_SCENE_NONE.
[out]rspResponse buffer, or NULL to keep from blocking. If the rsp.scenes parameter points to a valid buffer, it will be filled with at most rsp.count number of scenes, and rsp.count will be changed to reflect the number of retrieved scenes.
Return values
0Successfully sent the store message and processed the response.
-EINVALInvalid scene number.
-EALREADYA blocking request is already in progress.
-EADDRNOTAVAILA message context was not provided and publishing is not configured.
-EAGAINThe device has not been provisioned.
-ETIMEDOUTThe request timed out without a response.