Struct DigitalOutput 

pub struct DigitalOutput { /* private fields */ }

Represents a digital actuator of unspecified type: an Output Device that write digital values from an OUTPUT compatible pin. https://docs.arduino.cc/language-reference/en/functions/digital-io/digitalwrite/

Implementations

impl DigitalOutput

pub fn new<T: Into<PinIdOrName>>( board: &dyn Hardware, pin: T, default: bool, ) -> Result<Self, Error>

Creates an instance of a DigitalOutput attached to a given board.

Errors

• HardwareError::UnknownPin: this function will bail an error if the pin does not exist for this board.
• HardwareError::IncompatiblePin: this function will bail an error if the pin does not support OUTPUT mode.

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

Turn the output HIGH.

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

Turn the output LOW.

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

Toggle the current state, if on then turn off, if off then turn on.

pub fn get_pin(&self) -> u8

Returns the pin (id) used by the device.

pub fn get_pin_info(&self) -> Result<Pin, Error>

Returns Pin information.

pub fn is_high(&self) -> bool

Indicates if the device state is HIGH.

pub fn is_low(&self) -> bool

Indicates if the device state is LOW.

Trait Implementations

impl Clone for DigitalOutput

fn clone(&self) -> DigitalOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DigitalOutput

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

Formats the value using the given formatter.

impl Display for DigitalOutput

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

Formats the value using the given formatter.

impl Output for DigitalOutput

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

Internal only: you should rather use Self::turn_on(), Self::turn_off() functions.

fn get_state(&self) -> State

Returns the actuator current state.

fn get_default(&self) -> State

Returns the actuator default (or neutral) state.

fn animate<S: Into<State>>( &mut self, state: S, duration: u64, transition: Easing, )

Animates the output of the device. In other word: the state of the device will be animated from current step to targeted step through an interpolation of in-between states. The function will last for the required duration and the interpolation will follow an easing transition function.

fn is_busy(&self) -> bool

Indicates the busy status, ie if the device is running an animation.

fn stop(&mut self)

Stops the current animation, if any.

fn reset(&mut self) -> Result<State, Error>

Resets the actuator to default (or neutral) state.

fn scale_state( &mut self, previous: State, target: State, progress: f32, ) -> State

Internal only.

impl Device for DigitalOutput