From 28160ef5d68782c827884ceeac4fe46c3a0b9de5 Mon Sep 17 00:00:00 2001 From: Yuhan Wei Date: Wed, 24 Jul 2024 16:41:52 +0800 Subject: [PATCH] docs(ble): Adjusted the title level in en/api-guides/ble/blufi.rst --- docs/en/api-guides/ble/blufi.rst | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/docs/en/api-guides/ble/blufi.rst b/docs/en/api-guides/ble/blufi.rst index 460799826f..ce60c53f46 100644 --- a/docs/en/api-guides/ble/blufi.rst +++ b/docs/en/api-guides/ble/blufi.rst @@ -1,7 +1,10 @@ -Introduction -============== +BluFi +^^^^^^ -:link_to_translation:`zh_CN:[中文]` +:link_to_translation:`en:[English]` + +Overview +---------- The BluFi for {IDF_TARGET_NAME} is a Wi-Fi network configuration function via Bluetooth channel. It provides a secure protocol to pass Wi-Fi configuration and credentials to {IDF_TARGET_NAME}. Using this information, {IDF_TARGET_NAME} can then connect to an AP or establish a SoftAP. @@ -10,7 +13,7 @@ Fragmenting, data encryption, and checksum verification in the BluFi layer are t You can customize symmetric encryption, asymmetric encryption, and checksum support customization. Here we use the DH algorithm for key negotiation, 128-AES algorithm for data encryption, and CRC16 algorithm for checksum verification. The BluFi Flow -=============== +---------------- The BluFi networking flow includes the configuration of the SoftAP and Station. @@ -43,7 +46,7 @@ The following uses Station as an example to illustrate the core parts of the pro 2. The data lengths before and after symmetric encryption/decryption must stay the same. It also supports in-place encryption and decryption. The Flow Chart of BluFi -======================== +------------------------- .. seqdiag:: :caption: BluFi Flow Chart @@ -72,7 +75,7 @@ The Flow Chart of BluFi .. _frame_formats: The Frame Formats Defined in BluFi -=================================== +------------------------------------ The frame formats for the communication between the mobile phone App and {IDF_TARGET_NAME} are defined as follows: @@ -428,7 +431,7 @@ The format of ACK Frame: The **CheckSum** field takes two bytes, which is used to check "sequence + data length + clear text data". The Security Implementation of {IDF_TARGET_NAME} -================================================= +-------------------------------------------------- 1. Securing Data @@ -479,7 +482,7 @@ The data to be encrypted and decrypted must be in the same length. The IV8 is an This function is used to compute CheckSum and return a value of CheckSum. BluFi uses the returned value to compare the CheckSum of the frame. GATT Related Instructions -========================== +---------------------------- UUID >>>>>