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

The AIROC Mesh Light Lightness Client module of the Mesh Models library provides a way for an application to control brightness level of the Light Lightness Servers in the mesh network optionally receive status information. More...

Macros

#define WICED_BT_MESH_MODEL_LIGHT_LIGHTNESS_CLIENT   { MESH_COMPANY_ID_BT_SIG, WICED_BT_MESH_CORE_MODEL_ID_LIGHT_LIGHTNESS_CLNT, wiced_bt_mesh_model_light_lightness_client_message_handler, NULL, NULL }
 

Typedefs

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

Functions

void wiced_bt_mesh_model_light_lightness_client_init (uint8_t element_idx, wiced_bt_mesh_light_lightness_client_callback_t *p_callback, wiced_bool_t is_provisioned)
 Light Lightness Client Module initialization. More...
 
wiced_bool_t wiced_bt_mesh_model_light_lightness_client_message_handler (wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint16_t data_len)
 Light Lightness Client Message Handler. More...
 
wiced_result_t wiced_bt_mesh_model_light_lightness_client_send_get (wiced_bt_mesh_event_t *p_event)
 The application can call this function to send the Light Lightness Get client message to the server. More...
 
wiced_result_t wiced_bt_mesh_model_light_lightness_client_send_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_light_lightness_actual_set_t *p_data)
 The application can call this function to send Light Lightness Set client message to the server. More...
 
wiced_result_t wiced_bt_mesh_model_light_lightness_client_send_linear_get (wiced_bt_mesh_event_t *p_event)
 The application can call this function to send the Light Lightness Linear Get client message to the server. More...
 
wiced_result_t wiced_bt_mesh_model_light_lightness_client_send_linear_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_light_lightness_linear_set_t *p_data)
 The application can call this function to send Light Lightness Linear Set client message to the server. More...
 
wiced_result_t wiced_bt_mesh_model_light_lightness_client_send_last_get (wiced_bt_mesh_event_t *p_event)
 The application can call this function to send the Light Lightness Last Get client message to the server. More...
 
wiced_result_t wiced_bt_mesh_model_light_lightness_client_send_default_get (wiced_bt_mesh_event_t *p_event)
 The application can call this function to send the Light Lightness Default Get client message to the server. More...
 
wiced_result_t wiced_bt_mesh_model_light_lightness_client_send_default_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_light_lightness_default_data_t *p_data)
 The application can call this function to send Light Lightness Default Set client message to the server. More...
 
wiced_result_t wiced_bt_mesh_model_light_lightness_client_send_range_get (wiced_bt_mesh_event_t *p_event)
 The application can call this function to send the Light Lightness Range Get client message to the server. More...
 
wiced_result_t wiced_bt_mesh_model_light_lightness_client_send_range_set (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_light_lightness_range_set_data_t *p_data)
 The application can call this function to send Light Lightness Default Set client message to the server. More...
 

Detailed Description

The AIROC Mesh Light Lightness Client module of the Mesh Models library provides a way for an application to control brightness level of the Light Lightness Servers in the mesh network optionally receive status information.

To include Light Lightness Client functionality, the device description shall contain WICED_BT_MESH_MODEL_LIGHT_LIGHTNESS_CLIENT.

Typedef Documentation

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

Light Lightness 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 Mesh Light Lightness Events)
p_eventinformation about the message received. The same pointer should be used in the reply if required.
p_dataPointer to the data to send
Returns
None

Function Documentation

void wiced_bt_mesh_model_light_lightness_client_init ( uint8_t  element_idx,
wiced_bt_mesh_light_lightness_client_callback_t p_callback,
wiced_bool_t  is_provisioned 
)

Light Lightness Client Module initialization.

Parameters
element_idxDevice element to where model is used
p_callbackThe 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_provisionedIf 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_light_lightness_client_message_handler ( wiced_bt_mesh_event_t p_event,
uint8_t *  p_data,
uint16_t  data_len 
)

Light Lightness 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.

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_light_lightness_client_send_default_get ( wiced_bt_mesh_event_t p_event)

The application can call this function to send the Light Lightness Default Get client message to the server.

Parameters
p_eventMesh event with the information about the message that has been 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_light_lightness_client_send_default_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_light_lightness_default_data_t p_data 
)

The application can call this function to send Light Lightness Default Set client message to the server.

Parameters
p_eventMesh event with the information about the message that has been created by the app for unsolicited message.
p_dataPointer to the data to send
Returns
WICED_BT_SUCCESS if message has been queued for transmission.
wiced_result_t wiced_bt_mesh_model_light_lightness_client_send_get ( wiced_bt_mesh_event_t p_event)

The application can call this function to send the Light Lightness Get client message to the server.

Parameters
p_eventMesh event with the information about the message that has been 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_light_lightness_client_send_last_get ( wiced_bt_mesh_event_t p_event)

The application can call this function to send the Light Lightness Last Get client message to the server.

Parameters
p_eventMesh event with the information about the message that has been 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_light_lightness_client_send_linear_get ( wiced_bt_mesh_event_t p_event)

The application can call this function to send the Light Lightness Linear Get client message to the server.

Parameters
p_eventMesh event with the information about the message that has been 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_light_lightness_client_send_linear_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_light_lightness_linear_set_t p_data 
)

The application can call this function to send Light Lightness Linear Set client message to the server.

Parameters
p_eventMesh event with the information about the message that has been created by the app for unsolicited message.
p_dataPointer to the data to send
Returns
WICED_BT_SUCCESS if message has been queued for transmission.
wiced_result_t wiced_bt_mesh_model_light_lightness_client_send_range_get ( wiced_bt_mesh_event_t p_event)

The application can call this function to send the Light Lightness Range Get client message to the server.

Parameters
p_eventMesh event with the information about the message that has been 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_light_lightness_client_send_range_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_light_lightness_range_set_data_t p_data 
)

The application can call this function to send Light Lightness Default Set client message to the server.

Parameters
p_eventMesh event with the information about the message that has been created by the app for unsolicited message.
p_dataPointer to the data to send
Returns
WICED_BT_SUCCESS if message has been queued for transmission.
wiced_result_t wiced_bt_mesh_model_light_lightness_client_send_set ( wiced_bt_mesh_event_t p_event,
wiced_bt_mesh_light_lightness_actual_set_t p_data 
)

The application can call this function to send Light Lightness Set client message to the server.

Parameters
p_eventMesh event with the information about the message that has been created by the app for unsolicited message.
p_dataPointer to the data to send
Returns
WICED_BT_SUCCESS if message has been queued for transmission.