idf-install

Installs the idf toolchain for esp32 developement, targetting platformio


Keywords
template-python-cmd
License
BSD-1-Clause
Install
pip install idf-install==1.0.5

Documentation

idf-install

The missing installer for idf-installer for esp32 development. Run idf-install and an environment will be installed and files will be dropped to enter into the environment.

Linting

MacOS_Tests Ubuntu_Tests Win_Tests

MacOS Install Test Ubuntu Install Test Windows Install Test

Install idf-install toolset

Install the installer tool

pip install .

Then run the installer

idf-install

After that, run the idf_activate command to enter into the environment

Windows:

idf_activate.bat

Linux/MacOS

. ./idf_activate.sh

Then after this you are going to initialize the project

idf.py create-project myproject

Now cd into the directory and build it

cd myproject
idf.py build

Now you can flash the device

idf.py flash
# or idf.py -p (PORT) flash

And now you can monitor the device with

idf.py -p (PORT) monitor

Develop

To develop software, run . ./activate.sh

Windows

This environment requires you to use git-bash.

Linting

Run ./lint.sh to find linting errors using pylint, flake8 and mypy.

Versions

  • 1.0.5: Update readme.
  • 1.0.4: First release candidate of the project. See readme for details on using this.