IoT Controller

Project configuration

Install ESP toolchain and SDK

./setup.sh

Activate Python virtualenv and install required packages. Python 3 is required:

virtualenv venv
source venv/bin/activate
python -m pip install  -r $IDF_PATH/requirements.txt

To deactivate Python virtualenv run deactivate

NOTE: Python virtualenv MUST be activated with source venv/bin/activate each time before using make

Development

Cloning the project and submodules:

git clone --recurse-submodules https://github.com/vi7/iot-controller.git

Updating submodules:

git submodule update --init --recursive
# OR if changes already fetched and visible in the status:
git submodule update --remote

Working on a submodule:

# update local submodule branch by rebasing:
git submodule update --remote --rebase

Activate Python virtualenv with source venv/bin/activate

Compile project: make all

Compile and flash: make flash

Viewing serial output: make monitor

Serial monitor hotkeys: Quit: Ctrl+] | Menu: Ctrl+T | Help: Ctrl+T followed by Ctrl+H

Build just the app: make app

Flash just the app: make app-flash - will automatically rebuild the app if it needs it

Speed up build with compiling multiple files in parallel: make -jN app-flash - where N is the number of parallel make processes to run (generally N should be equal to or one more than the number of CPU cores in your system.)

Erase the entire flash: make erase_flash

Make targets could be combined in one run