Struct embassy_stm32::timer::simple_pwm::SimplePwm

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

Simple PWM driver.

Implementations

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

pub fn new( tim: impl Peripheral<P = T> + 'd, _ch1: Option<PwmPin<'d, T, Ch1>>, _ch2: Option<PwmPin<'d, T, Ch2>>, _ch3: Option<PwmPin<'d, T, Ch3>>, _ch4: Option<PwmPin<'d, T, Ch4>>, freq: Hertz, counting_mode: CountingMode ) -> Self

Create a new simple PWM driver.

pub fn enable(&mut self, channel: Channel)

Enable the given channel.

pub fn disable(&mut self, channel: Channel)

Disable the given channel.

pub fn is_enabled(&self, channel: Channel) -> bool

Check whether given channel is enabled

pub fn set_frequency(&mut self, freq: Hertz)

Set PWM frequency.

Note: when you call this, the max duty value changes, so you will have to call set_duty on all channels with the duty calculated based on the new max duty.

pub fn get_max_duty(&self) -> u32

Get max duty value.

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

pub fn set_duty(&mut self, channel: Channel, duty: u32)

Set the duty for a given channel.

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

pub fn get_duty(&self, channel: Channel) -> u32

Get the duty for a given channel.

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

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

Set the output polarity for a given channel.

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

Set the output compare mode for a given channel.

pub async fn waveform_up( &mut self, dma: impl Peripheral<P = impl UpDma<T>>, channel: Channel, duty: &[u16] )

Generate a sequence of PWM waveform

Note:
you will need to provide corresponding TIMx_UP DMA channel to use this method.

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

pub async fn waveform_ch1( &mut self, dma: impl Peripheral<P = impl Ch1Dma<T>>, duty: &[u16] )

Generate a sequence of PWM waveform

Note: you will need to provide corresponding TIMx_CHy DMA channel to use this method.

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

pub async fn waveform_ch2( &mut self, dma: impl Peripheral<P = impl Ch2Dma<T>>, duty: &[u16] )

Generate a sequence of PWM waveform

Note: you will need to provide corresponding TIMx_CHy DMA channel to use this method.

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

pub async fn waveform_ch3( &mut self, dma: impl Peripheral<P = impl Ch3Dma<T>>, duty: &[u16] )

Generate a sequence of PWM waveform

Note: you will need to provide corresponding TIMx_CHy DMA channel to use this method.

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

pub async fn waveform_ch4( &mut self, dma: impl Peripheral<P = impl Ch4Dma<T>>, duty: &[u16] )

Generate a sequence of PWM waveform

Note: you will need to provide corresponding TIMx_CHy DMA channel to use this method.

Trait Implementations

impl<'d, T: GeneralInstance4Channel> Pwm for SimplePwm<'d, T>

type Channel = Channel

Enumeration of channels that can be used with this Pwm interface

type Time = Hertz

A time unit that can be converted into a human time unit (e.g. seconds)

type Duty = u32

Type for the duty methods

fn disable(&mut self, channel: Self::Channel)

Disables a PWM channel

fn enable(&mut self, channel: Self::Channel)

Enables a PWM channel

fn get_period(&self) -> Self::Time

Returns the current PWM period

fn get_duty(&self, channel: Self::Channel) -> Self::Duty

Returns the current duty cycle

fn get_max_duty(&self) -> Self::Duty

Returns the maximum duty cycle value

fn set_duty(&mut self, channel: Self::Channel, duty: Self::Duty)

Sets a new duty cycle

fn set_period<P>(&mut self, period: P)

where P: Into<Self::Time>,

Sets a new PWM period