1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
//! Shared API for xpanse apps, module drivers, and platform firmware.
//!
//! Module drivers implement [`driver::Driver`] to turn an owned
//! [`gpio_bank::GpioBank`] into capabilities stored in a [`registry::Registry`].
//! Apps implement [`app::App`] and lease those capabilities for the duration of
//! their run. The platform constructs buses through [`bus::allocator::BusAllocator`]
//! while drivers are being initialized.
//!
//! # Runtime requirements
//!
//! This crate is `no_std`, but uses `alloc` for registry storage, trait objects,
//! and boxed futures. Firmware using the API must install a global allocator
//! before creating drivers, resources, or apps.
//!
//! # Typical lifecycle
//!
//! 1. Detect a module and select a driver using [`metadata::ModuleID`].
//! 2. Call [`driver::Driver::create`] with the module's GPIO bank.
//! 3. Check [`app::App::can_run`] and construct an app with [`app::App::new`].
//! 4. Run the app, then call [`app::App::release`] to return its resource leases.
//!
//! Exact versions of HAL traits used by this API are available through
//! [`reexports`], avoiding version mismatches in app and driver crates.
extern crate alloc;
/// Exact versions of dependencies whose types and traits appear in this crate's public API.
///
/// For example, import the async I2C trait implemented by
/// `bus::i2c::I2cBusHandle` from this module:
///
/// ```ignore
/// use xpanse_api::reexports::embedded_hal_async::i2c::I2c;
/// ```