Struct embedded_hal_sync_pins::pins::PushPullPin

pub struct PushPullPin { /* fields omitted */ }

A mutable output pin that can be safely shared between threads.

This pin implements embedded_hal::OutputPin and can be used to share an AtomicPinState with an embedded_hal implementation.

It also implements embedded_hal::InputPin, so it is possible to also read the internal state.

Examples

use embedded_hal_sync_pins::pins::{AtomicPinState, PushPullPin, PinState};
use embedded_hal::digital::blocking::{InputPin as HalInputPin, OutputPin};
use std::sync::Arc;

let state = Arc::new(AtomicPinState::new());
let mut pin = PushPullPin::new(state.clone());
pin.set_low().unwrap();
assert_eq!(Ok(true), pin.is_low());
pin.set_high().unwrap();
assert_eq!(Ok(true), pin.is_high());

Implementations

impl PushPullPin

pub fn new(state: Arc<AtomicPinState>) -> Self

Trait Implementations

impl Clone for PushPullPin

fn clone(&self) -> PushPullPin

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PushPullPin

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

Formats the value using the given formatter.

impl InputPin for PushPullPin

type Error = Infallible

Error type

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

Is the input pin high?

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

Is the input pin low?

impl OutputPin for PushPullPin

type Error = Infallible

Error type

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

Drives the pin high

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

Drives the pin low

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

Drives the pin high or low depending on the provided value

impl StatefulOutputPin for PushPullPin

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

Is the pin in drive high mode?

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

Is the pin in drive low mode?

impl ToggleableOutputPin for PushPullPin

type Error = Infallible

Error type

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

Toggle pin output.