# Espressif IDF Monitor
The ```esp-idf-monitor``` is a Python-based, open-source package that is part of the [ESP-IDF](https://github.com/espressif/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](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-monitor.html).
## Customizable Config
```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](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-monitor.html#configuration-file).
## Contributing
### Code Style & Static Analysis
Please follow these coding standards when writing code for ``esp-idf-monitor``:
#### Pre-commit checks
[pre-commit](https://pre-commit.com/) 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:
```sh
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-monitor`` complies with the [Conventional Commits standard](https://www.conventionalcommits.org/en/v1.0.0/#specification). Every commit message is checked with [Conventional Precommit Linter](https://github.com/espressif/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 or later. See the accompanying [LICENSE file](https://github.com/espressif/esp-idf-monitor/blob/master/LICENSE) for a copy.
Raw data
{
"_id": null,
"home_page": "",
"name": "esp-idf-monitor",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "espressif,embedded,monitor,serial",
"author": "Espressif Systems",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/c9/d3/4c1c803abeabeee782e993335d41b1dc9ce2608b6824152b590eaad510c4/esp-idf-monitor-1.4.0.tar.gz",
"platform": null,
"description": "# Espressif IDF Monitor\n\nThe ```esp-idf-monitor``` is a Python-based, open-source package that is part of the [ESP-IDF](https://github.com/espressif/esp-idf) SDK for Espressif products.\n\nThe 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](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-monitor.html).\n\n## Customizable Config\n\n```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](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/tools/idf-monitor.html#configuration-file).\n\n## Contributing\n\n### Code Style & Static Analysis\n\nPlease follow these coding standards when writing code for ``esp-idf-monitor``:\n\n#### Pre-commit checks\n\n[pre-commit](https://pre-commit.com/) is a framework for managing pre-commit hooks. These hooks help to identify simple issues before committing code for review.\n\nTo use the tool, first install ``pre-commit``. Then enable the ``pre-commit`` and ``commit-msg`` git hooks:\n\n```sh\npython -m pip install pre-commit\npre-commit install -t pre-commit -t commit-msg\n```\n\nOn 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.\n\n\n#### Conventional Commits\n\n``esp-idf-monitor`` complies with the [Conventional Commits standard](https://www.conventionalcommits.org/en/v1.0.0/#specification). Every commit message is checked with [Conventional Precommit Linter](https://github.com/espressif/conventional-precommit-linter), ensuring it adheres to the standard.\n\n\n## License\n\nThis document and the attached source code are released as Free Software under Apache License Version 2 or later. See the accompanying [LICENSE file](https://github.com/espressif/esp-idf-monitor/blob/master/LICENSE) for a copy.\n",
"bugtrack_url": null,
"license": "",
"summary": "Serial monitor for esp-idf",
"version": "1.4.0",
"project_urls": {
"Homepage": "https://github.com/espressif/esp-idf-monitor"
},
"split_keywords": [
"espressif",
"embedded",
"monitor",
"serial"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b5ecb7a9f5200fcafc972f3695f396d029110e48ecdfa6da6df0ec55a51671e6",
"md5": "5ab6e5ac74e6ae6e8a0d48f00c62da7a",
"sha256": "5b6e892359b72cb1e6a3912329b16e90f7e6c7112ac3cd01df30ddf30ed76855"
},
"downloads": -1,
"filename": "esp_idf_monitor-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5ab6e5ac74e6ae6e8a0d48f00c62da7a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 44224,
"upload_time": "2024-01-31T11:30:10",
"upload_time_iso_8601": "2024-01-31T11:30:10.807690Z",
"url": "https://files.pythonhosted.org/packages/b5/ec/b7a9f5200fcafc972f3695f396d029110e48ecdfa6da6df0ec55a51671e6/esp_idf_monitor-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c9d34c1c803abeabeee782e993335d41b1dc9ce2608b6824152b590eaad510c4",
"md5": "db465a29c9cfb0744f98acb338066298",
"sha256": "09a5ff780d7a7f82c153a9d4c2b22b9e5470dacec219ecce96b1c3ddda4ff289"
},
"downloads": -1,
"filename": "esp-idf-monitor-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "db465a29c9cfb0744f98acb338066298",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 34352,
"upload_time": "2024-01-31T11:30:12",
"upload_time_iso_8601": "2024-01-31T11:30:12.725525Z",
"url": "https://files.pythonhosted.org/packages/c9/d3/4c1c803abeabeee782e993335d41b1dc9ce2608b6824152b590eaad510c4/esp-idf-monitor-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-31 11:30:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "espressif",
"github_project": "esp-idf-monitor",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "esp-idf-monitor"
}
JSON
