Skip to content

A minimal esp-hal application template for use with cargo-generate

License

Notifications You must be signed in to change notification settings

sethp/esp-template

 
 

Repository files navigation

esp-template

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-C3, ESP32-S2, and ESP32-S3; additional devices will be added as they become available.

To generate a project using this template:

cargo generate https://github.com/esp-rs/esp-template

After running the command, there will be a few prompts:

  • Project Name: Name of the crate.

  • Which MCU to target?: SoC model.

  • Enable allocations via the esp-alloc crate?: Adds esp-alloc dependency, and initializes the heap.

  • Configure project to use Dev Containers (VS Code, GitHub Codespaces and Gitpod)?: Adds support for:

    Dev Containers also have integration with Wokwi simulator and allow flashing from the container using web flash.

For a more detailed explanation about the template see Understanding esp-template chapter of The Rust on ESP Book.

License

Licensed under either of:

at your option.

Contribution

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.

About

A minimal esp-hal application template for use with cargo-generate

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 38.5%
  • Rust 33.6%
  • Dockerfile 27.9%