Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

doc: Fix some ble mesh description

Browse source
This commit is contained in:
lly 2020-04-03 15:13:55 +08:00 committed by bot
parent 017f07cda7
commit 2f6a4140fa
8 changed files with 30 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
components/bt/esp_ble_mesh/api/esp_ble_mesh_defs.h
View file

@ -944,12 +944,12 @@ typedef union {
* @brief ESP_BLE_MESH_PROVISIONER_RECV_UNPROV_ADV_PKT_EVT * @brief ESP_BLE_MESH_PROVISIONER_RECV_UNPROV_ADV_PKT_EVT
*/ */
struct ble_mesh_provisioner_recv_unprov_adv_pkt_param { struct ble_mesh_provisioner_recv_unprov_adv_pkt_param {
uint8_t dev_uuid[16]; /*!< Device UUID of the unprovisoned device */ uint8_t dev_uuid[16]; /*!< Device UUID of the unprovisioned device */
esp_ble_mesh_bd_addr_t addr; /*!< Device address of the unprovisoned device */ esp_ble_mesh_bd_addr_t addr; /*!< Device address of the unprovisioned device */
esp_ble_mesh_addr_type_t addr_type; /*!< Device address type */ esp_ble_mesh_addr_type_t addr_type; /*!< Device address type */
uint16_t oob_info; /*!< OOB Info of the unprovisoned device */ uint16_t oob_info; /*!< OOB Info of the unprovisioned device */
uint8_t adv_type; /*!< Avertising type of the unprovisoned device */ uint8_t adv_type; /*!< Avertising type of the unprovisioned device */
esp_ble_mesh_prov_bearer_t bearer; /*!< Bearer of the unprovisoned device */ esp_ble_mesh_prov_bearer_t bearer; /*!< Bearer of the unprovisioned device */
int8_t rssi; /*!< RSSI of the received advertising packet */ int8_t rssi; /*!< RSSI of the received advertising packet */
} provisioner_recv_unprov_adv_pkt; /*!< Event parameter of ESP_BLE_MESH_PROVISIONER_RECV_UNPROV_ADV_PKT_EVT */ } provisioner_recv_unprov_adv_pkt; /*!< Event parameter of ESP_BLE_MESH_PROVISIONER_RECV_UNPROV_ADV_PKT_EVT */
/** /**
@ -1197,7 +1197,7 @@ typedef union {
* @brief ESP_BLE_MESH_FRIEND_FRIENDSHIP_ESTABLISH_EVT * @brief ESP_BLE_MESH_FRIEND_FRIENDSHIP_ESTABLISH_EVT
*/ */
struct ble_mesh_friend_friendship_establish_param { struct ble_mesh_friend_friendship_establish_param {
uint16_t lpn_addr; /*!< Low Power Node unciast address */ uint16_t lpn_addr; /*!< Low Power Node unicast address */
} frnd_friendship_establish; /*!< Event parameter of ESP_BLE_MESH_FRIEND_FRIENDSHIP_ESTABLISH_EVT */ } frnd_friendship_establish; /*!< Event parameter of ESP_BLE_MESH_FRIEND_FRIENDSHIP_ESTABLISH_EVT */
/** /**
* @brief ESP_BLE_MESH_FRIEND_FRIENDSHIP_TERMINATE_EVT * @brief ESP_BLE_MESH_FRIEND_FRIENDSHIP_TERMINATE_EVT
@ -1418,7 +1418,7 @@ typedef uint32_t esp_ble_mesh_opcode_config_client_set_t;
#define ESP_BLE_MESH_MODEL_OP_RELAY_SET ESP_BLE_MESH_MODEL_OP_2(0x80, 0x27) /*!< Config Relay Set */ #define ESP_BLE_MESH_MODEL_OP_RELAY_SET ESP_BLE_MESH_MODEL_OP_2(0x80, 0x27) /*!< Config Relay Set */
#define ESP_BLE_MESH_MODEL_OP_MODEL_PUB_SET ESP_BLE_MESH_MODEL_OP_1(0x03) /*!< Config Model Publication Set */ #define ESP_BLE_MESH_MODEL_OP_MODEL_PUB_SET ESP_BLE_MESH_MODEL_OP_1(0x03) /*!< Config Model Publication Set */
#define ESP_BLE_MESH_MODEL_OP_MODEL_SUB_ADD ESP_BLE_MESH_MODEL_OP_2(0x80, 0x1B) /*!< Config Model Subscription Add */ #define ESP_BLE_MESH_MODEL_OP_MODEL_SUB_ADD ESP_BLE_MESH_MODEL_OP_2(0x80, 0x1B) /*!< Config Model Subscription Add */
#define ESP_BLE_MESH_MODEL_OP_MODEL_SUB_VIRTUAL_ADDR_ADD ESP_BLE_MESH_MODEL_OP_2(0x80, 0x20) /*!< Config Model Subscription Vritual Address Add */ #define ESP_BLE_MESH_MODEL_OP_MODEL_SUB_VIRTUAL_ADDR_ADD ESP_BLE_MESH_MODEL_OP_2(0x80, 0x20) /*!< Config Model Subscription Virtual Address Add */
#define ESP_BLE_MESH_MODEL_OP_MODEL_SUB_DELETE ESP_BLE_MESH_MODEL_OP_2(0x80, 0x1C) /*!< Config Model Subscription Delete */ #define ESP_BLE_MESH_MODEL_OP_MODEL_SUB_DELETE ESP_BLE_MESH_MODEL_OP_2(0x80, 0x1C) /*!< Config Model Subscription Delete */
#define ESP_BLE_MESH_MODEL_OP_MODEL_SUB_VIRTUAL_ADDR_DELETE ESP_BLE_MESH_MODEL_OP_2(0x80, 0x21) /*!< Config Model Subscription Virtual Address Delete */ #define ESP_BLE_MESH_MODEL_OP_MODEL_SUB_VIRTUAL_ADDR_DELETE ESP_BLE_MESH_MODEL_OP_2(0x80, 0x21) /*!< Config Model Subscription Virtual Address Delete */
#define ESP_BLE_MESH_MODEL_OP_MODEL_SUB_OVERWRITE ESP_BLE_MESH_MODEL_OP_2(0x80, 0x1E) /*!< Config Model Subscription Overwrite */ #define ESP_BLE_MESH_MODEL_OP_MODEL_SUB_OVERWRITE ESP_BLE_MESH_MODEL_OP_2(0x80, 0x1E) /*!< Config Model Subscription Overwrite */
@ -1851,7 +1851,7 @@ typedef struct {
esp_ble_mesh_model_t *model; /*!< Pointer to the client model. Initialized by the stack. */ esp_ble_mesh_model_t *model; /*!< Pointer to the client model. Initialized by the stack. */
int op_pair_size; /*!< Size of the op_pair */ int op_pair_size; /*!< Size of the op_pair */
const esp_ble_mesh_client_op_pair_t *op_pair; /*!< Table containing get/set message opcode and corresponding status message opcode */ const esp_ble_mesh_client_op_pair_t *op_pair; /*!< Table containing get/set message opcode and corresponding status message opcode */
uint32_t publish_status; /*!< Callback used to handle the received unsoliciated message. Initialized by the stack. */ uint32_t publish_status; /*!< Callback used to handle the received unsolicited message. Initialized by the stack. */
void *internal_data; /*!< Pointer to the internal data of client model */ void *internal_data; /*!< Pointer to the internal data of client model */
uint8_t msg_role; /*!< Role of the device (Node/Provisioner) that is going to send messages */ uint8_t msg_role; /*!< Role of the device (Node/Provisioner) that is going to send messages */
} esp_ble_mesh_client_t; } esp_ble_mesh_client_t;
@ -1905,7 +1905,7 @@ typedef struct {
typedef struct { typedef struct {
uint8_t tid; /*!< Transaction number of the last message */ uint8_t tid; /*!< Transaction number of the last message */
uint16_t src; /*!< Source address of the last message */ uint16_t src; /*!< Source address of the last message */
uint16_t dst; /*!< Destination address of the last messgae */ uint16_t dst; /*!< Destination address of the last message */
int64_t timestamp; /*!< Time when the last message is received */ int64_t timestamp; /*!< Time when the last message is received */
} esp_ble_mesh_last_msg_info_t; } esp_ble_mesh_last_msg_info_t;
@ -2018,7 +2018,7 @@ typedef union {
* @brief ESP_BLE_MESH_MODEL_OPERATION_EVT * @brief ESP_BLE_MESH_MODEL_OPERATION_EVT
*/ */
struct ble_mesh_model_operation_evt_param { struct ble_mesh_model_operation_evt_param {
uint32_t opcode; /*!< Opcode of the recieved message */ uint32_t opcode; /*!< Opcode of the received message */
esp_ble_mesh_model_t *model; /*!< Pointer to the model which receives the message */ esp_ble_mesh_model_t *model; /*!< Pointer to the model which receives the message */
esp_ble_mesh_msg_ctx_t *ctx; /*!< Pointer to the context of the received message */ esp_ble_mesh_msg_ctx_t *ctx; /*!< Pointer to the context of the received message */
uint16_t length; /*!< Length of the received message */ uint16_t length; /*!< Length of the received message */
@ -2044,7 +2044,7 @@ typedef union {
* @brief ESP_BLE_MESH_CLIENT_MODEL_RECV_PUBLISH_MSG_EVT * @brief ESP_BLE_MESH_CLIENT_MODEL_RECV_PUBLISH_MSG_EVT
*/ */
struct ble_mesh_mod_recv_publish_msg_param { struct ble_mesh_mod_recv_publish_msg_param {
uint32_t opcode; /*!< Opcode of the unsoliciated received message */ uint32_t opcode; /*!< Opcode of the unsolicited received message */
esp_ble_mesh_model_t *model; /*!< Pointer to the model which receives the message */ esp_ble_mesh_model_t *model; /*!< Pointer to the model which receives the message */
esp_ble_mesh_msg_ctx_t *ctx; /*!< Pointer to the context of the message */ esp_ble_mesh_msg_ctx_t *ctx; /*!< Pointer to the context of the message */
uint16_t length; /*!< Length of the received message */ uint16_t length; /*!< Length of the received message */

2
components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_generic_model_api.h
View file

@ -256,7 +256,7 @@ typedef struct {
/** Parameters of Generic Admin Property Set. */ /** Parameters of Generic Admin Property Set. */
typedef struct { typedef struct {
uint16_t property_id; /*!< Property ID identifying a Generic Admin Property */ uint16_t property_id; /*!< Property ID identifying a Generic Admin Property */
uint8_t user_access; /*!< Enumeration indicating user accessn */ uint8_t user_access; /*!< Enumeration indicating user access */
struct net_buf_simple *property_value; /*!< Raw value for the Admin Property */ struct net_buf_simple *property_value; /*!< Raw value for the Admin Property */
} esp_ble_mesh_gen_admin_property_set_t; } esp_ble_mesh_gen_admin_property_set_t;

4
components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_lighting_model_api.h
View file

@ -1061,7 +1061,7 @@ typedef struct {
* Occupancy state upon receiving a Sensor Status message from an * Occupancy state upon receiving a Sensor Status message from an
* occupancy sensor. * occupancy sensor.
*/ */
uint32_t time_occupancy_delay; /*!< The value of Light LC Time Occupany Delay state */ uint32_t time_occupancy_delay; /*!< The value of Light LC Time Occupancy Delay state */
/** /**
* A timing state that determines the time the controlled lights fade * A timing state that determines the time the controlled lights fade
* to the level determined by the Light LC Lightness On state. * to the level determined by the Light LC Lightness On state.
@ -1341,7 +1341,7 @@ typedef struct {
/** Parameter of Light LC Occupancy Mode state change event */ /** Parameter of Light LC Occupancy Mode state change event */
typedef struct { typedef struct {
uint8_t mode; /*!< The value of Light LC Occupany Mode state */ uint8_t mode; /*!< The value of Light LC Occupancy Mode state */
} esp_ble_mesh_state_change_light_lc_om_set_t; } esp_ble_mesh_state_change_light_lc_om_set_t;
/** Parameter of Light LC Light OnOff state change event */ /** Parameter of Light LC Light OnOff state change event */

2
components/bt/esp_ble_mesh/api/models/include/esp_ble_mesh_sensor_model_api.h
View file

@ -523,7 +523,7 @@ typedef struct {
typedef struct { typedef struct {
bool op_en; /*!< Indicate if optional parameters are included */ bool op_en; /*!< Indicate if optional parameters are included */
uint16_t property_id; /*!< Property identifying a sensor */ uint16_t property_id; /*!< Property identifying a sensor */
struct net_buf_simple *raw_value; /*!< Raw value containg X1 and X2 (optional) */ struct net_buf_simple *raw_value; /*!< Raw value containing X1 and X2 (optional) */
} esp_ble_mesh_server_recv_sensor_series_get_t; } esp_ble_mesh_server_recv_sensor_series_get_t;
/** /**

12
docs/en/api-guides/esp-ble-mesh/ble-mesh-architecture.rst
View file

@ -261,7 +261,7 @@ Specific files that provide implementation of provisioning of Node are shown in
- Functionality - Functionality
* - :component_file:`prov.c <bt/esp_ble_mesh/mesh_core/prov.c>` * - :component_file:`prov.c <bt/esp_ble_mesh/mesh_core/prov.c>`
- ESP-BLE-MESH Node provisioning (PB-ADV & PB-GATT) - ESP-BLE-MESH Node provisioning (PB-ADV & PB-GATT)
* - :component_file:`proxy_client.c <bt/esp_ble_mesh/mesh_core/proxy_client.c>` * - :component_file:`proxy_server.c <bt/esp_ble_mesh/mesh_core/proxy_server.c>`
- ESP-BLE-MESH Proxy Server related functionalities - 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/mesh_core/beacon.c>`
- APIs used to handle ESP-BLE-MESH Beacons - APIs used to handle ESP-BLE-MESH Beacons
@ -276,7 +276,7 @@ Specific files that implement functions of Provisioner are shown in Table 2.3:
- Functionality - Functionality
* - :component_file:`provisioner_prov.c <bt/esp_ble_mesh/mesh_core/provisioner_prov.c>` * - :component_file:`provisioner_prov.c <bt/esp_ble_mesh/mesh_core/provisioner_prov.c>`
- ESP-BLE-MESH Provisioner provisioning (PB-ADV & PB-GATT) - ESP-BLE-MESH Provisioner provisioning (PB-ADV & PB-GATT)
* - :component_file:`proxy_server.c <bt/esp_ble_mesh/mesh_core/proxy_server.c>` * - :component_file:`proxy_client.c <bt/esp_ble_mesh/mesh_core/proxy_client.c>`
- ESP-BLE-MESH Proxy Client related functionalities - ESP-BLE-MESH Proxy Client related functionalities
* - :component_file:`provisioner_main.c <bt/esp_ble_mesh/mesh_core/provisioner_main.c>` * - :component_file:`provisioner_main.c <bt/esp_ble_mesh/mesh_core/provisioner_main.c>`
- ESP-BLE-MESH Provisioner networking related functionalities - ESP-BLE-MESH Provisioner networking related functionalities
@ -385,11 +385,11 @@ When adopting the design of independent module, the two main factors should be c
- ESP-BLE-MESH Friend functionality - 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/mesh_core/net.c>`
- ESP-BLE-MESH Relay feature, network creation, IV Update procedure, IV Index recovery procedure, Key Refresh procedure related functionalities - ESP-BLE-MESH Relay feature, network creation, IV Update procedure, IV Index recovery procedure, Key Refresh procedure related functionalities
* - :component_file:`proxy_client.c <bt/esp_ble_mesh/mesh_core/proxy_client.c>`
- ESP-BLE-MESH Proxy Server 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/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>`
- ESP-BLE-MESH Proxy Client related functionalities - 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/mesh_core/settings.c>`
- ESP-BLE-MESH Node NVS storage functionality - 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/mesh_core/main.c>`
- ESP-BLE-MESH node removal related functionality - ESP-BLE-MESH stack initialize, stack enable, node removal related functionalities

2
docs/en/api-guides/esp-ble-mesh/ble-mesh-faq.rst
View file

@ -548,7 +548,7 @@ Generally, a Provisioner is used to provision unprovisioned devices and form a m
Normally when they are several unprovisioned devices, users can provision them one by one. But when it comes to a large number of unprovisioned devices (e.g. 100), provisioning them one by one will take huge amount of time. With fast provisioning, users can provision 100 unprovisioned devices in about 50 seconds. Normally when they are several unprovisioned devices, users can provision them one by one. But when it comes to a large number of unprovisioned devices (e.g. 100), provisioning them one by one will take huge amount of time. With fast provisioning, users can provision 100 unprovisioned devices in about 50 seconds.
4.2 Why EspBleMesh App would wait for a long time or keep waiting during fast provisioning? 4.2 Why EspBleMesh App would wait for a long time during fast provisioning?
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
After the App provisioned one Proxy node, it will disconnect from the App during fast provisioning, and reconnect with the App when all the nodes are provisioned. After the App provisioned one Proxy node, it will disconnect from the App during fast provisioning, and reconnect with the App when all the nodes are provisioned.

14
docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-architecture.rst
View file

@ -262,8 +262,8 @@ ESP-BLE-MESH 架构采用分层的方式进行设计，数据包的处理所经
- 功能 - 功能
* - :component_file:`prov.c <bt/esp_ble_mesh/mesh_core/prov.c>` * - :component_file:`prov.c <bt/esp_ble_mesh/mesh_core/prov.c>`
- BLE Mesh 节点配网 (PB-ADV & PB-GATT) - BLE Mesh 节点配网 (PB-ADV & PB-GATT)
* - :component_file:`proxy_client.c <bt/esp_ble_mesh/mesh_core/proxy_client.c>` * - :component_file:`proxy_server.c <bt/esp_ble_mesh/mesh_core/proxy_server.c>`
- BLE Mesh 节点代理相关功能 - BLE Mesh 节点代理服务器相关功能
* - :component_file:`beacon.c <bt/esp_ble_mesh/mesh_core/beacon.c>` * - :component_file:`beacon.c <bt/esp_ble_mesh/mesh_core/beacon.c>`
- 用于处理 BLE Mesh Beacon 的 API - 用于处理 BLE Mesh Beacon 的 API
@ -277,7 +277,7 @@ ESP-BLE-MESH 架构采用分层的方式进行设计，数据包的处理所经
- 功能 - 功能
* - :component_file:`provisioner_prov.c <bt/esp_ble_mesh/mesh_core/provisioner_prov.c>` * - :component_file:`provisioner_prov.c <bt/esp_ble_mesh/mesh_core/provisioner_prov.c>`
- BLE Mesh Provisioner 配置入网 (PB-ADV & PB-GATT) - BLE Mesh Provisioner 配置入网 (PB-ADV & PB-GATT)
* - :component_file:`proxy_server.c <bt/esp_ble_mesh/mesh_core/proxy_server.c>` * - :component_file:`proxy_client.c <bt/esp_ble_mesh/mesh_core/proxy_client.c>`
- BLE Mesh 代理客户端相关功能 - BLE Mesh 代理客户端相关功能
* - :component_file:`provisioner_main.c <bt/esp_ble_mesh/mesh_core/provisioner_main.c>` * - :component_file:`provisioner_main.c <bt/esp_ble_mesh/mesh_core/provisioner_main.c>`
- BLE Mesh Provisioner 网络相关功能 - BLE Mesh Provisioner 网络相关功能
@ -378,11 +378,11 @@ Mesh Bearers 在实现时充分考虑了可移植性。当 ESP-BLE-MESH 协议
- BLE Mesh 好友功能 - BLE Mesh 好友功能
* - :component_file:`net.c <bt/esp_ble_mesh/mesh_core/net.c>` * - :component_file:`net.c <bt/esp_ble_mesh/mesh_core/net.c>`
- BLE Mesh 中继功能、网络创建、网络索引更新程序、网络索引恢复程序、秘钥更新程序相关功能 - BLE Mesh 中继功能、网络创建、网络索引更新程序、网络索引恢复程序、秘钥更新程序相关功能
* - :component_file:`proxy_client.c <bt/esp_ble_mesh/mesh_core/proxy_client.c>`
- BLE Mesh 代理服务器相关功能
* - :component_file:`proxy_server.c <bt/esp_ble_mesh/mesh_core/proxy_server.c>` * - :component_file:`proxy_server.c <bt/esp_ble_mesh/mesh_core/proxy_server.c>`
- BLE Mesh 代理服务器相关功能
* - :component_file:`proxy_client.c <bt/esp_ble_mesh/mesh_core/proxy_client.c>`
- BLE Mesh 代理客户端相关功能 - BLE Mesh 代理客户端相关功能
* - :component_file:`settings.c <bt/esp_ble_mesh/mesh_core/settings.c>` * - :component_file:`settings.c <bt/esp_ble_mesh/mesh_core/settings.c>`
- BLE Mesh 节点 NVS 存储器功能 - BLE Mesh NVS 存储器功能
* - :component_file:`main.c <bt/esp_ble_mesh/mesh_core/main.c>` * - :component_file:`main.c <bt/esp_ble_mesh/mesh_core/main.c>`
- BLE Mesh 节点移除相关功能 - BLE Mesh 协议栈初始化，协议栈使能，节点移除相关功能

2
docs/zh_CN/api-guides/esp-ble-mesh/ble-mesh-faq.rst
View file

@ -550,7 +550,7 @@ ESP-BLE-MESH 常见问题手册
通常而言，存在少量未配网设备时，用户可以逐个配置。但是如果有大量未配网设备（比如 100 个）时，逐个配置会耗费大量时间。通过快速配网，用户可以在约 50 秒内配网 100 个未配网设备。 通常而言，存在少量未配网设备时，用户可以逐个配置。但是如果有大量未配网设备（比如 100 个）时，逐个配置会耗费大量时间。通过快速配网，用户可以在约 50 秒内配网 100 个未配网设备。
4.2 为什么会出现 EspBleMesh App 在快速配网期间长时等待或者一直等待的情况？ 4.2 为什么会出现 EspBleMesh App 在快速配网期间长时间等待的情况？
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
快速配网期间，代理节点在配置完一个节点后会断开与 APP 的连接，待所有节点配网完成后再与 APP 重新建立连接。 快速配网期间，代理节点在配置完一个节点后会断开与 APP 的连接，待所有节点配网完成后再与 APP 重新建立连接。