ESP Exception Decoder

ESP Exception Decoder helps you understand crash stack traces and backtraces from ESP8266 and ESP32 boards.

• VS Code (recommended): Runs as a Visual Studio Code extension and integrates with BoardLab.
• Arduino IDE 2.2.x (deprecated): Older 1.x versions still work when installed manually as a VSIX.

[!NOTE] Arduino IDE 2.2.x support is deprecated.

Starting with version 2.x, ESP Exception Decoder targets Visual Studio Code and requires BoardLab.

Arduino IDE 2.2.x users must stay on the 1.x release line and install the extension manually as a VSIX.

This extension uses the TraceBreaker CLI internally. This project is inspired by the original Java-based ESP8266/ESP32 Exception Stack Trace Decoder. The RISC-V decoder implementation originates from the esp_idf_monitor.

Usage

1. Compile the sketch.

2. Upload the sketch to the ESP8266/ESP32 board.

3. Open the Monitor and wait for an exception.

4. When an exception occurs, open the ESP Exception Decoder terminal:

   • Open the Command Palette using Ctrl/⌘+Shift+P.
   • Run ESP Exception Decoder: Show Decoder Terminal.

5. Paste the exception stack trace or backtrace into the decoder terminal.

   ⓘ For more details on copying and pasting in the terminal, see the VS Code documentation: https://code.visualstudio.com/docs/terminal/basics#copy-paste

Installation

VS Code

Install from the Visual Studio Code Marketplace.

• ESP Exception Decoder: https://marketplace.visualstudio.com/items?itemName=dankeboy36.esp-exception-decoder

Arduino IDE 2.2.x (deprecated, 1.x only)

[!WARNING] Arduino IDE 2.2.x is deprecated for this project.

Version 2.x and newer will not run in Arduino IDE 2.2.x and may prevent the IDE from starting correctly.

Arduino IDE does not install VS Code Marketplace extensions automatically. To use this decoder in Arduino IDE 2.2.x, you must manually install a 1.x VSIX.

1. Download the latest compatible 1.x extension from the GitHub release page. The filename should be esp-exception-decoder-${VERSION}.vsix, where ${VERSION} is the latest compatible 1.x version.
2. Make sure the Arduino IDE is not running. Then, copy the downloaded extension into the plugins folder located in the Arduino IDE's configuration directory. If the plugins folder does not exist, create it.
   • On Windows, it's under %UserProfile%\.arduinoIDE\plugins (typically C:\Users\<username>\.arduinoIDE\plugins where <username> is your Windows username).
   • On Linux and macOS, it's under ~/.arduinoIDE/plugins.

     ⓘ If you encounter issues, refer to the Installation section of the documentation for Arduino IDE 3rd party themes. The steps are very similar.

For detailed usage instructions specific to Arduino IDE 2.2.x, refer to the original documentation for the last compatible release:

• Usage guide (1.x): https://github.com/dankeboy36/esp-exception-decoder/tree/1.1.1?tab=readme-ov-file#usage
• Update guide (1.x): https://github.com/dankeboy36/esp-exception-decoder/tree/1.1.1?tab=readme-ov-file#update

Development

1. Install the dependencies:

   npm i
   

2. Build the extension:

   npm run compile
   

   ⓘ Use npm run package to bundle the VSIX for production.

3. Test the extension:

   npm run test
   

Acknowledgments

• Special thanks to @per1234 for his dedication to open-source contributions.
• Thanks to @me-no-dev for the original implementation.