Connection API

API Reference


group gatt_common_api

GATT Profile Connection Functions.

Functions

wiced_bool_t wiced_bt_gatt_le_connect(wiced_bt_device_address_t bd_addr, wiced_bt_ble_address_type_t bd_addr_type, wiced_bt_ble_conn_mode_t conn_mode, wiced_bool_t is_direct)

Open GATT over LE connection to a remote device Result is notified using GATT_CONNECTION_STATUS_EVT of wiced_bt_gatt_cback_t.

NOTE : If is_direct = WICED_FALSE, it will create background connection. Default Background connection type is BTM_BLE_CONN_NONE. Before calling wiced_bt_gatt_le_connect please set background connection type (AUTO / SELECTIVE) using wiced_bt_ble_set_background_connection_type API

Return

TRUE : If connection started FALSE : If connection start failure

Parameters
  • [in] bd_addr: : Remote device address

  • [in] bd_addr_type: Public or random address

  • [in] conn_mode: : connection scan mode

  • [in] is_direct: : Is direct connection or not

wiced_bt_gatt_status_t wiced_bt_gatt_register(wiced_bt_gatt_cback_t *p_gatt_cback)

Register an application callback for GATT.

Return

wiced_bt_gatt_status_t

Parameters
  • [in] p_gatt_cback: : The GATT notification callback

wiced_bool_t wiced_bt_gatt_cancel_connect(wiced_bt_device_address_t bd_addr, wiced_bool_t is_direct)

Cancel initiating GATT connection.

Return

TRUE : If connection started FALSE : If connection start failure

Parameters
  • [in] bd_addr: : Remote device address

  • [in] is_direct: : Is direct connection or not

wiced_bt_gatt_status_t wiced_bt_gatt_disconnect(uint16_t conn_id)

Close the specified GATT connection.

Result is notified using GATT_CONNECTION_STATUS_EVT of wiced_bt_gatt_cback_t.

Return

wiced_bt_gatt_status_t

Parameters
  • [in] conn_id: : GATT connection ID

wiced_bool_t wiced_bt_gatt_listen(wiced_bool_t start, wiced_bt_device_address_t bd_addr, wiced_bt_ble_address_type_t type)

Start or stop LE advertisement and listen for connection.

Return

TRUE : Success FALSE : Failure

Parameters
  • [in] start: : TRUE to add device to Filter Accept List / FALSE to remove

  • [in] bd_addr: : Device to add/remove from Filter Accept List

  • [in] type: : Address type of bd_addr

wiced_bt_gatt_status_t wiced_bt_gatt_get_device_address(uint16_t conn_id, wiced_bt_device_address_t *p_bdaddr, wiced_bt_transport_t *p_transport, wiced_bt_ble_address_type_t *p_addr_type)

API to get the bluetooth device address of the connected gatt conn_id.

note

: The API cannot be used to get the Bluetooth device address in case the device is disconnected

Return

wiced_bt_gatt_status_t

Parameters