Skip to content

Commit

Permalink
Merge branch 'docs/support_esp32s2_docs' into 'master'
Browse files Browse the repository at this point in the history
docs: Added the document support for esp32-s2

See merge request application/esp-at!1562
  • Loading branch information
xcguang committed May 23, 2024
2 parents 8894747 + c69f6da commit cd96007
Show file tree
Hide file tree
Showing 106 changed files with 1,096 additions and 470 deletions.
2 changes: 1 addition & 1 deletion .gitlab/ci/build_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
parallel:
matrix:
- DOCLANG: ["en", "zh_CN"]
DOCTGT: ["esp32", "esp32c2", "esp32c3", "esp32c6"]
DOCTGT: ["esp32", "esp32c2", "esp32c3", "esp32c6", "esp32s2"]

build_docs_html:
extends:
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/_static/at_version_esp32.png
Binary file not shown.
Binary file removed docs/_static/at_version_esp32c2.png
Binary file not shown.
Binary file removed docs/_static/at_version_esp32c3.png
Binary file not shown.
Binary file removed docs/_static/at_version_esp32c6.png
Binary file not shown.
Binary file removed docs/_static/choose_version.png
Binary file not shown.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file removed docs/_static/esp32-c2-hardware-connection.png
Binary file not shown.
Binary file removed docs/_static/esp32-c3-hardware-connection.png
Binary file not shown.
Binary file removed docs/_static/esp32-c6-hardware-connection.png
Binary file not shown.
Binary file removed docs/_static/esp32-hardware-connection.png
Binary file not shown.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
3 changes: 2 additions & 1 deletion docs/_static/js/at_versions.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ var DOCUMENTATION_VERSIONS = {
},
VERSIONS: [
// latest
{ name: "latest", has_targets: true, supported_targets: [ "esp32", "esp32c2", "esp32c3", "esp32c6"] },
{ name: "latest", has_targets: true, supported_targets: [ "esp32", "esp32c2", "esp32c3", "esp32c6", "esp32s2"] },

// v4.0.0.0
{ name: "release-v4.0.0.0", has_targets: true, supported_targets: [ "esp32", "esp32c2", "esp32c3", "esp32c6" ] },
Expand Down Expand Up @@ -40,6 +40,7 @@ var DOCUMENTATION_VERSIONS = {
{ text: "ESP32-C2 (ESP8684)", value: "esp32c2"},
{ text: "ESP32-C3", value: "esp32c3"},
{ text: "ESP32-C6", value: "esp32c6"},
{ text: "ESP32-S2", value: "esp32s2"},
{ text: "ESP32", value: "esp32"},
{ text: "ESP8266", value: "esp8266"},
]
Expand Down
Binary file removed docs/_static/what-you-need.png
Diff not rendered.
62 changes: 35 additions & 27 deletions docs/conf_common.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,38 +18,46 @@
sys.path.insert(0, os.path.abspath(ESP_DOCS_PATH))
from conf_docs import * # noqa: F403,F401

ESP32_DOCS = ['AT_Command_Examples/Ethernet_AT_Examples.rst',
'AT_Command_Examples/classic_bluetooth_at_examples.rst',
'AT_Command_Set/BT_AT_Commands.rst',
'AT_Command_Set/Ethernet_AT_Commands.rst',
'Compile_and_Develop/How_to_implement_SDIO_AT.rst',
'Compile_and_Develop/how_to_enable_at_classic_bluetooth.rst',
'Compile_and_Develop/How_to_enable_ESP_AT_Ethernet.rst',
'Customized_AT_Commands_and_Firmware/*'
]

ESP32C3_DOCS = ['Compile_and_Develop/How_to_implement_SPI_AT.rst',
'Customized_AT_Commands_and_Firmware/*',
'Customized_AT_Commands_and_Firmware/RainMaker_AT/index_of_abbreviations.rst',
'Customized_AT_Commands_and_Firmware/RainMaker_AT/index.rst',
'Customized_AT_Commands_and_Firmware/RainMaker_AT/RainMaker_AT_Command_Set.rst',
'Customized_AT_Commands_and_Firmware/RainMaker_AT/RainMaker_AT_Examples.rst',
'Customized_AT_Commands_and_Firmware/RainMaker_AT/RainMaker_AT_OTA_Guide.rst'
]

ESP32C2_DOCS = ['Compile_and_Develop/How_to_implement_SPI_AT.rst'
]

ESP32C6_DOCS = ['Compile_and_Develop/How_to_implement_SPI_AT.rst',
'Compile_and_Develop/How_to_implement_SDIO_AT.rst'
]
SPI_DOCS = ['Compile_and_Develop/How_to_implement_SPI_AT.rst']

SDIO_DOCS = ['Compile_and_Develop/How_to_implement_SDIO_AT.rst']

CLASSIC_BT_DOCS = ['AT_Command_Set/BT_AT_Commands.rst',
'Compile_and_Develop/how_to_enable_at_classic_bluetooth.rst',
'AT_Command_Examples/classic_bluetooth_at_examples.rst']

BLE_DOCS = ['AT_Command_Examples/bluetooth_le_at_examples.rst',
'Compile_and_Develop/How_to_customize_BLE_services.rst',
'AT_Command_Set/BLE_AT_Commands.rst']


ETHERNET_DOCS = ['AT_Command_Set/Ethernet_AT_Commands.rst',
'Compile_and_Develop/How_to_enable_ESP_AT_Ethernet.rst',
'AT_Command_Examples/Ethernet_AT_Examples.rst']

RAINMAKER_DOCS = ['Customized_AT_Commands_and_Firmware/RainMaker_AT/index_of_abbreviations.rst',
'Customized_AT_Commands_and_Firmware/RainMaker_AT/index.rst',
'Customized_AT_Commands_and_Firmware/RainMaker_AT/RainMaker_AT_Command_Set.rst',
'Customized_AT_Commands_and_Firmware/RainMaker_AT/RainMaker_AT_Examples.rst',
'Customized_AT_Commands_and_Firmware/RainMaker_AT/RainMaker_AT_OTA_Guide.rst']

ESP32_DOCS = SDIO_DOCS + CLASSIC_BT_DOCS + BLE_DOCS + ETHERNET_DOCS

ESP32C2_DOCS = SPI_DOCS + BLE_DOCS

ESP32C3_DOCS = SPI_DOCS + BLE_DOCS + RAINMAKER_DOCS

ESP32C6_DOCS = SPI_DOCS + SDIO_DOCS + BLE_DOCS

ESP32S2_DOCS = []

# format: {tag needed to include: documents to included}, tags are parsed from sdkconfig and peripheral_caps.h headers
conditional_include_dict = {
'esp32':ESP32_DOCS,
'esp32c2':ESP32C2_DOCS,
'esp32c3':ESP32C3_DOCS,
'esp32c6':ESP32C6_DOCS
'esp32c6':ESP32C6_DOCS,
'esp32s2':ESP32S2_DOCS
}

extensions += ['sphinx_copybutton',
Expand All @@ -67,7 +75,7 @@
html_context['github_user'] = 'espressif'
html_context['github_repo'] = 'esp-at'

idf_targets = ['esp32', 'esp32c2', 'esp32c3', 'esp32c6']
idf_targets = ['esp32', 'esp32c2', 'esp32c3', 'esp32c6', 'esp32s2']
languages = ['en', 'zh_CN']

google_analytics_id = 'G-R6EJ3YJP4G'
Expand Down
9 changes: 8 additions & 1 deletion docs/en/AT_Binary_Lists/esp_at_binaries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ It is recommended to use the lastest version of firmware. Currently, Espressif r
- :ref:`at-py-modify-uart`
- :ref:`at-py-modify-wifi`
- :ref:`at-py-modify-pki`
:esp32 or esp32c3 or esp32c6: - :ref:`at-py-modify-gatts`
:esp32 or esp32c2 or esp32c3 or esp32c6: - :ref:`at-py-modify-gatts`

.. only:: esp32

Expand Down Expand Up @@ -109,3 +109,10 @@ It is recommended to use the lastest version of firmware. Currently, Espressif r
^^^^^^^^^^^^^^^^^^^

- v4.0.0.0 `ESP32-C6-4MB-AT-V4.0.0.0.zip <https://dl.espressif.com/esp-at/firmwares/esp32c6/ESP32-C6-4MB-AT-V4.0.0.0.zip>`__ (Recommended)

.. only:: esp32s2

ESP32-S2-MINI Series
^^^^^^^^^^^^^^^^^^^^

- The first version of ESP-AT firmware (v3.4.0.0) is planned to be released in July 2024.
2 changes: 1 addition & 1 deletion docs/en/AT_Command_Examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ AT Command Examples

AT Response Message Format Control Examples <at_msg_resp_fmt_ctrl_examples>
TCP-IP AT Examples <TCP-IP_AT_Examples>
Bluetooth® Low Engergy AT Examples <bluetooth_le_at_examples>
:esp32 or esp32c2 or esp32c3 or esp32c6: Bluetooth® Low Engergy AT Examples <bluetooth_le_at_examples>
MQTT AT Examples <MQTT_AT_Examples>
MQTT AT Examples for Cloud <mqtt-at-examples-for-cloud>
:esp32: Ethernet AT Examples <Ethernet_AT_Examples>
Expand Down
4 changes: 1 addition & 3 deletions docs/en/AT_Command_Examples/sleep_at_examples.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
Sleep AT Examples
==========================

{IDF_TARGET_HYPHEN_LOWERCASE_NAME: default="undefined", esp32="esp32", esp32c2="esp32-c2", esp32c3="esp32-c3", esp32c6="esp32-c6"}

:link_to_translation:`zh_CN:[中文]`

This document provides an introduction and detailed command examples to illustrate how to utilize AT commands to set sleep modes on {IDF_TARGET_NAME} series of products.
Expand Down Expand Up @@ -40,7 +38,7 @@ In order to avoid some unnecessary interference during the power consumption tes

Refer to the following figure for hardware connection. (Note that the development board below only has the {IDF_TARGET_NAME} module on board, and all other peripheral components have been removed.)

.. figure:: ../../_static/{IDF_TARGET_HYPHEN_LOWERCASE_NAME}-hardware-connection.png
.. figure:: ../../_static/at_command_examples/esp-power-consumption-hardware-connection.png
:align: center
:alt: {IDF_TARGET_NAME} Hardware Connection

Expand Down
89 changes: 52 additions & 37 deletions docs/en/AT_Command_Set/Basic_AT_Commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ Parameter

- **<time>**: The duration when the device stays in Deep-sleep. Unit: millisecond. When the time is up, the device automatically wakes up, calls Deep-sleep wake stub, and then proceeds to load the application.

.. only:: esp32c3 or esp32c2 or esp32
.. only:: esp32c3 or esp32c2 or esp32 or esp32s2

- 0 means restarting right now

Expand Down Expand Up @@ -301,9 +301,11 @@ Notes
:ref:`AT+SAVETRANSLINK <TCPIP-AT>`: Set Whether to Enter Wi-Fi/Bluetooth LE :term:`Passthrough Mode` on Power-up
----------------------------------------------------------------------------------------------------------------

* :ref:`savetrans-tcpssl`
* :ref:`savetrans-udp`
* :ref:`savetrans-ble`
.. list::

* :ref:`savetrans-tcpssl`
* :ref:`savetrans-udp`
:esp32 or esp32c3 or esp32c6 or esp32c2: * :ref:`savetrans-ble`

.. _savetrans-tcpssl:

Expand Down Expand Up @@ -413,56 +415,58 @@ Example
AT+SAVETRANSLINK=1,"192.168.6.110",1002,"UDP",1005
AT+SAVETRANSLINK=1,"240e:3a1:2070:11c0:55ce:4e19:9649:b75",8081,"UDPv6",1005

.. _savetrans-ble:
.. only:: esp32c2 or esp32c3 or esp32c6 or esp32

For BLE Connection
^^^^^^^^^^^^^^^^^^^^
.. _savetrans-ble:

Set Command
""""""""""""""
For BLE Connection
^^^^^^^^^^^^^^^^^^^^

**Command:**
Set Command
""""""""""""""

::
**Command:**

AT+SAVETRANSLINK=<mode>,<role>,<tx_srv>,<tx_char>,<rx_srv>,<rx_char>,<peer_addr>
::

**Response:**
AT+SAVETRANSLINK=<mode>,<role>,<tx_srv>,<tx_char>,<rx_srv>,<rx_char>,<peer_addr>

::
**Response:**

OK
::

Parameters
""""""""""""""
OK

- **<mode>**:
Parameters
""""""""""""""

- 0: {IDF_TARGET_NAME} will NOT enter BLE :term:`Passthrough Mode` on power-up.
- 2: {IDF_TARGET_NAME} will enter BLE :term:`Passthrough Mode` on power-up.
- **<mode>**:

- **<role>**:
- 0: {IDF_TARGET_NAME} will NOT enter BLE :term:`Passthrough Mode` on power-up.
- 2: {IDF_TARGET_NAME} will enter BLE :term:`Passthrough Mode` on power-up.

- 1: client role.
- 2: server role.
- **<role>**:

- **<tx_srv>**: tx service's index. It can be queried with command :ref:`AT+BLEGATTCPRIMSRV <cmd-GCPRIMSRV>`\=<conn_index> if AT works as GATTC role or with command :ref:`AT+BLEGATTSSRV? <cmd-GSSRV>` if AT works as GATTS role.
- **<tx_char>**: tx characteristic's index. It can be queried with command :ref:`AT+BLEGATTCCHAR <cmd-GCCHAR>`\=<conn_index>,<srv_index> if AT works as GATTC role or with command :ref:`AT+BLEGATTSCHAR? <cmd-GSCHAR>` if AT works as GATTS role.
- **<rx_srv>**: rx service's index. It can be queried with command :ref:`AT+BLEGATTCPRIMSRV <cmd-GCPRIMSRV>`\=<conn_index> if AT works as GATTC role or with command :ref:`AT+BLEGATTSSRV? <cmd-GSSRV>` if AT works as GATTS role.
- **<rx_char>**: rx characteristic's index. It can be queried with command :ref:`AT+BLEGATTCCHAR <cmd-GCCHAR>`\=<conn_index>,<srv_index> if AT works as GATTC role or with command :ref:`AT+BLEGATTSCHAR? <cmd-GSCHAR>` if AT works as GATTS role.
- **<peer_addr>**: remote Bluetooth LE address.
- 1: client role.
- 2: server role.

Notes
"""""""
- **<tx_srv>**: tx service's index. It can be queried with command :ref:`AT+BLEGATTCPRIMSRV <cmd-GCPRIMSRV>`\=<conn_index> if AT works as GATTC role or with command :ref:`AT+BLEGATTSSRV? <cmd-GSSRV>` if AT works as GATTS role.
- **<tx_char>**: tx characteristic's index. It can be queried with command :ref:`AT+BLEGATTCCHAR <cmd-GCCHAR>`\=<conn_index>,<srv_index> if AT works as GATTC role or with command :ref:`AT+BLEGATTSCHAR? <cmd-GSCHAR>` if AT works as GATTS role.
- **<rx_srv>**: rx service's index. It can be queried with command :ref:`AT+BLEGATTCPRIMSRV <cmd-GCPRIMSRV>`\=<conn_index> if AT works as GATTC role or with command :ref:`AT+BLEGATTSSRV? <cmd-GSSRV>` if AT works as GATTS role.
- **<rx_char>**: rx characteristic's index. It can be queried with command :ref:`AT+BLEGATTCCHAR <cmd-GCCHAR>`\=<conn_index>,<srv_index> if AT works as GATTC role or with command :ref:`AT+BLEGATTSCHAR? <cmd-GSCHAR>` if AT works as GATTS role.
- **<peer_addr>**: remote Bluetooth LE address.

- This command will save the BLE :term:`Passthrough Mode` configuration in the NVS area. If ``<mode>`` is set to 2, {IDF_TARGET_NAME} will enter the Bluetooth LE :term:`Passthrough Mode` in the next power on. The configuration will take effect after {IDF_TARGET_NAME} reboots.
Notes
"""""""

Example
"""""""""
- This command will save the BLE :term:`Passthrough Mode` configuration in the NVS area. If ``<mode>`` is set to 2, {IDF_TARGET_NAME} will enter the Bluetooth LE :term:`Passthrough Mode` in the next power on. The configuration will take effect after {IDF_TARGET_NAME} reboots.

::
Example
"""""""""

::

AT+SAVETRANSLINK=2,2,1,7,1,5,"26:a2:11:22:33:88"
AT+SAVETRANSLINK=2,2,1,7,1,5,"26:a2:11:22:33:88"

.. _cmd-TRANSINTVL:

Expand Down Expand Up @@ -1553,7 +1557,7 @@ Query the RF TX Power.
+RFPOWER:<wifi_power>,<ble_adv_power>,<ble_scan_power>,<ble_conn_power>
OK

.. only:: esp32c2
.. only:: esp32c2 or esp32s2

::

Expand All @@ -1571,7 +1575,7 @@ Set Command

AT+RFPOWER=<wifi_power>[,<ble_adv_power>,<ble_scan_power>,<ble_conn_power>]

.. only:: esp32c2
.. only:: esp32c2 or esp32s2

::

Expand Down Expand Up @@ -1616,6 +1620,17 @@ Parameters
[81,84] <set value> 80 20
========= ============ ============ ==========

.. only:: esp32s2

- For {IDF_TARGET_NAME} devices, the range is [40,84]:

========= ============ ============ ==========
set value get value actual value actual dBm
========= ============ ============ ==========
[40,78] <set value> <set value> <set value> * 0.25
[79,84] <set value> 78 19.5
========= ============ ============ ==========

.. only:: esp32

- **<ble_adv_power>**: RF TX Power of Bluetooth LE advertising. Range: [0,7].
Expand Down
6 changes: 3 additions & 3 deletions docs/en/AT_Command_Set/Driver_AT_Commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Parameters

- **<channel>**: ADC1 channel.

.. only:: esp32
.. only:: esp32 or esp32s2

- For {IDF_TARGET_NAME} devices, the range is [0,7].

Expand Down Expand Up @@ -104,7 +104,7 @@ Parameters

- **<atten>**: attenuation.

.. only:: esp32
.. only:: esp32 or esp32s2

- 0: 0 dB attenuation, effective measurement range is [100, 950] mV.
- 1: 2.5 dB attenuation, effective measurement range is [100, 1250] mV.
Expand All @@ -130,7 +130,7 @@ Notes
Example
^^^^^^^^

.. only:: esp32
.. only:: esp32 or esp32s2

::

Expand Down
2 changes: 1 addition & 1 deletion docs/en/AT_Command_Set/HTTP_AT_Commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ HTTP AT Commands
Introduction
------------

.. only:: esp32 or esp32c3 or esp32c6
.. only:: esp32 or esp32c3 or esp32c6 or esp32s2

.. important::
The default AT firmware supports all the AT commands mentioned on this page. If you don't need {IDF_TARGET_NAME} to support HTTP commands, you can compile the ESP-AT project by following the steps in :doc:`Compile ESP-AT Project Locally <../Compile_and_Develop/How_to_clone_project_and_compile_it>` documentation. In the project configuration during the fifth step, make the following selections:
Expand Down
2 changes: 1 addition & 1 deletion docs/en/AT_Command_Set/TCP-IP_AT_Commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1390,7 +1390,7 @@ Note
- The asctime style time is defined at `asctime man page <https://linux.die.net/man/3/asctime>`_.
- When {IDF_TARGET_NAME} enters Light-sleep or Deep-sleep mode and then wakes up, the system time may become inaccurate. It is recommended to resend the :ref:`AT+CIPSNTPCFG <cmd-SNTPCFG>` command to obtain the new time from the NTP server.

.. only:: esp32 or esp32c3 or esp32c6
.. only:: esp32 or esp32c3 or esp32c6 or esp32s2

- The time obtained from SNTP is stored in the RTC area, so it will not be lost after a software reset (chip does not lose power).

Expand Down
4 changes: 2 additions & 2 deletions docs/en/AT_Command_Set/Wi-Fi_AT_Commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1096,7 +1096,7 @@ Note

- See `Wi-Fi Protocol Mode <https://docs.espressif.com/projects/esp-idf/en/latest/{IDF_TARGET_PATH_NAME}/api-guides/wifi.html#wi-fi-protocol-mode>`_ for the PHY mode supported by the {IDF_TARGET_NAME} device.

.. only:: esp32 or esp32c3 or esp32c2
.. only:: esp32 or esp32c3 or esp32c2 or esp32s2

- By default, PHY mode of {IDF_TARGET_NAME} is 802.11bgn mode.

Expand Down Expand Up @@ -1162,7 +1162,7 @@ Note

- See `Wi-Fi Protocol Mode <https://docs.espressif.com/projects/esp-idf/en/latest/{IDF_TARGET_PATH_NAME}/api-guides/wifi.html#wi-fi-protocol-mode>`_ for the PHY mode supported by the {IDF_TARGET_NAME} device.

.. only:: esp32 or esp32c3 or esp32c2
.. only:: esp32 or esp32c3 or esp32c2 or esp32s2

- By default, PHY mode of {IDF_TARGET_NAME} is 802.11bgn mode.

Expand Down
4 changes: 2 additions & 2 deletions docs/en/AT_Command_Set/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
AT Command Set
**************

{IDF_TARGET_VER: default="undefined", esp32="5.0", esp32c2="5.0", esp32c3="5.0", esp32c6="5.1"}
{IDF_TARGET_VER: default="undefined", esp32="5.0", esp32c2="5.0", esp32c3="5.0", esp32c6="5.1", esp32s2="5.0"}

:link_to_translation:`zh_CN:[中文]`

Expand All @@ -14,7 +14,7 @@ Here is a list of AT commands.
Basic AT Commands <Basic_AT_Commands>
Wi-Fi AT Commands <Wi-Fi_AT_Commands>
TCP-IP AT Commands <TCP-IP_AT_Commands>
Bluetooth® Low Energy AT Commands <BLE_AT_Commands>
:esp32 or esp32c2 or esp32c3 or esp32c6: Bluetooth® Low Energy AT Commands <BLE_AT_Commands>
:esp32: Bluetooth® AT Commands <BT_AT_Commands>
MQTT AT Commands <MQTT_AT_Commands>
HTTP AT Commands <HTTP_AT_Commands>
Expand Down
2 changes: 1 addition & 1 deletion docs/en/AT_Command_Set/user_at_commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Note

- If you use ESP32C2-2MB module config, OTA firmware is ``build/custom_ota_binaries/esp-at.bin.xz.packed``. If you use ESP32C2-4MB module config, OTA firmware is ``build/esp-at.bin``.

.. only:: esp32 or esp32c3 or esp32c6
.. only:: esp32 or esp32c3 or esp32c6 or esp32s2

- OTA firmware is ``build/esp-at.bin``.

Expand Down
Loading

0 comments on commit cd96007

Please sign in to comment.