Struct Switch 

pub struct Switch<P> { /* private fields */ }

An on/off part on an output line: a relay, a valve, a lamp.

Examples

use pamoja_core::Actuator;
use pamoja_gpio::pin::Polarity;
use pamoja_gpio::switch::Switch;
use pamoja_hal::digital::PinState;
use pamoja_hal::script::{block_on, PinScript};

// A relay board whose inputs are pulled low to energize the coil.
let mut valve = Switch::new(PinScript::new([]), Polarity::ActiveLow);
block_on(valve.apply(true))?;
block_on(valve.apply(false))?;
assert_eq!(valve.release().driven(), [PinState::Low, PinState::High]);

Implementations

impl<P> Switch<P>

pub fn new(pin: P, polarity: Polarity) -> Switch<P>

Wraps an output line, without driving it.

Arguments

• pin - the output line.
• polarity - which level asserts the part.

Returns

The switch, recorded as not asserted until it is first driven.

pub fn active_high(pin: P) -> Switch<P>

Wraps a line that asserts high.

Arguments

• pin - the output line.

Returns

The switch.

pub fn active_low(pin: P) -> Switch<P>

Wraps a line that asserts low, the shape of most relay boards.

Arguments

• pin - the output line.

Returns

The switch.

pub fn polarity(&self) -> Polarity

Returns the polarity the switch drives with.

pub fn is_asserted(&self) -> bool

Reports whether the part was last driven asserted.

Returns

true after a successful set(true), false after set(false) or before the line is first driven.

pub fn release(self) -> P

Gives back the line.

Returns

The pin the switch was built from.

impl<P: OutputPin> Switch<P>

pub fn set(&mut self, asserted: bool) -> Result<(), P::Error>

Drives the part asserted or not, at the level its polarity maps to.

Arguments

• asserted - true to energize, false to release.

Errors

Returns the pin’s error if the line cannot be driven; the recorded state is left unchanged.

Trait Implementations

impl<P> Actuator for Switch<P>

where P: OutputPin + Send, P::Error: Debug,

type Command = bool

The command accepted by a single application, for example a setpoint.

async fn apply(&mut self, asserted: bool) -> Result<()>

Applies a command to the actuator.

fn map_command<F, C>(self, convert: F) -> MapCommand<Self, F, C>

where Self: Sized, F: FnMut(C) -> Self::Command,

Wraps this actuator so every command passes through convert first.

impl<P: Debug> Debug for Switch<P>

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

Formats the value using the given formatter.