espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-05 05:34:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'docs/fix_readme_links' into 'master'

Browse Source 
docs: fixed two dead readme links

See merge request espressif/esp-idf!14461
This commit is contained in:
Marius Vikhammer
2021-07-21 10:53:49 +00:00
parent dbbf219d85 11ea7c9072
commit b691001cc1
2 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
examples/protocols/pppos_client/README.md
View File

@@ -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](https://www.simcom.com/product/SIM800.html) 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/lpwa-bg96-cat-m1-nb1-egprs/) 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.

16
examples/system/console_usb/README.md
View File

@@ -5,7 +5,7 @@
(See the README.md file in the upper level 'examples' directory for more information about examples.) (See the README.md file in the upper level 'examples' directory for more information about examples.)
This example is similar to the [console example](../console/README.md), but instead of the UART it uses USB CDC for console output. This example is similar to the [console example](../console/advanced/README.md), but instead of the UART it uses USB CDC for console output.
The example uses the [Console Component](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/console.html#console) to create an interactive shell. The example uses the [Console Component](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/console.html#console) to create an interactive shell.
The interactive shell implemented in this example contains a wide variety of commands, and can act as a basis for applications that require a command-line interface (CLI). The interactive shell implemented in this example contains a wide variety of commands, and can act as a basis for applications that require a command-line interface (CLI).
@@ -71,7 +71,7 @@ See the Getting Started Guide for full steps to configure and use ESP-IDF to bui
## Example Output ## Example Output
Enter the `help` command get a full list of all available commands. The following is a sample session of the Console Example where a variety of commands provided by the Console Example are used. Note that GPIO15 is connected to GND to remove the boot log output. Enter the `help` command get a full list of all available commands. The following is a sample session of the Console Example where a variety of commands provided by the Console Example are used. Note that GPIO15 is connected to GND to remove the boot log output.
``` ```
This is an example of ESP-IDF console component. This is an example of ESP-IDF console component.
@@ -79,22 +79,22 @@ Type 'help' to get the list of commands.
Use UP/DOWN arrows to navigate through command history. Use UP/DOWN arrows to navigate through command history.
Press TAB when typing command name to auto-complete. Press TAB when typing command name to auto-complete.
esp32s2> help esp32s2> help
help help
Print the list of registered commands Print the list of registered commands
free free
Get the current size of free heap memory Get the current size of free heap memory
heap heap
Get minimum size of free heap memory that was available during program execution Get minimum size of free heap memory that was available during program execution
version version
Get version of chip and SDK Get version of chip and SDK
restart restart
Software reset of the chip Software reset of the chip
tasks tasks
Get information about running tasks Get information about running tasks
(remaining output of the help command skipped here) (remaining output of the help command skipped here)