UMSH Rust API Docs

Workspace API documentation for the UMSH Rust crates.

Protocol Book Umbrella Crate

Umbrella and host tooling

• umsh — umbrella crate that re-exports the workspace surface and defines the Platform trait with its Tokio and Embassy adapters
• umshctl — host command-line tool for driving and capturing from a UMSH device
• umsh_cli — shared CLI command surface, usable on host and on-device
• umsh_mobile_core — stable, value-oriented facade for mobile applications
• umsh_uniffi_bindgen — UniFFI binding generator

Protocol core

• umsh_core — wire-format types and packet parse/build
• umsh_crypto — cryptographic constructions, identities, and key derivation
• umsh_mac — MAC-layer coordinator and state
• umsh_node — application-facing node layer atop the MAC
• umsh_uri — UMSH URI and address parsing and formatting
• umsh_hal — minimal hardware abstraction traits
• umsh_sync — single-threaded async primitives

Application protocols

• umsh_text — text messaging codec and sans-I/O engine
• umsh_chat_room — chat room payload types

Local Control Protocol (ULCP)

• umsh_ulcp — ULCP wire format
• umsh_ulcp_device — device-side session engine
• umsh_ulcp_runtime — board-agnostic device runtime shared across firmware targets
• umsh_ulcp_web_engine — sans-I/O engine behind the web debugger

Storage and radio

• umsh_flash_store — sequential-storage-backed persistence over any async NOR flash
• umsh_journal_store — power-loss-safe record journals for bonds, snapshots, and frame counters
• umsh_radio_loraphy — umsh_hal::Radio over any lora-phy RadioKind

Board support and UX

• umsh_bsp_nrf52840 — chip-level support shared by the nRF52840 boards
• umsh_bsp_t1000e — Seeed SenseCAP T1000-E
• umsh_bsp_techo — LilyGO T-Echo
• umsh_bsp_wio_tracker_l1 — Seeed Wio Tracker L1 / L1 Pro
• umsh_bsp_sensecap_solar — SenseCAP Solar Node P1 / P1-Pro
• umsh_ux_tracker — UX mechanism for tracker-class boards (button, LED, buzzer)
• umsh_ux_display_tracker — UX mechanism for display-tracker-class boards (menu, attention policy, input gate)
• umsh_app_ulcp_cli — console-harness application logic, generic over a board

Firmware images

• firmware_t1000e — T-1000E device image
• firmware_techo — T-Echo device image
• firmware_sensecap_solar — SenseCAP Solar device image
• firmware_wio_tracker_l1 — Wio Tracker L1 device image
• firmware_t1000e_console — T-1000E bringup harness
• firmware_techo_console — T-Echo bringup harness
• firmware_sensecap_solar_console — SenseCAP Solar bringup harness
• firmware_wio_tracker_l1_console — Wio Tracker L1 bringup harness

Firmware and board-support pages are generated on the host, where the bare-metal code is compiled out; they show the portable surface rather than the full device image. The Espressif boards live in a separate workspace that needs the Xtensa toolchain and are not included here.