espforge 0.1.15

A scaffolding++ project generator for ESP32 projects
Documentation

Espforge

A scaffolding++ tool for esp32 no_std rust projects.

Features

  • Uses esphome-like YAML configuration
  • Pre-built components and devices that sit on top of esphal https://github.com/esp-rs/esp-hal
  • Wire "app" code in rust.
  • Wokwi integration and working examples
  • Project samples

Prerequisites

Rust: Install Rust

ESP machinery(can always use cargo install if needed):

cargo install cargo-binstall
cargo binstall espup
espup install
cargo binstall esp-generate

Installation

cargo binstall espforge

ALternatively

cargo install espforge

Geting started

Run

espforge examples

Pick a category eg 01.Basics, then pick an example, eg. blink

This will create a generated folder with artifacts that include a blink.yaml

In that folder, run

espforge compile blink.yaml

This creates a rust project in-place alongside the artifacts created in the previous step.

Finally:

cargo build

Updating yaml file

When the yaml file is updated, simply run:

espforge compile blink.yaml
cargo build

Building from source

cargo build -p espforge

Wokwi

If using VSCode, enable wokwi extension, then double-click on diagram.json

Projects

in the espforge_projects folder

  1. using mousefood/ratatui with ili9341 to create a menu

License

MIT