Note
The current ESP-BLE-MESH v1.1 related code is a preview version, so the Mesh Protocol v1.1 related Structures, MACROs, and APIs involved in the code may be changed.
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 :ref:`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 :doc:`../../api-guides/esp-ble-mesh/ble-mesh-architecture`.
Please refer to Sections :ref:`esp-ble-mesh-examples` and :ref:`esp-ble-mesh-demo-videos`.
ESP-BLE-MESH APIs are divided into the following parts:
- ESP-BLE-MESH Definitions
- ESP-BLE-MESH Core API Reference
- ESP-BLE-MESH Models API Reference
- ESP-BLE-MESH (v1.1) Core API Reference
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
.. include-build-file:: inc/esp_ble_mesh_defs.inc
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
.. include-build-file:: inc/esp_ble_mesh_common_api.inc
.. include-build-file:: inc/esp_ble_mesh_local_data_operation_api.inc
.. include-build-file:: inc/esp_ble_mesh_low_power_api.inc
.. include-build-file:: inc/esp_ble_mesh_networking_api.inc
.. include-build-file:: inc/esp_ble_mesh_provisioning_api.inc
.. include-build-file:: inc/esp_ble_mesh_proxy_api.inc
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.
.. include-build-file:: inc/esp_ble_mesh_config_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_health_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_generic_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_sensor_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_time_scene_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_lighting_model_api.inc
Note
This section is a preview version, so the related structures, macros, and APIs may be changed.
This section contains ESP-BLE-MESH v1.1 Core related APIs, event types, event parameters, etc.
This API reference covers 10 components:
- Remote Provisioning
- Directed Forwarding
- Subnet Bridge Configuration
- Mesh Private Beacon
- On-Demand Private Proxy
- SAR Configuration
- Solicitation PDU RPL Configuration
- Opcodes Aggregator
- Large Composition Data
- Composition and Metadata
.. include-build-file:: inc/esp_ble_mesh_rpr_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_df_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_brc_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_prb_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_odp_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_sar_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_srpl_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_agg_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_lcd_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_cm_data_api.inc