Espressif 32¶

CPU Frequency¶

See board_build.f_cpu option from Project Configuration File platformio.ini

[env:myenv]
; set frequency to 160MHz
board_build.f_cpu = 160000000L

FLASH Frequency¶

Please use board_build.f_flash option from Project Configuration File platformio.ini to change a value. Possible values:

• 40000000L (default)

• 80000000L

[env:myenv]
; set frequency to 80MHz
board_build.f_flash = 80000000L

FLASH Mode¶

Flash chip interface mode. This parameter is stored in the binary image header, along with the flash size and flash frequency. The ROM bootloader in the ESP chip uses the value of these parameters in order to know how to talk to the flash chip.

Please use board_build.flash_mode option from Project Configuration File platformio.ini to change a value. Possible values:

• qio

• qout

• dio

• dout

[env:myenv]
board_build.flash_mode = qio

Debug Level¶

Please use one of the next build_flags to change debug level. A build_flags option could be used only the one time per build environment. If you need to specify more flags, please separate them with a new line or space.

Actual information is available in Arduino for ESP32 Board Manifest. Please scroll to esp32.menu.DebugLevel section.

[env:myenv]
platform = ...
board = ...
framework = arduino

;;;;; Possible options ;;;;;;

; None
build_flags = -DCORE_DEBUG_LEVEL=0

; Error
build_flags = -DCORE_DEBUG_LEVEL=1

; Warn
build_flags = -DCORE_DEBUG_LEVEL=2

; Info
build_flags = -DCORE_DEBUG_LEVEL=3

; Debug
build_flags = -DCORE_DEBUG_LEVEL=4

; Verbose
build_flags = -DCORE_DEBUG_LEVEL=5

Upload Speed¶

You can set custom upload speed using upload_speed option from Project Configuration File platformio.ini

[env:myenv]
upload_speed = 9600

Enable C++ exceptions¶

Please add -D PIO_FRAMEWORK_ESP_IDF_ENABLE_EXCEPTIONS to build_flags of Project Configuration File platformio.ini to enable C++ exceptions for ESP-IDF.

See project example.

Partition Tables¶

You can create a custom partitions table (CSV) following ESP32 Partition Tables documentation. PlatformIO uses default partition tables depending on a framework type:

• “default.csv” for Arduino

• “partitions_singleapp.csv” for ESP-IDF

To override default table please use board_build.partitions option in Project Configuration File platformio.ini.

Examples:

; 1) A "partitions_custom.csv" in the root of project directory
[env:custom_table]
board_build.partitions = partitions_custom.csv

; 2) Switch between built-in tables
; https://github.com/espressif/arduino-esp32/tree/master/tools/partitions
; https://github.com/espressif/esp-idf/tree/master/components/partition_table
[env:custom_builtin_table]
board_build.partitions = no_ota.csv

Uploading files to file system SPIFFS¶

1. Initialize project platformio init (if you have not initialized yet)

2. Create data folder (it should be on the same level as src folder) and put files here. Also, you can specify own location for data_dir

3. Run buildfs or uploadfs target using platformio run --target command.

To upload SPIFFS image using OTA update please specify upload_port / --upload-port as IP address or mDNS host name (ending with the *.local).

Examples:

• SPIFFS for Arduino

• SPIFFS for ESP-IDF

Over-the-Air (OTA) update¶

Demo code for:

• Arduino

• ESP-IDF

There are 2 options how to upload firmware OTA:

• Directly specify platformio run --upload-port in command line

platformio run --target upload --upload-port IP_ADDRESS_HERE or mDNS_NAME.local

• Specify upload_port option in Project Configuration File platformio.ini

[env:myenv]
upload_port = IP_ADDRESS_HERE or mDNS_NAME.local

For example,

• platformio run -t upload --upload-port 192.168.0.255

• platformio run -t upload --upload-port myesp32.local

[env:myenv]
upload_flags = --port=3232

~/.platformio/packages/tool-espotapy/espota.py -h

Usage: espota.py [options]

Transmit image over the air to the esp32 module with OTA support.

Options:
  -h, --help            show this help message and exit

  Destination:
    -i ESP_IP, --ip=ESP_IP
                        ESP32 IP Address.
    -p ESP_PORT, --port=ESP_PORT
                        ESP32 ota Port. Default 3232

  Authentication:
    -a AUTH, --auth=AUTH
                        Set authentication password.

  Image:
    -f FILE, --file=FILE
                        Image file.
    -s, --spiffs        Use this option to transmit a SPIFFS image and do not
                        flash the module.

  Output:
    -d, --debug         Show debug output. And override loglevel with debug.
    -r, --progress      Show progress output. Does not work for ArduinoIDE

Using Arduino Framework with Staging version¶

PlatformIO will install the latest Arduino Core for ESP32 from https://github.com/espressif/arduino-esp32. The Git should be installed in a system. To update Arduino Core to the latest revision, please open PlatformIO IDE and navigate to PIO Home > Platforms > Updates.

1. Please install PlatformIO IDE

2. Initialize a new project, open Project Configuration File platformio.ini and set platform to https://github.com/platformio/platform-espressif32.git#feature/stage. For example,

   [env:esp32dev]
   platform = https://github.com/platformio/platform-espressif32.git#feature/stage
   board = esp32dev
   framework = arduino
   

3. Try to build project

4. If you see build errors, then try to build this project using the same stage with Arduino IDE

5. If it works with Arduino IDE but doesn’t work with PlatformIO, then please file new issue with attached information:

   • test project/files

   • detailed log of build process from Arduino IDE (please copy it from console to https://hastebin.com)

   • detailed log of build process from PlatformIO Build System (please copy it from console to https://hastebin.com)

Arduino Core Wiki¶

Tips, tricks and common problems: http://desire.giesecke.tk/index.php/2018/01/30/esp32-wiki-entries/

On-Board tools¶

Boards listed below have on-board debugging tools and ARE READY for debugging! You do not need to use/buy external debugger.

External tools¶

Boards listed below are compatible with PIO Unified Debugger but depend on external debugging tools. See “Debug” column for compatible debugging tools.

Stable¶

; Latest stable version
[env:latest_stable]
platform = espressif32
board = ...

; Custom stable version
[env:custom_stable]
platform = espressif32@x.y.z
board = ...

Upstream¶

[env:upstream_develop]
platform = https://github.com/platformio/platform-espressif32.git
board = ...

Adafruit¶

Aiyarafun¶

April Brother¶

DFRobot¶

DOIT¶

Dongsen Technology¶

DycodeX¶

ESP32vn¶

Electronic SweetPeas¶

Espressif¶

Heltec Automation¶

Hornbill¶

IntoRobot¶

M5Stack¶

MH-ET Live¶

MakerAsia¶

Microduino¶

NodeMCU¶

Noduino¶

OLIMEX¶

Onehorse¶

SparkFun Electronics¶

ThaiEasyElec¶

WEMOS¶

Widora¶

u-blox¶