Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

For blazing-fast dependency installation, use the Nix package manager. If you already have Nix, skip to the Nix Way section.

Clone the SDK repository first.

git clone https://github.com/akagi-dev/rohi-sdk && cd rohi-sdk

Prerequisites

Rust & Cargo

Use the rustup.rs script for a quick Rust compiler installation.

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

The required toolchain, components and both RISC-V targets (riscv32imc-unknown-none-elf for the ESP32-C3 and riscv32imac-unknown-none-elf for the ESP32-C6) are listed in rust-toolchain.toml. Run rustup inside the repository to install them (add rustup to your PATH if you’ve just installed it).

rustup toolchain install

Espflash

This tool is required for flashing ESP hardware. The SDK prepares the firmware and launches the flashing process, but the espflash binary must be available in your PATH. For setup details, see the official installation instructions.

Nix Way

The repository is a Nix flake. The development shell provides the pinned Rust toolchain, espflash, mdbook and the linker, nothing else has to be installed.

nix develop

Verify the installation

Build and test the SDK as described in Build and test: cargo test on the host, and cargo check-esp32c3 / cargo check-esp32c6 for the two chips. Documentation tooling (mdbook, link check) is covered in Documentation style and policy; the Nix shell provides it.