This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

CONFIG_BT_WHITELIST

Enable whitelist support

Type: bool

Help

This option enables the whitelist API. This takes advantage of the
whitelisting feature of a BLE controller.
The whitelist is a global list and the same whitelist is used
by both scanner and advertiser. The whitelist cannot be modified while
it is in use.

An Advertiser can whitelist which peers can connect or request scan
response data.
A scanner can whitelist advertiser for which it will generate
advertising reports.
Connections can be established automatically for whitelisted peers.

This options deprecates the bt_le_set_auto_conn API in favor of the
bt_conn_create_aute_le API.

Direct dependencies

BT_HCI_HOST && BT_HCI && BT

(Includes any dependencies from ifs and menus.)

Defaults

No defaults. Implicitly defaults to n.

Kconfig definition

At subsys/bluetooth/host/Kconfig:175

Included via Kconfig:8Kconfig.zephyr:42subsys/Kconfig:9subsys/bluetooth/Kconfig:313

Menu path: (Top) → Sub Systems and OS Services → Bluetooth

config BT_WHITELIST
    bool "Enable whitelist support"
    depends on BT_HCI_HOST && BT_HCI && BT
    help
      This option enables the whitelist API. This takes advantage of the
      whitelisting feature of a BLE controller.
      The whitelist is a global list and the same whitelist is used
      by both scanner and advertiser. The whitelist cannot be modified while
      it is in use.

      An Advertiser can whitelist which peers can connect or request scan
      response data.
      A scanner can whitelist advertiser for which it will generate
      advertising reports.
      Connections can be established automatically for whitelisted peers.

      This options deprecates the bt_le_set_auto_conn API in favor of the
      bt_conn_create_aute_le API.

(The ‘depends on’ condition includes propagated dependencies from ifs and menus.)