Bluetooth Host Stack Library
Connection and Filter Accept List

General Description

This section provides functions for LE connection related and Filter Accept List operations.

Functions

wiced_bool_t wiced_bt_ble_set_background_connection_type (wiced_bt_ble_conn_type_t conn_type, void *p_select_cback)
 Set LE background connection procedure type. More...
 
wiced_bool_t wiced_bt_ble_update_background_connection_device (wiced_bool_t add_remove, wiced_bt_device_address_t remote_bda, wiced_bt_ble_address_type_t ble_addr_type)
 This function is called to add or remove a device into/from the filter list. More...
 
wiced_result_t wiced_bt_ble_get_connection_parameters (wiced_bt_device_address_t remote_bda, wiced_bt_ble_conn_params_t *p_conn_parameters)
 To read LE connection parameters based on connection address received in gatt connection up indication. More...
 
wiced_bool_t wiced_bt_ble_update_advertising_filter_accept_list (wiced_bool_t add, wiced_bt_ble_address_type_t addr_type, wiced_bt_device_address_t remote_bda)
 Add or remove device from advertising filter Accept List. More...
 
wiced_bool_t wiced_bt_ble_update_scanner_filter_list (wiced_bool_t add, wiced_bt_device_address_t remote_bda, wiced_bt_ble_address_type_t addr_type)
 Add or remove device from scanner filter Accept List. More...
 
wiced_bool_t wiced_bt_ble_clear_filter_accept_list (void)
 Request clearing filter Accept List in controller side. More...
 
uint8_t wiced_bt_ble_get_filter_accept_list_size (void)
 Returns size of Filter Accept List size in controller side. More...
 

Function Documentation

◆ wiced_bt_ble_set_background_connection_type()

wiced_bool_t wiced_bt_ble_set_background_connection_type ( wiced_bt_ble_conn_type_t  conn_type,
void *  p_select_cback 
)

Set LE background connection procedure type.

Parameters
[in]conn_typeBTM_BLE_CONN_NONE or BTM_BLE_CONN_AUTO
[in]p_select_cbackUNUSED
Returns
TRUE if background connection set

◆ wiced_bt_ble_update_background_connection_device()

wiced_bool_t wiced_bt_ble_update_background_connection_device ( wiced_bool_t  add_remove,
wiced_bt_device_address_t  remote_bda,
wiced_bt_ble_address_type_t  ble_addr_type 
)

This function is called to add or remove a device into/from the filter list.

The background connection procedure is decided by the background connection type, it can be auto connection, or none.

Parameters
[in]add_remove: TRUE to add; FALSE to remove.
[in]remote_bda: device address to add/remove.
[in]ble_addr_type: Address type.
Returns
TRUE if successful

◆ wiced_bt_ble_get_connection_parameters()

wiced_result_t wiced_bt_ble_get_connection_parameters ( wiced_bt_device_address_t  remote_bda,
wiced_bt_ble_conn_params_t p_conn_parameters 
)

To read LE connection parameters based on connection address received in gatt connection up indication.

Parameters
[in]remote_bda: remote device address.
[in]p_conn_parameters: Connection Parameters
Returns
wiced_result_t
WICED_BT_ILLEGAL_VALUE : if p_conn_parameters is NULL.
WICED_BT_UNKNOWN_ADDR : if device address is bad.
WICED_BT_SUCCESS otherwise.

◆ wiced_bt_ble_update_advertising_filter_accept_list()

wiced_bool_t wiced_bt_ble_update_advertising_filter_accept_list ( wiced_bool_t  add,
wiced_bt_ble_address_type_t  addr_type,
wiced_bt_device_address_t  remote_bda 
)

Add or remove device from advertising filter Accept List.

Parameters
[in]addTRUE to add; FALSE to remove
[in]addr_typeType of the addr
[in]remote_bdaremote device address.
Returns
wiced_bool_t ( WICED_TRUE if successful else WICED_FALSE )

◆ wiced_bt_ble_update_scanner_filter_list()

wiced_bool_t wiced_bt_ble_update_scanner_filter_list ( wiced_bool_t  add,
wiced_bt_device_address_t  remote_bda,
wiced_bt_ble_address_type_t  addr_type 
)

Add or remove device from scanner filter Accept List.

Parameters
[in]addTRUE to add; FALSE to remove
[in]remote_bdaremote device address.
[in]addr_type: remote device address type .
Returns
WICED_TRUE if successful else WICED_FALSE

◆ wiced_bt_ble_clear_filter_accept_list()

wiced_bool_t wiced_bt_ble_clear_filter_accept_list ( void  )

Request clearing filter Accept List in controller side.

Returns
TRUE if request of clear is sent to controller side

◆ wiced_bt_ble_get_filter_accept_list_size()

uint8_t wiced_bt_ble_get_filter_accept_list_size ( void  )

Returns size of Filter Accept List size in controller side.

Returns
size of Filter Accept List in current controller