From 11ea7c907258586c7f9510ee929522706e53e787 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Wed, 21 Jul 2021 15:20:57 +0800 Subject: [PATCH] docs: fixed two dead readme links --- examples/protocols/pppos_client/README.md | 2 +- examples/system/console_usb/README.md | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/examples/protocols/pppos_client/README.md b/examples/protocols/pppos_client/README.md index 03022b5ea0..c00e8f626d 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](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. **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/system/console_usb/README.md b/examples/system/console_usb/README.md index e2dc5b192f..921793950e 100644 --- a/examples/system/console_usb/README.md +++ b/examples/system/console_usb/README.md @@ -5,7 +5,7 @@ (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 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 -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. @@ -79,22 +79,22 @@ Type 'help' to get the list of commands. Use UP/DOWN arrows to navigate through command history. Press TAB when typing command name to auto-complete. esp32s2> help -help +help Print the list of registered commands -free +free Get the current size of free heap memory -heap +heap Get minimum size of free heap memory that was available during program execution -version +version Get version of chip and SDK -restart +restart Software reset of the chip -tasks +tasks Get information about running tasks (remaining output of the help command skipped here)