esp-generate

Template generation tool to create no_std applications targeting Espressif's line of SoCs and modules.

At present, this template supports the ESP32, ESP32-C2/C3/C6, ESP32-H2, and ESP32-S2/S3. Support for additional devices will be added as they become available.

Quickstart

To generate a project using this template:

1. Install esp-generate:

cargo install esp-generate --locked

You can also directly download pre-compiled release binaries or use cargo-binstall.

2. Generate a project. There are two options:

   1. Using the Terminal User Interface (TUI):

      esp-generate
      

      You will be prompted to select a target chip and name for your project, after which you would use TUI to select the other options you need for your project.

   2. Using the Command Line Interface (CLI), adding the options to the esp-generate command:

      esp-generate --chip esp32 -o alloc -o wifi your-project
      

      Use the --headless flag to avoid using the TUI.

      Replace the chip and project name accordingly, and select the desired options using the -o/--option flag. Use the esp-generate list-options command to see a list of available options. Use esp-generate explain <option> to get a detailed explanation of an option.

License

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.

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.