From 3725e372f20066c4da211747c32f209f768260d2 Mon Sep 17 00:00:00 2001 From: Chen Wu Date: Mon, 4 Nov 2024 14:53:45 +0800 Subject: [PATCH] docs: Added a disclaimer for the esp-at project (v3.4.0.0) --- README.md | 2 +- README_CN.md | 2 +- docs/en/AT_Binary_Lists/esp_at_binaries.rst | 5 ++ docs/en/Get_Started/What_is_ESP-AT.rst | 3 + docs/en/disclaimer.rst | 63 +++++++++++++++++++ docs/en/index.rst | 1 + .../zh_CN/AT_Binary_Lists/esp_at_binaries.rst | 5 ++ docs/zh_CN/Get_Started/What_is_ESP-AT.rst | 3 + docs/zh_CN/disclaimer.rst | 63 +++++++++++++++++++ docs/zh_CN/index.rst | 1 + 10 files changed, 146 insertions(+), 2 deletions(-) create mode 100644 docs/en/disclaimer.rst create mode 100644 docs/zh_CN/disclaimer.rst diff --git a/README.md b/README.md index af05edb06..2ccaf93c4 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ - [中文版](./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)). +It is now supported and maintained by Espressif esp-at team (@[esp-at](https://github.com/espressif/esp-at)). **Before using the ESP-AT solution, please read the [disclaimer](https://docs.espressif.com/projects/esp-at/en/latest/esp32/disclaimer.html) carefully and comply with its terms and precautions.** # Introduction 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. diff --git a/README_CN.md b/README_CN.md index c3c1a6010..6266d4556 100644 --- a/README_CN.md +++ b/README_CN.md @@ -6,7 +6,7 @@ - [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)) 负责技术支持和维护。 +当前该项目由 Espressif esp-at 团队 (@[esp-at](https://github.com/espressif/esp-at)) 负责技术支持和维护。**在使用 ESP-AT 方案前，请仔细阅读 [特别声明](https://docs.espressif.com/projects/esp-at/zh_CN/latest/esp32/disclaimer.html)，并遵循其中的各项条款和注意事项。** # 简介 乐鑫 SoC 芯片可以用作附加模块，完美集成在其他现有产品上，提供丰富的无线功能。为降低客户开发成本，乐鑫开发了一套 [AT 命令集](https://docs.espressif.com/projects/esp-at/zh_CN/latest/esp32/AT_Command_Set/index.html)（请在页面左上方的下拉菜单中选择您的目标芯片），方便客户简单快速地使用 AT 命令来控制芯片。 diff --git a/docs/en/AT_Binary_Lists/esp_at_binaries.rst b/docs/en/AT_Binary_Lists/esp_at_binaries.rst index e86be2f48..5db5e6dd4 100644 --- a/docs/en/AT_Binary_Lists/esp_at_binaries.rst +++ b/docs/en/AT_Binary_Lists/esp_at_binaries.rst @@ -20,6 +20,11 @@ It is recommended to use the lastest version of firmware. Currently, Espressif r - :ref:`at-py-modify-pki` :esp32 or esp32c2 or esp32c3 or esp32c6: - :ref:`at-py-modify-gatts` +Disclaimer +^^^^^^^^^^ + +Before using the AT firmware below, please read the :doc:`../disclaimer` carefully and comply with its terms and precautions. + .. only:: esp32 ESP32-WROOM-32 Series diff --git a/docs/en/Get_Started/What_is_ESP-AT.rst b/docs/en/Get_Started/What_is_ESP-AT.rst index 0319aaa9f..3508f17b0 100644 --- a/docs/en/Get_Started/What_is_ESP-AT.rst +++ b/docs/en/Get_Started/What_is_ESP-AT.rst @@ -3,6 +3,9 @@ What is ESP-AT :link_to_translation:`zh_CN:[中文]` +.. important:: + Before using the ESP-AT, please read the :doc:`../disclaimer` carefully and comply with its terms and precautions. + ESP-AT is a solution developed by Espressif to integrate connectivity into customers' products, which can be quickly moved to mass production. It aims to reduce software development costs and quickly form products. With ESP-AT commands, you can quickly join the wireless network, connect to the cloud platform, realize data transmission and remote control functions, and realize the interconnection of everything through wireless communication easily. ESP-AT is a project based on ESP-IDF. It makes an {IDF_TARGET_NAME} board work as a slave, and an MCU as a host. The host MCU sends AT commands to the {IDF_TARGET_NAME} chip and receives AT responses back. ESP-AT provides a wide range of AT commands with different functions, such as Wi-Fi commands, TCP/IP commands, Bluetooth LE commands, Bluetooth commands, MQTT commands, HTTP commands, and Ethernet commands. diff --git a/docs/en/disclaimer.rst b/docs/en/disclaimer.rst new file mode 100644 index 000000000..f20869b07 --- /dev/null +++ b/docs/en/disclaimer.rst @@ -0,0 +1,63 @@ +Disclaimer +========== + +:link_to_translation:`zh_CN:[中文]` + +Thank you for choosing to use [Solution/Firmware ESP-AT]. To ensure the safe, legal, and effective use of this solution (firmware), please carefully read the following Disclaimer. This Disclaimer aims to clarify the terms and precautions that users must follow when using this solution (firmware). By continuing to use this solution (firmware), you indicate your acceptance and agreement to comply with these terms. + +Application Scenario Verification +--------------------------------- + +This solution (firmware) is a general version. Despite extensive testing across various scenarios, there remains a risk that certain use cases may not be covered. Prior to making commercial production decisions based on this solution (firmware), please conduct thorough and comprehensive validation tailored to your specific application scenarios. + +Compatibility +------------- + +Given the rapid advancement of technology, the emergence of new technologies, solutions, or standards may lead to compatibility issues. Users are advised to conduct appropriate testing and validation based on their products and to stay informed about new version releases of this solution (firmware) + +Server Upgrade Considerations +----------------------------- + +When upgrading servers, including but not limited to operating system upgrades, tool upgrades, and certificate upgrades, it is essential to conduct testing and validation prior to any formal upgrades to prevent connectivity issues arising from server changes. + +Wireless Solution Issue Handling +-------------------------------- + +Wireless solutions are susceptible to external factors and can present complex issue diagnostics. Users should plan remote OTA and remote issue information retrieval solutions in conjunction with their products and cloud platforms. Otherwise, users may need to provide on-site logs, data packets, and other necessary information for problem analysis. + +Usage Restrictions +------------------ + +Users must not utilize this solution (firmware) for illegal activities or purposes that violate applicable laws and regulations. Users are responsible for ensuring that their use of this solution (this firmware) complies with all relevant laws and regulations. We accept no responsibility for any consequences arising from illegal use of this solution (firmware). + +Limitation of Liability +----------------------- + +We shall not be liable for any direct, indirect, incidental, special, or consequential damages (including but not limited to data loss, profit loss, business interruption, etc.) resulting from the use of this solution (firmware), even if we have been advised of the possibility of such damages. + +Third-Party Software and Technology +----------------------------------- + +This solution (firmware) may contain third-party software or technology. We assume no responsibility for the applicability and compliance of such third-party software or technology. Users should adhere to the licensing agreements and usage terms of third parties. + +Data Protection +--------------- + +Users are solely responsible for the protection and backup of any data generated during the use of this solution (firmware). We accept no liability for any losses resulting from data loss or leakage. + +Version Updates and Maintenance +------------------------------- + +This solution (firmware) will undergo periodic maintenance updates and version releases. Users are encouraged to monitor version status, and no separate notification will be provided. + +Disclaimer Updates +------------------ + +The terms of this Disclaimer may be updated periodically without prior notice. + +User Responsibility +------------------- + +Users are strongly encouraged to read and strictly adhere to the terms of this Disclaimer. Any risks arising from non-compliance shall be borne by the user. + +Thank you for your understanding and cooperation! diff --git a/docs/en/index.rst b/docs/en/index.rst index 55e524d2b..70f886682 100644 --- a/docs/en/index.rst +++ b/docs/en/index.rst @@ -53,6 +53,7 @@ This is the documentation for `ESP-AT `_ De Customized AT Commands and Firmware FAQ Index of Abbreviations + Disclaimer About * :ref:`genindex` diff --git a/docs/zh_CN/AT_Binary_Lists/esp_at_binaries.rst b/docs/zh_CN/AT_Binary_Lists/esp_at_binaries.rst index 4a209f618..e09a7b265 100644 --- a/docs/zh_CN/AT_Binary_Lists/esp_at_binaries.rst +++ b/docs/zh_CN/AT_Binary_Lists/esp_at_binaries.rst @@ -20,6 +20,11 @@ - :ref:`at-py-modify-pki` :esp32 or esp32c2 or esp32c3 or esp32c6: - :ref:`at-py-modify-gatts` +特别声明 +^^^^^^^^ + +在使用下面的 AT 固件前，请仔细阅读 :doc:`../disclaimer`，并遵循其中的各项条款和注意事项。 + .. only:: esp32 ESP32-WROOM-32 系列 diff --git a/docs/zh_CN/Get_Started/What_is_ESP-AT.rst b/docs/zh_CN/Get_Started/What_is_ESP-AT.rst index 3d7c05f33..90d1861fe 100644 --- a/docs/zh_CN/Get_Started/What_is_ESP-AT.rst +++ b/docs/zh_CN/Get_Started/What_is_ESP-AT.rst @@ -3,6 +3,9 @@ ESP-AT 是什么 :link_to_translation:`en:[English]` +.. important:: + 在使用 ESP-AT 前，请仔细阅读 :doc:`../disclaimer`，并遵循其中的各项条款和注意事项。 + ESP-AT 是乐鑫开发的可直接用于量产的物联网应用固件，旨在降低客户开发成本，快速形成产品。通过 ESP-AT 命令，您可以快速加入无线网络、连接云平台、实现数据通信以及远程控制等功能，真正的通过无线通讯实现万物互联。 ESP-AT 是基于 ESP-IDF 实现的软件工程。它使 {IDF_TARGET_NAME} 模组作为从机，MCU 作为主机。MCU 发送 AT 命令给 {IDF_TARGET_NAME} 模组，控制 {IDF_TARGET_NAME} 模组执行不同的操作，并接收 {IDF_TARGET_NAME} 模组返回的 AT 响应。ESP-AT 提供了大量功能不同的 AT 命令，如 Wi-Fi 命令、TCP/IP 命令、Bluetooth LE 命令、Bluetooth 命令、MQTT 命令、HTTP 命令、Ethernet 命令等。 diff --git a/docs/zh_CN/disclaimer.rst b/docs/zh_CN/disclaimer.rst new file mode 100644 index 000000000..00e854828 --- /dev/null +++ b/docs/zh_CN/disclaimer.rst @@ -0,0 +1,63 @@ +特别声明 +======== + +:link_to_translation:`en:[English]` + +感谢您选择使用 ESP-AT 方案（固件）。为了确保您对本方案（本固件）的使用安全、合法且符合预期效果，请仔细阅读以下特别声明。本声明旨在明确用户在使用本方案（本固件）过程中需要遵循的各项条款和注意事项。通过继续使用本方案（本固件），您即表示接受并同意遵守这些条款。 + +应用场景验证 +------------ + +本方案（本固件）为通用版本，尽管针对各种场景做了大量的测试，但测试用例仍存在某些应用场景无法覆盖的风险，在决定基于本方案（本固件）进行商用量产前，请结合自己的应用场景，进行充足且全面的验证。 + +兼容性 +------ + +由于技术日新月异，当某一新的技术、方案或标准出现时，可能导致兼容性问题，请结合自己产品做好相应的测试验证，并关注本方案（本固件）的新版本发布情况。 + +服务器升级注意事项 +------------------ + +当对服务器进行升级时，包括但不限于操作系统升级、工具升级、证书升级等，请务必在正式升级前进行测试验证，避免因服务器变动导致的连接问题。 + +无线方案问题处理 +---------------- + +无线方案易受外部因素影响，且问题定位复杂。请结合自身产品和云平台，规划好远程 OTA 和远程问题信息获取的解决方案，否则可能需要用户现场提供日志、数据包等必需的信息进行问题分析。 + +使用限制 +-------- + +用户不得将本方案（本固件）用于非法活动或违反相关法律法规的用途。用户应确保其使用本方案（本固件）的行为符合所有适用的法律和法规，我司不对因非法使用本方案（固件）而产生的任何后果负责。 + +责任限制 +-------- + +对于因使用本方案（本固件）造成的直接、间接、偶然、特殊或继发性的损害（包括但不限于数据丢失、利润损失、业务中断等），我司不承担任何责任，即使已被告知可能发生此类损害。 + +第三方软件和技术 +---------------- + +本方案（本固件）可能包含第三方的软件或技术，我司对这些第三方软件或技术的适用性和合规性不承担责任。用户应遵循第三方的许可协议和使用条款。 + +数据保护 +-------- + +用户在使用本方案（本固件）过程中产生的数据应由用户自行负责保护和备份。我司对因数据丢失或泄露引起的任何损失不承担责任。 + +版本更新与维护 +-------------- + +本方案（本固件）会不定期进行维护更新及版本发布，请自行关注版本状态，恕不另行通知。 + +声明更新 +-------- + +本声明条款可能会不定期更新，恕不另行通知。 + +用户责任 +-------- + +强烈建议用户认真阅读并严格遵守本声明条款，由于未遵守导致的风险，需由用户承担。 + +感谢您的理解与配合！ diff --git a/docs/zh_CN/index.rst b/docs/zh_CN/index.rst index d3ab67d36..9ad11fad4 100644 --- a/docs/zh_CN/index.rst +++ b/docs/zh_CN/index.rst @@ -53,6 +53,7 @@ ESP-AT 用户指南 第三方定制化 AT 命令和固件 FAQ 缩写词索引 + 特别声明 关于 ESP-AT * :ref:`genindex`