BLE Mesh Scene Server Interface

Detailed Description

Interface for BLE Mesh Model Scene Server functions.

Summary

The BLE Mesh interface for the BLE Mesh Model Scene Server (BLE MESH HEALTH SERVER) middleware provides BLE Mesh Model Scene Server functionality.

Data Structures
struct	rm_ble_mesh_scene_server_callback_args_t
struct	rm_ble_mesh_scene_server_timeout_callback_args_t
struct	rm_ble_mesh_scene_server_cfg_t
struct	rm_ble_mesh_scene_server_api_t
struct	rm_ble_mesh_scene_server_instance_t

Typedefs
typedef void	rm_ble_mesh_scene_server_ctrl_t

Enumerations
enum	rm_ble_mesh_scene_srv_event_t

---

Data Structure Documentation

rm_ble_mesh_scene_server_callback_args_t

struct rm_ble_mesh_scene_server_callback_args_t

Mesh model scene server callback parameter definition

Data Fields
void const *	p_context	Placeholder for user data.
rm_ble_mesh_access_model_handle_t *	p_handle	Access Model handle.
rm_ble_mesh_scene_srv_event_t	event_type	Scene event types.
uint8_t *	p_event_data	Pointer to event data.
uint16_t	event_data_length	Event data length.

rm_ble_mesh_scene_server_timeout_callback_args_t

struct rm_ble_mesh_scene_server_timeout_callback_args_t

Mesh model scene server publication timeout callback.

Access Layer calls the registered callback to indicate Publication Timeout for the associated model.

Parameters

p_context	User data.
p_handle	Model Handle.
p_blob	Blob if any or NULL.

Data Fields
void const *	p_context	Placeholder for user data.
rm_ble_mesh_access_model_handle_t *	p_handle	Access Model handle.
void *	p_blob	Binary Large Object.

rm_ble_mesh_scene_server_cfg_t

struct rm_ble_mesh_scene_server_cfg_t

BLE mesh model scene server configuration parameters.

Data Fields
rm_ble_mesh_access_instance_t const *	p_access_instance
	Access Layer instance structure. More...
rm_ble_mesh_access_model_handle_t	model_handle
	Access Model handle.
rm_ble_mesh_access_model_handle_t	setup_server_handle
	Access Model handle for setup server.
void(*	p_callback )(rm_ble_mesh_scene_server_callback_args_t *p_args)
	Mesh model scene server callback.
void(*	p_timeout_callback )(rm_ble_mesh_scene_server_timeout_callback_args_t *p_args)
	Mesh model scene server publication timeout callback.
void const *	p_context
	Placeholder for user data.
void const *	p_extend
	Placeholder for user extension.

Field Documentation

p_access_instance

rm_ble_mesh_access_instance_t const* rm_ble_mesh_scene_server_cfg_t::p_access_instance

Access Layer instance structure.

the parameters for initialization.

rm_ble_mesh_scene_server_api_t

struct rm_ble_mesh_scene_server_api_t

Shared Interface definition for BLE MESH

Data Fields
fsp_err_t(*	open )(rm_ble_mesh_scene_server_ctrl_t *const p_ctrl, rm_ble_mesh_scene_server_cfg_t const *const p_cfg)
fsp_err_t(*	close )(rm_ble_mesh_scene_server_ctrl_t *const p_ctrl)
fsp_err_t(*	stateUpdate )(rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_server_state_t const *const p_state)

Field Documentation

open

fsp_err_t(* rm_ble_mesh_scene_server_api_t::open) (rm_ble_mesh_scene_server_ctrl_t *const p_ctrl, rm_ble_mesh_scene_server_cfg_t const *const p_cfg)

API to open scene server model.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_cfg	Pointer to configuration structure.

close

fsp_err_t(* rm_ble_mesh_scene_server_api_t::close) (rm_ble_mesh_scene_server_ctrl_t *const p_ctrl)

API to close scene server model.

Parameters

[in]

p_ctrl

Pointer to control structure.

stateUpdate

fsp_err_t(* rm_ble_mesh_scene_server_api_t::stateUpdate) (rm_ble_mesh_access_ctrl_t *const p_ctrl, rm_ble_mesh_access_server_state_t const *const p_state)

API to send reply or to update state change.

Parameters

[in]	p_ctrl	Pointer to control structure.
[in]	p_state	Pointer to model specific current/target state parameters.

rm_ble_mesh_scene_server_instance_t

struct rm_ble_mesh_scene_server_instance_t

This structure encompasses everything that is needed to use an instance of this interface.

Data Fields
rm_ble_mesh_scene_server_ctrl_t *	p_ctrl	Pointer to the control structure for this instance.
rm_ble_mesh_scene_server_cfg_t const *	p_cfg	Pointer to the configuration structure for this instance.
rm_ble_mesh_scene_server_api_t const *	p_api	Pointer to the API structure for this instance.

Typedef Documentation

rm_ble_mesh_scene_server_ctrl_t

typedef void rm_ble_mesh_scene_server_ctrl_t

BLE MESH SCENE SERVER control block. Allocate an instance specific control block to pass into the BLE mesh model scene server API calls.

Enumeration Type Documentation

rm_ble_mesh_scene_srv_event_t

enum rm_ble_mesh_scene_srv_event_t

Scene Event Types

Enumerator
RM_BLE_MESH_SCENE_SRV_EVENT_STORE	Scene Event - Store
RM_BLE_MESH_SCENE_SRV_EVENT_DELETE	Scene Event - Delete
RM_BLE_MESH_SCENE_SRV_EVENT_RECALL_START	Scene Event - Recall Start
RM_BLE_MESH_SCENE_SRV_EVENT_RECALL_COMPLETE	Scene Event - Recall Complete
RM_BLE_MESH_SCENE_SRV_EVENT_RECALL_IMMEDIATE	Scene Event - Recall Immediate