GithubHelp home page GithubHelp logo

esp-idf-monitor's Introduction

Espressif IDF Monitor

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.

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.

Contributing

Code Style & Static Analysis

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

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-monitor 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 or later. See the accompanying LICENSE file for a copy.

esp-idf-monitor's People

Contributors

dobairoland avatar peterdragun avatar projectgus avatar igrr avatar sio13 avatar hfudev avatar ginkgm avatar esp-marius avatar nomis avatar nonoo avatar alekseiapa avatar shubhamdp avatar krzychb avatar jakub-kocka avatar 0xjakob avatar daiziyan0225 avatar antmak avatar radimkarnis avatar suda-morris avatar alisitsyn avatar skywxfang avatar songruo avatar kumekay avatar rousveiga avatar renzbagaporo avatar possan avatar nlantau avatar natashali-espressif avatar mahavirj avatar chanibal avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.