Struct Pin

pub struct Pin {
    pub id: u8,
    pub name: String,
    pub mode: PinMode,
    pub supported_modes: Vec<PinMode>,
    pub channel: Option<u8>,
    pub value: u16,
}

Represents the current state and configuration of a pin.

Fields

id: u8

The pin ID, which also corresponds to the index of the IoData::pins hashmap.

name: String

The pin name: an alternative String representation of the pin name: ‘D13’, ‘A0’, ‘GPIO13’ for instance.

mode: PinMode

Currently configured mode.

supported_modes: Vec<PinMode>

All pin supported modes.

channel: Option<u8>

For analog pin, this is the channel number ie “A0”=>0, “A1”=>1, etc…

value: u16

Pin value.

Implementations

impl Pin

pub fn supports_mode(&self, mode: PinModeId) -> Option<PinMode>

Verifies if a pin supports the given mode and returns it if it does.

pub fn validate_current_mode(&self, mode: PinModeId) -> Result<(), Error>

Validates that the pin is in the given mode.

pub fn get_max_possible_value(&self) -> u16

Get the max value this pin can reach.

This is defined by the resolution of the current pin mode.

Trait Implementations

impl Clone for Pin

fn clone(&self) -> Pin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pin

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

Formats the value using the given formatter.

impl Default for Pin

fn default() -> Pin

Returns the “default value” for a type.