OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/samples/bluetooth/mesh/README.rst

62 lines
1.9 KiB
ReStructuredText
Raw Normal View History

samples: bluetooth: mesh: Add basic documentation Add documentation for the mesh and mesh_demo sample applications. Fixes #6279 Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2018-03-05 19:38:48 +08:00
.. _ble_mesh:
Bluetooth: Mesh
###############
Overview
********
Bluetooth: Mesh: Align capitalization for BT mesh Align the capitalization of the term "Bluetooth Mesh" to Bluetooth mesh" in the documentation. This is done to to match the new updated naming convention done in Bluetooth SIG. In the upcoming spec versions, it its used "Bluetooth mesh" with the lower case convention. Signed-off-by: Ingar Kulbrandstad <ingar.kulbrandstad@nordicsemi.no>
2021-06-08 15:32:13 +08:00
This sample demonstrates Bluetooth mesh functionality. It has several
standard mesh models, and supports provisioning over both the
samples: bluetooth: mesh: Add basic documentation Add documentation for the mesh and mesh_demo sample applications. Fixes #6279 Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2018-03-05 19:38:48 +08:00
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.
Bluetooth: Mesh: Add some actual behavior in sample Populates the onoff server stubs in the Bluetooth Mesh sample, and implements generic LED based hardware support to include more boards. Fixes #31031. Signed-off-by: Trond Einar Snekvik <Trond.Einar.Snekvik@nordicsemi.no>
2021-03-11 22:10:42 +08:00
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.
samples: bluetooth: mesh: Add basic documentation Add documentation for the mesh and mesh_demo sample applications. Fixes #6279 Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2018-03-05 19:38:48 +08:00
Requirements
************
* A board with Bluetooth LE support, or
* QEMU with BlueZ running on the host
Building and Running
********************
doc: use :zephyr_file: where appropriate A new role :zephyr_file: is available that renders to a link to the file or folder in GitHub. Find appropriate references using :file: and convert to :zephyr_file: to take advantage of its linking capability. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-09 06:21:37 +08:00
This sample can be found under :zephyr_file:`samples/bluetooth/mesh` in the
samples: bluetooth: mesh: Add basic documentation Add documentation for the mesh and mesh_demo sample applications. Fixes #6279 Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2018-03-05 19:38:48 +08:00
Zephyr tree.
doc: Bluetooth: Documentation overhaul Overhaul the Bluetooth documentation to split it into manageable units and include additional information, such as architecture and tooling. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2019-03-07 22:59:20 +08:00
See :ref:`bluetooth samples section <bluetooth-samples>` for details on how
samples: bluetooth: mesh: Add basic documentation Add documentation for the mesh and mesh_demo sample applications. Fixes #6279 Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2018-03-05 19:38:48 +08:00
to run the sample inside QEMU.
For other boards, build and flash the application as follows:
.. zephyr-app-commands::
:zephyr-app: samples/bluetooth/mesh
:board: <board>
:goals: flash
:compact:
Refer to your :ref:`board's documentation <boards>` for alternative
flash instructions if your board doesn't support the ``flash`` target.
Bluetooth: Mesh: Add some actual behavior in sample Populates the onoff server stubs in the Bluetooth Mesh sample, and implements generic LED based hardware support to include more boards. Fixes #31031. Signed-off-by: Trond Einar Snekvik <Trond.Einar.Snekvik@nordicsemi.no>
2021-03-11 22:10:42 +08:00
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.
samples: mesh: clean up Drop device_get_binding() for microbit, using a gpio_dt_spec instead. Rename the 'button' global to 'button_work' since it's a k_work related to the button and does not actually represent the button itself. Fix a typo in the docs. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-03-18 05:56:25 +08:00
When self-provisioning, the device will take a random unicast address and
Bluetooth: Mesh: Add some actual behavior in sample Populates the onoff server stubs in the Bluetooth Mesh sample, and implements generic LED based hardware support to include more boards. Fixes #31031. Signed-off-by: Trond Einar Snekvik <Trond.Einar.Snekvik@nordicsemi.no>
2021-03-11 22:10:42 +08:00
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.