Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

A minimal esp-hal application template for use with cargo-generate
https://github.com/esp-rs/esp-template

cargo-generate embedded esp32 rust

Last synced: 3 days ago
JSON representation

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

Awesome Lists containing this project

README 

        
# esp-template

[![CI](https://github.com/esp-rs/esp-template/actions/workflows/ci.yml/badge.svg)](https://github.com/esp-rs/esp-template/actions/workflows/ci.yml)

[![Container CI](https://github.com/esp-rs/esp-template/actions/workflows/ci_docker.yml/badge.svg)](https://github.com/esp-rs/esp-template/actions/workflows/ci_docker.yml)



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



To generate a project using this template:



```bash

cargo generate 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.

- `Configure advanced template options?`: If `false`, skips the rest of the prompts and uses their default value. If `true`, you will be prompted with:

  - `Enable allocations via the esp-alloc crate?`: Adds [`esp-alloc`] dependency, 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].

  - `Setup logging using the log crate?`: Adds [`log`] dependency and initializes logging.

  - `Configure project to use Dev Containers (VS Code and GitHub Codespaces)?`: Adds support for:

     -  [VS Code Dev Containers]

     -  [GitHub Codespaces]



   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 of the template, see [Understanding esp-template] chapter of [The Rust on ESP Book]. If you're seeking a beginner's guide for utilizing `no_std` (bare metal), consult the [Embedded Rust (no_std) on Espressif][no_std-training] training.



[cargo-generate]: https://github.com/cargo-generate/cargo-generate

[`esp-alloc`]: https://github.com/esp-rs/esp-alloc

[VS Code Dev Containers]: https://code.visualstudio.com/docs/remote/containers#_quick-start-open-an-existing-folder-in-a-container

[GitHub Codespaces]: https://docs.github.com/en/codespaces/developing-in-codespaces/creating-a-codespace

[Wokwi simulator]: https://wokwi.com/

[VS Code Wokwi extension]: https://marketplace.visualstudio.com/items?itemName=wokwi.wokwi-vscode

[web flash]: https://github.com/bjoernQ/esp-web-flash-server

[Understanding esp-template]: https://esp-rs.github.io/book/writing-your-own-application/generate-project/esp-template.html

[The Rust on ESP Book]: https://esp-rs.github.io/book/

[`log`]: https://docs.rs/log/latest/log/

[no_std-training]: https://esp-rs.github.io/no_std-training/



## License



Licensed under either of:



- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)



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.