Struct PwmOutput 

pub struct PwmOutput { /* private fields */ }

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

Implementations

impl PwmOutput

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

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

Errors

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

pub fn set_value(&mut self, value: u16) -> Result<&Self, Error>

Sets the PWM value.

pub fn set_percentage(&mut self, percentage: u8) -> Result<&Self, Error>

Sets the PWM value to a percentage of its max value. NOTE: everything above 100 is considered 100%.

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 get_value(&self) -> u16

Gets the current PWM value.

pub fn get_percentage(&self) -> u8

Gets the current percentage of the PWM value compared to max possible.

Trait Implementations

impl Clone for PwmOutput

fn clone(&self) -> PwmOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PwmOutput

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

Formats the value using the given formatter.

impl Display for PwmOutput

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

Formats the value using the given formatter.

impl Output for PwmOutput

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

Internal only: you should rather use Self::set_value() function.

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 PwmOutput