Trait embedded_hal::pwm::blocking::PwmPin

pub trait PwmPin {
    type Error: Debug;
    type Duty;
    fn disable(&mut self) -> Result<(), Self::Error>;
    fn enable(&mut self) -> Result<(), Self::Error>;
    fn get_duty(&self) -> Result<Self::Duty, Self::Error>;
    fn get_max_duty(&self) -> Result<Self::Duty, Self::Error>;
    fn set_duty(&mut self, duty: Self::Duty) -> Result<(), Self::Error>;
}

A single PWM channel / pin

See Pwm for details

Associated Types

type Error: Debug

Enumeration of PwmPin errors

type Duty

Type for the duty methods

The implementer is free to choose a float / percentage representation (e.g. 0.0 .. 1.0) or an integer representation (e.g. 0 .. 65535)

Required methods

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

Disables a PWM channel

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

Enables a PWM channel

fn get_duty(&self) -> Result<Self::Duty, Self::Error>

Returns the current duty cycle

While the pin is transitioning to the new duty cycle after a set_duty call, this may return the old or the new duty cycle depending on the implementation.

fn get_max_duty(&self) -> Result<Self::Duty, Self::Error>

Returns the maximum duty cycle value

fn set_duty(&mut self, duty: Self::Duty) -> Result<(), Self::Error>

Sets a new duty cycle

Implementors