Espressif Systems ESP User Manual

Table of contents
Table of contents i
1 Instruction 3
1.1 Question search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.1 Question Search Techniques . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.2 Question Classi󰝘cation Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2 Document contribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2.1 Commit process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2.2 Create a new branch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2.3 Branch naming conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.2.4 Q&A Guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.2.5 Local build environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
1.2.6 Commit message standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
1.2.7 Submit a merge request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2 Development environment 9
2.1 IDE plugins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.1.1 How to add ESP32 development board on Arduino IDE? . . . . . . . . . . . . . . . . . . 9
2.1.2 When using the Arduino IDE development platform, how to read the MAC address of the
Wi-Fi that comes with ESP32? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.1.3 How to use the 󰝙ash download tool to 󰝙ash the bin 󰝘le generated by Arduino to ESP32? . 9
2.2 Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.2.1 What is the serial port name of ESP devices？ . . . . . . . . . . . . . . . . . . . . . . . 10
2.2.2 How to block debugging messages sent through UART0 by default in ESP32? . . . . . . . 10
2.2.3 How to modify the default method of RF calibration in ESP32? . . . . . . . . . . . . . . 10
2.2.4 How to modify the default method of RF calibration in ESP8266? . . . . . . . . . . . . . 10
2.2.5 How to troubleshoot in ESP32 Boot mode？ . . . . . . . . . . . . . . . . . . . . . . . . 11
2.2.6 When debugging with ESP32 JLINK, an ERROR occurs as: No Symbols For Freertos.
How can I resolve such issue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.2.7 How to monitor the free space of the task stack? . . . . . . . . . . . . . . . . . . . . . . 11
2.2.8 Is it possible to use JTAG to debug with ESP32-S2？ . . . . . . . . . . . . . . . . . . . 11
2.2.9 How to modify the log output without changing the output level of menucon󰝘g？ . . . . . 11
2.2.10 ESP8266 enters boot mode (2,7) and hits a watchdog reset. What could be wrong? . . . . 12
2.2.11 When using the ESP-WROVER-KIT board with OpenOCD, an error occurred as: Can’t
󰝘nd board/esp32-wrover-kit-3.3v.cfg. How can I resolve such issue? . . . . . . . . . . . . 12
2.2.12 The RTC_watch_dog keeps resetting during ESP32 SPI boot. What could be the reason? . 12
2.2.13 How to obtain and parse coredump with ESP32? . . . . . . . . . . . . . . . . . . . . . . 12
2.2.14 How to do RF performance test with ESP32, ESP8266, and ESP32S2? . . . . . . . . . . 13
2.2.15 My PC cannot recognize the device connected in Win10 system. What could be the reason? 13
2.2.16 One error occurred with ESP32 as: Core 1 paniced (Cache disabled but cache memory
region accessed). What could be the reason? . . . . . . . . . . . . . . . . . . . . . . . . 13
2.2.17 How to read the 󰝙ash model information of the modules? . . . . . . . . . . . . . . . . . 13
2.2.18 When debugging the Ethernet Example in ESP-IDF, the following exception log appears.
How can I resolve such issue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.2.19 I found a “Brownout detector was triggered”failure on my ESP32. How to resolve such
issue? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
i

Espressif Systems ESP Specifications

General

Brand	Espressif Systems
Model	ESP
Category	Motherboard
Language	English