Merge branch 'docs/detail_at_version_control' into 'master'

docs(ESPAT-1976): Updated a series of AT docs

Closes ESPAT-1976 and ESPAT-1994

See merge request application/esp-at!1566

README.md

@@ -1,115 +1,65 @@
 # ESP-AT
-[![Documentation Version](./docs/_static/at_doc_latest.svg)](https://docs.espressif.com/projects/esp-at/en/latest/)
+[![alt text][doc-latest]](https://docs.espressif.com/projects/esp-at/en/latest/)
 
-- [中文版](#esp-at-项目)
+[doc-latest]: https://img.shields.io/badge/docs-latest-blue
 
-esp-at project was started and powered by Espressif Systems (@[espressif](https://github.com/espressif/)) as an official project, for the **ESP32-C2**, **ESP32-C3**, **ESP32-C6**, **ESP32**, and **ESP8266** Series SoCs provided for Windows, Linux, and macOS.  
+- [中文版](./README_CN.md)
+
+esp-at project was started and powered by Espressif Systems (@[espressif](https://github.com/espressif/)) as an official project, for the **ESP32-C2**, **ESP32-C3**, **ESP32-C6**, **ESP32**, and **ESP32-S2** Series SoCs provided for Windows, Linux, and macOS.  
 It is now supported and maintained by Espressif esp-at team (@[esp-at](https://github.com/espressif/esp-at)).
 
 # Introduction
-Espressif Wi-Fi and Bluetooth® chipsets are often used as add-on modules to seamlessly integrate wireless connectivity features into new and existing products.  
-In an effort to facilitate this and cut down on engineering costs, Espressif Systems has developed a set of AT commands that can be used to interface with Espressif products.
-
-"AT" means 'attention'. Each command string is prefixed with "AT", and a number of discrete commands can be concatenated after the "AT".
+Espressif SoC chipsets are often used as add-on modules to seamlessly integrate wireless connectivity features into new and existing products. In an effort to facilitate this and cut down on engineering costs, Espressif Systems has developed a set of [AT commands](https://docs.espressif.com/projects/esp-at/en/latest/esp32/AT_Command_Set/index.html) (Please select your target chip from the dropdown menu in the top left corner of the page) that can be used to interface with Espressif products.
 
-The AT command firmware allows for rapid integration by providing:
+The AT solution provided by Espressif allows for rapid integration by providing:
 
-- In-built TCP/IP stack and data buffering
+- In-built a large number of AT commands
 - Easy integration with resource-constrained host platforms
 - Easy-to-parse command-response protocols
 - Customized, user-defined AT commands
 
-# Resources
-- There are several guides for esp-at developers and users. These guides can be rendered in a number of formats, like HTML and PDF.  
-  Documentation for the latest version: [https://docs.espressif.com/projects/esp-at/en/latest/index.html](https://docs.espressif.com/projects/esp-at/en/latest/index.html). This documentation is built from the [docs directory](https://github.com/espressif/esp-at/tree/master/docs) of this repository.
-
-- The Changelogs of historic released versions: https://github.com/espressif/esp-at/releases
-
-- [Check the Issues section on GitHub](https://github.com/espressif/esp-at/issues) if you find a bug or have a feature request. Please check existing Issues before opening a new one.
-
-- The [esp-at forum](https://www.esp32.com/viewforum.php?f=42) is a place to ask questions and find community resources.
-
-- The [ESP Product Selector](https://products.espressif.com/#/product-selector?language=en&names=) is a tool to help you compare different chips or modules.
-
-# ESP-AT Support Policy for ESP Chip Series
-
-- ESP32-C2 Series
-  - **Preferred recommended chip for using ESP-AT on**
-  - Recommended released version: [v3.3.0.0](https://github.com/espressif/esp-at/releases/tag/v3.3.0.0)
+# ESP-AT Release and SoC Compatibility
+The following table shows ESP-AT support status of Espressif SoCs.
 
-- ESP32-C3 Series
-  - **Preferred recommended chip for using ESP-AT on**
-  - Recommended released version: [v3.3.0.0](https://github.com/espressif/esp-at/releases/tag/v3.3.0.0)
+| Chip | v3.2.0.0 | v3.3.0.0 | v3.4.0.0 | v4.0.0.0 | master |
+|:- |:-:| :-:| :-:| :-:| :-:|
+| ESP32 | [![alt text][released]](https://github.com/espressif/esp-at/releases/tag/v3.2.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v3.3.0.0) | [![alt text][released]](https://github.com/espressif/esp-at/releases/tag/v3.4.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v4.0.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/master) |
+|ESP32-C3 | [![alt text][released]](https://github.com/espressif/esp-at/releases/tag/v3.2.0.0) | [![alt text][released]](https://github.com/espressif/esp-at/releases/tag/v3.3.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v3.4.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v4.0.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/master) |
+|ESP32-C2 | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v3.2.0.0) | [![alt text][released]](https://github.com/espressif/esp-at/releases/tag/v3.3.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v3.4.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v4.0.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/master) |
+|ESP32-C6 | | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v3.3.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v3.4.0.0) | [![alt text][released]](https://github.com/espressif/esp-at/releases/tag/v4.0.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/master) |
+|ESP32-S2 | | |  [![alt text][released]](https://github.com/espressif/esp-at/releases/tag/v3.4.0.0) | | [![alt text][supported]](https://github.com/espressif/esp-at/tree/master) |
 
-- ESP32-C6 Series
-  - **Preferred recommended chip for using ESP-AT on**
-  - Recommended released version: [v4.0.0.0](https://github.com/espressif/esp-at/releases/tag/v4.0.0.0)
+- ![alt text][released]: Released versions, you can click ![alt text][released] to go to the corresponding release page and download the AT firmware.
+- ![alt text][supported]: Rupported versions, you can click ![alt text][supported] to go to the corresponding branch and develop your own AT firmware.
+- ![alt text][pre-release]: Pre-release versions, expected to release AT firmware for the corresponding chip soon.
 
-- ESP32 Series
-  - Recommended released version: [v3.2.0.0](https://github.com/espressif/esp-at/releases/tag/v3.2.0.0)
+Please choose one of the following options based on your needs:
+- **The default AT firmware meets your requirements**: It is recommended to use the latest released version of the firmware corresponding to the chip.
+- **The default AT firmware does not meet your requirements and stability is a priority**: It is recommended to develop your AT firmware based on the latest released version of the firmware corresponding to the chip.
+- **The default AT firmware does not meet your requirements and you want more new features**: It is recommended to develop your AT firmware based on the [master branch](https://github.com/espressif/esp-at/tree/master).
 
-- ESP8266 Series
-  - **ESP32-C2 is recommended to use instead**
-  - ESP-AT will not release the major version for ESP8266.
-  - ESP-AT no longer adds new features to ESP8266.
-  - [v2.2.1.0_esp8266](https://github.com/espressif/esp-at/releases/tag/v2.2.1.0_esp8266) is the last version of ESP-AT for ESP8266, corresponding to branch [release/v2.2.0.0_esp8266](https://github.com/espressif/esp-at/tree/release/v2.2.0.0_esp8266), corresponding to documentation [https://docs.espressif.com/projects/esp-at/en/release-v2.2.0.0_esp8266](https://docs.espressif.com/projects/esp-at/en/release-v2.2.0.0_esp8266/).
-  - ESP-AT will regularly update [release/v2.2.0.0_esp8266](https://github.com/espressif/esp-at/tree/release/v2.2.0.0_esp8266) branch for ESP8266. Update includes vital bugfix and security repair.
+[released]: https://img.shields.io/badge/-released-4CBB17
+[supported]: https://img.shields.io/badge/-supported-1F51FF
+[pre-release]: https://img.shields.io/badge/-pre--release-FFC000
 
-- Other Series
-  - ESP-AT will support ESP32-C5 series of chips.
-  - ESP-AT will not support ESP32-S and ESP32-H series of chips.
+**Other series of chips:**
+- ESP-AT will support ESP32-C5 series of chips.
+- ESP-AT will not support ESP32-S3 and ESP32-H series of chips.
 
-# ESP-AT 项目
-esp-at 作为由 Espressif Systems (@[espressif](https://github.com/espressif/)) 发起和提供技术支持的官方项目，适用于 Windows、Linux、macOS 上的 **ESP32-C2**、**ESP32-C3**、**ESP32-C6**、**ESP32**、和 **ESP8266** 系列芯片。  
-当前该项目由 Espressif esp-at 团队 (@[esp-at](https://github.com/espressif/esp-at)) 负责技术支持和维护。  
+# Support Periods of ESP-AT
 
-# 简介
-乐鑫 Wi-Fi 和蓝牙芯片可以用作附加模块，完美集成在其他现有产品上，提供无线通讯功能。
-为降低客户开发成本，乐鑫开发了一套 AT 指令集，方便客户简单快速地使用 AT 指令来控制芯片。
+![support periods](docs/_static/at-support-periods.png)
 
-乐鑫提供的 AT 指令固件具有以下特色，利于芯片集成到应用中：
+- Please refer to [ESP-AT Versions](https://docs.espressif.com/projects/esp-at/en/latest/esp32/versions.html) for more details。
 
-- 内置 TCP/IP 堆栈和数据缓冲
-- 能便捷地集成到资源受限的主机平台中
-- 主机对指令的回应易于解析
-- 用户可自定义 AT 指令
-
-# 资源
-- 这里为开发者和用户提供了一些指南，这些指南可以以多种格式呈现，比如 HTML 和 PDF。  
-  最新文档见：[https://docs.espressif.com/projects/esp-at/zh_CN/latest/index.html](https://docs.espressif.com/projects/esp-at/zh_CN/latest/index.html)。该文档是由本仓库 [docs 目录](https://github.com/espressif/esp-at/tree/master/docs) 自动编译构建的。
-
-- 已发布版本的修改记录见：https://github.com/espressif/esp-at/releases
-
-- 如果你有 bug 上报或者功能需求，可以在 [GitHub Issues](https://github.com/espressif/esp-at/issues) 里提交。请在提交前检索下是否有相同的 Issue。
-
-- [esp-at 社区](https://www.esp32.com/viewforum.php?f=34) 可以用来询问问题或寻找一些社区资源。
-
-- [产品选型工具](https://products.espressif.com/#/product-selector?language=zh&names=) 可以帮助你对比不同的芯片或模组。
-
-# ESP-AT 对不同芯片系列支持策略
-
-- ESP32-C2 系列
-  - **ESP-AT 首选推荐芯片**
-  - 推荐使用的发布版本：[v3.3.0.0](https://github.com/espressif/esp-at/releases/tag/v3.3.0.0)
-
-- ESP32-C3 系列
-  - **ESP-AT 首选推荐芯片**
-  - 推荐使用的发布版本：[v3.3.0.0](https://github.com/espressif/esp-at/releases/tag/v3.3.0.0)
+# Resources
+- There are several guides for esp-at developers and users. These guides can be rendered in a number of formats, like HTML and PDF.  
+  Documentation for the latest version: [https://docs.espressif.com/projects/esp-at/en/latest/index.html](https://docs.espressif.com/projects/esp-at/en/latest/index.html). This documentation is built from the [docs directory](https://github.com/espressif/esp-at/tree/master/docs) of this repository.
 
-- ESP32-C6 系列
-  - **ESP-AT 首选推荐芯片**
-  - 推荐使用的发布版本：[v4.0.0.0](https://github.com/espressif/esp-at/releases/tag/v4.0.0.0)
+- The Changelogs of historic released versions: https://github.com/espressif/esp-at/releases
 
-- ESP32 系列
-  - 推荐使用的发布版本：[v3.2.0.0](https://github.com/espressif/esp-at/releases/tag/v3.2.0.0)
+- [Check the Issues section on GitHub](https://github.com/espressif/esp-at/issues) if you find a bug or have a feature request. Please check existing Issues before opening a new one.
 
-- ESP8266 系列
-  - **推荐使用 ESP32-C2 芯片**
-  - ESP-AT 不再为 ESP8266 添加新功能
-  - ESP-AT 不再为 ESP8266 发布大版本
-  - [v2.2.1.0_esp8266](https://github.com/espressif/esp-at/releases/tag/v2.2.1.0_esp8266) 是 ESP-AT 为 ESP8266 发布的最后一个版本，对应分支为 [release/v2.2.0.0_esp8266](https://github.com/espressif/esp-at/tree/release/v2.2.0.0_esp8266)，对应文档为 [https://docs.espressif.com/projects/esp-at/zh_CN/release-v2.2.0.0_esp8266](https://docs.espressif.com/projects/esp-at/zh_CN/release-v2.2.0.0_esp8266/)
-  - ESP-AT 将定期在 [release/v2.2.0.0_esp8266](https://github.com/espressif/esp-at/tree/release/v2.2.0.0_esp8266) 分支为 ESP8266 进行重要 bug 修复，安全修补等更新
+- The [esp-at forum](https://www.esp32.com/viewforum.php?f=42) is a place to ask questions and find community resources.
 
-- 其它系列
-  - ESP-AT 将计划支持 ESP32-C5 系列芯片
-  - ESP-AT 无计划支持 ESP32-S、ESP32-H 系列芯片
+- The [ESP Product Selector](https://products.espressif.com/#/product-selector?language=en&names=) is a tool to help you compare different chips or modules.

README_CN.md

@@ -0,0 +1,65 @@
+# ESP-AT
+[![alt text][doc-latest]](https://docs.espressif.com/projects/esp-at/en/latest/)
+
+[doc-latest]: https://img.shields.io/badge/docs-latest-blue
+
+- [English Version](./README.md)
+
+esp-at 作为由 Espressif Systems (@[espressif](https://github.com/espressif/)) 发起和提供技术支持的官方项目，适用于 Windows、Linux、macOS 上的 **ESP32-C2**、**ESP32-C3**、**ESP32-C6**、**ESP32**、和 **ESP32-S2** 系列芯片。  
+当前该项目由 Espressif esp-at 团队 (@[esp-at](https://github.com/espressif/esp-at)) 负责技术支持和维护。  
+
+# 简介
+乐鑫 SoC 芯片可以用作附加模块，完美集成在其他现有产品上，提供丰富的无线功能。为降低客户开发成本，乐鑫开发了一套 [AT 命令集](https://docs.espressif.com/projects/esp-at/zh_CN/latest/esp32/AT_Command_Set/index.html)（请在页面左上方的下拉菜单中选择您的目标芯片），方便客户简单快速地使用 AT 命令来控制芯片。
+
+乐鑫提供的 AT 方案具有以下特色，利于芯片集成到应用中：
+
+- 内置丰富的 AT 命令集
+- 能便捷地集成到资源受限的主机平台中
+- 主机对命令的回应易于解析
+- 用户可自定义 AT 命令
+
+# ESP-AT 与乐鑫芯片
+下表总结了乐鑫芯片在 ESP-AT 主要版本中的支持状态。
+
+| 芯片 | v3.2.0.0 | v3.3.0.0 | v3.4.0.0 | v4.0.0.0 | master |
+|:- |:-:| :-:| :-:| :-:| :-:|
+| ESP32 | [![alt text][released]](https://github.com/espressif/esp-at/releases/tag/v3.2.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v3.3.0.0) | [![alt text][released]](https://github.com/espressif/esp-at/releases/tag/v3.4.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v4.0.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/master) |
+|ESP32-C3 | [![alt text][released]](https://github.com/espressif/esp-at/releases/tag/v3.2.0.0) | [![alt text][released]](https://github.com/espressif/esp-at/releases/tag/v3.3.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v3.4.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v4.0.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/master) |
+|ESP32-C2 | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v3.2.0.0) | [![alt text][released]](https://github.com/espressif/esp-at/releases/tag/v3.3.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v3.4.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v4.0.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/master) |
+|ESP32-C6 | | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v3.3.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/release/v3.4.0.0) | [![alt text][released]](https://github.com/espressif/esp-at/releases/tag/v4.0.0.0) | [![alt text][supported]](https://github.com/espressif/esp-at/tree/master) |
+|ESP32-S2 | | |  [![alt text][released]](https://github.com/espressif/esp-at/releases/tag/v3.4.0.0) | | [![alt text][supported]](https://github.com/espressif/esp-at/tree/master) |
+
+- ![alt text][released]：已发布的版本，您可以点击 ![alt text][released] 前往对应的发布页下载 AT 固件。
+- ![alt text][supported]：已支持的版本，您可以点击 ![alt text][supported] 前往对应的分支开发您自己的 AT 固件。
+- ![alt text][pre-release]：在测试的版本，预计近期发布对应芯片的 AT 固件。
+
+请根据您的需求，从以下选项中任选其一：
+- **默认 AT 固件已满足您的需求**：推荐选用该芯片最新已发布的版本对应的 AT 固件。
+- **默认 AT 固件不满足您的需求且希望稳定性优先**：推荐基于该芯片最新已发布的版本对应的分支开发您的 AT 固件。
+- **默认 AT 固件不满足您的需求且希望更多新功能**：推荐基于 [master 分支](https://github.com/espressif/esp-at/tree/master) 开发您的 AT 固件。
+
+[released]: https://img.shields.io/badge/-已发布-4CBB17
+[supported]: https://img.shields.io/badge/-已支持-1F51FF
+[pre-release]: https://img.shields.io/badge/-待发布-FFC000
+
+**其它系列芯片：**
+- ESP-AT 将计划支持 ESP32-C5 芯片。
+- ESP-AT 无计划支持 ESP32-S3、ESP32-H 系列芯片。
+
+# ESP-AT 版本支持期限
+
+![support periods](docs/_static/at-support-periods.png)
+
+- 请参考 [ESP-AT 版本简介](https://docs.espressif.com/projects/esp-at/zh_CN/latest/esp32/versions.html) 了解更多关于 ESP-AT 版本的信息。
+
+# 资源
+- 这里为开发者和用户提供了一些指南，这些指南可以以多种格式呈现，比如 HTML 和 PDF。  
+  最新文档见：[https://docs.espressif.com/projects/esp-at/zh_CN/latest/index.html](https://docs.espressif.com/projects/esp-at/zh_CN/latest/index.html)。该文档是由本仓库 [docs 目录](https://github.com/espressif/esp-at/tree/master/docs) 自动编译构建的。
+
+- 已发布版本的修改记录见：https://github.com/espressif/esp-at/releases
+
+- 如果你有 bug 上报或者功能需求，可以在 [GitHub Issues](https://github.com/espressif/esp-at/issues) 里提交。请在提交前检索下是否有相同的 Issue。
+
+- [esp-at 社区](https://www.esp32.com/viewforum.php?f=34) 可以用来询问问题或寻找一些社区资源。
+
+- [产品选型工具](https://products.espressif.com/#/product-selector?language=zh&names=) 可以帮助你对比不同的芯片或模组。

docs/_static/js/at_versions.js

@@ -9,6 +9,9 @@ var DOCUMENTATION_VERSIONS = {
         // v4.0.0.0
         { name: "release-v4.0.0.0", has_targets: true, supported_targets: [ "esp32", "esp32c2", "esp32c3", "esp32c6" ] },
 
+        // v3.4.0.0
+        { name: "release-v3.4.0.0", has_targets: true, supported_targets: [ "esp32", "esp32c2", "esp32c3", "esp32c6", "esp32s2" ] },
+
         // v3.3.0.0
         { name: "release-v3.3.0.0", has_targets: true, supported_targets: [ "esp32", "esp32c2", "esp32c3", "esp32c6" ] },