Struct stm32f1xx_hal::timer::pwm::Pwm

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

Implementations

impl<TIM, REMAP, P, PINS, const FREQ: u32> Pwm<TIM, REMAP, P, PINS, FREQ>where
    TIM: Instance + WithPwm,
    REMAP: Remap<Periph = TIM>,
    PINS: Pins<REMAP, P>,

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

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

impl<TIM, REMAP, P, PINS, const FREQ: u32> Pwm<TIM, REMAP, P, PINS, FREQ>where
    TIM: Instance + WithPwm,
    REMAP: Remap<Periph = TIM>,
    PINS: Pins<REMAP, P>,

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

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

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

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

pub fn get_max_duty(&self) -> u16

If 0 returned means max_duty is 2^16

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

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

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

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

Calculate prescaler depending on Clocks state

pub fn listen(&mut self, event: Event)

Starts listening for an event

Note, you will also have to enable the TIM2 interrupt in the NVIC to start receiving events.

pub fn clear_interrupt(&mut self, event: Event)

Clears interrupt associated with event.

If the interrupt is not cleared, it will immediately retrigger after the ISR has finished.

pub fn get_interrupt(&mut self) -> Event

pub fn unlisten(&mut self, event: Event)

Stops listening for an event

pub fn stop_in_debug(&mut self, dbg: &mut DBG, state: bool)

Stopping timer in debug mode can cause troubles when sampling the signal

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

Trait Implementations

impl<TIM, REMAP, P, PINS, const FREQ: u32> Deref for Pwm<TIM, REMAP, P, PINS, FREQ>where
    TIM: Instance + WithPwm,
    REMAP: Remap<Periph = TIM>,
    PINS: Pins<REMAP, P>,

type Target = FTimer<TIM, FREQ>

The resulting type after dereferencing.

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

Dereferences the value.

impl<TIM, REMAP, P, PINS, const FREQ: u32> DerefMut for Pwm<TIM, REMAP, P, PINS, FREQ>where
    TIM: Instance + WithPwm,
    REMAP: Remap<Periph = TIM>,
    PINS: Pins<REMAP, P>,

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

Mutably dereferences the value.

impl<TIM, REMAP, P, PINS, const FREQ: u32> Pwm for Pwm<TIM, REMAP, P, PINS, FREQ>where
    TIM: Instance + WithPwm,
    REMAP: Remap<Periph = TIM>,
    PINS: Pins<REMAP, P>,

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