Doc

@defgroup boards_esp32_esp-wrover-kit ESP-WROVER-KIT V3 @ingroup boards_esp32 @brief Support for for Espressif ESP-WROVER-KIT V3 @author Gunar Schorcht [email protected]

\section esp32_wrover_kit ESP-WROVER-KIT V3

Table of Contents {#esp32_wrover_kit_toc}

1. Overview
2. Hardware
   1. MCU
   2. Board Configuration
   3. Board Pinout
   4. Optional Hardware Configurations
3. Flashing the Device
4. On-Chip Debugging with the device
5. Other Documentation Resources

Overview {#esp32_wrover_kit_overview}

The Espressif ESP-WROVER-KIT is a development board that uses the ESP32-WROVER module which includes a built-in 4 MByte SPI RAM. Most important features of the board are

• Micro-SD card interface
• OV7670 camera interface
• 3.2" SPI LCD panel
• RGB LED
• USB bridge with JTAG interface
• external 32.768 kHz crystal for RTC

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.

@image html "https://dl.espressif.com/dl/schematics/pictures/esp-wrover-kit-v3.jpg" "ESP-WROVER-KIT V3" width=500px

Back to table of contents

Hardware {#esp32_wrover_kit_hardware}

This section describes

• the MCU,
• the default board configuration,
• optional hardware configurations,
• the board pinout.

Back to table of contents

MCU {#esp32_wrover_kit_mcu}

Most features of the board are provided by the ESP32 SoC. For detailed information about the ESP32, see section \ref esp32_mcu_esp32 "MCU ESP32".

Back to table of contents

Board Configuration {#esp32_wrover_kit_board_configuration}

ESP-WROVER-KIT has the following on-board components

• Micro-SD card interface
• OV7670 camera interface
• 3.2" SPI LCD panel
• RGB LED
• USB bridge with JTAG interface
• external 32.768 kHz crystal for RTC

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_application_specific_configurations .

These abbreviations are used in subsequent tables:

SDC = SD-Card interface is used (module periph_sdmmc is enabled)\n CAM = Camera is plugged in/used

Following table shows the default board configuration sorted by GPIOs depending on used hardware.

@note

• SPI_DEV(0) uses the HSPI interface with the GPIO2 pin as the MISO signal. Since GPIO2 has bootstrapping functionality, it might be necessary to to press the Boot button for flashing RIOT when the SD card or the peripheral hardware is attached to this SPI interface.
• GPIO0 cannot be used as SPI CS signal for external hardware connected to SPI_DEV(0). The reason for this is that the LEDs on this board are high-active and the default state of the LEDs after power-up causes a low level on the corresponding GPIO outputs.
• GPIO2 cannot be used as PWM_DEV(0) channel 1 / LED0 when SPI_DEV(0) is used in any way. Reason is that GPIO2 is the MISO signal when SPI_DEV(0) is used and is therefore an input. PWM channels are outputs.
• It might be necessary to remove the SD card or the peripheral hardware attached to the SPI_DEV(0) interface for flashing RIOT. Reason is that the SPI_DEV(0) interface uses the HSPI interface with the GPIO2 pin as the MISO signal, which has bootstrapping functionality.
• GPIO16 and GPIO17 are used for the built-in SPI RAM and are not available on the I/O expansion connector, even though they are labeled there.
• GPIO32 and GPIO33 are attached to a 32 kHz crystal by default. To make them available as a GPIO on the I/O expansion connector, SMD resistors would need to be removed and soldered. Module esp_rtc_timer_32k is enabled by default.

For detailed information about the configuration of ESP32 boards, see section Peripherals in \ref esp32_riot.

Back to table of contents

Optional Hardware Configurations {#esp32_wrover_kit_optional_hardware}

MRF24J40-based IEEE 802.15.4 radio modules and ENC28J60-based Ethernet network interface modules have been tested with the board. You could use the following code in your \ref esp32_application_specific_configurations "application-specific configuration" to use such modules:

#ifdef BOARD_ESP32_WROVER_KIT

#if MODULE_MRF24J40
#define MRF24J40_PARAM_CS       GPIO9       /* MRF24J40 CS signal    */
#define MRF24J40_PARAM_INT      GPIO10      /* MRF24J40 INT signal   */
#define MRF24J40_PARAM_RESET    GPIO12      /* MRF24J40 RESET signal */
#endif

#if MODULE_ENC28J80
#define ENC28J80_PARAM_CS       GPIO9       /* ENC28J80 CS signal    */
#define ENC28J80_PARAM_INT      GPIO10      /* ENC28J80 INT signal   */
#define ENC28J80_PARAM_RESET    GPIO12      /* ENC28J80 RESET signal */
#endif

#endif

For other parameters, the default values defined by the drivers can be used.

@note

• Only a few GPIOs are available for external hardware on ESP-WROVER-KIT boards. Therefore, MRF24J40 and ENC28J60 based modules use the same GPIOs and only one of these modules can be used simultaneously.
• The RESET signal of MRF24J40 and ENC28J60 based modules can also be connected to the RST pin of the board (see \ref esp32_wrover_kit_pinout "pinout") to keep the configured GPIO free for other purposes.

Back to table of contents

Board Pinout {#esp32_wrover_kit_pinout}

The following picture shows the pinout of the ESP-WROVER-KIT V3 boards as defined by the default board configuration. The light green GPIOs are not used by configured on-board hardware components and can be used for any purpose. However, if optional off-board hardware modules are used, these GPIOs may also be occupied, see section \ref esp32_wrover_kit_board_configuration for more information.

The corresponding board schematic can be found here.

@image html "https://gitlab.com/gschorcht/RIOT.wiki-Images/raw/master/esp32/ESP-WROVER-KIT_V3_pinout.png" "ESP32-WROVER-KIT V3 Pinout"

Flashing the Device {#esp32_wrover_kit_flashing}

Flashing RIOT is quite straight forward. The board has a Micro-USB connector with reset/boot/flash logic. Just connect the board using the programming port to your host computer and type:

make flash BOARD=esp32-wrover-kit ...

The USB bridge is based on FDI FT2232HL and offers two USB interfaces:

• the first interface is the JTAG interface for On-Chip 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:

make flash BOARD=esp32-wrover-kit PORT=/dev/ttyUSB1 ...

For detailed information about ESP32 as well as configuring and compiling RIOT for ESP32 boards, see \ref esp32_riot.

Back to table of contents

On-Chip Debugging with the Device {#esp32_wrover_kit_debugging}

Since the USB bridge based on FDI FT2232HL provides a JTAG interface for debugging through an USB interface, using ESP-WROVER-Kit V3 is the easiest and most convenient way for On-Chip debugging. Please refer the ESP-IDF Programming Guide for details on how to setup and how to use ESP-WROVER-Kit V3 and OpenOCD.

To use the JTAG interface, the esp_jtag module has to be enabled for compilation.

USEMODULE=esp_jtag make flash BOARD=esp32-wrover-kit ...

To flash and debug using OpenOCD, the precompiled version of OpenOCD for ESP32 has to be installed using the install script while being in RIOT's root directory, see also section Using Local Toolchain Installation.

dist/tools/esptool/install.sh openocd

Before OpenOCD can then be used, the PATH variable has to be set correctly and the OPENOCD variable has to be exported using the following command.

. dist/tools/esptool/export.sh openocd

Once the PATH variable and the OPENOCD variable are set, OpenOCD can be used

• to flash the application using command
  Copy

  PROGRAMMER=openocd USEMODULE=esp_jtag make flash BOARD=esp32-wrover-kit ...
  

• to start a debugging session (the board will be reset, but not flashed) using command
  Copy

  PROGRAMMER=openocd USEMODULE=esp_jtag make debug BOARD=esp32-wrover-kit ...
  

by setting the PROGRAMMER variable to openocd.

@note Even if the JTAG interface is used for debugging, the ESP32 standard method for flashing with esptool.py can still be used. In that case, the flash target is made without setting the PROGRAMMER variable.

Back to table of contents

Other Documentation Resources {#esp32_wrover_kit_other-resources}

There is a comprehensive Getting Started Guide for the ESP-WROVER-KIT with a lot information about hardware configuration.