CentralScene

Collaboration diagram for CentralScene:

Data Structures
struct	central_scene_configuration_t
struct	s_CC_centralScene_data_t_
struct	_cc_central_scene_t

Macros
#define	CC_CENTRAL_SCENE_SIZE_OF_SUPPORTED_SCENES_ATTRIBUTES   sizeof(((cc_central_scene_t *)0)->scene_attributes)

Typedefs
typedef struct s_CC_centralScene_data_t_	s_CC_centralScene_data_t
typedef struct _cc_central_scene_t	cc_central_scene_t

Functions
JOB_STATUS	cc_central_scene_notification_tx (AGI_PROFILE *pProfile, uint8_t keyAttribute, uint8_t sceneNumber, ZAF_TX_Callback_t pCbFunc)
void	cc_central_scene_handle_notification_timer (bool start_timer, uint8_t scene_number)
cc_central_scene_t *	cc_central_scene_config_get_scenes_attributes (void)
uint8_t	cc_central_scene_config_get_number_of_scenes (void)
uint8_t	cc_central_scene_config_get_attribute_bitmask (uint8_t scene_number)
uint8_t	cc_central_scene_config_get_identical (void)
bool	cc_central_scene_read (central_scene_configuration_t *pConfig)
bool	cc_central_scene_write (const central_scene_configuration_t *pConfig)
void	cc_central_scene_migrate (void)

Detailed Description

Macro Definition Documentation

CC_CENTRAL_SCENE_SIZE_OF_SUPPORTED_SCENES_ATTRIBUTES

#define CC_CENTRAL_SCENE_SIZE_OF_SUPPORTED_SCENES_ATTRIBUTES   sizeof(((cc_central_scene_t *)0)->scene_attributes)

Size of supported scenes. This field advertises the size of each "Supported Key Attributes" field measured in bytes.

Note

: This value can have values 1-3, but all attributes available in current version of Central Scene (V3) can fit into a single byte.

Typedef Documentation

cc_central_scene_t

typedef struct _cc_central_scene_t cc_central_scene_t

Structure that describes a single scene

s_CC_centralScene_data_t

typedef struct s_CC_centralScene_data_t_ s_CC_centralScene_data_t

Function Documentation

cc_central_scene_config_get_attribute_bitmask()

uint8_t cc_central_scene_config_get_attribute_bitmask

(

uint8_t

scene_number

)

Returns supported attributes for a given scene

Note

This function is used to prepare CENTRAL_SCENE_SUPPORTED_REPORT It is assumption that argument scene_number is higher than 1 only in case when scenes are not identical.

Parameters

scene_number

Number of scene to get supported attributes for

Returns

Supported attributes as bitmask

cc_central_scene_config_get_identical()

uint8_t cc_central_scene_config_get_identical

(

void

)

Gets 'identical' attribute that describes supported key attributes

Returns

True if all keys are identical, False if different key attributes supported

cc_central_scene_config_get_number_of_scenes()

uint8_t cc_central_scene_config_get_number_of_scenes

(

void

)

Returns number of supported scenes

Returns

Total amount of scenes supported by the app.

cc_central_scene_config_get_scenes_attributes()

cc_central_scene_t * cc_central_scene_config_get_scenes_attributes

(

void

)

Returns the array of central scenes.

Note

If scenes are identical, the array will contain only one element

Returns

Address of the first element in the central scene array.

cc_central_scene_handle_notification_timer()

void cc_central_scene_handle_notification_timer	(	bool	start_timer,
		uint8_t	scene_number )

Start or stop Central Scene Notification timer Used when event CENTRAL_SCENE_NOTIFICATION_KEY_ATTRIBUTES_KEY_HELD_DOWN happens. App will send notifications periodically as long as the event is active. Frequency depends on whether slow refresh is enabled or not.

Parameters

start_timer	True if timer should be started, false will stop active timer.
scene_number	Number of active scene.

cc_central_scene_migrate()

void cc_central_scene_migrate

(

void

)

cc_central_scene_notification_tx()

JOB_STATUS cc_central_scene_notification_tx	(	AGI_PROFILE *	pProfile,
		uint8_t	keyAttribute,
		uint8_t	sceneNumber,
		ZAF_TX_Callback_t	pCbFunc )

Initiates the transmission of a "Central Scene Notification" command.

Note

Source Endpoint is always set to Root in this function

Parameters

[in]	pProfile	pointer to AGI profile or NULL for lifeline
[in]	keyAttribute	The key event.
[in]	sceneNumber	The scene number.
[in]	pCbFunc	Callback function to be called when transmission is done/failed.

Returns

Status of the job.

cc_central_scene_read()

bool cc_central_scene_read

(

central_scene_configuration_t *

pConfig

)

cc_central_scene_write()

bool cc_central_scene_write

(

const central_scene_configuration_t *

pConfig

)