From 18cb678dd76d2d946ab5fb961182f20eebdee853 Mon Sep 17 00:00:00 2001 From: Gunar Schorcht Date: Fri, 3 May 2019 07:56:28 +0200 Subject: [PATCH 1/4] boards/esp32_wrover_kit: documentation improvement Adds a reference to a vendor document about hardware configuration. --- boards/esp32-wrover-kit/doc.txt | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/boards/esp32-wrover-kit/doc.txt b/boards/esp32-wrover-kit/doc.txt index 4b40725787..6862593a62 100644 --- a/boards/esp32-wrover-kit/doc.txt +++ b/boards/esp32-wrover-kit/doc.txt @@ -22,6 +22,7 @@ 4. [Optional Hardware Configurations](#optional_hardware) 3. [Flashing the Device](#flashing) 4. [On-Chip Debugging with the device](#debugging) +5. [Other Documentation Resources](#other-resources) ## Overview    [[TOC](#toc)] @@ -257,4 +258,8 @@ For detailed information about ESP32 as well as configuring and compiling RIOT f ## On-Chip Debugging with the Device    [[TOC](#toc)] Since the USB bridge based on FDI FT2232HL provides a JTAG interface for debugging through an USB interface, using ESP-ROVER-KIT is the easiest and most convinient way for On-Chip debugging. Please refer the [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/jtag-debugging/index.html) for details on how to setup and how to use ESP-WROVER-KIT and OpenOCD. + +## Other Documentation Resources    [[TOC](#toc)] + +There is a comprehensive [Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/get-started-wrover-kit-v3.html) for the ESP-WROVER-KIT with a lot information about hardware configuration. */ From 0eb82759252fecfa8958758333f287b8e00268bb Mon Sep 17 00:00:00 2001 From: Gunar Schorcht Date: Fri, 3 May 2019 07:56:46 +0200 Subject: [PATCH 2/4] boards/esp32_wrover_kit: documentation improvement --- boards/esp32-wrover-kit/doc.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/boards/esp32-wrover-kit/doc.txt b/boards/esp32-wrover-kit/doc.txt index 6862593a62..1de27c8a72 100644 --- a/boards/esp32-wrover-kit/doc.txt +++ b/boards/esp32-wrover-kit/doc.txt @@ -93,7 +93,7 @@ ESP-WROVER-KIT has the following on-board components The following table shows the default board configuration sorted according to the defined functionality of GPIOs for different hardware options. This configuration can be overridden by \ref esp32_app_spec_conf "application-specific configurations". -In the following table following abbreviations are used: +These abbreviations are used in subsequent tables: SDC = SD-Card interface is used (module **sdcard_spi** is enabled)
CAM = Camera is plugged in/used From 38843792c488ce1e806cac5a5ebd77d2bfe4447a Mon Sep 17 00:00:00 2001 From: Gunar Schorcht Date: Fri, 3 May 2019 07:54:10 +0200 Subject: [PATCH 3/4] boards/esp32_wrover_kit: documentation fix Fixes a reference to vendor picture that has been moved to a different location. --- boards/esp32-wrover-kit/doc.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/boards/esp32-wrover-kit/doc.txt b/boards/esp32-wrover-kit/doc.txt index 1de27c8a72..6035b8a169 100644 --- a/boards/esp32-wrover-kit/doc.txt +++ b/boards/esp32-wrover-kit/doc.txt @@ -36,7 +36,7 @@ The Espressif ESP-WROVER-KIT is a development board that uses the ESP32-WROVER m Furthermore, many GPIOs are broken out for extension. The USB bridge based on FDI FT2232HL provides a JTAG interface for OCD debugging through the USB interface. -\htmlonly\endhtmlonly@image html "https://docs.espressif.com/projects/esp-idf/en/latest/_images/esp32-wrover-kit-layout-front.jpg" "ESP-WROVER-KIT V3" +\htmlonly\endhtmlonly@image html "https://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v3.jpg" "ESP-WROVER-KIT V3" ## Hardware    [[TOC](#toc)] From bf60857442722f962d3b620be77a7d5fbd726c18 Mon Sep 17 00:00:00 2001 From: Gunar Schorcht Date: Fri, 3 May 2019 07:55:57 +0200 Subject: [PATCH 4/4] boards/esp32_wrover_kit: documentation fix Fixes the bold faced references **/dev/ttyUSB** that stopped doxygen generation --- boards/esp32-wrover-kit/doc.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/boards/esp32-wrover-kit/doc.txt b/boards/esp32-wrover-kit/doc.txt index 6035b8a169..4094d19f7b 100644 --- a/boards/esp32-wrover-kit/doc.txt +++ b/boards/esp32-wrover-kit/doc.txt @@ -248,7 +248,7 @@ The USB bridge is based on FDI FT2232HL and offers two USB interfaces: - the first interface is the JTAG interface for [On-Chip debugging](#debugging) - the second interface is the console interface, which is also used for flashing -Therefore, you have to declare the USB interface in the make command. For example, if the ESP32-WROVER-KIT is connected to the host computer through the USB interfaces **/dev/ttyUSB0** and **/dev/ttyUSB1**, the make command would be used as following: +Therefore, you have to declare the USB interface in the make command. For example, if the ESP32-WROVER-KIT is connected to the host computer through the USB interfaces `/dev/ttyUSB0` and `/dev/ttyUSB1`, the make command would be used as following: ``` make flash BOARD=esp32-wrover-kit PORT=/dev/ttyUSB1 ... ```