Firmware images are automatically build by GitHub actions. They can be downloaded from the releases page and flashed from your browser. The setup described below is only needed for local development.
For local development, you need a Rust toolchain. If your OS doesn't already provide it, easiest way to install and manage Rust toolchains is to use rustup. Alternatively, you can run Rust using the official Docker image rust:1.
To flash the firmware to a device, the espflash tool can be used. It integrates well with the Rust build tools and can be installed with cargo install espflash cargo-espflash.
Use Rust's build tool cargo to build the firmware:
cargo build --releaseTo flash the firmware to a device, connect the device via its USB-C serial port and use espflash:
cargo espflash flash --releaseConfiguration is stored in a separate flash partition and is therefore unaffected by firmware updates. As there is currently no way to change the configuration at runtime, it needs to be flashed to the device manually (once).
Create a custom configuration, e.g. config.json. See config-example.json for available settings. Keep it as small as possible, either by removing all comments and whitespace manually or by using the jq tool:
jq -c < config.json > config.min.jsonStore the minimized configuration to the device's config partition at 0xc000 using espflash:
espflash write-bin 0xc000 config.min.jsonIf you implement changes or features that can be useful for everyone, please fork this repository and open a pull request. Make sure to also update documentation and code comments accordingly and add a high level description of your changes to the changelog. Also make sure that all CI jobs are passing and ideally try flashing and using the firmware image artifact to verify its behaviour.