Docs: fix broken example README links
This commit is contained in:
parent
4891fcea78
commit
a3ef357b8d
4 changed files with 10 additions and 10 deletions
|
@ -1,6 +1,6 @@
|
||||||
# ESP-BLE-MESH Examples
|
# ESP-BLE-MESH Examples
|
||||||
|
|
||||||
[ESP-BLE-MESH]($IDF_PATH/components/bt/esp_ble_mesh/) is the official Bluetooth® Mesh stack of Espressif Systems. We will provide long-term support for new features, performance optimization, etc.
|
[ESP-BLE-MESH](../../../components/bt/esp_ble_mesh/) is the official Bluetooth® Mesh stack of Espressif Systems. We will provide long-term support for new features, performance optimization, etc.
|
||||||
|
|
||||||
Please help note that breaking changes may be introduced into ESP-BLE-MESH on [minor IDF versions](https://docs.espressif.com/projects/esp-idf/en/latest/versions.html).
|
Please help note that breaking changes may be introduced into ESP-BLE-MESH on [minor IDF versions](https://docs.espressif.com/projects/esp-idf/en/latest/versions.html).
|
||||||
|
|
||||||
|
|
|
@ -14,7 +14,7 @@ When PPP connection has been established, the IP packet flow from application si
|
||||||
### Hardware Required
|
### 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).
|
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.
|
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.
|
**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.
|
||||||
|
|
|
@ -176,7 +176,7 @@ This is the log we have been looking for, complete with timestamps as if printed
|
||||||
|
|
||||||
## Example Output
|
## Example Output
|
||||||
|
|
||||||
Check the full example code [app_trace_to_host](main/app_trace_to_host_test.c) that combines both tests above and runs them in a loop showing instantly the number of samples collected:
|
Check the full example code [app_trace_to_host](main/app_trace_to_host_example_main.c) that combines both tests above and runs them in a loop showing instantly the number of samples collected:
|
||||||
|
|
||||||
```
|
```
|
||||||
I (4289) example: Sampling ADC and sending data to the host...
|
I (4289) example: Sampling ADC and sending data to the host...
|
||||||
|
|
|
@ -1,12 +1,12 @@
|
||||||
# OTA Tool Example
|
# 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,
|
- reading, writing and erasing OTA partitions,
|
||||||
- switching boot partitions, and
|
- switching boot partitions, and
|
||||||
- switching to factory partition.
|
- switching to factory partition.
|
||||||
|
|
||||||
Users taking a look at this example should focus on the contents of the python script [otatool_example.py](otatool_example.py). The script contains programmatic invocations of the tool [otatool.py](../../../components/app_update/otatool.py) in Python for the operations mentioned above; and can serve as a guide for users wanting to do the same in their applications.
|
Users taking a look at this example should focus on the contents of the python script [otatool_example.py](otatool_example.py). The script contains programmatic invocations of the tool [otatool.py](../../../../components/app_update/otatool.py) in Python for the operations mentioned above; and can serve as a guide for users wanting to do the same in their applications.
|
||||||
|
|
||||||
The built application in this example outputs the currently running partition, whose output is used to verify if the tool switched OTA
|
The built application in this example outputs the currently running partition, whose output is used to verify if the tool switched OTA
|
||||||
partitions succesfully. The built application binary is written to all OTA partitions at the start of the example to be able to determine the running
|
partitions succesfully. The built application binary is written to all OTA partitions at the start of the example to be able to determine the running
|
||||||
|
|
Loading…
Reference in a new issue