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.

Bluetooth: Mesh Provisioner

Overview

This sample demonstrates how to use the Bluetooth mesh APIs related to provisioning and using the Configuration Database (CDB). It is intended to be tested together with a device capable of being provisioned. For example, one could use the sample in samples/bluetooth/mesh or tests/bluetooth/mesh_shell.

The application provisions itself and loads the CDB with an application key, then waits to receive an Unprovisioned Beacon from a device. If the board has a push button connected via GPIO and configured using the sw0 devicetree alias, the application then waits for the user to press the button, which will trigger provisioning using PB-ADV. If the board doesn’t have the push button, the sample will provision detected devices automatically. Once provisioning is done, the node will be present in the CDB but not yet marked as configured. The application will notice the unconfigured node and start configuring it. If no errors are encountered, the node is marked as configured.

The configuration of a node involves adding an application key, getting the composition data, and binding all its models to the application key.

Requirements

  • A board with Bluetooth LE support, or

  • QEMU with BlueZ running on the host

Building and Running

This sample can be found under samples/bluetooth/mesh_provisioner in the Zephyr tree.

See bluetooth samples section for details on how to run the sample inside QEMU.

For other boards, build and flash the application as follows:

west build -b <board> samples/bluetooth/mesh_provisioner
west flash

Refer to your board’s documentation for alternative flash instructions if your board doesn’t support the flash target.