Struct stm32f4xx_hal::timer::Timer

pub struct Timer<TIM> { /* private fields */ }

Timer wrapper.

This wrapper can be used both for the system timer (SYST) or the general-purpose timers (TIMx).

Note: If you want to use the timer to sleep a certain amount of time, use Delay.

Implementations

impl Timer<SYST>

pub fn counter_hz(self) -> SysCounterHz

Creates SysCounterHz which takes Hertz as Duration

pub fn counter<const FREQ: u32>(self) -> SysCounter<FREQ>

Creates SysCounter with custom precision (core frequency recommended is known)

pub fn counter_us(self) -> SysCounterUs

Creates SysCounter 1 microsecond precision

impl Timer<SYST>

pub fn delay(self) -> SysDelay

impl<TIM: Instance + WithPwm> Timer<TIM>

pub fn pwm_hz<PINS>(self, _pins: PINS, freq: Hertz) -> PwmHz<TIM, PINS>

where PINS: Pins<TIM>,

impl Timer<TIM1>

pub fn pwm_input( self, best_guess: Hertz, pins: impl Into<<TIM1 as CPin<0>>::Ch<PushPull>> ) -> PwmInput<TIM1>

Configures this timer for PWM input. Accepts the best_guess frequency of the signal Note: this should be as close as possible to the frequency of the PWM waveform for best accuracy.

This device will emit an interrupt on CC1, which occurs at two times in this mode:

1. When a new cycle is started: the duty cycle will be 1.00
2. When the period is captured. the duty cycle will be an observable value. See the pwm input example for an suitable interrupt handler.

impl Timer<TIM2>

pub fn pwm_input( self, best_guess: Hertz, pins: impl Into<<TIM2 as CPin<0>>::Ch<PushPull>> ) -> PwmInput<TIM2>

Configures this timer for PWM input. Accepts the best_guess frequency of the signal Note: this should be as close as possible to the frequency of the PWM waveform for best accuracy.

This device will emit an interrupt on CC1, which occurs at two times in this mode:

1. When a new cycle is started: the duty cycle will be 1.00
2. When the period is captured. the duty cycle will be an observable value. See the pwm input example for an suitable interrupt handler.

impl Timer<TIM3>

pub fn pwm_input( self, best_guess: Hertz, pins: impl Into<<TIM3 as CPin<0>>::Ch<PushPull>> ) -> PwmInput<TIM3>

Configures this timer for PWM input. Accepts the best_guess frequency of the signal Note: this should be as close as possible to the frequency of the PWM waveform for best accuracy.

This device will emit an interrupt on CC1, which occurs at two times in this mode:

1. When a new cycle is started: the duty cycle will be 1.00
2. When the period is captured. the duty cycle will be an observable value. See the pwm input example for an suitable interrupt handler.

impl Timer<TIM4>

pub fn pwm_input( self, best_guess: Hertz, pins: impl Into<<TIM4 as CPin<0>>::Ch<PushPull>> ) -> PwmInput<TIM4>

Configures this timer for PWM input. Accepts the best_guess frequency of the signal Note: this should be as close as possible to the frequency of the PWM waveform for best accuracy.

This device will emit an interrupt on CC1, which occurs at two times in this mode:

1. When a new cycle is started: the duty cycle will be 1.00
2. When the period is captured. the duty cycle will be an observable value. See the pwm input example for an suitable interrupt handler.

impl Timer<TIM5>

pub fn pwm_input( self, best_guess: Hertz, pins: impl Into<<TIM5 as CPin<0>>::Ch<PushPull>> ) -> PwmInput<TIM5>

Configures this timer for PWM input. Accepts the best_guess frequency of the signal Note: this should be as close as possible to the frequency of the PWM waveform for best accuracy.

This device will emit an interrupt on CC1, which occurs at two times in this mode:

1. When a new cycle is started: the duty cycle will be 1.00
2. When the period is captured. the duty cycle will be an observable value. See the pwm input example for an suitable interrupt handler.

impl Timer<TIM8>

pub fn pwm_input( self, best_guess: Hertz, pins: impl Into<<TIM8 as CPin<0>>::Ch<PushPull>> ) -> PwmInput<TIM8>

Configures this timer for PWM input. Accepts the best_guess frequency of the signal Note: this should be as close as possible to the frequency of the PWM waveform for best accuracy.

This device will emit an interrupt on CC1, which occurs at two times in this mode:

1. When a new cycle is started: the duty cycle will be 1.00
2. When the period is captured. the duty cycle will be an observable value. See the pwm input example for an suitable interrupt handler.

impl Timer<TIM9>

pub fn pwm_input( self, best_guess: Hertz, pins: impl Into<<TIM9 as CPin<0>>::Ch<PushPull>> ) -> PwmInput<TIM9>

Configures this timer for PWM input. Accepts the best_guess frequency of the signal Note: this should be as close as possible to the frequency of the PWM waveform for best accuracy.

This device will emit an interrupt on CC1, which occurs at two times in this mode:

1. When a new cycle is started: the duty cycle will be 1.00
2. When the period is captured. the duty cycle will be an observable value. See the pwm input example for an suitable interrupt handler.

impl Timer<TIM12>

pub fn pwm_input( self, best_guess: Hertz, pins: impl Into<<TIM12 as CPin<0>>::Ch<PushPull>> ) -> PwmInput<TIM12>

Configures this timer for PWM input. Accepts the best_guess frequency of the signal Note: this should be as close as possible to the frequency of the PWM waveform for best accuracy.

This device will emit an interrupt on CC1, which occurs at two times in this mode:

1. When a new cycle is started: the duty cycle will be 1.00
2. When the period is captured. the duty cycle will be an observable value. See the pwm input example for an suitable interrupt handler.

impl Timer<SYST>

pub fn syst(tim: SYST, clocks: &Clocks) -> Self

Initialize SysTick timer

pub fn syst_external(tim: SYST, clocks: &Clocks) -> Self

Initialize SysTick timer and set it frequency to HCLK / 8

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

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

pub fn release(self) -> SYST

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

Starts listening for an event

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

Stops listening for an event

impl<TIM: Instance> Timer<TIM>

pub fn new(tim: TIM, clocks: &Clocks) -> Self

Initialize timer

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

pub fn counter_hz(self) -> CounterHz<TIM>

pub fn release(self) -> TIM

impl<TIM: Instance + MasterTimer> Timer<TIM>

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

Trait Implementations

impl<TIM: Instance> ClearFlags for Timer<TIM>

type Flag = Flag

Enum of manually clearable flags

fn clear_flags(&mut self, event: impl Into<BitFlags<Flag>>)

Clear interrupts flags with Self::Flagss

fn clear_all_flags(&mut self)

Clears all interrupts flags

impl<TIM: Instance> Listen for Timer<TIM>

type Event = Event

Enum of bit flags associated with events

fn listen(&mut self, event: impl Into<BitFlags<Event>>)

Start listening for Events

fn listen_only(&mut self, event: impl Into<BitFlags<Event>>)

Start listening for Events, stop all other

fn unlisten(&mut self, event: impl Into<BitFlags<Event>>)

Stop listening for Events

fn listen_all(&mut self)

Start listening all Events

fn unlisten_all(&mut self)

Stop listening all Events

impl<TIM: Instance> ReadFlags for Timer<TIM>

type Flag = Flag

Enum of bit flags

fn flags(&self) -> BitFlags<Flag>

Get all interrupts flags a once.