{"id":13612474,"url":"https://github.com/esp-rs/esp-template","last_synced_at":"2025-04-13T11:32:23.316Z","repository":{"id":39634538,"uuid":"467630957","full_name":"esp-rs/esp-template","owner":"esp-rs","description":"A minimal esp-hal application template for use with cargo-generate","archived":false,"fork":false,"pushed_at":"2024-10-24T09:01:00.000Z","size":126,"stargazers_count":146,"open_issues_count":9,"forks_count":29,"subscribers_count":11,"default_branch":"main","last_synced_at":"2024-11-07T20:42:18.633Z","etag":null,"topics":["cargo-generate","embedded","esp32","rust"],"latest_commit_sha":null,"homepage":"","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/esp-rs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-08T18:29:35.000Z","updated_at":"2024-11-04T21:05:27.000Z","dependencies_parsed_at":"2023-01-28T09:45:16.276Z","dependency_job_id":"1f2ccd40-e13e-465c-a741-29af47a39184","html_url":"https://github.com/esp-rs/esp-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esp-rs%2Fesp-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esp-rs%2Fesp-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esp-rs%2Fesp-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/esp-rs%2Fesp-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/esp-rs","download_url":"https://codeload.github.com/esp-rs/esp-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248705842,"owners_count":21148604,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cargo-generate","embedded","esp32","rust"],"created_at":"2024-08-01T20:00:30.472Z","updated_at":"2025-04-13T11:32:18.300Z","avatar_url":"https://github.com/esp-rs.png","language":"Dockerfile","funding_links":[],"categories":["Templates"],"sub_categories":[],"readme":"# esp-template\n[![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)\n[![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)\n\nA 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.\n\nTo generate a project using this template:\n\n```bash\ncargo generate esp-rs/esp-template\n```\n\nAfter running the command, there will be a few prompts:\n- `Project Name`: Name of the crate.\n- `Which MCU to target?`: SoC model.\n- `Configure advanced template options?`: If `false`, skips the rest of the prompts and uses their default value. If `true`, you will be prompted with:\n  - `Enable allocations via the esp-alloc crate?`: Adds [`esp-alloc`] dependency, and initializes the heap.\n  - `Configure project to support Wokwi simulation with Wokwi VS Code extension?`: Adds support for Wokwi simulation using [VS Code Wokwi extension].\n  - `Setup logging using the log crate?`: Adds [`log`] dependency and initializes logging.\n  - `Configure project to use Dev Containers (VS Code and GitHub Codespaces)?`: Adds support for:\n     -  [VS Code Dev Containers]\n     -  [GitHub Codespaces]\n\n   Dev Containers also allow flashing from the container using [web flash] and have the [VS Code Wokwi extension] already installed.\n\nFor 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.\n\n[cargo-generate]: https://github.com/cargo-generate/cargo-generate\n[`esp-alloc`]: https://github.com/esp-rs/esp-alloc\n[VS Code Dev Containers]: https://code.visualstudio.com/docs/remote/containers#_quick-start-open-an-existing-folder-in-a-container\n[GitHub Codespaces]: https://docs.github.com/en/codespaces/developing-in-codespaces/creating-a-codespace\n[Wokwi simulator]: https://wokwi.com/\n[VS Code Wokwi extension]: https://marketplace.visualstudio.com/items?itemName=wokwi.wokwi-vscode\n[web flash]: https://github.com/bjoernQ/esp-web-flash-server\n[Understanding esp-template]: https://esp-rs.github.io/book/writing-your-own-application/generate-project/esp-template.html\n[The Rust on ESP Book]: https://esp-rs.github.io/book/\n[`log`]: https://docs.rs/log/latest/log/\n[no_std-training]: https://esp-rs.github.io/no_std-training/\n\n## License\n\nLicensed under either of:\n\n- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)\n- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)\n\nat your option.\n\n### Contribution\n\nUnless you explicitly state otherwise, any contribution intentionally submitted for inclusion in\nthe work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without\nany additional terms or conditions.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fesp-rs%2Fesp-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fesp-rs%2Fesp-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fesp-rs%2Fesp-template/lists"}