Struct DeviceModel 

pub struct DeviceModel {
    pub name: String,
    pub pins: HashMap<u8, PinModel>,
}

Device model defining the capabilities of all pins on a device

Fields

name: String

Device model name

pins: HashMap<u8, PinModel>

Map of pin numbers to pin models

Implementations

impl DeviceModel

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Load a device model from a YAML file

Arguments

• path - Path to the YAML file

Returns

• Result<DeviceModel> - The loaded device model or an error

pub fn validate(&self) -> Result<()>

Validate the device model

Checks that the model is well-formed and that all related capabilities are properly defined.

Returns

• Result<()> - Ok if the model is valid, an error otherwise

pub fn is_pin_capability_supported(&self, pin_num: u8, capability: &str) -> bool

Check if a pin supports a specific capability

Arguments

• pin_num - The pin number to check
• capability - The capability to check for

Returns

• bool - True if the pin supports the capability, false otherwise

pub fn get_pin_capabilities(&self, pin_num: u8) -> Vec<String>

Get all capabilities for a pin

Arguments

• pin_num - The pin number to get capabilities for

Returns

• Vec<String> - List of capabilities supported by the pin

pub fn get_related_capabilities( &self, pin_num: u8, capability: &str, ) -> Vec<(String, u8)>

Get related capabilities for a specific capability

For example, if the capability is “Encoder_1A”, this will return [(“Encoder_1B”, pin_num)] where pin_num is the pin that has the “Encoder_1B” capability.

Arguments

• pin_num - The pin number with the capability
• capability - The capability to find related capabilities for

Returns

• Vec<(String, u8)> - List of related capabilities and their pin numbers

pub fn validate_pin_capability( &self, pin_num: u8, capability: &str, ) -> Result<()>

Validate that a pin can be configured with a specific capability

This checks both that the pin supports the capability and that any related capabilities are properly configured.

Arguments

• pin_num - The pin number to check
• capability - The capability to check for

Returns

• Result<()> - Ok if the capability is valid, an error otherwise

pub fn validate_led_matrix_config(&self, config: &LedMatrixConfig) -> Result<()>

Validate LED matrix configuration against device model

Arguments

• config - LED matrix configuration to validate

Returns

• Result<()> - Ok if valid, error if invalid

pub fn reserve_led_matrix_pins(&mut self, matrix_id: u8) -> Result<()>

Reserve LED matrix pins in the device model

Arguments

• matrix_id - Matrix ID (1 or 2)

Returns

• Result<()> - Ok if pins reserved successfully, error if conflict

Trait Implementations

impl Clone for DeviceModel

fn clone(&self) -> DeviceModel

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeviceModel

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DeviceModel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DeviceModel

fn eq(&self, other: &DeviceModel) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DeviceModel

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for DeviceModel