Struct PinScript 

pub struct PinScript { /* private fields */ }

A GPIO line that records the levels it is driven to and answers reads from a script.

Driving the pin appends to driven. Reading it returns the next scripted level, or the level it was last driven to once the script is used up, so a line that is only ever an output never runs dry.

Examples

use pamoja_hal::digital::{InputPin, OutputPin, PinState};
use pamoja_hal::script::PinScript;

let mut pin = PinScript::new([PinState::Low, PinState::High]);
pin.set_high()?;
pin.set_low()?;
assert_eq!(pin.driven(), [PinState::High, PinState::Low]);
assert!(pin.is_low()?);
assert!(pin.is_high()?);

Implementations

impl PinScript

pub fn new(inputs: impl IntoIterator<Item = PinState>) -> PinScript

Creates a released (high) line whose reads answer inputs in order.

Arguments

• inputs - the levels each read returns, in order.

Returns

The scripted pin.

pub fn driven(&self) -> &[PinState]

Returns every level the pin was driven to, oldest first.

Returns

The levels set through OutputPin.

pub fn level(&self) -> PinState

Returns the level the pin was last driven to.

Returns

The current output level.

pub fn remaining(&self) -> usize

Reports how many scripted input levels remain unread.

Returns

The number of reads the script still answers.

Trait Implementations

impl Clone for PinScript

fn clone(&self) -> PinScript

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PinScript

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

Formats the value using the given formatter.

impl Default for PinScript

fn default() -> Self

Returns the “default value” for a type.

impl ErrorType for PinScript

type Error = Infallible

Error type

impl InputPin for PinScript

fn is_high(&mut self) -> Result<bool, Self::Error>

Is the input pin high?

fn is_low(&mut self) -> Result<bool, Self::Error>

Is the input pin low?

impl OutputPin for PinScript

fn set_low(&mut self) -> Result<(), Self::Error>

Drives the pin low.

fn set_high(&mut self) -> Result<(), Self::Error>

Drives the pin high.

fn set_state(&mut self, state: PinState) -> Result<(), Self::Error>

Drives the pin high or low depending on the provided value.

impl StatefulOutputPin for PinScript

fn is_set_high(&mut self) -> Result<bool, Self::Error>

Is the pin in drive high mode?

fn is_set_low(&mut self) -> Result<bool, Self::Error>

Is the pin in drive low mode?

fn toggle(&mut self) -> Result<(), Self::Error>

Toggle pin output.