esp-idf-panic-decoder

ESP IDF panic decoder

The esp-idf-panic-decoder is a Python-based, open-source package that is part of the ESP-IDF SDK for Espressif products.

The main part is a script that parses ESP-IDF panic handler output (registers & stack dump), and then acts as a GDB server over stdin/stdout, presenting the information from the panic handler to GDB. This allows for generating backtraces out of raw stack dumps on architectures where backtracing on the target side is not possible.

Contributing

Code Style & Static Analysis

Please follow these coding standards when writing code for esp-idf-panic-decoder:

Pre-commit checks

pre-commit is a framework for managing pre-commit hooks. These hooks help to identify simple issues before committing code for review.

To use the tool, first install pre-commit. Then enable the pre-commit and commit-msg git hooks:

python -m pip install pre-commit
pre-commit install -t pre-commit -t commit-msg

On the first commit pre-commit will install the hooks, subsequent checks will be significantly faster. If an error is found an appropriate error message will be displayed.

Conventional Commits

esp-idf-panic-decoder complies with the Conventional Commits standard. Every commit message is checked with Conventional Precommit Linter, ensuring it adheres to the standard.

License

This document and the attached source code are released as Free Software under Apache License Version 2. See the accompanying LICENSE file for a copy.