Struct SimplePwm 

pub struct SimplePwm<'d> { /* private fields */ }

SimplePwm is the traditional pwm interface you’re probably used to, allowing to simply set a duty cycle across up to four channels.

Per-channel handles implementing embedded_hal_1::pwm::SetDutyCycle can be obtained with ch0..ch3 (borrowed) or split (owned).

Implementations

impl<'d> SimplePwm<'d>

pub fn new_1ch<T: Instance>( pwm: Peri<'d, T>, ch0: Peri<'d, impl GpioPin>, config: SimpleConfig, ) -> Self

Create a new 1-channel PWM

pub fn new_2ch<T: Instance>( pwm: Peri<'d, T>, ch0: Peri<'d, impl GpioPin>, ch1: Peri<'d, impl GpioPin>, config: SimpleConfig, ) -> Self

Create a new 2-channel PWM

pub fn new_3ch<T: Instance>( pwm: Peri<'d, T>, ch0: Peri<'d, impl GpioPin>, ch1: Peri<'d, impl GpioPin>, ch2: Peri<'d, impl GpioPin>, config: SimpleConfig, ) -> Self

Create a new 3-channel PWM

pub fn new_4ch<T: Instance>( pwm: Peri<'d, T>, ch0: Peri<'d, impl GpioPin>, ch1: Peri<'d, impl GpioPin>, ch2: Peri<'d, impl GpioPin>, ch3: Peri<'d, impl GpioPin>, config: SimpleConfig, ) -> Self

Create a new 4-channel PWM

pub fn ch0(&mut self) -> SimplePwmChannel<'_>

Borrow channel 0.

pub fn ch1(&mut self) -> SimplePwmChannel<'_>

Borrow channel 1.

pub fn ch2(&mut self) -> SimplePwmChannel<'_>

Borrow channel 2.

pub fn ch3(&mut self) -> SimplePwmChannel<'_>

Borrow channel 3.

pub fn split( self, ) -> (Option<SimplePwmChannel<'d>>, Option<SimplePwmChannel<'d>>, Option<SimplePwmChannel<'d>>, Option<SimplePwmChannel<'d>>)

Split the PWM into its channels, consuming the driver.

A channel is returned for every pin the PWM was created with. The PWM is disabled once all the returned channels have been dropped.

pub fn is_enabled(&self) -> bool

Returns the enable state of the pwm counter

pub fn enable(&mut self)

Enables the PWM generator.

pub fn disable(&mut self)

Disables the PWM generator. Does NOT clear the last duty cycle from the pin.

pub fn duties(&self) -> [DutyCycle; 4]

Returns the current duty cycles of all channels.

pub fn set_all_duties(&mut self, duty: [DutyCycle; 4])

Sets the duty cycle (15 bit) and polarity for all PWM channels.

You can safely set the duty cycle of disabled PWM channels.

When using this function, a single DMA transfer sets all the duty cycles. If you call SimplePwmChannel::set_duty() multiple times, each duty cycle will be set by a separate DMA transfer.

pub fn set_prescaler(&mut self, div: Prescaler)

Sets the PWM clock prescaler.

pub fn prescaler(&self) -> Prescaler

Gets the PWM clock prescaler.

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

Sets the maximum duty cycle value.

pub fn max_duty(&self) -> u16

Returns the maximum duty cycle value.

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

Sets the PWM output frequency, by adjusting the maximum duty cycle value.

The current prescaler limits the range of reachable frequencies: with Div1 the lowest is about 489 Hz, with Div128 about 3.8 Hz. Set the prescaler first for low frequencies.

pub fn frequency(&self) -> Hertz

Returns the PWM output frequency.

pub fn set_ch0_drive(&mut self, drive: OutputDrive)

Sets the PWM-Channel0 output drive strength

pub fn set_ch1_drive(&mut self, drive: OutputDrive)

Sets the PWM-Channel1 output drive strength

pub fn set_ch2_drive(&mut self, drive: OutputDrive)

Sets the PWM-Channel2 output drive strength

pub fn set_ch3_drive(&mut self, drive: OutputDrive)

Sets the PWM-Channel3 output drive strength

Trait Implementations

impl<'a> Drop for SimplePwm<'a>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.