From 80da446be7c993ffd3de2f739125ca494f4c3fa8 Mon Sep 17 00:00:00 2001 From: Hao Ning Date: Fri, 26 Feb 2021 15:12:45 +0800 Subject: [PATCH] fix dead links directed to iot solution repo resolve confilcts modify a board name rebase master fix ota example link in readme --- docs/en/api-reference/peripherals/touch_pad.rst | 5 ++--- docs/en/get-started-legacy/establish-serial-connection.rst | 6 +++--- docs/en/get-started/establish-serial-connection.rst | 6 +++--- docs/zh_CN/api-reference/peripherals/touch_pad.rst | 2 +- .../get-started-legacy/establish-serial-connection.rst | 6 +++--- docs/zh_CN/get-started/establish-serial-connection.rst | 6 +++--- examples/ethernet/eth2ap/README.md | 2 +- examples/peripherals/touch_pad_interrupt/README.md | 2 +- examples/peripherals/touch_pad_read/README.md | 2 +- examples/system/deep_sleep/README.md | 2 +- examples/system/ota/README.md | 4 ++-- 11 files changed, 21 insertions(+), 22 deletions(-) diff --git a/docs/en/api-reference/peripherals/touch_pad.rst b/docs/en/api-reference/peripherals/touch_pad.rst index e5427449cd..45aca83a73 100644 --- a/docs/en/api-reference/peripherals/touch_pad.rst +++ b/docs/en/api-reference/peripherals/touch_pad.rst @@ -1,6 +1,5 @@ Touch Sensor ============ - :link_to_translation:`zh_CN:[中文]` Introduction @@ -20,11 +19,11 @@ A touch sensor system is built on a substrate which carries electrodes and relev For design, operation, and control registers of a touch sensor, see *{IDF_TARGET_NAME} Technical Reference Manual* > *On-Chip Sensors and Analog Signal Processing* [`PDF <{IDF_TARGET_TRM_EN_URL}#sensor>`__]. -In-depth design details of touch sensors and firmware development guidelines for {IDF_TARGET_NAME} are available in `Touch Sensor Application Note `_. +In-depth design details of touch sensors and firmware development guidelines for {IDF_TARGET_NAME} are available in `Touch Sensor Application Note `_. .. only:: esp32 - If you want to test touch sensors in various configurations without building them on your own, check the `Guide for ESP32-Sense Development Kit `_. + For more information about testing touch sensors in various configurations, please check the `Guide for ESP32-Sense-Kit `_. Functionality Overview diff --git a/docs/en/get-started-legacy/establish-serial-connection.rst b/docs/en/get-started-legacy/establish-serial-connection.rst index e44bf73d2f..4e821040b0 100644 --- a/docs/en/get-started-legacy/establish-serial-connection.rst +++ b/docs/en/get-started-legacy/establish-serial-connection.rst @@ -26,12 +26,12 @@ Below are the links to drivers for ESP32 and other boards produced by Espressif: :ref:`ESP-WROVER-KIT `, `FTDI`_ :ref:`ESP32 Demo Board `, `FTDI`_ `ESP-Prog`_, `FTDI`_, Programmer board (w/o ESP32) - `ESP32-MeshKit-Sense `_, n/a, Use with `ESP-Prog`_ - `ESP32-Sense Kit `_, n/a, Use with `ESP-Prog`_ + `ESP32-MeshKit-Sense `_, n/a, Use with `ESP-Prog`_ + `ESP32-Sense-Kit `_, n/a, Use with `ESP-Prog`_ .. _CP210x: https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers .. _FTDI: https://www.ftdichip.com/Drivers/VCP.htm -.. _ESP-Prog: https://github.com/espressif/esp-iot-solution/blob/master/documents/evaluation_boards/ESP-Prog_guide_en.md#introduction-to-the-esp-prog-board +.. _ESP-Prog: https://github.com/espressif/esp-dev-kits/blob/master/esp-prog/docs/ESP-Prog_guide_en.md * CP210x: `CP210x USB to UART Bridge VCP Drivers `_ * FTDI: `FTDI Virtual COM Port Drivers `_ diff --git a/docs/en/get-started/establish-serial-connection.rst b/docs/en/get-started/establish-serial-connection.rst index ad75ef1169..c152602674 100644 --- a/docs/en/get-started/establish-serial-connection.rst +++ b/docs/en/get-started/establish-serial-connection.rst @@ -26,12 +26,12 @@ Below are the links to drivers for {IDF_TARGET_NAME} boards produced by Espressi :ref:`ESP-WROVER-KIT `, `FTDI`_ :ref:`ESP32 Demo Board `, `FTDI`_ `ESP-Prog`_, `FTDI`_, Programmer board (w/o ESP32) - `ESP32-MeshKit-Sense `_, n/a, Use with `ESP-Prog`_ - `ESP32-Sense Kit `_, n/a, Use with `ESP-Prog`_ + `ESP32-MeshKit-Sense `_, n/a, Use with `ESP-Prog`_ + `ESP32-Sense-Kit `_, n/a, Use with `ESP-Prog`_ .. _CP210x: https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers .. _FTDI: https://www.ftdichip.com/Drivers/VCP.htm - .. _ESP-Prog: https://github.com/espressif/esp-iot-solution/blob/master/documents/evaluation_boards/ESP-Prog_guide_en.md#introduction-to-the-esp-prog-board + .. _ESP-Prog: https://github.com/espressif/esp-dev-kits/blob/master/esp-prog/docs/ESP-Prog_guide_en.md * CP210x: `CP210x USB to UART Bridge VCP Drivers `_ * FTDI: `FTDI Virtual COM Port Drivers `_ diff --git a/docs/zh_CN/api-reference/peripherals/touch_pad.rst b/docs/zh_CN/api-reference/peripherals/touch_pad.rst index 57ae303025..393b98ea60 100644 --- a/docs/zh_CN/api-reference/peripherals/touch_pad.rst +++ b/docs/zh_CN/api-reference/peripherals/touch_pad.rst @@ -12,7 +12,7 @@ ESP32 可支持最多 10 个电容式触摸板/GPIO，触摸板可以以矩阵 如需了解触摸传感器设计、操作及其控制寄存器等相关信息，请参考《`{IDF_TARGET_NAME} 技术参考手册 <{IDF_TARGET_TRM_CN_URL}>`_》(PDF)，您也可以在《ESP32 技术参考手册》中查看这一子系统是如何运行的。 -请参考 `触摸传感器应用方案简介 `_，查看触摸传感器设计详情和固件开发指南。如果不想亲自在多种配置环境下测试触摸传感器，请查看 `ESP32 触摸功能开发套件 `_。 +请参考 `触摸传感器应用方案简介 `_，查看触摸传感器设计详情和固件开发指南。更多关于在多种配置环境下测试触摸传感器的信息，请参考 `ESP32 触摸功能开发套件 `_。 功能介绍 ---------------------- diff --git a/docs/zh_CN/get-started-legacy/establish-serial-connection.rst b/docs/zh_CN/get-started-legacy/establish-serial-connection.rst index b7cdba676f..875a7771a9 100644 --- a/docs/zh_CN/get-started-legacy/establish-serial-connection.rst +++ b/docs/zh_CN/get-started-legacy/establish-serial-connection.rst @@ -26,12 +26,12 @@ :ref:`ESP-WROVER-KIT `, `FTDI`_ :ref:`ESP32 Demo 板 `, `FTDI`_ `ESP-Prog`_, `FTDI`_, 编程板 (w/o ESP32) - `ESP32-MeshKit-Sense `_, n/a, 搭配 `ESP-Prog`_ 使用 - `ESP32-Sense Kit `_, n/a, 搭配 `ESP-Prog`_ 使用 + `ESP32-MeshKit-Sense `_, n/a, 搭配 `ESP-Prog`_ 使用 + `ESP32-Sense Kit `_, n/a, 搭配 `ESP-Prog`_ 使用 .. _CP210x: https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers .. _FTDI: https://www.ftdichip.com/Drivers/VCP.htm -.. _ESP-Prog: https://github.com/espressif/esp-iot-solution/blob/master/documents/evaluation_boards/ESP-Prog_guide_en.md#introduction-to-the-esp-prog-board +.. _ESP-Prog: https://github.com/espressif/esp-dev-kits/blob/master/esp-prog/docs/ESP-Prog_guide_cn.md * CP210x: `CP210x USB to UART Bridge VCP Drivers `_ * FTDI: `FTDI Virtual COM Port Drivers `_ diff --git a/docs/zh_CN/get-started/establish-serial-connection.rst b/docs/zh_CN/get-started/establish-serial-connection.rst index 3731df18aa..7eea612404 100644 --- a/docs/zh_CN/get-started/establish-serial-connection.rst +++ b/docs/zh_CN/get-started/establish-serial-connection.rst @@ -26,12 +26,12 @@ :ref:`ESP-WROVER-KIT `, `FTDI`_ :ref:`ESP32 Demo 板 `, `FTDI`_ `ESP-Prog`_, `FTDI`_, 编程板 (w/o ESP32) - `ESP32-MeshKit-Sense `_, n/a, 搭配 `ESP-Prog`_ 使用 - `ESP32-Sense Kit `_, n/a, 搭配 `ESP-Prog`_ 使用 + `ESP32-MeshKit-Sense `_, n/a, 搭配 `ESP-Prog`_ 使用 + `ESP32-Sense-Kit `_, n/a, 搭配 `ESP-Prog`_ 使用 .. _CP210x: https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers .. _FTDI: https://www.ftdichip.com/Drivers/VCP.htm -.. _ESP-Prog: https://github.com/espressif/esp-iot-solution/blob/master/documents/evaluation_boards/ESP-Prog_guide_en.md#introduction-to-the-esp-prog-board +.. _ESP-Prog: https://github.com/espressif/esp-dev-kits/blob/master/esp-prog/docs/ESP-Prog_guide_cn.md * CP210x: `CP210x USB 至 UART 桥 VCP 驱动程序 `_ * FTDI: `FTDI 虚拟 COM 端口驱动程序 `_ diff --git a/examples/ethernet/eth2ap/README.md b/examples/ethernet/eth2ap/README.md index 73a8e67bec..13bd9aa0b9 100644 --- a/examples/ethernet/eth2ap/README.md +++ b/examples/ethernet/eth2ap/README.md @@ -1,5 +1,5 @@ # eth2ap Example -(See the README.md file in the upper level 'examples' directory for more information about examples. To try a more complex application about Ethernet to WiFi data forwarding, please go to [iot-solution](https://github.com/espressif/esp-iot-solution/tree/master/examples/eth2wifi).) +(See the README.md file in the upper level 'examples' directory for more information about examples. To try a more complex application about Ethernet to WiFi data forwarding, please go to [iot-solution](https://github.com/espressif/esp-iot-solution/tree/release/v1.0/examples/eth2wifi).) **Note:** This example uses some internal APIs (e.g. `esp_wifi_internal_tx`) which might get changed between minor versions of ESP-IDF. diff --git a/examples/peripherals/touch_pad_interrupt/README.md b/examples/peripherals/touch_pad_interrupt/README.md index 395e689a32..e39c0bc46f 100644 --- a/examples/peripherals/touch_pad_interrupt/README.md +++ b/examples/peripherals/touch_pad_interrupt/README.md @@ -63,6 +63,6 @@ I (6194) Touch pad: TouchSensor [9] be inactived, status mask 0x0 For a simpler example how to configure and read capacitive touch pads, please refer to [touch_pad_read](../touch_pad_read). -Design and implementation of the touch sensor system is a complex process. The [Touch Sensor Application Note](https://github.com/espressif/esp-iot-solution/blob/master/documents/touch_pad_solution/touch_sensor_design_en.md) contains several ESP32 specific notes and comments to optimize the design and get the best out of the application with sensors controlled with the ESP32. +Design and implementation of the touch sensor system is a complex process. The [Touch Sensor Application Note](https://github.com/espressif/esp-iot-solution/blob/release/v1.0/documents/touch_pad_solution/touch_sensor_design_en.md) contains several ESP32 specific notes and comments to optimize the design and get the best out of the application with sensors controlled with the ESP32. See the README.md file in the upper level 'examples' directory for more information about examples. \ No newline at end of file diff --git a/examples/peripherals/touch_pad_read/README.md b/examples/peripherals/touch_pad_read/README.md index 4e1fb2e044..3bfd7040e5 100644 --- a/examples/peripherals/touch_pad_read/README.md +++ b/examples/peripherals/touch_pad_read/README.md @@ -43,7 +43,7 @@ T1: [6476] T2: [6508] T3: [6641] T4: [8919] T5: [9053] T6: [7190] T7: [7177] T8: ## Reference Information -For hardware and firmware design guidelines on ESP32 touch sensor system, please refer to [Touch Sensor Application Note](https://github.com/espressif/esp-iot-solution/blob/master/documents/touch_pad_solution/touch_sensor_design_en.md), where you may find comprehensive information on how to design and implement touch sensing applications, such as linear slider, wheel slider, matrix buttons and spring buttons. +For hardware and firmware design guidelines on ESP32 touch sensor system, please refer to [Touch Sensor Application Note](https://github.com/espressif/esp-iot-solution/blob/release/v1.0/documents/touch_pad_solution/touch_sensor_design_en.md), where you may find comprehensive information on how to design and implement touch sensing applications, such as linear slider, wheel slider, matrix buttons and spring buttons. There is another similar example that demonstrates how to perform simple calibration and trigger an interrupt when a pat is touched - see [touch_pad_interrupt](../touch_pad_interrupt). diff --git a/examples/system/deep_sleep/README.md b/examples/system/deep_sleep/README.md index 999fecdbd5..c250f05ee1 100644 --- a/examples/system/deep_sleep/README.md +++ b/examples/system/deep_sleep/README.md @@ -23,7 +23,7 @@ This example should be able to run on any commonly available ESP32 development b - **EXT1:** GPIO2 and GPIO4 should be connected to LOW to avoid floating pins. When triggering a wake up, connect one or both of the pins to HIGH. Note that floating pins may trigger a wake up. -- **Touch:** GPIO32, GPIO33 in ESP32 or GPIO9 in ESP32-S2 should be connected to touch sensors (see [Touch Sensor Application Note](https://github.com/espressif/esp-iot-solution/blob/master/documents/touch_pad_solution/touch_sensor_design_en.md)). +- **Touch:** GPIO32, GPIO33 in ESP32 or GPIO9 in ESP32-S2 should be connected to touch sensors (see [Touch Sensor Application Note](https://github.com/espressif/esp-iot-solution/blob/release/v1.0/documents/touch_pad_solution/touch_sensor_design_en.md)). ### Configure the project diff --git a/examples/system/ota/README.md b/examples/system/ota/README.md index 698665b9e6..6c0c1734b7 100644 --- a/examples/system/ota/README.md +++ b/examples/system/ota/README.md @@ -70,7 +70,7 @@ After a successful build, we need to create a self-signed certificate and run a (Some windows builds of openssl translate CR/LF sequences to LF in the served files, leading to corrupted image received by the OTA client; Others might interpret `0x1a`/`SUB` character in the binary as an escape sequence, i.e. end of file, thus closing the connection, failing the OTA client to receive the entire image). * It's recommended to use `openssl` bundled in `Git For Windows` from the [ESP-IDF Tool installer](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/windows-setup.html): Open the ESP-IDF command prompt and add the internal openssl binary to your path: `set PATH=%LocalAppData%\Git\usr\bin;%PATH%` and run the openssl's http server command as above. - * Alternatively, you can use any windows based openssl of version at least `v1.1.1i` build on `Msys-x86_64` platform, or a simple python https server -- see start_https_server in the [example_test](simple_ota/example_test.py) script. + * Alternatively, you can use any windows based openssl of version at least `v1.1.1i` build on `Msys-x86_64` platform, or a simple python https server -- see start_https_server in the [example_test](simple_ota_example/example_test.py) script. ### Flash Certificate to ESP32 @@ -141,7 +141,7 @@ Running a local https server might be tricky in some cases (due to self signed c - Execute `python -m http.server 8070` in the directory with the firmware image. - Use http://:8070/ as firmware upgrade URL. - Enable *Allow HTTP for OTA* (`CONFIG_OTA_ALLOW_HTTP`) in `Component config -> ESP HTTPS OTA` so the URI with no certificate is accepted. -* Start the https server using [example_test](simple_ota/example_test.py) with two or more parameters: `example_test.py [CERT_DIR]`, where +* Start the https server using [example_test](simple_ota_example/example_test.py) with two or more parameters: `example_test.py [CERT_DIR]`, where - `` is a directory containing the image and by default also the certificate and key files:`ca_cert.pem` and `ca_key.pem`. - `` is the server's port, here `8070` - `[CERT_DIR]` is an optional argument pointing to a specific directory with the certificate and key file.