Mesh Scheduler Server

The AIROC Mesh Scheduler Server module provides a way for an application to implement a functionality for the devices that support Scheduler. More...

Typedefs
typedef void(	wiced_bt_mesh_scheduler_server_callback_t )(uint16_t event, wiced_bt_mesh_event_t *p_event, void *p_data)
	Scheduler Server callback is called by the Mesh Models library on receiving a message from the peer. More...

Functions
void	wiced_bt_mesh_model_scheduler_server_init (wiced_bt_mesh_scheduler_server_callback_t *p_callback, wiced_bool_t is_provisioned)
	Scheduler Server Module initialization. More...
wiced_bool_t	wiced_bt_mesh_model_scheduler_server_message_handler (wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint16_t data_len)
	Scheduler Server Message Handler. More...
wiced_bool_t	wiced_bt_mesh_model_scheduler_setup_server_message_handler (wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint16_t data_len)
	Scheduler Setup Server Message Handler. More...

Detailed Description

The AIROC Mesh Scheduler Server module provides a way for an application to implement a functionality for the devices that support Scheduler.

TBD

Typedef Documentation

typedef void( wiced_bt_mesh_scheduler_server_callback_t)(uint16_t event, wiced_bt_mesh_event_t *p_event, void *p_data)

Scheduler 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 Scheduler Events)
p_event	information about the message received. The same pointer should be used in the reply if required.
p_data	Pointer to the data structure

Returns

None

Function Documentation

void wiced_bt_mesh_model_scheduler_server_init	(	wiced_bt_mesh_scheduler_server_callback_t *	p_callback,
		wiced_bool_t	is_provisioned
	)

Scheduler Server Module initialization.

Parameters

p_callback	Application or Parent model callback that will be executed on receiving a message
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_scheduler_server_message_handler	(	wiced_bt_mesh_event_t *	p_event,
		uint8_t *	p_data,
		uint16_t	data_len
	)

Scheduler 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. The function parses the message and if appropriate calls the parent back to perform functionality.

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.

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

Scheduler Setup 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. The function parses the message and if appropriate calls the parent back to perform functionality.

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.