1.. _bluetooth_mesh_models_priv_beacon_cli:
2
3Private Beacon Client
4#####################
5
6The Private Beacon Client model is a foundation model defined by the Bluetooth
7mesh specification. It is enabled with the
8:kconfig:option:`CONFIG_BT_MESH_PRIV_BEACON_CLI` option.
9
10The Private Beacon Client model is introduced in the Bluetooth Mesh Protocol
11Specification version 1.1, and provides functionality for configuring the
12:ref:`bluetooth_mesh_models_priv_beacon_srv` models.
13
14The Private Beacons feature adds privacy to the different Bluetooth Mesh
15beacons by periodically randomizing the beacon input data. This protects the
16mesh node from being tracked by devices outside the mesh network, and hides the
17network's IV index, IV update and the Key Refresh state.
18
19The Private Beacon Client model communicates with a
20:ref:`bluetooth_mesh_models_priv_beacon_srv` model using the device key of the
21target node. The Private Beacon Client model may communicate with servers on
22other nodes or self-configure through the local Private Beacon Server model.
23
24All configuration functions in the Private Beacon Client API have ``net_idx``
25and ``addr`` as their first parameters. These should be set to the network
26index and the primary unicast address the target node was provisioned with.
27
28If present, the Private Beacon Client model must only be instantiated on the primary element.
29
30API reference
31*************
32
33.. doxygengroup:: bt_mesh_priv_beacon_cli
34