Struct embedded_hal_sync_pins::pins::OpenDrainPin

pub struct OpenDrainPin { /* fields omitted */ }

A mutable output pin in open drain configuration 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. In open drain configuration this pin is in a floating state (not connected) if it is set to low and logical low ("pull to GND") if it is set to high.

It also implements embedded_hal::InputPin, so it is possible to also read the internal state, which will be either Floating or Low.

Examples

use embedded_hal_sync_pins::pins::{AtomicPinState, OpenDrainPin, PinState};
use embedded_hal::digital::{InputPin as HalInputPin, OutputPin};
use std::sync::{Arc, atomic::Ordering};

let state = Arc::new(AtomicPinState::new());
let mut pin = OpenDrainPin::new(state.clone());
pin.try_set_low().unwrap();
assert_eq!(Ok(false), pin.try_is_low());
assert_eq!(Ok(false), pin.try_is_high());
assert_eq!(PinState::Floating, state.load(Ordering::SeqCst));
pin.try_set_high().unwrap();
assert_eq!(Ok(false), pin.try_is_high());
assert_eq!(Ok(true), pin.try_is_low());

Implementations

impl OpenDrainPin

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

Trait Implementations

impl Clone for OpenDrainPin

pub fn clone(&self) -> OpenDrainPin

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenDrainPin

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

Formats the value using the given formatter.

impl InputPin for OpenDrainPin

type Error = Infallible

Error type

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

Is the input pin high?

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

Is the input pin low?

impl OutputPin for OpenDrainPin

type Error = Infallible

Error type

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

Drives the pin high

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

Drives the pin low

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

Drives the pin high or low depending on the provided value