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

The mesh client API. More...

Functions

wiced_bool_t wiced_bt_mesh_remote_provisioning_is_gatt_connecting (void)
 Checking GATT connection. More...
 
void wiced_bt_mesh_remote_provisioning_connection_state_changed (uint16_t conn_id, uint16_t reason)
 Connection State Changed. More...
 
void wiced_bt_mesh_client_search_proxy (uint8_t start)
 Search for Proxy device. More...
 
wiced_bool_t wiced_bt_mesh_client_proxy_connect (wiced_bt_mesh_proxy_connect_data_t *p_data)
 Proxy Connect. More...
 
wiced_bool_t wiced_bt_mesh_client_proxy_disconnect (void)
 Proxy Disonnect. More...
 
wiced_bool_t wiced_bt_mesh_client_provision_connect (wiced_bt_mesh_event_t *p_event, wiced_bt_mesh_provision_connect_data_t *p_connect, wiced_bool_t use_pb_gatt)
 
wiced_bool_t wiced_bt_mesh_provision_disconnect (wiced_bt_mesh_event_t *p_event)
 Provisioner Disconnect. More...
 
void wiced_bt_ble_set_scan_mode (uint8_t is_active)
 Set Scan Mode. More...
 
void wiced_bt_mesh_client_vendor_data (wiced_bt_mesh_event_t *p_event, uint8_t *p_data, uint16_t data_len)
 Send Vendor Data message. More...
 

Detailed Description

The mesh client API.

Function Documentation

void wiced_bt_ble_set_scan_mode ( uint8_t  is_active)

Set Scan Mode.

The application can call this function to switch between passive and active scan.

Parameters
is_activeIf set to 1, the stack will perform the active scan
Returns
none
wiced_bool_t wiced_bt_mesh_client_proxy_connect ( wiced_bt_mesh_proxy_connect_data_t p_data)

Proxy Connect.

The application can call this function to establish GATT Proxy connection. Depending on the parameters the connection should be establishing either to a device advertising it's identity, or a device advertising a mesh network

Parameters
p_dataPointer to the data structure with the node identity or network.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_client_proxy_disconnect ( void  )

Proxy Disonnect.

The application can call this function to terminat GATT Proxy connection.

Parameters
none
Returns
WICED_TRUE/WICED_FALSE - success/failed.
void wiced_bt_mesh_client_search_proxy ( uint8_t  start)

Search for Proxy device.

Process command from the MCU to start or stop scanning for GATT Proxy devices.

Parameters
p_dataPointer to the data structure with start/stop information.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
void wiced_bt_mesh_client_vendor_data ( wiced_bt_mesh_event_t p_event,
uint8_t *  p_data,
uint16_t  data_len 
)

Send Vendor Data message.

The application can call this function to send Vendor Data message to the Client

Parameters
p_eventPointer to the event structure which identified the remote provisioning server.
p_dataPointer to the vendor data
data_lenLength of the vendor data
Returns
none
wiced_bool_t wiced_bt_mesh_provision_disconnect ( wiced_bt_mesh_event_t p_event)

Provisioner Disconnect.

The application can call this function to terminate GATT Provisioning connection.

Parameters
p_eventPointer to the event structure which identified the remote provisioning server.
Returns
WICED_TRUE/WICED_FALSE - success/failed.
void wiced_bt_mesh_remote_provisioning_connection_state_changed ( uint16_t  conn_id,
uint16_t  reason 
)

Connection State Changed.

The application shall call this function when connection is established or dropped.

Parameters
conn_idGATT connection ID, or 0 if connection is lost.
reasonDisconnection reason
Returns
WICED_TRUE/WICED_FALSE - success/failed.
wiced_bool_t wiced_bt_mesh_remote_provisioning_is_gatt_connecting ( void  )

Checking GATT connection.

This function returns TRUE if remote provisioning started GATT connection

Parameters
none
Returns
WICED_TRUE/WICED_FALSE - success/failed.