swaits
1c93b77d0b
- Added embedded-hal 1.0 as direct dep (already transitive via embedded-hal-async) - SimpleLed<P: OutputPin> now generic over any HAL — single definition in driver/ - Removed duplicate SimpleLed from board/esp32s3.rs and board/wio_tracker_l1.rs - Changed BoardParts.led from Option<L> to L — boards with no LED use () - Display task calls led.set_rgb() unconditionally (no-op for () boards) - RAK board: led: () instead of led: None
62 lines
2.0 KiB
Rust
62 lines
2.0 KiB
Rust
//! Board abstraction trait.
|
|
//!
|
|
//! Every board must implement [`LoRaBoard`] with concrete associated types
|
|
//! for its radio, host communication, display, and LED peripherals. The
|
|
//! compiler enforces completeness — missing types or methods are compile errors.
|
|
//!
|
|
//! See `src/board/PORTING.md` for a step-by-step guide to adding a new board.
|
|
|
|
use embedded_graphics::draw_target::DrawTarget;
|
|
use embedded_graphics::pixelcolor::BinaryColor;
|
|
|
|
/// Async RGB LED control. Boards without an LED use `()` which is a no-op.
|
|
pub trait RgbLed {
|
|
fn set_rgb(&mut self, r: u8, g: u8, b: u8) -> impl core::future::Future<Output = ()>;
|
|
}
|
|
|
|
impl RgbLed for () {
|
|
async fn set_rgb(&mut self, _r: u8, _g: u8, _b: u8) {}
|
|
}
|
|
|
|
/// Compile-time contract for a DongLoRa board.
|
|
pub trait LoRaBoard: Sized {
|
|
/// Human-readable board name (shown on display splash screen).
|
|
const NAME: &'static str;
|
|
|
|
/// TX power range in dBm (min, max) for this board's radio + PA.
|
|
const TX_POWER_RANGE: (i8, i8);
|
|
|
|
/// Radio peripheral bundle (driver + delay).
|
|
type RadioParts;
|
|
|
|
/// Host communication peripheral bundle (USB or UART driver).
|
|
type CommParts;
|
|
|
|
/// Display peripheral bundle (I2C bus for display init).
|
|
type DisplayParts;
|
|
|
|
/// Concrete display driver type (must implement DrawTarget for rendering).
|
|
type DisplayDriver: DrawTarget<Color = BinaryColor>;
|
|
|
|
/// RGB LED driver. Boards without an LED use `()`.
|
|
type LedDriver: RgbLed;
|
|
|
|
/// Initialize the board hardware.
|
|
fn init() -> Self;
|
|
|
|
/// Read the board's unique hardware address (MAC, device ID, etc.).
|
|
fn mac_address() -> [u8; 6];
|
|
|
|
/// Decompose initialized board into peripheral bundles for each task.
|
|
fn into_parts(self) -> BoardParts<Self::RadioParts, Self::CommParts, Self::DisplayParts, Self::LedDriver>;
|
|
}
|
|
|
|
/// Peripheral bundles for each firmware task, produced by [`LoRaBoard::into_parts`].
|
|
pub struct BoardParts<R, C, D, L> {
|
|
pub radio: R,
|
|
pub host: C,
|
|
pub display: Option<D>,
|
|
pub led: L,
|
|
pub mac: [u8; 6],
|
|
}
|