Struct SimplePwmChannel

pub struct SimplePwmChannel<'d, T: GeneralInstance4Channel> { /* private fields */ }

A single channel of a pwm, obtained from SimplePwm::split, SimplePwm::channel, SimplePwm::ch1, etc.

It is not possible to change the pwm frequency because the frequency configuration is shared with all four channels.

Implementations

impl<'d, T: GeneralInstance4Channel> SimplePwmChannel<'d, T>

pub fn enable(&mut self)

Enable the given channel.

pub fn disable(&mut self)

Disable the given channel.

pub fn is_enabled(&self) -> bool

Check whether given channel is enabled

pub fn max_duty_cycle(&self) -> u16

Get max duty value.

This value depends on the configured frequency and the timer’s clock rate from RCC.

pub fn set_duty_cycle(&mut self, duty: u16)

Set the duty for a given channel.

The value ranges from 0 for 0% duty, to max_duty_cycle for 100% duty, both included.

pub fn set_duty_cycle_fully_off(&mut self)

Set the duty cycle to 0%, or always inactive.

pub fn set_duty_cycle_fully_on(&mut self)

Set the duty cycle to 100%, or always active.

pub fn set_duty_cycle_fraction(&mut self, num: u16, denom: u16)

Set the duty cycle to num / denom.

The caller is responsible for ensuring that num is less than or equal to denom, and that denom is not zero.

pub fn set_duty_cycle_percent(&mut self, percent: u8)

Set the duty cycle to percent / 100

The caller is responsible for ensuring that percent is less than or equal to 100.

pub fn current_duty_cycle(&self) -> u16

Get the duty for a given channel.

The value ranges from 0 for 0% duty, to max_duty_cycle for 100% duty, both included.

pub fn set_polarity(&mut self, polarity: OutputPolarity)

Set the output polarity for a given channel.

pub fn set_output_compare_mode(&mut self, mode: OutputCompareMode)

Set the output compare mode for a given channel.

Trait Implementations

impl<'d, T: GeneralInstance4Channel> ErrorType for SimplePwmChannel<'d, T>

type Error = Infallible

Error type

impl<'d, T: GeneralInstance4Channel> SetDutyCycle for SimplePwmChannel<'d, T>

fn max_duty_cycle(&self) -> u16

Get the maximum duty cycle value.

fn set_duty_cycle(&mut self, duty: u16) -> Result<(), Self::Error>

Set the duty cycle to duty / max_duty.

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

Set the duty cycle to 0%, or always inactive.

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

Set the duty cycle to 100%, or always active.

fn set_duty_cycle_fraction( &mut self, num: u16, denom: u16, ) -> Result<(), Self::Error>

Set the duty cycle to num / denom.

fn set_duty_cycle_percent(&mut self, percent: u8) -> Result<(), Self::Error>

Set the duty cycle to percent / 100