Struct Led 

pub struct Led { /* private fields */ }

Represents a LED controlled by a digital pin. There are two kinds of pins that can be used:

• OUTPUT: for digital on/off led
• PWM: for more control on the LED brightness

Implementations

impl Led

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

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

Errors

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

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

Turns the LED on.

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

Turns the LED off.

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

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

pub fn blink(&mut self, ms: u64) -> &Self

Blinks the LED on/off in phases of milliseconds duration. This is an animation and can be stopped by calling Led::stop().

pub fn pulse(&mut self, ms: u64) -> &Self

Pulses the LED on/off (using fading) in phases of ms (milliseconds) duration. This is an animation and can be stopped by calling Led::stop().

pub fn get_pin(&self) -> u8

Returns the pin (id) used by the device.

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

Returns the Pin information.

pub fn get_brightness(&self) -> u8

Returns the LED current brightness in percentage (0-100%).

pub fn set_brightness(self, brightness: u8) -> Result<Self, Error>

Set the LED brightness (integer between 0-100) in percent of the max brightness. If a number higher than 100 is used, the brightness is set to 100%. If the requested brightness is 100%, the LED will reset to simple on/off (OUTPUT) mode.

Errors

• IncompatiblePin: this function will bail an error if the LED pin does not support PWM.

pub fn is_on(&self) -> bool

Indicates if the LED is current ON (regardless its brightness).

pub fn is_off(&self) -> bool

Indicates if the LED is current OFF.

Trait Implementations

impl Clone for Led

fn clone(&self) -> Led

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Led

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

Formats the value using the given formatter.

impl Display for Led

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

Formats the value using the given formatter.

impl Output for Led

fn get_state(&self) -> State

Returns the actuator current state.

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

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

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 Led