With various features of ESP-BLE-MESH, users can create a managed flooding mesh network for several scenarios, such as lighting, sensor and etc.
For an ESP32 to join and work on a ESP-BLE-MESH network, it must be provisioned firstly. By provisioning, the ESP32, as an unprovisioned device, will join the ESP-BLE-MESH network and become a ESP-BLE-MESH node, communicating with other nodes within or beyond the radio range.
Apart from ESP-BLE-MESH nodes, inside ESP-BLE-MESH network, there is also ESP32 that works as ESP-BLE-MESH Provisioner, which could provision unprovisioned devices into ESP-BLE-MESH nodes and configure the nodes with various features.
For information how to start using ESP32 and ESP-BLE-MESH, please see the Section getting-started-with-ble-mesh. If you are interested in information on ESP-BLE-MESH architecture, including some details of software implementation, please see Section ../../api-guides/esp-ble-mesh/ble-mesh-architecture.
Please refer to Sections esp-ble-mesh-examples and esp-ble-mesh-demo-videos.
ESP-BLE-MESH APIs are divided into the following parts:
This section contains only one header file, which lists the following items of ESP-BLE-MESH.
- ID of all the models and related message opcodes
- Structs of model, element and Composition Data
- Structs of used by ESP-BLE-MESH Node/Provisioner for provisioning
- Structs used to transmit/receive messages
- Event types and related event parameters
This section contains ESP-BLE-MESH Core related APIs, which can be used to initialize ESP-BLE-MESH stack, provision, send/publish messages, etc.
This API reference covers six components:
- ESP-BLE-MESH Stack Initialization
- Reading of Local Data Information
- Low Power Operation (Updating)
- Send/Publish Messages, add Local AppKey, etc.
- ESP-BLE-MESH Node/Provisioner Provisioning
- ESP-BLE-MESH GATT Proxy Server
This section contains ESP-BLE-MESH Model related APIs, event types, event parameters, etc.
There are six categories of models:
- Configuration Client/Server Models
- Health Client/Server Models
- Generic Client/Server Models
- Sensor Client/Server Models
- Time and Scenes Client/Server Models
- Lighting Client/Server Models
Note
Definitions related to Server Models are being updated, and will be released soon.