docs(ble): Modified the table of content in ble/index.rst

This commit is contained in:
Yuhan Wei
2024-07-24 16:22:53 +08:00
committed by Wei Yu Han
parent 95f9bf8e64
commit dc6f1503c2
4 changed files with 16 additions and 38 deletions

View File

@@ -16,19 +16,8 @@ Overview
Profile Profile
********** **********
.. only:: SOC_BLE_MESH_SUPPORTED .. toctree::
:maxdepth: 2
ESP-BLE-MESH :SOC_BLE_MESH_SUPPORTED: ../esp-ble-mesh/ble-mesh-index
^^^^^^^^^^^^^ :SOC_BLUFI_SUPPORTED: blufi
- See the :doc:`ESP-BLE-MESH documentation <../esp-ble-mesh/ble-mesh-index>`.
.. only:: SOC_BLUFI_SUPPORTED
BluFi
^^^^^
.. toctree::
:maxdepth: 1
blufi

View File

@@ -1,10 +1,10 @@
BluFi BluFi
^^^^^ ^^^^^^
:link_to_translation:`en:[English]` :link_to_translation:`en:[English]`
概览 概览
----- --------
BluFi 是一项基于蓝牙通道的 Wi-Fi 网络配置功能,适用于 {IDF_TARGET_NAME}。它通过安全协议将 Wi-Fi 的 SSID、密码等配置信息传输到 {IDF_TARGET_NAME}。基于这些信息,{IDF_TARGET_NAME} 可进而连接到 AP 或建立 SoftAP。 BluFi 是一项基于蓝牙通道的 Wi-Fi 网络配置功能,适用于 {IDF_TARGET_NAME}。它通过安全协议将 Wi-Fi 的 SSID、密码等配置信息传输到 {IDF_TARGET_NAME}。基于这些信息,{IDF_TARGET_NAME} 可进而连接到 AP 或建立 SoftAP。
@@ -13,7 +13,7 @@ BluFi 流程的关键部分包括数据的分片、加密以及校验和验证
用户可按需自定义用于对称加密、非对称加密以及校验的算法。此处,我们采用 DH 算法进行密钥协商128-AES 算法用于数据加密CRC16 算法用于校验和验证。 用户可按需自定义用于对称加密、非对称加密以及校验的算法。此处,我们采用 DH 算法进行密钥协商128-AES 算法用于数据加密CRC16 算法用于校验和验证。
BluFi 流程 BluFi 流程
---------- -----------
BluFi 配网流程包含配置 SoftAP 和配置 Station 两部分。 BluFi 配网流程包含配置 SoftAP 和配置 Station 两部分。
@@ -46,7 +46,7 @@ BluFi 配网流程包含配置 SoftAP 和配置 Station 两部分。
2. 进行对称加密和解密时,加密和解密前后的数据长度必须一致。支持原地加密和解密。 2. 进行对称加密和解密时,加密和解密前后的数据长度必须一致。支持原地加密和解密。
BluFi 流程图 BluFi 流程图
--------------- ------------
.. seqdiag:: .. seqdiag::
:caption: BluFi Flow Chart :caption: BluFi Flow Chart
@@ -75,7 +75,7 @@ BluFi 流程图
.. _frame_formats: .. _frame_formats:
BluFi 中定义的帧格式 BluFi 中定义的帧格式
---------------------------- ---------------------
手机应用程序与 {IDF_TARGET_NAME} 之间的 BluFi 通信格式定义如下: 手机应用程序与 {IDF_TARGET_NAME} 之间的 BluFi 通信格式定义如下:
@@ -431,7 +431,7 @@ ACK 帧格式 (8 bit)
此字段占两个字节,用来校验序列、数据长度以及明文。 此字段占两个字节,用来校验序列、数据长度以及明文。
{IDF_TARGET_NAME} 端的安全实现 {IDF_TARGET_NAME} 端的安全实现
---------------------------------- -----------------------------
1. 数据安全 1. 数据安全

View File

@@ -2,7 +2,7 @@
低功耗蓝牙® 低功耗蓝牙®
################ ################
:link_to_translation:`zh_CN:[中文]` :link_to_translation:`en:[English]`
***** *****
概览 概览
@@ -16,19 +16,8 @@
蓝牙规范 蓝牙规范
********** **********
.. only:: SOC_BLE_MESH_SUPPORTED .. toctree::
:maxdepth: 2
ESP-BLE-MESH :SOC_BLE_MESH_SUPPORTED: ../esp-ble-mesh/ble-mesh-index
^^^^^^^^^^^^^ :SOC_BLUFI_SUPPORTED: blufi
- See the :doc:`ESP-BLE-MESH documentation <../esp-ble-mesh/ble-mesh-index>`.
.. only:: SOC_BLUFI_SUPPORTED
BluFi
^^^^^
.. toctree::
:maxdepth: 1
blufi

View File

@@ -238,7 +238,7 @@ Step 5. 运行网络
常见问题手册 常见问题手册
=========== =============
* :ref:`ble-mesh-faq-provisioner-development` * :ref:`ble-mesh-faq-provisioner-development`
* :ref:`ble-mesh-faq-node-development` * :ref:`ble-mesh-faq-node-development`