| layout | title | permalink | breadcrumb | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
default |
Build firmware from source |
/make/esp32/firmware_build |
|
When the AirMeter.io firmware is built for the ESP32 platform it uses the latest v4.4 ESP32 IDF SDK.
Espressif provide a Windows package which ensures all the required components are installed. This is the simplest way to setup a Windows build environment, the install can be found at https://dl.espressif.com/dl/esp-idf/?idf=4.4. Install the v4.4 sdk.
More in depth instructions and other installation methods can be found at https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/windows-setup.html.
The remaining instructions in this document assume that the "ESP-IDF CMD" link on the start menu is being used as the CLI to enter commands.
Follow the instructions at https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/ and ensure that the user environment is set up correctly.
The remaining instructions in this document assume that the users shell has the appropriate environment variables set and the IDF v4.4 SDK checked out.
Clone the repository & change into the directory.
git clone https://github.com/airmeter-io/AirMeter.IO.Firmware.git
cd AirMeter.IO.Firmware
Initialise the GIT Submodules.
git submodule init
git submodule update
Copy the ESP32 SDK config files to the project root director.
On Linux type:-
cp boards/esp32-idf/sdkconfig* .
On Windows type:-
copy boards\esp32-idf\sdkconfig*.* .
Type the following to build the project.
idf.py build
On Linux type:
idf.py flash /dev/ttsyusb0
Replace /dev/ttsyusb0 with the com port device exposed by the ESP32-WROOM32 board.
On Windows type:
idf.py flash COM4
Replace COM4 with the correct COM port exposed by the ESP32-WROOM32 board.