Infineon Logo AIROC BTSDK v4.3 - Documentation
 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Mesh Time Client

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

Typedefs

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

Functions

void wiced_bt_mesh_model_time_client_init (wiced_bt_mesh_time_client_callback_t *p_callback, wiced_bool_t is_provisioned)
 Time Client Module initialization. More...
 
wiced_bool_t wiced_bt_mesh_model_time_client_message_handler (wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint16_t data_len)
 Time Client Message Handler. More...
 
wiced_result_t wiced_bt_mesh_model_time_client_time_get_send (wiced_bt_mesh_event_t *p_event)
 Time Get send. More...
 
wiced_result_t wiced_bt_mesh_model_time_client_time_set_send (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_time_state_msg_t *p_time_set_data)
 Time Set send. More...
 
wiced_result_t wiced_bt_mesh_model_time_client_time_zone_get_send (wiced_bt_mesh_event_t *p_event)
 Time Zone Get send. More...
 
wiced_result_t wiced_bt_mesh_model_time_client_time_zone_set_send (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_time_zone_set_t *p_set_data)
 Time Zone Set send. More...
 
wiced_result_t wiced_bt_mesh_model_time_client_tai_utc_delta_get_send (wiced_bt_mesh_event_t *p_event)
 Time TAI UTC delta Get send. More...
 
wiced_result_t wiced_bt_mesh_model_time_client_tai_utc_delta_set_send (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_time_tai_utc_delta_set_t *p_time_delta_set)
 Time TAI UTC delta Set send. More...
 
wiced_result_t wiced_bt_mesh_model_time_client_time_role_get_send (wiced_bt_mesh_event_t *p_event)
 Time Role get send. More...
 
wiced_result_t wiced_bt_mesh_model_time_client_time_role_set_send (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_time_role_msg_t *p_set_data)
 Time role Set send. More...
 

Detailed Description

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

To include the Mesh Models support for the Time Client module the application shall contain the WICED_BT_MESH_MODEL_TIME_CLIENT

TBD

Typedef Documentation

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

Time Client callback is called by the Mesh Models library on receiving a message from the peer.

Parameters
eventThe event that the application should process (see Time Events)
p_eventinformation about the message received. The same pointer should be used in the reply if required.
p_dataPointer to the data structure
Returns
None

Function Documentation

void wiced_bt_mesh_model_time_client_init ( wiced_bt_mesh_time_client_callback_t p_callback,
wiced_bool_t  is_provisioned 
)

Time Client Module initialization.

Parameters
element_idxDevice element to where model is used
p_callbackApplication or Parent model callback that will be executed on receiving a message
Returns
None
wiced_bool_t wiced_bt_mesh_model_time_client_message_handler ( wiced_bt_mesh_event_t p_event,
uint8_t *  p_data,
uint16_t  data_len 
)

Time Client 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_eventMesh event with information about received message.
p_dataPointer to the data portion of the message
data_lenLength 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_client_tai_utc_delta_get_send ( wiced_bt_mesh_event_t p_event)

Time TAI UTC delta Get send.

Parameters
p_eventMesh 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_result_t wiced_bt_mesh_model_time_client_tai_utc_delta_set_send ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_time_tai_utc_delta_set_t p_time_delta_set 
)

Time TAI UTC delta Set send.

Parameters
p_eventMesh 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_setpointer to data portion of the Time TAI UTC delta Set message
Returns
WICED_BT_SUCCESS if message has been queued for transmission.
wiced_result_t wiced_bt_mesh_model_time_client_time_get_send ( wiced_bt_mesh_event_t p_event)

Time Get send.

Parameters
p_eventMesh 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_result_t wiced_bt_mesh_model_time_client_time_role_get_send ( wiced_bt_mesh_event_t p_event)

Time Role get send.

Parameters
p_eventMesh 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_result_t wiced_bt_mesh_model_time_client_time_role_set_send ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_time_role_msg_t p_set_data 
)

Time role Set send.

Parameters
p_eventMesh event with the information about the message that has been received in the request, or created by the app for unsolicited message.
p_set_datapointer to data portion of the Time role Set message
Returns
WICED_BT_SUCCESS if message has been queued for transmission.
wiced_result_t wiced_bt_mesh_model_time_client_time_set_send ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_time_state_msg_t p_time_set_data 
)

Time Set send.

Parameters
p_eventMesh event with the information about the message that has been received in the request, or created by the app for unsolicited message.
p_time_set_datapointer to data portion of the Time set message
Returns
WICED_BT_SUCCESS if message has been queued for transmission.
wiced_result_t wiced_bt_mesh_model_time_client_time_zone_get_send ( wiced_bt_mesh_event_t p_event)

Time Zone Get send.

Parameters
p_eventMesh 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_result_t wiced_bt_mesh_model_time_client_time_zone_set_send ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_time_zone_set_t p_set_data 
)

Time Zone Set send.

Parameters
p_eventMesh event with the information about the message that has been received in the request, or created by the app for unsolicited message.
p_set_datapointer to data portion of the Time zone set message
Returns
WICED_BT_SUCCESS if message has been queued for transmission.