bt_mesh_scene_cli_recall()

int bt_mesh_scene_cli_recall	(	struct bt_mesh_scene_cli *	cli,
		struct bt_mesh_msg_ctx *	ctx,
		uint16_t	scene,
		const struct bt_mesh_model_transition *	transition,
		struct bt_mesh_scene_state *	rsp
	)

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

Recall the given scene.

All models that participate in the scene will transition to the stored scene state with the given transition parameters.

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

Parameters

[in]	cli	Scene client model.
[in]	ctx	Message context to send with, or NULL to use the configured publication parameters.
[in]	scene	Scene to recall. Cannot be BT_MESH_SCENE_NONE.
[in]	transition	Parameters for the scene transition, or NULL to use the target's default parameters.
[out]	rsp	Response buffer, or NULL to keep from blocking.

Return values

0	Successfully sent the recall message and processed the response.
-EINVAL	Invalid scene number or transition parameters.
-EALREADY	A blocking request is already in progress.
-EADDRNOTAVAIL	A message context was not provided and publishing is not configured.
-EAGAIN	The device has not been provisioned.
-ETIMEDOUT	The request timed out without a response.