OVMS3-idf/examples/bluetooth/esp_ble_mesh/README.md

# ESP-BLE-MESH Examples

[ESP-BLE-MESH]($IDF_PATH/components/bt/esp_ble_mesh/) is the official Bluetooth® Mesh stack of Espressif Systems. We will provide long-term support for new features, performance optimization, etc.

Please help note that breaking changes may be introduced into ESP-BLE-MESH on [minor IDF versions](https://docs.espressif.com/projects/esp-idf/en/latest/versions.html).

Note: To use examples in this directory, you need to have Bluetooth enabled in configuration, and either Bluedroid or NimBLE can be selected as the host stack.

# Example Layout

This directory includes examples to demonstrate ESP-BLE-MESH functionality based on [Zephyr Bluetooth Mesh stack](https://github.com/zephyrproject-rtos/zephyr/tree/master/subsys/bluetooth/mesh).

## ble_mesh_console

This example demonstrates how ESP-BLE-MESH uses Console for message transmitting/receiving tests.

#### ble_mesh_node

This example shows how ESP32 acts as a BLE Mesh Node and sends vendor messages for testing.

See [ble_mesh_node](ble_mesh_console/ble_mesh_node) folder for more details.

#### ble_mesh_provisioner

This example shows how ESP32 acts as a BLE Mesh Provisioner and sends vendor messages for testing.

See [ble_mesh_provisioner](ble_mesh_console/ble_mesh_provisioner) folder for more details.

## ble_mesh_fast_provision

This example illustrates the solution of ESP-BLE-MESH Fast Provisioning.

#### ble_mesh_fast_prov_client

This example shows how ESP32, acting as a BLE Mesh Fast Provisioning Client, provisions other unprovisioned devices and then controls the nodes.

See [ble_mesh_fast_prov_client](ble_mesh_fast_provision/ble_mesh_fast_prov_client) folder for more details.

#### ble_mesh_fast_prov_server

This example illustrates the process that:
1. ESP32 as a BLE Mesh Fast Provisioning Server is provisioned into a node;
2. ESP32 as a Temporary Provisioner provisions other unprovisioned devices.

See [ble_mesh_fast_prov_server](ble_mesh_fast_provision/ble_mesh_fast_prov_server) folder for more details.

## ble_mesh_node

This example demonstrates how ESP32 acts as a BLE Mesh node with Generic OnOff Server model or Generic OnOff Client model on board.

#### onoff_client

This example shows how ESP32 acts as a BLE Mesh Node with Generic OnOff Client model in the Primary Element.

See [onoff_client](ble_mesh_node/onoff_client) folder for more details.

#### onoff_server

This example shows how ESP32 acts as a BLE Mesh Node with only Generic OnOff Server model in the Primary Element.

See [onoff_server](ble_mesh_node/onoff_server) folder for more details.

## ble_mesh_provisioner

This example shows how ESP32 acts as a BLE Mesh Provisioner and provisions other unprovisioned devices.

See [ble_mesh_provisioner](ble_mesh_provisioner) folder for more details.

## ble_mesh_wifi_coexist

This example shows how ESP32 acts as a BLE Mesh Fast Provisioning Server and coexists with Wi-Fi iperf functionality.

See [ble_mesh_wifi_coexist](ble_mesh_wifi_coexist) folder for more details.

# More

See the [README.md](../../README.md) file in the upper level [examples](../../) directory for more information about examples.
doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`# ESP-BLE-MESH Examples`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`[ESP-BLE-MESH]($IDF_PATH/components/bt/esp_ble_mesh/) is the official Bluetooth® Mesh stack of Espressif Systems. We will provide long-term support for new features, performance optimization, etc.`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`Please help note that breaking changes may be introduced into ESP-BLE-MESH on [minor IDF versions](https://docs.espressif.com/projects/esp-idf/en/latest/versions.html).`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`Note: To use examples in this directory, you need to have Bluetooth enabled in configuration, and either Bluedroid or NimBLE can be selected as the host stack.`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
			`# Example Layout`

doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`This directory includes examples to demonstrate ESP-BLE-MESH functionality based on [Zephyr Bluetooth Mesh stack](https://github.com/zephyrproject-rtos/zephyr/tree/master/subsys/bluetooth/mesh).`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
			`## ble_mesh_console`

doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`This example demonstrates how ESP-BLE-MESH uses Console for message transmitting/receiving tests.`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`#### ble_mesh_node`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
			`This example shows how ESP32 acts as a BLE Mesh Node and sends vendor messages for testing.`

doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`See [ble_mesh_node](ble_mesh_console/ble_mesh_node) folder for more details.`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`#### ble_mesh_provisioner`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
			`This example shows how ESP32 acts as a BLE Mesh Provisioner and sends vendor messages for testing.`

doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`See [ble_mesh_provisioner](ble_mesh_console/ble_mesh_provisioner) folder for more details.`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
			`## ble_mesh_fast_provision`

doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`This example illustrates the solution of ESP-BLE-MESH Fast Provisioning.`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`#### ble_mesh_fast_prov_client`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`This example shows how ESP32, acting as a BLE Mesh Fast Provisioning Client, provisions other unprovisioned devices and then controls the nodes.`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`See [ble_mesh_fast_prov_client](ble_mesh_fast_provision/ble_mesh_fast_prov_client) folder for more details.`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`#### ble_mesh_fast_prov_server`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
			`This example illustrates the process that:`
doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`1. ESP32 as a BLE Mesh Fast Provisioning Server is provisioned into a node;`
			`2. ESP32 as a Temporary Provisioner provisions other unprovisioned devices.`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`See [ble_mesh_fast_prov_server](ble_mesh_fast_provision/ble_mesh_fast_prov_server) folder for more details.`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
			`## ble_mesh_node`

doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`This example demonstrates how ESP32 acts as a BLE Mesh node with Generic OnOff Server model or Generic OnOff Client model on board.`

			`#### onoff_client`

			`This example shows how ESP32 acts as a BLE Mesh Node with Generic OnOff Client model in the Primary Element.`

			`See [onoff_client](ble_mesh_node/onoff_client) folder for more details.`

			`#### onoff_server`

			`This example shows how ESP32 acts as a BLE Mesh Node with only Generic OnOff Server model in the Primary Element.`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`See [onoff_server](ble_mesh_node/onoff_server) folder for more details.`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
			`## ble_mesh_provisioner`

			`This example shows how ESP32 acts as a BLE Mesh Provisioner and provisions other unprovisioned devices.`

doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`See [ble_mesh_provisioner](ble_mesh_provisioner) folder for more details.`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
			`## ble_mesh_wifi_coexist`

			`This example shows how ESP32 acts as a BLE Mesh Fast Provisioning Server and coexists with Wi-Fi iperf functionality.`

doc: update ble mesh docs based on the feature and example update 2019-11-27 01:53:20 +00:00			`See [ble_mesh_wifi_coexist](ble_mesh_wifi_coexist) folder for more details.`
ble_mesh: add ble mesh example description 2019-08-07 08:33:42 +00:00
			`# More`

			`See the [README.md](../../README.md) file in the upper level [examples](../../) directory for more information about examples.`