feat(ble_mesh): Bluetooth Mesh folder and file misc updates

This commit is contained in:
Liu Linyan
2023-08-25 14:28:44 +08:00
committed by wangjialiang
parent c301deb351
commit bf51fb965b
156 changed files with 437 additions and 437 deletions
@@ -238,13 +238,13 @@ The list of files and the functions implemented in each file in ``Mesh Networkin
* - File
- Functionality
* - :component_file:`access.c <bt/esp_ble_mesh/mesh_core/access.c>`
* - :component_file:`access.c <bt/esp_ble_mesh/core/access.c>`
- ESP-BLE-MESH Access Layer
* - :component_file:`transport.c <bt/esp_ble_mesh/mesh_core/transport.c>`
* - :component_file:`transport.c <bt/esp_ble_mesh/core/transport.c>`
- ESP-BLE-MESH Lower/Upper Transport Layer
* - :component_file:`net.c <bt/esp_ble_mesh/mesh_core/net.c>`
* - :component_file:`net.c <bt/esp_ble_mesh/core/net.c>`
- ESP-BLE-MESH Network Layer
* - :component_file:`adv.c <bt/esp_ble_mesh/mesh_core/adv.c>`
* - :component_file:`adv.c <bt/esp_ble_mesh/core/adv.c>`
- A task used to send ESP-BLE-MESH advertising packets, a callback used to handle received advertising packets and APIs used to allocate adv buffers
2.1.2 Mesh Provisioning Implementation
@@ -260,11 +260,11 @@ Specific files that provide implementation of provisioning of Node are shown in
* - File
- Functionality
* - :component_file:`prov.c <bt/esp_ble_mesh/mesh_core/prov.c>`
* - :component_file:`prov_node.c <bt/esp_ble_mesh/core/prov_node.c>`
- ESP-BLE-MESH Node provisioning (PB-ADV & PB-GATT)
* - :component_file:`proxy_server.c <bt/esp_ble_mesh/mesh_core/proxy_server.c>`
* - :component_file:`proxy_server.c <bt/esp_ble_mesh/core/proxy_server.c>`
- ESP-BLE-MESH Proxy Server related functionalities
* - :component_file:`beacon.c <bt/esp_ble_mesh/mesh_core/beacon.c>`
* - :component_file:`beacon.c <bt/esp_ble_mesh/core/beacon.c>`
- APIs used to handle ESP-BLE-MESH Beacons
Specific files that implement functions of Provisioner are shown in Table 2.3:
@@ -275,11 +275,11 @@ Specific files that implement functions of Provisioner are shown in Table 2.3:
* - File
- Functionality
* - :component_file:`provisioner_prov.c <bt/esp_ble_mesh/mesh_core/provisioner_prov.c>`
* - :component_file:`prov_pvnr.c <bt/esp_ble_mesh/core/prov_pvnr.c>`
- ESP-BLE-MESH Provisioner provisioning (PB-ADV & PB-GATT)
* - :component_file:`proxy_client.c <bt/esp_ble_mesh/mesh_core/proxy_client.c>`
* - :component_file:`proxy_client.c <bt/esp_ble_mesh/core/proxy_client.c>`
- ESP-BLE-MESH Proxy Client related functionalities
* - :component_file:`provisioner_main.c <bt/esp_ble_mesh/mesh_core/provisioner_main.c>`
* - :component_file:`pvnr_mgmt.c <bt/esp_ble_mesh/core/pvnr_mgmt.c>`
- ESP-BLE-MESH Provisioner networking related functionalities
2.1.3 Mesh Models Implementation
@@ -293,37 +293,37 @@ Mesh Models are used to implement the specific functions of model in nodes. Serv
* - File
- Functionality
* - :component_file:`cfg_cli.c <bt/esp_ble_mesh/mesh_core/cfg_cli.c>`
* - :component_file:`cfg_cli.c <bt/esp_ble_mesh/core/cfg_cli.c>`
- Send Configuration Client messages and receive corresponding response messages
* - :component_file:`cfg_srv.c <bt/esp_ble_mesh/mesh_core/cfg_srv.c>`
* - :component_file:`cfg_srv.c <bt/esp_ble_mesh/core/cfg_srv.c>`
- Receive Configuration Client messages and send proper response messages
* - :component_file:`health_cli.c <bt/esp_ble_mesh/mesh_core/health_cli.c>`
* - :component_file:`health_cli.c <bt/esp_ble_mesh/core/health_cli.c>`
- Send Health Client messages and receive corresponding response messages
* - :component_file:`health_srv.c <bt/esp_ble_mesh/mesh_core/health_srv.c>`
* - :component_file:`health_srv.c <bt/esp_ble_mesh/core/health_srv.c>`
- Receive Health Client messages and send proper response messages
* - :component_file:`client_common.c <bt/esp_ble_mesh/mesh_models/client/client_common.c>`
* - :component_file:`client_common.c <bt/esp_ble_mesh/models/client/client_common.c>`
- ESP-BLE-MESH model related operations
* - :component_file:`generic_client.c <bt/esp_ble_mesh/mesh_models/client/generic_client.c>`
* - :component_file:`generic_client.c <bt/esp_ble_mesh/models/client/generic_client.c>`
- Send ESP-BLE-MESH Generic Client messages and receive corresponding response messages
* - :component_file:`lighting_client.c <bt/esp_ble_mesh/mesh_models/client/lighting_client.c>`
* - :component_file:`lighting_client.c <bt/esp_ble_mesh/models/client/lighting_client.c>`
- Send ESP-BLE-MESH Lighting Client messages and receive corresponding response messages
* - :component_file:`sensor_client.c <bt/esp_ble_mesh/mesh_models/client/sensor_client.c>`
* - :component_file:`sensor_client.c <bt/esp_ble_mesh/models/client/sensor_client.c>`
- Send ESP-BLE-MESH Sensor Client messages and receive corresponding response messages
* - :component_file:`time_scene_client.c <bt/esp_ble_mesh/mesh_models/client/time_scene_client.c>`
* - :component_file:`time_scene_client.c <bt/esp_ble_mesh/models/client/time_scene_client.c>`
- Send ESP-BLE-MESH Time Scene Client messages and receive corresponding response messages
* - :component_file:`generic_server.c <bt/esp_ble_mesh/mesh_models/server/generic_server.c>`
* - :component_file:`generic_server.c <bt/esp_ble_mesh/models/server/generic_server.c>`
- Receive ESP-BLE-MESH Generic Client messages and send corresponding response messages
* - :component_file:`lighting_server.c <bt/esp_ble_mesh/mesh_models/server/lighting_server.c>`
* - :component_file:`lighting_server.c <bt/esp_ble_mesh/models/server/lighting_server.c>`
- Receive ESP-BLE-MESH Lighting Client messages and send corresponding response messages
* - :component_file:`sensor_server.c <bt/esp_ble_mesh/mesh_models/server/sensor_server.c>`
* - :component_file:`sensor_server.c <bt/esp_ble_mesh/models/server/sensor_server.c>`
- Receive ESP-BLE-MESH Sensor Client messages and send corresponding response messages
* - :component_file:`time_scene_server.c <bt/esp_ble_mesh/mesh_models/server/time_scene_server.c>`
* - :component_file:`time_scene_server.c <bt/esp_ble_mesh/models/server/time_scene_server.c>`
- Receive ESP-BLE-MESH Time Scene Client messages and send corresponding response messages
2.2 Mesh Bearers Implementation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Portability is fully considered in the implementation of Mesh Bearers. When the ESP-BLE-MESH protocol stack is being ported to other platforms, users only need to modify :component_file:`mesh_bearer_adapt.c <bt/esp_ble_mesh/mesh_core/bluedroid_host/mesh_bearer_adapt.c>` (example of :component_file:`NimBLE version <bt/esp_ble_mesh/mesh_core/nimble_host/mesh_bearer_adapt.c>`).
Portability is fully considered in the implementation of Mesh Bearers. When the ESP-BLE-MESH protocol stack is being ported to other platforms, users only need to modify :component_file:`adapter.c <bt/esp_ble_mesh/core/bluedroid_host/adapter.c>` (example of :component_file:`NimBLE version <bt/esp_ble_mesh/core/nimble_host/adapter.c>`).
.. list-table:: Table 2.5 Mesh Bearers File Description
:widths: 40 150
@@ -331,12 +331,12 @@ Portability is fully considered in the implementation of Mesh Bearers. When the
* - File
- Functionality
* - :component_file:`mesh_bearer_adapt.c <bt/esp_ble_mesh/mesh_core/bluedroid_host/mesh_bearer_adapt.c>`
* - :component_file:`adapter.c <bt/esp_ble_mesh/core/bluedroid_host/adapter.c>`
- ESP-BLE-MESH Bearer Layer adapterThis file provides the interfaces used to receive and send ESP-BLE-MESH ADV & GATT related packets.
.. note::
:component_file:`mesh_bearer_adapt.c <bt/esp_ble_mesh/mesh_core/bluedroid_host/mesh_bearer_adapt.c>` is the implementation of ``Advertising Bearer`` and ``GATT Bearer`` in Mesh Networking framework.
:component_file:`adapter.c <bt/esp_ble_mesh/core/bluedroid_host/adapter.c>` is the implementation of ``Advertising Bearer`` and ``GATT Bearer`` in Mesh Networking framework.
2.3 Mesh Applications Implementation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -380,17 +380,17 @@ When adopting the design of independent module, the two main factors should be c
* - File
- Functionality
* - :component_file:`lpn.c <bt/esp_ble_mesh/mesh_core/lpn.c>`
* - :component_file:`lpn.c <bt/esp_ble_mesh/core/lpn.c>`
- ESP-BLE-MESH Low Power functionality
* - :component_file:`friend.c <bt/esp_ble_mesh/mesh_core/friend.c>`
* - :component_file:`friend.c <bt/esp_ble_mesh/core/friend.c>`
- ESP-BLE-MESH Friend functionality
* - :component_file:`net.c <bt/esp_ble_mesh/mesh_core/net.c>`
* - :component_file:`net.c <bt/esp_ble_mesh/core/net.c>`
- ESP-BLE-MESH Relay feature, network creation, IV Update procedure, IV Index recovery procedure, Key Refresh procedure related functionalities
* - :component_file:`proxy_server.c <bt/esp_ble_mesh/mesh_core/proxy_server.c>`
* - :component_file:`proxy_server.c <bt/esp_ble_mesh/core/proxy_server.c>`
- ESP-BLE-MESH Proxy Server related functionalities
* - :component_file:`proxy_client.c <bt/esp_ble_mesh/mesh_core/proxy_client.c>`
* - :component_file:`proxy_client.c <bt/esp_ble_mesh/core/proxy_client.c>`
- ESP-BLE-MESH Proxy Client related functionalities
* - :component_file:`settings.c <bt/esp_ble_mesh/mesh_core/settings.c>`
* - :component_file:`settings.c <bt/esp_ble_mesh/core/settings.c>`
- ESP-BLE-MESH NVS storage functionality
* - :component_file:`main.c <bt/esp_ble_mesh/mesh_core/main.c>`
* - :component_file:`main.c <bt/esp_ble_mesh/core/main.c>`
- ESP-BLE-MESH stack initialize, stack enable, node removal related functionalities