Scene models

This model implements the message based interface required to set the Scene Setup server states. More...

Modules
	Scene client model interface
	Persistence module for the Scene Setup Server model related states
	This module provides APIs for handling persistence of the Scene Setup Server model related states.
	Scene Setup server model interface

Data Structures
struct	scene_store_params_t
	Parameters for the Scene Store message. More...
struct	scene_recall_params_t
	Parameters for the Scene Recall message. More...
struct	scene_status_params_t
	Parameters for the Scene Status message. More...
struct	scene_register_status_params_t
	Parameters for the Scene Register Status message. More...
struct	scene_delete_params_t
	Parameters for the Scene Delete message. More...

Macros
#define	SCENE_COMPANY_ID   0xFFFF
	Model Company ID.
#define	SCENE_REGISTER_SCENE_NUMBER_MIN   (1)
	Minimum allowed value of the Scene Register Number defined in Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 5.1.3.1.
#define	SCENE_NUMBER_NO_SCENE   (0x0000)
	Defines the default value for the Current Scene from Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 5.1.3.2 and Target Scene from Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 5.1.3.3.
#define	SCENE_NO_PROPERTY_ID   0
#define	SCENE_SCENES_MAX   (65535)
	Maximum value of number of scenes, as defined in Bluetooth Mesh Model Specification (MshMDLv1.0.1)
#define	SCENE_REGISTER_ARRAY_SIZE   (16)
	Scene Register size definitions. More...

Enumerations
enum	scene_status_t { SCENE_STATUS_SUCCESS, SCENE_STATUS_REGISTER_FULL, SCENE_STATUS_NOT_FOUND }
	Status code values used by scene_status_params_t and scene_register_status_params_t. More...

Detailed Description

This model implements the message based interface required to set the Scene Setup server states.

The model sends its state information to the mid app to be stored in flash (to be read at boot time) and use it appropriately. Scenes are the stored states of a device that can be recalled using messges or at a given time.

Macro Definition Documentation

SCENE_REGISTER_ARRAY_SIZE

#define SCENE_REGISTER_ARRAY_SIZE   (16)

Scene Register size definitions.

Although the Scene Register array has a variable size, it is never bigger than 16 elements. So we set 16 elements to be used as array size. See Bluetooth Mesh Model Specification (MshMDLv1.0.1) section 5.1.3.1.

Warning

Changing this value to anything other than 16 makes the Scene Model non-compliant with the Bluetooth Mesh Model Specification (MshMDLv1.0.1).

Definition at line 86 of file scene_common.h.

Enumeration Type Documentation

scene_status_t

enum scene_status_t

Status code values used by scene_status_params_t and scene_register_status_params_t.

Enumerator
SCENE_STATUS_SUCCESS	The previous operation is valid.
SCENE_STATUS_REGISTER_FULL	The previous operation is failed because register was full.
SCENE_STATUS_NOT_FOUND	The previous operation is failed because scene was not found.

Definition at line 92 of file scene_common.h.