Mesh Default Transition Time Server

The AIROC Mesh Default Transition Time Server module of the Mesh Models library provides implementation of the Default Transition Time model. More...

Macros
#define	WICED_BT_MESH_MODEL_DEFAULT_TRANSITION_TIME_SERVER   { MESH_COMPANY_ID_BT_SIG, WICED_BT_MESH_CORE_MODEL_ID_GENERIC_DEFTT_SRV, wiced_bt_mesh_model_default_transition_time_server_message_handler, NULL, NULL }
	Mesh Default Transition Time Server Module. More...

Typedefs
typedef void(	wiced_bt_mesh_default_transition_time_server_callback_t )(uint16_t event, wiced_bt_mesh_event_t *p_event, void *wiced_bt_mesh_default_transition_time_data_t)
	Generic Default Transition Time Server callback is called by the Mesh Models library on receiving a message from the peer. More...

Functions
void	wiced_bt_mesh_model_default_transition_time_server_init (uint8_t element_idx, wiced_bt_mesh_default_transition_time_server_callback_t *p_callback, wiced_bool_t is_provisioned)
	Generic Default Transition Time Module initialization. More...
wiced_bool_t	wiced_bt_mesh_model_default_transition_time_server_message_handler (wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint16_t data_len)
	Default Transition Time Server Message Handler. More...

Detailed Description

The AIROC Mesh Default Transition Time Server module of the Mesh Models library provides implementation of the Default Transition Time model.

The module cannot be used as a standalone device. But it is required to be included in the definition of various other devices.

All functions of the module are implemented internally in the Mesh Models library and do not need to be replicated in the application, unless application needs to replace the functionality of the server.

Macro Definition Documentation

#define WICED_BT_MESH_MODEL_DEFAULT_TRANSITION_TIME_SERVER   { MESH_COMPANY_ID_BT_SIG, WICED_BT_MESH_CORE_MODEL_ID_GENERIC_DEFTT_SRV, wiced_bt_mesh_model_default_transition_time_server_message_handler, NULL, NULL }

Mesh Default Transition Time Server Module.

The model is used as a base for multiple other models. It is typically not used standalone.

Typedef Documentation

typedef void( wiced_bt_mesh_default_transition_time_server_callback_t)(uint16_t event, wiced_bt_mesh_event_t *p_event, void *wiced_bt_mesh_default_transition_time_data_t)

Generic Default Transition Time Server callback is called by the Mesh Models library on receiving a message from the peer.

Parameters

event	The event that the application should process (see Default Transition Time Events)
p_event	information about the message received. The same pointer should be used in the reply if required.
p_data	Pointer to the on/off state data

Returns

None

Function Documentation

void wiced_bt_mesh_model_default_transition_time_server_init	(	uint8_t	element_idx,
		wiced_bt_mesh_default_transition_time_server_callback_t *	p_callback,
		wiced_bool_t	is_provisioned
	)

Generic Default Transition Time Module initialization.

An application should initialize default transition time model for each element which supports any of the server models that have transitions. The callback that is passed as a parameter will be executed if the provisioner changes the value of the default transition time.

Parameters

element_idx	Device element to where model is used
p_callback	The application callback function that will be executed by the mesh models library when application action is required, or when a reply for the application request has been received.
is_provisioned	If TRUE, the application is being restarted after being provisioned or after a power loss. If FALSE the model cleans up NVRAM on startup.

Returns

None

wiced_bool_t wiced_bt_mesh_model_default_transition_time_server_message_handler	(	wiced_bt_mesh_event_t *	p_event,
		uint8_t *	p_data,
		uint16_t	data_len
	)

Default Transition Time Server Message Handler.

The Mesh Core library calls this function for each message received. The function returns WICED_TRUE if the message is destined for this specific model and successfully processed, and returns WICED_FALSE otherwise.

Parameters

p_event	Mesh event with information about received message.
p_data	Pointer to the data portion of the message
data_len	Length of the data in the message

Returns

WICED_TRUE if the message is for this company ID/Model/Element Index combination, WICED_FALSE otherwise.