|
|
@@ -4,6 +4,7 @@ BluFi
|
|
|
|
|
|
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 the {IDF_TARGET_NAME}. Using this information {IDF_TARGET_NAME} can then e.g. connect to an AP or establish a SoftAP.
|
|
|
|
|
|
Fragmenting, data encryption, checksum verification in the BluFi layer are the key elements of this process.
|
|
|
@@ -12,6 +13,7 @@ You can customize symmetric encryption, asymmetric encryption and checksum suppo
|
|
|
|
|
|
The BluFi Flow
|
|
|
---------------
|
|
|
+
|
|
|
The BluFi networking flow includes the configuration of the SoftAP and Station.
|
|
|
|
|
|
The following uses Station as an example to illustrate the core parts of the procedure, including broadcast, connection, service discovery, negotiation of the shared key, data transmission, connection status backhaul.
|
|
|
@@ -42,8 +44,8 @@ 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
|
|
|
------------------------
|
|
|
+The Flow Chart of BluFi
|
|
|
+--------------------------
|
|
|
|
|
|
.. seqdiag::
|
|
|
:caption: BluFi Flow Chart
|
|
|
@@ -78,64 +80,72 @@ The frame formats for the communication between the mobile phone App and {IDF_TA
|
|
|
|
|
|
The frame format with no fragment (8 bit)：
|
|
|
|
|
|
-+-----------------+----------------+
|
|
|
-| Description | Value |
|
|
|
-+=================+================+
|
|
|
-| LSB - Type | 1 |
|
|
|
-+-----------------+----------------+
|
|
|
-| Frame Control | 1 |
|
|
|
-+-----------------+----------------+
|
|
|
-| Sequence Number | 1 |
|
|
|
-+-----------------+----------------+
|
|
|
-| Data Length | 1 |
|
|
|
-+-----------------+----------------+
|
|
|
-| Data | ${Data Length} |
|
|
|
-+-----------------+----------------+
|
|
|
-| MSB - CheckSum | 2 |
|
|
|
-+-----------------+----------------+
|
|
|
+.. list-table::
|
|
|
+ :header-rows: 1
|
|
|
+ :widths: 25 25
|
|
|
+
|
|
|
+ * - Description
|
|
|
+ - Value
|
|
|
+ * - Type (Least Significant Bit)
|
|
|
+ - 1
|
|
|
+ * - Frame Control
|
|
|
+ - 1
|
|
|
+ * - Sequence Number
|
|
|
+ - 1
|
|
|
+ * - Data Length
|
|
|
+ - 1
|
|
|
+ * - Data
|
|
|
+ - ${Data Length}
|
|
|
+ * - CheckSum (Most Siginificant Bit)
|
|
|
+ - 2
|
|
|
|
|
|
If the **Frame Ctrl** bit is enabled, the **Total length** bit indicates the length of remaining part of the frame. It can tell the remote how much memory needs to be alloced.
|
|
|
|
|
|
The frame format with fragments（8 bit）：
|
|
|
|
|
|
-+--------------------+-------------------------------------------+
|
|
|
-| Description | Value |
|
|
|
-+====================+===========================================+
|
|
|
-| LSB - Type | 1 |
|
|
|
-+--------------------+-------------------------------------------+
|
|
|
-| FrameControl(Frag) | 1 |
|
|
|
-+--------------------+-------------------------------------------+
|
|
|
-| SequenceNumber | 1 |
|
|
|
-+--------------------+-------------------------------------------+
|
|
|
-| DataLength | 1 |
|
|
|
-+--------------------+----------------------+--------------------+
|
|
|
-| | Total Content Length | 2 |
|
|
|
-+ Data +----------------------+--------------------+
|
|
|
-| | Content | ${Data Length} - 2 |
|
|
|
-+--------------------+----------------------+--------------------+
|
|
|
-| MSB - CheckSum | 2 |
|
|
|
-+--------------------+-------------------------------------------+
|
|
|
-
|
|
|
-Normally, the control frame does not contain data bits, except for Ack Frame.
|
|
|
-
|
|
|
-The format of Ack Frame（8 bit）：
|
|
|
-
|
|
|
-+------------------+--------------------------------------------+
|
|
|
-| Description | Value |
|
|
|
-+------------------+--------------------------------------------+
|
|
|
-| LSB - Type (Ack) | 1 |
|
|
|
-+------------------+--------------------------------------------+
|
|
|
-| Frame Control | 1 |
|
|
|
-+------------------+--------------------------------------------+
|
|
|
-| SequenceNumber | 1 |
|
|
|
-+------------------+--------------------------------------------+
|
|
|
-| DataLength | 1 |
|
|
|
-+------------------+-----------------------+--------------------+
|
|
|
-+ Data + Acked Sequence Number + 2 +
|
|
|
-| | | |
|
|
|
-+------------------+-----------------------+--------------------+
|
|
|
-| MSB - CheckSum | 2 |
|
|
|
-+------------------+--------------------------------------------+
|
|
|
+.. list-table::
|
|
|
+ :header-rows: 1
|
|
|
+ :widths: 25 25
|
|
|
+
|
|
|
+ * - Description
|
|
|
+ - Value
|
|
|
+ * - Type (Least Significant Bit)
|
|
|
+ - 1
|
|
|
+ * - Frame Control (Frag)
|
|
|
+ - 1
|
|
|
+ * - Sequence Number
|
|
|
+ - 1
|
|
|
+ * - Data Length
|
|
|
+ - 1
|
|
|
+ * - Data
|
|
|
+ - * Total Content Length: 2
|
|
|
+ * Content: ${Data Length} - 2
|
|
|
+ * - CheckSum (Most Siginificant Bit)
|
|
|
+ - 2
|
|
|
+
|
|
|
+Normally, the control frame does not contain data bits, except for ACK Frame.
|
|
|
+
|
|
|
+The format of ACK Frame（8 bit）：
|
|
|
+
|
|
|
+.. list-table::
|
|
|
+ :header-rows: 1
|
|
|
+ :widths: 25 25
|
|
|
+
|
|
|
+ * - Description
|
|
|
+ - Value
|
|
|
+ * - Type - ACK (Least Significant Bit)
|
|
|
+ - 1
|
|
|
+ * - Frame Control
|
|
|
+ - 1
|
|
|
+ * - Sequence Number
|
|
|
+ - 1
|
|
|
+ * - Data Length
|
|
|
+ - 1
|
|
|
+ * - Data
|
|
|
+ - Acked Sequence Number: 2
|
|
|
+ * - CheckSum (Most Siginificant Bit)
|
|
|
+ - 2
|
|
|
+
|
|
|
|
|
|
1. Type
|
|
|
|
|
|
@@ -145,235 +155,248 @@ The format of Ack Frame（8 bit）：
|
|
|
|
|
|
* The data frame supports to be encrypted and verified.
|
|
|
|
|
|
- **1.1 Control Frame (0x0 b’00)**
|
|
|
-
|
|
|
- +-------------------------+--------------------------------------------------------------+---------------------------------------------------------------+---------------------------------------------------------------+
|
|
|
- | Control Frame (Binary) | Implication | Explanation | Note |
|
|
|
- +=========================+==============================================================+===============================================================+===============================================================+
|
|
|
- | 0x0 (b’000000) | Ack | The data field of the Ack frame uses the same | The data field consumes a byte and its value is |
|
|
|
- | | | sequence value of the frame to reply to. | the same as the sequence field of the frame to reply to. |
|
|
|
- +-------------------------+--------------------------------------------------------------+---------------------------------------------------------------+---------------------------------------------------------------+
|
|
|
- | 0x1 (b’000001) | Set ESP device to the security mode. | To inform ESP device of the security mode to use | The data field consumes a byte. |
|
|
|
- | | | when sending data, which is allowed to be reset | The higher 4 bits are for the security mode setting |
|
|
|
- | | | multiple times during the process. | of the control frame, and the lower 4 bits are for |
|
|
|
- | | | Each setting affects the subsequent security mode used. | the security mode setting of the data frame. |
|
|
|
- + + + If it is not set, ESP device will send the control frame +---------------------------------------------------------------+
|
|
|
- | | | and data frame with no checksum and encryption by default. | b’0000: no checksum and no encryption; |
|
|
|
- + + + The data transmission from the mobile phone to ESP device is +---------------------------------------------------------------+
|
|
|
- | | | controlled by this control frame. | b’0001: with checksum but no encryption; |
|
|
|
- + + + +---------------------------------------------------------------+
|
|
|
- | | | | b’0010: no checksum but with encryption; |
|
|
|
- + + + +---------------------------------------------------------------+
|
|
|
- | | | | b’0011: with both checksum and encryption. |
|
|
|
- +-------------------------+--------------------------------------------------------------+---------------------------------------------------------------+---------------------------------------------------------------+
|
|
|
- | 0x2 (b’000010) | Set the opmode of Wi-Fi. | The frame contains opmode settings for | data[0] is for opmode settings, including: |
|
|
|
- + + + configuring for the Wi-Fi mode of ESP device. +---------------------------------------------------------------+
|
|
|
- | | | | 0x00: NULL； |
|
|
|
- + + + +---------------------------------------------------------------+
|
|
|
- | | | | 0x01: STA; |
|
|
|
- + + + +---------------------------------------------------------------+
|
|
|
- | | | | 0x02: SoftAP; |
|
|
|
- + + + +---------------------------------------------------------------+
|
|
|
- | | | | 0x03: SoftAP&STA. |
|
|
|
- + + + +---------------------------------------------------------------+
|
|
|
- | | | | Please set the SSID/Password/Max Connection Number of |
|
|
|
- | | | | the AP mode in the first place if an AP gets involved. |
|
|
|
- +-------------------------+--------------------------------------------------------------+---------------------------------------------------------------+---------------------------------------------------------------+
|
|
|
- | 0x3 (b’000011) | Connect ESP device to the AP. | To notify ESP device that the essential information has been | No data field is contained. |
|
|
|
- | | | sent and it is allowed to connect to the AP. | |
|
|
|
- +-------------------------+--------------------------------------------------------------+---------------------------------------------------------------+---------------------------------------------------------------+
|
|
|
- | 0x4 (b’000100) | Disconnect ESP device from the AP. | | No data field is contained. |
|
|
|
- +-------------------------+--------------------------------------------------------------+---------------------------------------------------------------+---------------------------------------------------------------+
|
|
|
- | 0x5 (b’000101) | To get the information of ESP device’s Wi-Fi mode and | | No data field is contained. |
|
|
|
- | | it's status. | | When receiving this control frame, ESP device will send back |
|
|
|
- | | | | a follow-up frame of Wi-Fi connection state report to |
|
|
|
- | | | | the mobile phone with the information of the current opmode, |
|
|
|
- | | | | connection status, SSID and so on. |
|
|
|
- | | | | The types of information sent to the mobile phone is |
|
|
|
- | | | | defined by the application installed on the phone. |
|
|
|
- +-------------------------+--------------------------------------------------------------+---------------------------------------------------------------+---------------------------------------------------------------+
|
|
|
- | 0x6 (b’000110) | Disconnect the STA device from the SoftAP (in SoftAP mode). | | Date[0~5] is taken as the MAC address for the STA device. |
|
|
|
- | | | | If there is a second STA device, then it uses data[6-11] |
|
|
|
- | | | | and the rest can be done in the same manner. |
|
|
|
- +-------------------------+--------------------------------------------------------------+---------------------------------------------------------------+---------------------------------------------------------------+
|
|
|
- | 0x7 (b'000111) | Get the version information. | | |
|
|
|
- +-------------------------+--------------------------------------------------------------+---------------------------------------------------------------+---------------------------------------------------------------+
|
|
|
- | 0x8 (b’001000) | Disconnect the BLE GATT link. | | ESP device will disconnect the BLE GATT link |
|
|
|
- | | | | after receives this command. |
|
|
|
- +-------------------------+--------------------------------------------------------------+---------------------------------------------------------------+---------------------------------------------------------------+
|
|
|
- | 0x9 (b’001001) | Get the Wi-Fi list. | To get ESP device to scan the Wi-Fi access points around. | No data field is contained. |
|
|
|
- | | | | When receiving this control frame, |
|
|
|
- | | | | ESP device will send back a follow-up frame of Wi-Fi lis |
|
|
|
- | | | | report to the mobile phone. |
|
|
|
- +-------------------------+--------------------------------------------------------------+---------------------------------------------------------------+---------------------------------------------------------------+
|
|
|
-
|
|
|
- **1.2 Data Frame (0x1 b’01)**
|
|
|
-
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- |Data Frame(Binary)| Implication | Explanation | Note |
|
|
|
- +==================+====================================================+===============================================================+=======================================================================+
|
|
|
- | 0x0 (b’000000) | Send the negotiation data. | The negotiation data will be sent to the callback | The length of the data depends on the length field. |
|
|
|
- | | | function registered in the application layer. | |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0x1 (b’000001) | Send the BSSID for STA mode. | To send the BSSID of the AP for the STA device to | The length of the data depends on the length field. |
|
|
|
- | | | connect under the condition that the SSID is hidden. | When the transmission direction is ESP device to the mobile phone, |
|
|
|
- | | | | it means to provide the mobile phone with the needed information. |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0x2 (b’000010) | Send the SSID for STA mode. | To send the SSID of the AP for the STA device to connect. | The length of the data depends on the length field. |
|
|
|
- | | | | When the transmission direction is ESP device to the mobile phone, |
|
|
|
- | | | | it means to provide the mobile phone with the needed information. |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0x3 (b’000011) | Send the password for STA mode. | To send the password of the AP for the STA device to connect. | The length of the data depends on the length field. |
|
|
|
- | | | | When the transmission direction is ESP device to the mobile phone, |
|
|
|
- | | | | it means to provide the mobile phone with the needed information. |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0x4 (b’000100) | Send the SSID for SoftAP mode. | | The length of the data depends on the length field. |
|
|
|
- | | | | When the transmission direction is ESP device to the mobile phone, |
|
|
|
- | | | | it means to provide the mobile phone with the needed information. |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0x5 (b’000101) | Send the password for SoftAPmode. | | The length of the data depends on the length field. |
|
|
|
- | | | | When the transmission direction is ESP device to the mobile phone, |
|
|
|
- | | | | it means to provide the mobile phone with the needed information. |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0x6 (b’000110) | Set the maximum connection number for SoftAP mode. | | data[0] represents the value of the connection number, |
|
|
|
- | | | | ranging from 1 to 4. When the transmission direction is ESP device |
|
|
|
- | | | | to the mobile phone, it means to provide the mobile phone with |
|
|
|
- | | | | the needed information. |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0x7 (b’000111) | Set the authentication mode for the SoftAP. | | data[0]： |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | 0x00: OPEN |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | 0x01: WEP |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | 0x02: WPA_PSK |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | 0x03: WPA2_PSK |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | 0x04: WPA_WPA2_PSK |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | When the transmission direction is ESP device to the mobile phone, |
|
|
|
- | | | | it means to provide the mobile phone with the needed information. |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0x8 (b’001000) | Set the channel amount for SoftAP mode. | | data[0] represents the quantity of the supported channels, |
|
|
|
- | | | | ranging from 1 to 14. |
|
|
|
- | | | | When the transmission direction is ESP device to the mobile phone, |
|
|
|
- | | | | it means to provide the mobile phone with the needed information. |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0x9 (b’001001) | Username | It provides the username of the GATT client when using | The length of the data depends on the length field. |
|
|
|
- | | | encryption of enterprise level. | |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0xa (b’001010) | CA Certification | It provides the CA Certification when using encryption | The length of the data depends on the length field. |
|
|
|
- | | | of enterprise level. | The frame supports to be fragmented if the data length is not enough. |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0xb (b’001011) | Client Certification | It provides the client certification when | The length of the data depends on the length field. |
|
|
|
- | | | using encryption of enterprise level. | The frame supports to be fragmented if the data length is not enough. |
|
|
|
- | | | Whether the private key is contained or not | |
|
|
|
- | | | depends on the content of the certification. | |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0xc (b’001100) | Server Certification | It provides the sever certification when using | The length of the data depends on the length field. |
|
|
|
- | | | encryption of enterprise level. Whether the private key is | The frame supports to be fragmented if the data length is not enough. |
|
|
|
- | | | contained or not depends on the content of the certification. | |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0xd (b’001101) | ClientPrivate Key | It provides the private key of the client when | The length of the data depends on the length field. |
|
|
|
- | | | using encryption of enterprise level. | The frame supports to be fragmented if the data length is not enough. |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0xe (b’001110) | ServerPrivate Key | It provides the private key of the sever when | The length of the data depends on the length field. |
|
|
|
- | | | using encryption of enterprise level. | The frame supports to be fragmented if the data length is not enough. |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0xf (b’001111) | Wi-Fi Connection State Report | To notify the phone of the ESP device's Wi-Fi status, | data[0] represents opmode, including: |
|
|
|
- + + + including STA status and SoftAP status. +-----------------------------------------------------------------------+
|
|
|
- | | | It is for the STA device to connect to the | 0x00: NULL |
|
|
|
- + + + mobile phone or the SoftAP. +-----------------------------------------------------------------------+
|
|
|
- | | | However, when the mobile phone receives the Wi-Fi status, | 0x01: STA |
|
|
|
- + + + it can reply to other frames in addition to this frame. +-----------------------------------------------------------------------+
|
|
|
- | | | | 0x02: SoftAP |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | 0x03: SoftAP&STA |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | data[1]：the connection state of the STA device, |
|
|
|
- | | | | 0x0 indicates a connection state, |
|
|
|
- | | | | and others represent a disconnected state; |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | data[2]：the connection state of the SoftAP, |
|
|
|
- | | | | that is, how many STA devices have been connected. |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | data[3] and the subsequent is in accordance with the |
|
|
|
- | | | | format of SSID/BSSID information. |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0x10 (b’010000) | Version | | data[0]= great versiondata[1]= sub version |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0x11 (b’010001) | Wi-Fi List | To send the Wi-Fi list to ESP device. | The format of the data frame is length + RSSI + SSID |
|
|
|
- | | | | and it supports to be sent into fragments |
|
|
|
- | | | | if the data length is too long. |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0x12 (b’010010) | Report Error | To notify the mobile phone that there is an error with BluFi. | 0x00: sequence error |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | 0x01: checksum error |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | 0x02: decrypt error |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | 0x03: encrypt error |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | 0x04: init security error |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | 0x05: dh malloc error |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | 0x06: dh param error |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | 0x07: read param error |
|
|
|
- + + + +-----------------------------------------------------------------------+
|
|
|
- | | | | 0x08: make public error |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
- | 0x13 (b’010011) | Custom Data | To send or receive custom data. | The data frame supports to be sent into |
|
|
|
- | | | | fragments if the data length is too long. |
|
|
|
- +------------------+----------------------------------------------------+---------------------------------------------------------------+-----------------------------------------------------------------------+
|
|
|
+1.1 Control Frame (Binary: 0x0 b’00)
|
|
|
+
|
|
|
+.. list-table::
|
|
|
+ :header-rows: 1
|
|
|
+ :widths: 5 15 20 30
|
|
|
+
|
|
|
+ * - Control Frame
|
|
|
+ - Implication
|
|
|
+ - Explanation
|
|
|
+ - Note
|
|
|
+
|
|
|
+ * - 0x0 (b’000000)
|
|
|
+ - ACK
|
|
|
+ - The data field of the ACK frame uses the same sequence value of the frame to reply to.
|
|
|
+ - The data field consumes a byte and its value is the same as the sequence field of the frame to reply to.
|
|
|
+
|
|
|
+ * - 0x1 (b’000001)
|
|
|
+ - Set ESP device to the security mode.
|
|
|
+ - To inform ESP device of the security mode to use when sending data, which is allowed to be reset multiple times during the process. Each setting affects the subsequent security mode used.
|
|
|
+
|
|
|
+ If it is not set, ESP device will send the control frame and data frame with no checksum and encryption by default. The data transmission from the mobile phone to ESP device is controlled by this control frame.
|
|
|
+ - The data field consumes a byte. The higher 4 bits are for the security mode setting of the control frame, and the lower 4 bits are for the security mode setting of the data frame.
|
|
|
+
|
|
|
+ * b’0000: no checksum and no encryption;
|
|
|
+ * b’0001: with checksum but no encryption;
|
|
|
+ * b’0010: no checksum but with encryption;
|
|
|
+ * b’0011: with both checksum and encryption.
|
|
|
+
|
|
|
+ * - 0x2 (b’000010)
|
|
|
+ - Set the opmode of Wi-Fi.
|
|
|
+ - The frame contains opmode settings for configuring the Wi-Fi mode of ESP device.
|
|
|
+ - data[0] is for opmode settings, including:
|
|
|
+
|
|
|
+ * 0x00: NULL
|
|
|
+ * 0x01: STA
|
|
|
+ * 0x02: SoftAP
|
|
|
+ * 0x03: SoftAP & STA
|
|
|
+
|
|
|
+ Please set the SSID/Password/Max Connection Number of the AP mode in the first place if an AP gets involved.
|
|
|
+
|
|
|
+ * - 0x3 (b’000011)
|
|
|
+ - Connect ESP device to the AP.
|
|
|
+ - To notify ESP device that the essential information has been sent and it is allowed to connect to the AP.
|
|
|
+ - No data field is contained.
|
|
|
+
|
|
|
+ * - 0x4 (b’000100)
|
|
|
+ - Disconnect ESP device from the AP.
|
|
|
+ -
|
|
|
+ - No data field is contained.
|
|
|
+
|
|
|
+ * - 0x5 (b’000101)
|
|
|
+ - To get the information of ESP device’s Wi-Fi mode and it’s status.
|
|
|
+ -
|
|
|
+ - * No data field is contained. When receiving this control frame, ESP device will send back a follow-up frame of Wi-Fi connection state report to the mobile phone with the information of the current opmode, connection status, SSID and so on.
|
|
|
+ * The types of information sent to the mobile phone is defined by the application installed on the phone.
|
|
|
+
|
|
|
+ * - 0x6 (b’000110)
|
|
|
+ - Disconnect the STA device from the SoftAP (in SoftAP mode).
|
|
|
+ -
|
|
|
+ - Date[0~5] is taken as the MAC address for the STA device. If there is a second STA device, then it uses data[6-11] and the rest can be done in the same manner.
|
|
|
+
|
|
|
+ * - 0x7 (b’000111)
|
|
|
+ - Get the version information.
|
|
|
+ -
|
|
|
+ -
|
|
|
+
|
|
|
+ * - 0x8 (b’001000)
|
|
|
+ - Disconnect the BLE GATT link.
|
|
|
+ -
|
|
|
+ - ESP device will disconnect the BLE GATT link after receives this command.
|
|
|
+
|
|
|
+ * - 0x9 (b’001001)
|
|
|
+ - Get the Wi-Fi list.
|
|
|
+ - To get ESP device to scan the Wi-Fi access points around.
|
|
|
+ - No data field is contained. When receiving this control frame, ESP device will send back a follow-up frame of Wi-Fi list report to the mobile phone.
|
|
|
+
|
|
|
+
|
|
|
+
|
|
|
+1.2 Data Frame (Binary: 0x1 b’01)
|
|
|
+
|
|
|
+.. list-table::
|
|
|
+ :header-rows: 1
|
|
|
+ :widths: 5 15 20 30
|
|
|
+
|
|
|
+ * - Data Frame
|
|
|
+ - Implication
|
|
|
+ - Explanation
|
|
|
+ - Note
|
|
|
+ * - 0x0 (b’000000)
|
|
|
+ - Send the negotiation data.
|
|
|
+ - The negotiation data will be sent to the callback function registered in the application layer.
|
|
|
+ - The length of the data depends on the length field.
|
|
|
+ * - 0x1 (b’000001)
|
|
|
+ - Send the BSSID for STA mode.
|
|
|
+ - To send the BSSID of the AP for the STA device to connect under the condition that the SSID is hidden.
|
|
|
+ - Please refer to Note 1 below.
|
|
|
+ * - 0x2 (b’000010)
|
|
|
+ - Send the SSID for STA mode.
|
|
|
+ - To send the SSID of the AP for the STA device to connect.
|
|
|
+ - Please refer to Note 1 below.
|
|
|
+ * - 0x3 (b’000011)
|
|
|
+ - Send the password for STA mode.
|
|
|
+ - To send the password of the AP for the STA device to connect.
|
|
|
+ - Please refer to Note 1 below.
|
|
|
+ * - 0x4 (b’000100)
|
|
|
+ - Send the SSID for SoftAP mode.
|
|
|
+ -
|
|
|
+ - Please refer to Note 1 below.
|
|
|
+ * - 0x5 (b’000101)
|
|
|
+ - Send the password for SoftAPmode.
|
|
|
+ -
|
|
|
+ - Please refer to Note 1 below.
|
|
|
+ * - 0x6 (b’000110)
|
|
|
+ - Set the maximum connection number for SoftAP mode.
|
|
|
+ -
|
|
|
+ - data[0] represents the value of the connection number, ranging from 1 to 4. When the transmission direction is ESP device to the mobile phone, it means to provide the mobile phone with the needed information.
|
|
|
+ * - 0x7 (b’000111)
|
|
|
+ - Set the authentication mode for the SoftAP.
|
|
|
+ -
|
|
|
+ - data[0]：
|
|
|
+
|
|
|
+ * 0x00: OPEN
|
|
|
+ * 0x01: WEP
|
|
|
+ * 0x02: WPA_PSK
|
|
|
+ * 0x03: WPA2_PSK
|
|
|
+ * 0x04: WPA_WPA2_PSK
|
|
|
+
|
|
|
+ When the transmission direction is ESP device to the mobile phone, it means to provide the mobile phone with the needed information.
|
|
|
+ * - 0x8 (b’001000)
|
|
|
+ - Set the number of channels for SoftAP mode.
|
|
|
+ -
|
|
|
+ - data[0] represents the quantity of the supported channels, ranging from 1 to 14. When the transmission direction is ESP device to the mobile phone, it means to provide the mobile phone with the needed information.
|
|
|
+ * - 0x9 (b’001001)
|
|
|
+ - Username
|
|
|
+ - It provides the username of the GATT client when using encryption of enterprise level.
|
|
|
+ - The length of the data depends on the length field.
|
|
|
+ * - 0xa (b’001010)
|
|
|
+ - CA Certification
|
|
|
+ - It provides the CA Certification when using encryption of enterprise level.
|
|
|
+ - Please refer to Note 2 below.
|
|
|
+ * - 0xb (b’001011)
|
|
|
+ - Client Certification
|
|
|
+ - It provides the client certification when using encryption of enterprise level. Whether the private key is contained or not depends on the content of the certification.
|
|
|
+ - Please refer to Note 2 below.
|
|
|
+ * - 0xc (b’001100)
|
|
|
+ - Server Certification
|
|
|
+ - It provides the sever certification when using encryption of enterprise level. Whether the private key is contained or not depends on the content of the certification.
|
|
|
+ - Please refer to Note 2 below.
|
|
|
+ * - 0xd (b’001101)
|
|
|
+ - Client Private Key
|
|
|
+ - It provides the private key of the client when using encryption of enterprise level.
|
|
|
+ - Please refer to Note 2 below.
|
|
|
+ * - 0xe (b’001110)
|
|
|
+ - Server Private Key
|
|
|
+ - It provides the private key of the sever when using encryption of enterprise level.
|
|
|
+ - Please refer to Note 2 below.
|
|
|
+ * - 0xf (b’001111)
|
|
|
+ - Wi-Fi Connection State Report
|
|
|
+ - To notify the phone of the ESP device’s Wi-Fi status, including STA status and SoftAP status. It is for the STA device to connect to the mobile phone or the SoftAP. However, when the mobile phone receives the Wi-Fi status, it can reply to other frames in addition to this frame.
|
|
|
+ - data[0] represents opmode, including:
|
|
|
+
|
|
|
+ * 0x00: NULL
|
|
|
+ * 0x01: STA
|
|
|
+ * 0x02: SoftAP
|
|
|
+ * 0x03: SoftAP & STA
|
|
|
+
|
|
|
+ data[1]：the connection state of the STA device, 0x0 indicates a connection state, and others represent a disconnected state;
|
|
|
+
|
|
|
+ data[2]：the connection state of the SoftAP, that is, how many STA devices have been connected.
|
|
|
+
|
|
|
+ data[3] and the subsequent is in accordance with the format of SSID/BSSID information.
|
|
|
+ * - 0x10 (b’010000)
|
|
|
+ - Version
|
|
|
+ -
|
|
|
+ - * data[0]= great version
|
|
|
+ * data[1]= sub version
|
|
|
+ * - 0x11 (b’010001)
|
|
|
+ - Wi-Fi List
|
|
|
+ - To send the Wi-Fi list to ESP device.
|
|
|
+ - The format of the data frame is length + RSSI + SSID and it supports to be sent into fragments if the data length is too long.
|
|
|
+ * - 0x12 (b’010010)
|
|
|
+ - Report Error
|
|
|
+ - To notify the mobile phone that there is an error with BluFi.
|
|
|
+ - * 0x00: sequence error
|
|
|
+ * 0x01: checksum error
|
|
|
+ * 0x02: decrypt error
|
|
|
+ * 0x03: encrypt error
|
|
|
+ * 0x04: init security error
|
|
|
+ * 0x05: dh malloc error
|
|
|
+ * 0x06: dh param error
|
|
|
+ * 0x07: read param error
|
|
|
+ * 0x08: make public error
|
|
|
+ * - 0x13 (b’010011)
|
|
|
+ - Custom Data
|
|
|
+ - To send or receive custom data.
|
|
|
+ - The data frame supports to be sent into fragments if the data length is too long.
|
|
|
+
|
|
|
+.. note::
|
|
|
+
|
|
|
+ - Note 1: The length of the data depends on the length field. When the transmission direction is ESP device to the mobile phone, it means to provide the mobile phone with the needed information.
|
|
|
+
|
|
|
+ - Note 2: The length of the data depends on the length field. The frame supports to be fragmented if the data length is not enough.
|
|
|
|
|
|
2. Frame Control
|
|
|
|
|
|
Control field, takes 1 byte and each bit has a different meaning.
|
|
|
|
|
|
- +--------------------+------------------------------------------------------------------------------------------------+
|
|
|
- | Bit | Meaning |
|
|
|
- +====================+================================================================================================+
|
|
|
- | 0x01 | Indicates whether the frame is encrypted. |
|
|
|
- + +------------------------------------------------------------------------------------------------+
|
|
|
- | | 1 means encryption, and 0 means unencrypted. |
|
|
|
- + +------------------------------------------------------------------------------------------------+
|
|
|
- | | The encrypted part of the frame includes |
|
|
|
- | | the full clear data before the DATA field is encrypted (no checksum). |
|
|
|
- + +------------------------------------------------------------------------------------------------+
|
|
|
- | | Control frame is not encrypted, so this bit is 0. |
|
|
|
- +--------------------+------------------------------------------------------------------------------------------------+
|
|
|
- | 0x02 | The data field that indicates whether a frame contains |
|
|
|
- | | a checksum (such as SHA1,MD5,CRC, etc.) for the end of |
|
|
|
- | | the frame data field includes SEQUCNE + data length + clear text. |
|
|
|
- | | Both the control frame and the data frame can contain a check bit or not. |
|
|
|
- +--------------------+------------------------------------------------------------------------------------------------+
|
|
|
- | 0x04 | Represents the data direction. |
|
|
|
- +--------------------+------------------------------------------------------------------------------------------------+
|
|
|
- | | 0 means the mobile phone to ESP device; |
|
|
|
- +--------------------+------------------------------------------------------------------------------------------------+
|
|
|
- | | 1 means ESP device to the mobile phone. |
|
|
|
- +--------------------+------------------------------------------------------------------------------------------------+
|
|
|
- | 0x08 | Indicates whether the other person is required to reply to an ACK. |
|
|
|
- +--------------------+------------------------------------------------------------------------------------------------+
|
|
|
- | | 0 indicates no requirement; |
|
|
|
- +--------------------+------------------------------------------------------------------------------------------------+
|
|
|
- | | 1 indicates to reply Ack. |
|
|
|
- +--------------------+------------------------------------------------------------------------------------------------+
|
|
|
- | 0x10 | Indicates whether there are subsequent data fragments. |
|
|
|
- +--------------------+------------------------------------------------------------------------------------------------+
|
|
|
- | | 0 indicates that there are no subsequent data fragments for this frame; |
|
|
|
- +--------------------+------------------------------------------------------------------------------------------------+
|
|
|
- | | 1 indicates that there are subsequent data fragments and used to transmit longer data. |
|
|
|
- +--------------------+------------------------------------------------------------------------------------------------+
|
|
|
- | | In the case of a frag frame, |
|
|
|
- | | the total length of the current content section + subsequent content section is given, |
|
|
|
- | | in the first 2 bytes of the data field (that is, the content data of the maximum support 64K). |
|
|
|
- +--------------------+------------------------------------------------------------------------------------------------+
|
|
|
- | 0x10~0x80 reserved | |
|
|
|
- +--------------------+------------------------------------------------------------------------------------------------+
|
|
|
+
|
|
|
+.. list-table::
|
|
|
+ :header-rows: 1
|
|
|
+ :widths: 10 35
|
|
|
+
|
|
|
+ * - Bit
|
|
|
+ - Meaning
|
|
|
+ * - 0x01
|
|
|
+ - Indicates whether the frame is encrypted.
|
|
|
+
|
|
|
+ * 1 means encryption
|
|
|
+ * 0 means unencrypted
|
|
|
+
|
|
|
+ The encrypted part of the frame includes the full clear data before the DATA field is encrypted (no checksum). Control frame is not encrypted, so this bit is 0.
|
|
|
+ * - 0x02
|
|
|
+ - The data field that indicates whether a frame contains a checksum (such as SHA1,MD5,CRC, etc.) for the end of the frame. Data field includes sequence + data length + clear text. Both the control frame and the data frame can contain a check bit or not.
|
|
|
+ * - 0x04
|
|
|
+ - Represents the data direction.
|
|
|
+
|
|
|
+ * 0 means the mobile phone to ESP device;
|
|
|
+ * 1 means ESP device to the mobile phone.
|
|
|
+ * - 0x08
|
|
|
+ - Indicates whether the other person is required to reply to an ACK.
|
|
|
+
|
|
|
+ * 0 indicates no requirement;
|
|
|
+ * 1 indicates to reply ACK.
|
|
|
+ * - 0x10
|
|
|
+ - Indicates whether there are subsequent data fragments.
|
|
|
+
|
|
|
+ * 0 indicates that there are no subsequent data fragments for this frame;
|
|
|
+ * 1 indicates that there are subsequent data fragments and used to transmit longer data.
|
|
|
+
|
|
|
+ In the case of a frag frame, the total length of the current content section + subsequent content section is given, in the first 2 bytes of the data field (that is, the content data of the maximum support 64 K).
|
|
|
+ * - 0x10~0x80
|
|
|
+ - reserved
|
|
|
|
|
|
3. Sequence Control
|
|
|
|
|
|
@@ -448,7 +471,7 @@ GATT Related Instructions
|
|
|
UUID
|
|
|
>>>>>
|
|
|
|
|
|
-BluFi Service UUID: 0xFFFF，16 bit
|
|
|
+BluFi Service UUID: 0xFFFF, 16 bit
|
|
|
|
|
|
BluFi (the mobile -> {IDF_TARGET_NAME}): 0xFF01, writable
|
|
|
|
Dai Zi Yan