From a80cff924b138688303f82f2ecb88b868b5fcee1 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Tue, 16 Jun 2020 19:01:44 +0800 Subject: [PATCH] docs: fix broken links in example READMEs --- examples/bluetooth/bluedroid/ble/blufi/README.md | 4 ++-- .../bluedroid/coex/gattc_gatts_coex/README.md | 8 ++++---- .../esp_ble_mesh/ble_mesh_wifi_coexist/README.md | 2 +- examples/protocols/pppos_client/README.md | 2 +- .../sockets/tcp_client_multi_net/README.md | 14 +++++++------- examples/system/ota/otatool/README.md | 4 ++-- 6 files changed, 17 insertions(+), 17 deletions(-) diff --git a/examples/bluetooth/bluedroid/ble/blufi/README.md b/examples/bluetooth/bluedroid/ble/blufi/README.md index 7c1430175..1da24f460 100644 --- a/examples/bluetooth/bluedroid/ble/blufi/README.md +++ b/examples/bluetooth/bluedroid/ble/blufi/README.md @@ -6,11 +6,11 @@ ESP-IDF Blufi demo This is the demo for bluetooth config wifi connection to ap. -To test this demo, you need to prepare a mobile phone with blufi application installed. You can download the blufi application from [Android version](https://github.com/EspressifApp/EspBlufi) and [iOS version](https://itunes.apple.com/cn/app/espblufi/id1450614082?mt=8). +To test this demo, you need to prepare a mobile phone with blufi application installed. You can download the blufi application from [Android version](https://github.com/EspressifApp/EspBlufi) and [iOS version](https://itunes.apple.com/cn/app/espblufi/id1450614082?mt=8). Blufi is completely open source, here is the download link: -* [blufi source code](https://github.com/espressif/esp-idf/tree/master/examples/bluetooth/blufi) +* [blufi source code](https://github.com/espressif/esp-idf/tree/master/examples/bluetooth/bluedroid/ble/blufi) * [BluFi protocol](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/blufi.html?highlight=blufi#the-frame-formats-defined-in-blufi) diff --git a/examples/bluetooth/bluedroid/coex/gattc_gatts_coex/README.md b/examples/bluetooth/bluedroid/coex/gattc_gatts_coex/README.md index 5c979c98f..7690711cd 100644 --- a/examples/bluetooth/bluedroid/coex/gattc_gatts_coex/README.md +++ b/examples/bluetooth/bluedroid/coex/gattc_gatts_coex/README.md @@ -8,10 +8,10 @@ This example demonstrates the coexistence of gattc and gatts. This example creates a GATT service and starts ADV. The ADV name is `ESP_GATTS_DEMO`, then waits to be connected. At the same time, a gatt client is created, the ADV name is `ESP_GATTS_DEMO`, the device is connected, and the data is exchanged. If the device is not found within 120 seconds, the example will stop scanning. -ESP-IDF also allows users to create a GATT service via an attribute table, rather than add attributes one by one. And it is recommended for users to use. For more information about this method, please refer to [gatt_server_service_table_demo](../gatt_server_service_table). +ESP-IDF also allows users to create a GATT service via an attribute table, rather than add attributes one by one. And it is recommended for users to use. For more information about this method, please refer to [gatt_server_service_table_demo](../../ble/gatt_server_service_table). -To test this example, you can run the [gatt_client_demo](../gatt_client), which can scan for and connect to this example automatically, and run [gatt_server_demo](../gatt_server), Waiting to be connected. They will start exchanging data once the GATT client has enabled the notification function of the GATT server. +To test this example, you can run the [gatt_client_demo](../../ble/gatt_client), which can scan for and connect to this example automatically, and run [gatt_server_demo](../../ble/gatt_server), Waiting to be connected. They will start exchanging data once the GATT client has enabled the notification function of the GATT server. -Please check the [tutorial](tutorial/Gatt_Server_Example_Walkthrough.md) for more information about the gatts part of this example. -Please check the [tutorial](tutorial/Gatt_Client_Example_Walkthrough.md) for more information about the gattc part of this example. +Please check the [tutorial](../../ble/gatt_server/tutorial/Gatt_Server_Example_Walkthrough.md) for more information about the gatts part of this example. +Please check the [tutorial](../../ble/gatt_client/tutorial/Gatt_Client_Example_Walkthrough.md) for more information about the gattc part of this example. diff --git a/examples/bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/README.md b/examples/bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/README.md index f49459343..51ca9c1f4 100644 --- a/examples/bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/README.md +++ b/examples/bluetooth/esp_ble_mesh/ble_mesh_wifi_coexist/README.md @@ -20,4 +20,4 @@ WiFi的Iperf协议使用方法请参考[WiFi Iperf README](../../../wifi/iperf/R - Generic OnOff Server Model：此Model通过暴露自己的OnOff State，从而实现LED 灯的开关功能 - Generic OnOff Client Model： 使用此Model可以实现开关功能，控制别的node 的LED灯的开关 - Fast Provision Server Model： 此Model是为了进行快速配网而实现的自定义Model，通过此Model当节点作为临时provisioner进行配网成功后，需要将生成的Element地址通过此Model进行传给provisioner -- Fast Provision Client Model：此Model和Fast Provision Server Model是配合使用的 \ No newline at end of file +- Fast Provision Client Model：此Model和Fast Provision Server Model是配合使用的 diff --git a/examples/protocols/pppos_client/README.md b/examples/protocols/pppos_client/README.md index 0fe442c22..03022b5ea 100644 --- a/examples/protocols/pppos_client/README.md +++ b/examples/protocols/pppos_client/README.md @@ -14,7 +14,7 @@ When PPP connection has been established, the IP packet flow from application si ### Hardware Required To run this example, you need an ESP32 dev board (e.g. ESP32-WROVER Kit) or ESP32 core board (e.g. ESP32-DevKitC). -For test purpose, you also need a cellular modem module. Here we take the [SIM800L](http://www.simcom.com/product/showproduct.php?lang=en&id=277) and [BG96](https://www.quectel.com/product/bg96.htm) as an example. +For test purpose, you also need a cellular modem module. Here we take the [SIM800L](https://www.simcom.com/product/SIM800.html) and [BG96](https://www.quectel.com/product/bg96.htm) as an example. You can also try other modules as long as they embedded PPP protocol. **Note:** Since SIM800L only support **2G** which will **not** work in some countries. And also keep in mind that in some other countries it will stop working soon (many remaining 2G networks will be switched off in the next 2-3 years). So you should **check with your local providers for further details** if you try this example with any 2G modules. diff --git a/examples/protocols/sockets/tcp_client_multi_net/README.md b/examples/protocols/sockets/tcp_client_multi_net/README.md index 0217fce72..1fefef431 100644 --- a/examples/protocols/sockets/tcp_client_multi_net/README.md +++ b/examples/protocols/sockets/tcp_client_multi_net/README.md @@ -89,13 +89,13 @@ I (6965) tcp_client_multiple: HTTP/1.1 200 OK Date: Thu, 23 Apr 2020 07:02:58 GMT Expires: -1 Cache-Control: private, max-age=0 -Content-Type: text/html; +Content-Type: text/html; I (6965) tcp_client_multiple: "example_connect: sta" Received Data 127 bytes I (6985) tcp_client_multiple: HTTP/1.1 200 OK Date: Thu, 23 Apr 2020 07:02:58 GMT Expires: -1 Cache-Control: private, max-age=0 -Content-Type: text/html; +Content-Type: text/html; I (7675) tcp_client_multiple: "example_connect: eth" Socket created I (7675) tcp_client_multiple: "example_connect: eth" Successfully connected I (7695) tcp_client_multiple: "example_connect: sta" Socket created @@ -105,13 +105,13 @@ I (7735) tcp_client_multiple: HTTP/1.1 200 OK Date: Thu, 23 Apr 2020 07:02:59 GMT Expires: -1 Cache-Control: private, max-age=0 -Content-Type: text/html; +Content-Type: text/html; I (7955) tcp_client_multiple: "example_connect: sta" Received Data 127 bytes I (7955) tcp_client_multiple: HTTP/1.1 200 OK Date: Thu, 23 Apr 2020 07:02:59 GMT Expires: -1 Cache-Control: private, max-age=0 -Content-Type: text/html; +Content-Type: text/html; I (8445) tcp_client_multiple: "example_connect: eth" Socket created I (8445) tcp_client_multiple: "example_connect: eth" Successfully connected I (8505) tcp_client_multiple: "example_connect: eth" Received Data 127 bytes @@ -119,7 +119,7 @@ I (8505) tcp_client_multiple: HTTP/1.1 200 OK Date: Thu, 23 Apr 2020 07:03:00 GMT Expires: -1 Cache-Control: private, max-age=0 -Content-Type: text/html; +Content-Type: text/html; I (8675) tcp_client_multiple: "example_connect: sta" Socket created ``` @@ -127,7 +127,7 @@ I (8675) tcp_client_multiple: "example_connect: sta" Socket created * When connecting using Ethernet, please consult troubleshooting described in [Ethernet common readme](../../../ethernet/README.md) or [Ethernet documentation](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/network/esp_eth.html). -If using Ethernet for the first time, it is recommended to start with the [Ethernet example readme](../../../ethernet/basic/README.md), which contains instructions for connecting and configuring the PHY. +If using Ethernet for the first time, it is recommended to start with the [Ethernet example readme](../../../ethernet/basic/README.md), which contains instructions for connecting and configuring the PHY. Once Ethernet example obtains IP address successfully, proceed to this example. -* When connecting using Wi-Fi, please refer to the WiFi examples in [examples/wifi/getting_started/](../wifi/getting_started). +* When connecting using Wi-Fi, please refer to the WiFi examples in [examples/wifi/getting_started/](../../../wifi/getting_started). diff --git a/examples/system/ota/otatool/README.md b/examples/system/ota/otatool/README.md index 9b52e8952..52bc5f0be 100644 --- a/examples/system/ota/otatool/README.md +++ b/examples/system/ota/otatool/README.md @@ -1,6 +1,6 @@ # OTA Tool Example -This example demonstrates common operations the OTA tool [otatool.py](../../../components/app_update/otatool.py) allows the user to perform: +This example demonstrates common operations the OTA tool [otatool.py](../../../../components/app_update/otatool.py) allows the user to perform: - reading, writing and erasing OTA partitions, - switching boot partitions, and @@ -44,7 +44,7 @@ Shell script: ./otatool_example.sh ``` -The script searches for valid target devices connected to the host and performs the operations on the first one it finds. This could present problems if there +The script searches for valid target devices connected to the host and performs the operations on the first one it finds. This could present problems if there are multiple viable target devices attached to the host. To perform the operations on a specific device, specify the port it is attached to during script invocation ("/dev/ttyUSB2" for example): Python script: