This is the documentation for the latest (master) 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

Overview

This sample demonstrates Bluetooth Mesh functionality. It has several standard Mesh models, and supports provisioning over both the Advertising and the GATT Provisioning Bearers (i.e. PB-ADV and PB-GATT). The application also needs a functioning serial console, since that’s used for the Out-of-Band provisioning procedure.

On boards with LEDs, a Generic OnOff Server model exposes functionality for controlling the first LED on the board over the mesh.

On boards with buttons, a Generic OnOff Client model will send Onoff messages to all nodes in the network when the button is pressed.

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 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
west flash

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

Interacting with the sample

The sample can either be provisioned into an existing mesh network with an external provisioner device, or self-provision through a button press.

When provisioning with a provisioner device, the provisioner must give the device an Application key and bind it to both Generic OnOff models.

When self-provisioning, the device will take a random unicast address and bind a dummy Application key to these models.

Once provisioned, messages to the Generic OnOff Server will be used to turn the LED on or off, and button presses will be used to broadcast OnOff messages to all nodes in the same network.