Struct stm32f4xx_hal::timer::pwm::Pwm

pub struct Pwm<TIM, PINS, const FREQ: u32>
where
    TIM: Instance + WithPwm,
    PINS: Pins<TIM>,
{ /* private fields */ }

Implementations

impl<TIM, PINS, const FREQ: u32> Pwm<TIM, PINS, FREQ>

where TIM: Instance + WithPwm, PINS: Pins<TIM>,

pub fn split(self) -> PINS::Channels

pub fn release(self) -> FTimer<TIM, FREQ>

impl<TIM, PINS, const FREQ: u32> Pwm<TIM, PINS, FREQ>

where TIM: Instance + WithPwm, PINS: Pins<TIM>,

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

Enable PWM output of the timer on channel channel

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

Disable PWM output of the timer on channel channel

pub fn set_polarity(&mut self, channel: Channel, p: Polarity)

Set the polarity of the active state for the primary PWM output of the timer on channel channel

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

Get the current duty cycle of the timer on channel channel

pub fn get_duty_time(&self, channel: Channel) -> TimerDurationU32<FREQ>

Get the current duty cycle of the timer on channel channel and convert to a duration

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

Set the duty cycle of the timer on channel channel

pub fn set_duty_time(&mut self, channel: Channel, duty: TimerDurationU32<FREQ>)

Set the duty cycle of the timer on channel channel from a duration

pub fn get_max_duty(&self) -> u16

Get the maximum duty cycle value of the timer

If 0 returned means max_duty is 2^16

pub fn get_period(&self) -> TimerDurationU32<FREQ>

Get the PWM frequency of the timer as a duration

pub fn set_period(&mut self, period: TimerDurationU32<FREQ>)

Set the PWM frequency for the timer from a duration

pub fn set_complementary_polarity(&mut self, channel: Channel, p: Polarity)

Set the polarity of the active state for the complementary PWM output of the advanced timer on channel channel

impl<TIM, PINS, const FREQ: u32> Pwm<TIM, PINS, FREQ>

where TIM: Instance + WithPwm + Advanced, PINS: Pins<TIM>,

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

Enable complementary PWM output of the timer on channel channel

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

Disable complementary PWM output of the timer on channel channel

pub fn set_dead_time(&mut self, dts_ticks: u16)

Set number DTS ticks during that the primary and complementary PWM pins are simultaneously forced to their inactive states ( see Polarity setting ) when changing PWM state. This duration when both channels are in an ‘off’ state is called ‘dead time’.

This is necessary in applications like motor control or power converters to prevent the destruction of the switching elements by short circuit in the moment of switching.

pub fn set_dead_time_bits(&mut self, bits: u8)

Set raw dead time (DTG) bits

The dead time generation is nonlinear and constrained by the DTS tick duration. DTG register configuration and calculation of the actual resulting dead time is described in the application note RM0368 from ST Microelectronics

pub fn get_dead_time(&self) -> u16

Return dead time for complementary pins in the unit of DTS ticks

pub fn get_dead_time_bits(&self) -> u8

Get raw dead time (DTG) bits

pub fn set_idle_state(&mut self, channel: Channel, s: IdleState)

Set the pin idle state

pub fn set_complementary_idle_state(&mut self, channel: Channel, s: IdleState)

Set the complementary pin idle state

Methods from Deref<Target = FTimer<TIM, FREQ>>

pub fn configure(&mut self, clocks: &Clocks)

Calculate prescaler depending on Clocks state

pub fn set_master_mode(&mut self, mode: TIM::Mms)

Trait Implementations

impl<TIM, PINS, const FREQ: u32> Deref for Pwm<TIM, PINS, FREQ>

where TIM: Instance + WithPwm, PINS: Pins<TIM>,

type Target = FTimer<TIM, FREQ>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<TIM, PINS, const FREQ: u32> DerefMut for Pwm<TIM, PINS, FREQ>

where TIM: Instance + WithPwm, PINS: Pins<TIM>,

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<TIM, PINS, const FREQ: u32> Pwm for Pwm<TIM, PINS, FREQ>

where TIM: Instance + WithPwm, PINS: Pins<TIM>,

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

If 0 returned means max_duty is 2^16

type Channel = Channel

Enumeration of channels that can be used with this Pwm interface

type Duty = u16

Type for the duty methods

type Time = Duration<u32, 1, FREQ>

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

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

Enables a PWM channel

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

Disables a PWM channel

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

Returns the current duty cycle

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

Sets a new duty cycle

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

Returns the current PWM period

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

where T: Into<Self::Time>,

Sets a new PWM period