Mesh Time Server

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

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

Functions
void	wiced_bt_mesh_model_time_server_init (wiced_bt_mesh_time_server_callback_t *p_callback, wiced_bool_t is_provisioned)
	Time Server Module initialization. More...
wiced_bool_t	wiced_bt_mesh_model_time_server_message_handler (wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint16_t data_len)
	Time Server Message Handler. More...
wiced_bool_t	wiced_bt_mesh_model_time_setup_server_message_handler (wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint16_t data_len)
	Time Setup Server Message Handler. More...
wiced_result_t	wiced_bt_mesh_model_time_server_status_send (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_time_state_msg_t *p_time_status_data)
	Time server status send. More...
wiced_result_t	wiced_bt_mesh_model_time_server_zone_status_send (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_time_zone_status_t *p_time_zone_status_data)
	Time zone status send. More...
wiced_result_t	wiced_bt_mesh_model_time_server_tai_utc_delta_status_send (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_time_tai_utc_delta_status_t *p_time_delta_status_data)
	Time TAI_UTC delta status send. More...

Detailed Description

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

To include the Mesh Models support for the Time Server module the application shall contain the WICED_BT_MESH_MODEL_TIME_SERVER

TBD

Typedef Documentation

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

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 Time Events)
p_data	Pointer to the RTC Time data structure

Returns

None

Function Documentation

void wiced_bt_mesh_model_time_server_init	(	wiced_bt_mesh_time_server_callback_t *	p_callback,
		wiced_bool_t	is_provisioned
	)

Time Server Module initialization.

Parameters

p_callback

Application or Parent model callback that will be executed on receiving a message

Returns

None

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

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. 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_result_t wiced_bt_mesh_model_time_server_status_send	(	wiced_bt_mesh_event_t *	p_event,
		wiced_bt_mesh_time_state_msg_t *	p_time_status_data
	)

Time server status send.

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_time_zone_status_data	pointer to data portion of the time zone status message

Returns

WICED_BT_SUCCESS if message has been queued for transmission.

wiced_result_t wiced_bt_mesh_model_time_server_tai_utc_delta_status_send	(	wiced_bt_mesh_event_t *	p_event,
		wiced_bt_mesh_time_tai_utc_delta_status_t *	p_time_delta_status_data
	)

Time TAI_UTC delta status send.

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_time_delta_status_data	pointer to data portion of the Time TAI_UTC delta status message

Returns

WICED_BT_SUCCESS if message has been queued for transmission.

wiced_result_t wiced_bt_mesh_model_time_server_zone_status_send	(	wiced_bt_mesh_event_t *	p_event,
		wiced_bt_mesh_time_zone_status_t *	p_time_zone_status_data
	)

Time zone status send.

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_time_status_data	pointer to data portion of the time status message

Returns

WICED_BT_SUCCESS if message has been queued for transmission.

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

Time 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.