The ESP32 firmware can be compiled in multiple variations to be used on different devices:
First, PlatformIO and Node.js have to be installed according to their installation manuals. For PlatformIO we recommend using the PlatformIO IDE extension for Visual Studio Code, but you can also use PlatformIO Core instead.
In general you should always use the latest version of PlatformIO and Node.js.
For the Node.js package manager
npm version 8 or newer is required.
For Windows the Silicon Labs CP210x Universal Windows Driver has to be installed. Linux and macOS have this driver already build in.
platformio.ini file is located in the
software/ directory. Make sure
to open the
software/ directory in Visual Studio Code as the PlatformIO
project directory and build the
to prepare the build of other environments. In general this has to be done only
once and not before every build of other environments
Choose the PlatformIO environment corresponding to the firmware variation you want to build:
To build a specific firmware run its corresponding PlatformIO "Build" task. To build a firmware, upload it to a Brick and connect to its serial console all in one step you can run the PlatformIO "Upload and Monitor" task. This requires that the Brick is connected to USB beforehand.
The functionality and the web interface of the firmware are put together from
modules. The variations of the firmware differ mostly in their list of active
modules. This list is specified per environment in the corresponding
file using the
The tutorial regarding the ESP32 firmware shows step by step how to add a custom module to the firmware.