diff --git a/docs/page_redirects.txt b/docs/page_redirects.txt index d84f8cfd4e..31a91daeb5 100644 --- a/docs/page_redirects.txt +++ b/docs/page_redirects.txt @@ -57,7 +57,8 @@ get-started-cmake/get-started-pico-kit-v3 hw-reference/esp32/get-started-p api-guides/build-system-cmake api-guides/build-system api-guides/ulp-cmake api-guides/ulp api-guides/unit-tests-cmake api-guides/unit-tests -api-guides/ulps2_instruction_set.rst api-guides/ulp_extended_instruction_set.rst +api-guides/ulps2_instruction_set api-guides/ulp_extended_instruction_set +api-guides/console api-reference/system/console api-reference/network/tcpip_adapter api-reference/network/esp_netif diff --git a/examples/ethernet/iperf/README.md b/examples/ethernet/iperf/README.md index b48c860afc..94403967cc 100644 --- a/examples/ethernet/iperf/README.md +++ b/examples/ethernet/iperf/README.md @@ -9,7 +9,7 @@ This example demonstrates basic usage of [iperf](https://iperf.fr/) protocol to measure the throughout/bandwidth of Ethernet. -The cli environment in the example is based on the [console component](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/console.html). +The cli environment in the example is based on the [console component](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/console.html). ## How to use example diff --git a/examples/peripherals/i2c/i2c_tools/README.md b/examples/peripherals/i2c/i2c_tools/README.md index 71176acfe2..5b0a22231e 100644 --- a/examples/peripherals/i2c/i2c_tools/README.md +++ b/examples/peripherals/i2c/i2c_tools/README.md @@ -4,7 +4,7 @@ ## Overview -[I2C Tools](https://i2c.wiki.kernel.org/index.php/I2C_Tools) is a simple but very useful tool for developing I2C related applications, which is also famous in Linux platform. This example just implements some of basic features of [I2C Tools](https://i2c.wiki.kernel.org/index.php/I2C_Tools) based on [esp32 console component](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/console.html). As follows, this example supports five command-line tools: +[I2C Tools](https://i2c.wiki.kernel.org/index.php/I2C_Tools) is a simple but very useful tool for developing I2C related applications, which is also famous in Linux platform. This example just implements some of basic features of [I2C Tools](https://i2c.wiki.kernel.org/index.php/I2C_Tools) based on [esp32 console component](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/console.html). As follows, this example supports five command-line tools: 1. `i2cconfig`: It will configure the I2C bus with specific GPIO number, port number and frequency. 2. `i2cdetect`: It will scan an I2C bus for devices and output a table with the list of detected devices on the bus. diff --git a/examples/protocols/icmp_echo/README.md b/examples/protocols/icmp_echo/README.md index efcac6791e..92f3417d58 100644 --- a/examples/protocols/icmp_echo/README.md +++ b/examples/protocols/icmp_echo/README.md @@ -2,11 +2,11 @@ (See the README.md file in the upper level 'examples' directory for more information about examples.) -Ping is a useful network utility used to test if a remote host is reachable on the IP network. It measures the round-trip time for messages sent from the source host to a destination target that are echoed back to the source. +Ping is a useful network utility used to test if a remote host is reachable on the IP network. It measures the round-trip time for messages sent from the source host to a destination target that are echoed back to the source. Ping operates by sending Internet Control Message Protocol (ICMP) echo request packets to the target host and waiting for an ICMP echo reply. -This example implements a simple ping command line util based on the [console component](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/console.html). +This example implements a simple ping command line util based on the [console component](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/console.html). **Notes:** Currently this example only supports IPv4. diff --git a/examples/system/console/README.md b/examples/system/console/README.md index 851ae7e276..843cf4e8ec 100644 --- a/examples/system/console/README.md +++ b/examples/system/console/README.md @@ -2,7 +2,7 @@ (See the README.md file in the upper level 'examples' directory for more information about examples.) -Examples in this directory illustrate the usage of the [Console Component](https://docs.espressif.com/projects/esp-idf/en/stable/api-guides/console.html#console) to create an interactive shell on the ESP chip. +Examples in this directory illustrate the usage of the [Console Component](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/console.html#console) to create an interactive shell on the ESP chip. ## basic example @@ -14,7 +14,7 @@ It is the recommended starting point when getting familiar with console componen ## advanced example -This example illustrates lower-level APIs for line editing and autocompletion (`linenoise`), argument parsing (`argparse3`) and command registration (`esp_console`). +This example illustrates lower-level APIs for line editing and autocompletion (`linenoise`), argument parsing (`argparse3`) and command registration (`esp_console`). These APIs allow for a lot of flexibility when building a console application, but require more code to be written. diff --git a/examples/system/console/advanced/README.md b/examples/system/console/advanced/README.md index 94c080aa98..3ba5defdc3 100644 --- a/examples/system/console/advanced/README.md +++ b/examples/system/console/advanced/README.md @@ -2,7 +2,7 @@ (See the README.md file in the upper level 'examples' directory for more information about examples.) -This example illustrates the usage of the [Console Component](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/console.html#console) to create an interactive shell on the ESP32. The interactive shell running on the ESP32 can then be controlled/interacted with over a serial port (UART). +This example illustrates the usage of the [Console Component](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/console.html#console) to create an interactive shell on the ESP32. The interactive shell running on the ESP32 can then be controlled/interacted with over a serial port (UART). 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). diff --git a/examples/system/console/advanced_usb_cdc/README.md b/examples/system/console/advanced_usb_cdc/README.md index 809ec282e0..d2b69b50b1 100644 --- a/examples/system/console/advanced_usb_cdc/README.md +++ b/examples/system/console/advanced_usb_cdc/README.md @@ -6,7 +6,7 @@ (See the README.md file in the upper level 'examples' directory for more information about examples.) This example is similar to the [advanced console example](../advanced/README.md), but instead of the UART it uses the USB CDC port provided by USB_OTG peripheral 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/esp32/api-reference/system/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). diff --git a/examples/system/console/basic/README.md b/examples/system/console/basic/README.md index 67a67be03b..75969ec6d6 100644 --- a/examples/system/console/basic/README.md +++ b/examples/system/console/basic/README.md @@ -2,7 +2,7 @@ (See the README.md file in the upper level 'examples' directory for more information about examples.) -This example illustrates the usage of the REPL (Read-Eval-Print Loop) APIs of the [Console Component](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/console.html#console) to create an interactive shell on the ESP chip. The interactive shell running on the ESP chip can then be controlled/interacted with over a serial interface. This example supports UART and USB interfaces. +This example illustrates the usage of the REPL (Read-Eval-Print Loop) APIs of the [Console Component](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/console.html#console) to create an interactive shell on the ESP chip. The interactive shell running on the ESP chip can then be controlled/interacted with over a serial interface. This example supports UART and USB interfaces. 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).