The esp-idf-monitor is a Python-based, open-source package that is part of the ESP-IDF SDK for Espressif products.
The main responsibility of the IDF Monitor is serial communication input and output in ESP-IDF projects. More information about IDF Monitor can be found in IDF documentation.
esp-idf-monitor supports customizable menu keystrokes using a config file. For more information about setting up the config and supported options please follow IDF documentation.
Please follow these coding standards when writing code for esp-idf-monitor:
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-msgOn 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.
This repository utilizes an automatic spell checker integrated into the pre-commit process. If any spelling issues are detected, the recommended corrections will be applied automatically to the file, ready for commit. In the event of false positives, you can adjust the configuration in the pyproject.toml file under the [tool.codespell] section. To exclude files from the spell check, utilize the skip keyword followed by comma-separated paths to the files (wildcards are supported). Additionally, to exclude specific words from the spell check, employ the ignore-words-list keyword followed by comma-separated words to be skipped.
esp-idf-monitor complies with the Conventional Commits standard. Every commit message is checked with Conventional Precommit Linter, ensuring it adheres to the standard.
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.