White-List APIs

This group includes GAP White-List related APIs.

Functions
at_ble_status_t	at_ble_get_whitelist_size (uint8_t *size)
	Get total number of white list entries that can be stored in the Controller. More...
at_ble_status_t	at_ble_whitelist_add (at_ble_addr_t *address)
	Adds a peer device address to the white-list. More...
at_ble_status_t	at_ble_whitelist_clear (void)
	Clear the white-list. More...
at_ble_status_t	at_ble_whitelist_remove (at_ble_addr_t *address)
	Removes a peer device address from the white-list. More...

at_ble_status_t at_ble_get_whitelist_size

(

uint8_t *

size

)

Get total number of white list entries that can be stored in the Controller.

Parameters

[out]

size

The white-list size

Note

the returned size is the maximum size of Public address white list only, Randome static address white list has the same size too

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t

at_ble_status_t at_ble_whitelist_add

(

at_ble_addr_t *

address

)

Adds a peer device address to the white-list.

Parameters

[in]

address

peer device address

Note

This command can be used at any time except when:

• the advertising filter policy uses the white list and advertising is enabled.
• the scanning filter policy uses the white list and scanning is enabled.
• the initiator filter policy uses the white list and a create connection command is outstanding.

The only addresses that should be added to the white-list is Public device address or random static device address

In case of connection mode is AUTO, the white-list will be cleared

To get scan results from only peers added to white list, make sure that "filter_whitelist" argument of at_ble_scan_start is true.

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t

Parameters

[in]

address

Peer device address

Note

To get scan results from only peers added to white list, make sure that "filter_whitelist" argument of at_ble_scan_start is true.

Returns

AT_BLE_SUCCESS Operation completed successfully

AT_BLE_FAILURE Generic error

References at_ble_addr_t::addr, AT_BLE_FAILURE, GAPM_ADD_DEV_IN_WLIST, gapm_white_list_mgm_cmd(), NULL, and at_ble_addr_t::type.

at_ble_status_t at_ble_whitelist_clear

(

void

)

Clear the white-list.

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t

AT_BLE_SUCCESS Operation completed successfully

AT_BLE_FAILURE Generic error

References GAPM_CLEAR_WLIST, gapm_white_list_mgm_cmd(), and NULL.

at_ble_status_t at_ble_whitelist_remove

(

at_ble_addr_t *

address

)

Removes a peer device address from the white-list.

Parameters

[in]

address

peer device address

Note

This command can be used at any time except when:

• the advertising filter policy uses the white list and advertising is enabled.
• the scanning filter policy uses the white list and scanning is enabled.
• the initiator filter policy uses the white list and a create connection command is outstanding.

Returns

Upon successful completion the function shall return AT_BLE_SUCCESS, Otherwise the function shall return at_ble_status_t

Parameters

[in]

address

Peer device address

Returns

AT_BLE_SUCCESS Operation completed successfully

AT_BLE_FAILURE Generic error

References at_ble_addr_t::addr, AT_BLE_FAILURE, GAPM_RMV_DEV_FRM_WLIST, gapm_white_list_mgm_cmd(), NULL, and at_ble_addr_t::type.