One day, maybe, a collection of templates for creating applications using esp-hal.
Currently, a single opinionated template for creating applications using esp-hal and embassy. Compatible with all devices supported by esp-hal (i.e. the entire ESP32 line of chips).
It is assumed that Rust, and in turn cargo, are already installed on your system. If you have not yet installed Rust, please visit https://rustup.rs/ for installation instructions.
In order to use this template, you must first install cargo-generate and probe-rs:
cargo install cargo-generate probe-rs-tools
With the prerequisite tools installed, you can generate a project from the template:
cargo generate jessebraham/esp-hal-template embassy
After answering the prompts, you can cd into your new project's directory.
Make sure that you have connected the device you wish to flash using an interface which is compatible with probe-rs. For any devices which have the USB_SERIAL_JTAG peripheral (ESP32-C3/C6/H2/S3) then you can use this interface, usually labelled USB on the official devkits from Espressif. For chips without this peripheral (ESP32, ESP32-C2) you must use an external programmer such as an ESP-Prog in order to use probe-rs with that device.
Important
At the time of writing, probe-rs does not support flashing the original ESP32; with time this should change. All other devices can be flashed.
Finally, to build, flash, and execute your application on-device using probe-rs:
cargo run --release
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.