uferris-bsp 0.1.2

A Board Support Package for the uFerris Learner Board
Documentation

crates.io docs.rs

uFerris is a Rust embedded learning/experimentation kit that can accept various Seeed Studio Xiao controllers.

The uferris-bsp crate provides a generic Board Support Package that aims to be mostly MCU-agnostic, allowing the same high-level board API to work across different supported Xiao controllers (ESP32-C3, RP2040, etc.).

Controller-specific support is enabled via feature flags.

Architecture Overview

The crate adopts the following layered approach:

The architechture adds two layers on top of existing community crates:

  • uFerris Board Logic Layer: This layer implments the hardware-agnostic uFerris board API.
  • uFerris Board Adapter Layer: This layer maps the generic logic to concrete MCU HALs (uses embedded-hal traits where possible).

async Support

Although there is an embassy feature flag, async support is not implemented for all devices. Adding async support would require implementing async versions of the main board methods (most likely using embedded-hal-async traits).

Support Status

Controller Feature flag Support Status async Support
Xiao ESP32-C3 xiao-esp32c3 ✅ ❌
Xiao ESP32-C5 - ❌ ❌
Xiao ESP32-C6 - ❌ ❌
Xiao ESP32-S3 - ❌ ❌
Xiao ESP32-S3 Sense - ❌ ❌
Xiao nRF52840 - ❌ ❌
Xiao nRF52840 Sense - ❌ ❌
Xiao nRF54L15 - ❌ ❌
Xiao nRF54L15 Sense - ❌ ❌
Xiao RP2350 - ❌ ❌
Xiao RP2040 - ❌ ❌
Xiao SAMD21 - ❌ ❌
Xiao RA4M1 - ❌ ❌
Xiao MG24 - ❌ ❌
Xiao MG24 Sense - ❌ ❌

Adding Support for a New Xiao Controller

Adding support for a new Xiao board entails two parts:

  1. Adding a Device Feature Flag in Cargo.toml: A feature flag that imports the new device HAL needs to be added.
  2. Adding a Device Board Adapter: This entails adding a new board definition (adapter layer) under the crate boards/ folder.

The rest of the crate files should not need to change.

Feature Flags

Available Cargo features:

  • xiao-esp32c3 — Xiao ESP32-C3 Device Support
  • powerboard — uFerris Megalops Power Board Extension Support
  • embassy — embassy Support Feature Flag

Quick Start / Usage

Generally, you need to:

  • Enable the correct feature flags in your Cargo.toml
  • Pass the correct HAL peripherals struct to uferris_init()

Everything else should stay the same regardless of which Xiao is mounted. A simple example is presented below.

#![no_std]
#![no_main]

use uferris_bsp::uferris_init;

#[entry]
fn main() -> ! {
    // 1. Get your HAL peripherals (depends on MCU)
    let peripherals = your_hal::take().unwrap();

    // 2. Initialize the uFerris board abstraction
    let mut uferris = uferris_init(peripherals).unwrap();

    // 3. Use the board API
    uferris.led1_on();

    loop {}
}

License

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

Made with 🦀