Mesh Scheduler Client

General Description

The AIROC Mesh Scheduler Client module provides a way for an application to control Scheduler Servers in the mesh network.

TBD

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

Functions
void	wiced_bt_mesh_model_scheduler_client_init (wiced_bt_mesh_scheduler_client_callback_t *p_callback, wiced_bool_t is_provisioned)
	Scheduler Client Module initialization. More...
wiced_bool_t	wiced_bt_mesh_model_scheduler_client_message_handler (wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint16_t data_len)
	Scheduler client Message Handler. More...
wiced_result_t	wiced_bt_mesh_model_scheduler_client_send_get (wiced_bt_mesh_event_t *p_event)
	Scheduler Client send Get request. More...
wiced_result_t	wiced_bt_mesh_model_scheduler_client_send_action_get (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_scheduler_action_get_t *p_data)
	Scheduler Client Send Action Get request. More...
wiced_result_t	wiced_bt_mesh_model_scheduler_client_send_action_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_scheduler_action_data_t *p_data)
	Scheduler Client Send Action Set request. More...

Typedef Documentation

wiced_bt_mesh_scheduler_client_callback_t

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

Scheduler Client 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

wiced_bt_mesh_model_scheduler_client_init()

void wiced_bt_mesh_model_scheduler_client_init	(	wiced_bt_mesh_scheduler_client_callback_t *	p_callback,
		wiced_bool_t	is_provisioned
	)

Scheduler Client Module initialization.

Parameters

element_idx	Device element to where model is used
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_bt_mesh_model_scheduler_client_message_handler()

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

Scheduler client Message Handler.

An application or a parent model can call this models library function to process a message received from the Scheduler Server device. 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_bt_mesh_model_scheduler_client_send_get()

wiced_result_t wiced_bt_mesh_model_scheduler_client_send_get

(

wiced_bt_mesh_event_t *

p_event

)

Scheduler Client send Get request.

Application can call Scheduler Client Get function to send Scheduler Get client message to the server.

Parameters

p_event

Mesh event with the information about the message that has been received in the request, or created by the app for unsolicited message.

Returns

WICED_BT_SUCCESS if message has been queued for transmission.

wiced_bt_mesh_model_scheduler_client_send_action_get()

wiced_result_t wiced_bt_mesh_model_scheduler_client_send_action_get	(	wiced_bt_mesh_event_t *	p_event,
		wiced_bt_mesh_scheduler_action_get_t *	p_data
	)

Scheduler Client Send Action Get request.

Application can call Scheduler Client Action Get function to send Scheduler Action Get client message to the server.

Parameters

p_event	Mesh event with the information about the message that has been received in the request, or created by the app for unsolicited message.
p_data	Pointer to the data structure containing the action number of interest

Returns

WICED_BT_SUCCESS if message has been queued for transmission.

wiced_bt_mesh_model_scheduler_client_send_action_set()

wiced_result_t wiced_bt_mesh_model_scheduler_client_send_action_set	(	wiced_bt_mesh_event_t *	p_event,
		wiced_bt_mesh_scheduler_action_data_t *	p_data
	)

Scheduler Client Send Action Set request.

Application can call Scheduler Client Action Set function to send Scheduler Action Set client message to the server.

Parameters

p_event	Mesh event with the information about the message that has been received in the request, or created by the app for unsolicited message.
p_data	Pointer to the data structure containing the action number of interest, time stamp when action should accure and the scene number for the device to move to.

Returns

WICED_BT_SUCCESS if message has been queued for transmission.