A minimalist template for use with cargo-generate to create no_std applications targeting Espressif's line of SoCs and modules. At present, this template supports the ESP32, ESP32-C2, ESP32-C3,ESP32-C6, ESP32-S2, and ESP32-S3; additional devices will be added as they become available.
To generate a project using this template:
cargo generate -a many-branches/espflashbridge-templateAfter running the command, there will be a few prompts:
-
Project Name: Name of the crate. -
Which MCU to target?: SoC model. -
Use template default values?: Skips the rest of the prompts and uses their default value. If false, you will be prompted with:Enable allocations via the esp-alloc crate?: Addsesp-allocdependency, and initializes the heap.Configure project to support Wokwi simulation with Wokwi VS Code extension?: Adds support for Wokwi simulation using VS Code Wokwi extension.Configure project to use Dev Containers (VS Code and GitHub Codespaces)?: Adds support for:
Dev Containers also allow flashing from the container using web flash and have the VS Code Wokwi extension already installed.
For a more detailed explanation about the template, see Understanding esp-template chapter of The Rust on ESP Book.
This fork of espflash-template provides additional utilities for flashing your device from a container. These utilities were originally added with the intent of facilitating containerized development on Apple Silicon hosts as serial port forwarding is not yet feasible on these machines.
Utilities are provided to flash by running ssh -t to connect to the host and run a command. These utilities require remote access to be enabled on the host. This template makes no provisions to facilitate enabling or securing said access.
If you are working out of VsCode devcontainers, you can simply run cargo run as before.
| Platform | Guidelines |
|---|---|
| macos | Ensure you've granted full disk access: https://superuser.com/questions/1615072/getting-an-operation-not-permitted-error-when-running-commands-after-to-sshing . You may also need to add Remote Management permissions. |
On the host, start the server with ./scripts/serve-flashbridge.sh. In the container, to flash using the server, run FLASH_MODE=server ./scripts/flashbridge.sh <path-to-binary> <serial-port>.
Licensed under either of:
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.