Struct MonoTimer

pub struct MonoTimer<TIM, const FREQ: u32> { /* private fields */ }

Implementations

impl<TIM: Instance, const FREQ: u32> MonoTimer<TIM, FREQ>

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

Releases the TIM peripheral

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, const FREQ: u32> Deref for MonoTimer<TIM, FREQ>

type Target = FTimer<TIM, FREQ>

The resulting type after dereferencing.

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

Dereferences the value.

impl<TIM, const FREQ: u32> DerefMut for MonoTimer<TIM, FREQ>

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

Mutably dereferences the value.

impl<const FREQ: u32> Monotonic for MonoTimer<TIM1, FREQ>

type Instant = Instant<u32, 1, FREQ>

The type for instant, defining an instant in time.

type Duration = Duration<u32, 1, FREQ>

The type for duration, defining an duration of time.

unsafe fn reset(&mut self)

Optionally resets the counter to zero for a fixed baseline in a system.

fn now(&mut self) -> Self::Instant

Get the current time.

fn set_compare(&mut self, instant: Self::Instant)

Set the compare value of the timer interrupt.

fn clear_compare_flag(&mut self)

Clear the compare interrupt flag.

fn on_interrupt(&mut self)

Optional. Commonly used for performing housekeeping of a timer when it has been extended, e.g. a 16 bit timer extended to 32/64 bits. This will be called at the end of the interrupt handler after all other operations have finished.

fn zero() -> Self::Instant

The time at time zero. Used by RTIC before the monotonic has been initialized.

const DISABLE_INTERRUPT_ON_EMPTY_QUEUE: bool = true

This tells RTIC if it should disable the interrupt bound to the monotonic if there are no scheduled tasks. One may want to set this to false if one is using the on_interrupt method to perform housekeeping and need overflow interrupts to happen, such as when extending a 16 bit timer to 32/64 bits, even if there are no scheduled tasks.

fn enable_timer(&mut self)

Optional. This is used to save power, this is called when the Monotonic interrupt is enabled.

fn disable_timer(&mut self)

Optional. This is used to save power, this is called when the Monotonic interrupt is disabled.

impl<const FREQ: u32> Monotonic for MonoTimer<TIM2, FREQ>

type Instant = Instant<u32, 1, FREQ>

The type for instant, defining an instant in time.

type Duration = Duration<u32, 1, FREQ>

The type for duration, defining an duration of time.

unsafe fn reset(&mut self)

Optionally resets the counter to zero for a fixed baseline in a system.

fn now(&mut self) -> Self::Instant

Get the current time.

fn set_compare(&mut self, instant: Self::Instant)

Set the compare value of the timer interrupt.

fn clear_compare_flag(&mut self)

Clear the compare interrupt flag.

fn on_interrupt(&mut self)

Optional. Commonly used for performing housekeeping of a timer when it has been extended, e.g. a 16 bit timer extended to 32/64 bits. This will be called at the end of the interrupt handler after all other operations have finished.

fn zero() -> Self::Instant

The time at time zero. Used by RTIC before the monotonic has been initialized.

const DISABLE_INTERRUPT_ON_EMPTY_QUEUE: bool = true

This tells RTIC if it should disable the interrupt bound to the monotonic if there are no scheduled tasks. One may want to set this to false if one is using the on_interrupt method to perform housekeeping and need overflow interrupts to happen, such as when extending a 16 bit timer to 32/64 bits, even if there are no scheduled tasks.

fn enable_timer(&mut self)

Optional. This is used to save power, this is called when the Monotonic interrupt is enabled.

fn disable_timer(&mut self)

Optional. This is used to save power, this is called when the Monotonic interrupt is disabled.

impl<const FREQ: u32> Monotonic for MonoTimer<TIM3, FREQ>

type Instant = Instant<u32, 1, FREQ>

The type for instant, defining an instant in time.

type Duration = Duration<u32, 1, FREQ>

The type for duration, defining an duration of time.

unsafe fn reset(&mut self)

Optionally resets the counter to zero for a fixed baseline in a system.

fn now(&mut self) -> Self::Instant

Get the current time.

fn set_compare(&mut self, instant: Self::Instant)

Set the compare value of the timer interrupt.

fn clear_compare_flag(&mut self)

Clear the compare interrupt flag.

fn on_interrupt(&mut self)

Optional. Commonly used for performing housekeeping of a timer when it has been extended, e.g. a 16 bit timer extended to 32/64 bits. This will be called at the end of the interrupt handler after all other operations have finished.

fn zero() -> Self::Instant

The time at time zero. Used by RTIC before the monotonic has been initialized.

const DISABLE_INTERRUPT_ON_EMPTY_QUEUE: bool = true

This tells RTIC if it should disable the interrupt bound to the monotonic if there are no scheduled tasks. One may want to set this to false if one is using the on_interrupt method to perform housekeeping and need overflow interrupts to happen, such as when extending a 16 bit timer to 32/64 bits, even if there are no scheduled tasks.

fn enable_timer(&mut self)

Optional. This is used to save power, this is called when the Monotonic interrupt is enabled.

fn disable_timer(&mut self)

Optional. This is used to save power, this is called when the Monotonic interrupt is disabled.

impl<const FREQ: u32> Monotonic for MonoTimer<TIM4, FREQ>

type Instant = Instant<u32, 1, FREQ>

The type for instant, defining an instant in time.

type Duration = Duration<u32, 1, FREQ>

The type for duration, defining an duration of time.

unsafe fn reset(&mut self)

Optionally resets the counter to zero for a fixed baseline in a system.

fn now(&mut self) -> Self::Instant

Get the current time.

fn set_compare(&mut self, instant: Self::Instant)

Set the compare value of the timer interrupt.

fn clear_compare_flag(&mut self)

Clear the compare interrupt flag.

fn on_interrupt(&mut self)

Optional. Commonly used for performing housekeeping of a timer when it has been extended, e.g. a 16 bit timer extended to 32/64 bits. This will be called at the end of the interrupt handler after all other operations have finished.

fn zero() -> Self::Instant

The time at time zero. Used by RTIC before the monotonic has been initialized.

const DISABLE_INTERRUPT_ON_EMPTY_QUEUE: bool = true

This tells RTIC if it should disable the interrupt bound to the monotonic if there are no scheduled tasks. One may want to set this to false if one is using the on_interrupt method to perform housekeeping and need overflow interrupts to happen, such as when extending a 16 bit timer to 32/64 bits, even if there are no scheduled tasks.

fn enable_timer(&mut self)

Optional. This is used to save power, this is called when the Monotonic interrupt is enabled.

fn disable_timer(&mut self)

Optional. This is used to save power, this is called when the Monotonic interrupt is disabled.

impl<const FREQ: u32> Monotonic for MonoTimer<TIM5, FREQ>

type Instant = Instant<u32, 1, FREQ>

The type for instant, defining an instant in time.

type Duration = Duration<u32, 1, FREQ>

The type for duration, defining an duration of time.

unsafe fn reset(&mut self)

Optionally resets the counter to zero for a fixed baseline in a system.

fn now(&mut self) -> Self::Instant

Get the current time.

fn set_compare(&mut self, instant: Self::Instant)

Set the compare value of the timer interrupt.

fn clear_compare_flag(&mut self)

Clear the compare interrupt flag.

fn on_interrupt(&mut self)

Optional. Commonly used for performing housekeeping of a timer when it has been extended, e.g. a 16 bit timer extended to 32/64 bits. This will be called at the end of the interrupt handler after all other operations have finished.

fn zero() -> Self::Instant

The time at time zero. Used by RTIC before the monotonic has been initialized.

const DISABLE_INTERRUPT_ON_EMPTY_QUEUE: bool = true

This tells RTIC if it should disable the interrupt bound to the monotonic if there are no scheduled tasks. One may want to set this to false if one is using the on_interrupt method to perform housekeeping and need overflow interrupts to happen, such as when extending a 16 bit timer to 32/64 bits, even if there are no scheduled tasks.

fn enable_timer(&mut self)

Optional. This is used to save power, this is called when the Monotonic interrupt is enabled.

fn disable_timer(&mut self)

Optional. This is used to save power, this is called when the Monotonic interrupt is disabled.

impl<const FREQ: u32> Monotonic for MonoTimer<TIM8, FREQ>

type Instant = Instant<u32, 1, FREQ>

The type for instant, defining an instant in time.

type Duration = Duration<u32, 1, FREQ>

The type for duration, defining an duration of time.

unsafe fn reset(&mut self)

Optionally resets the counter to zero for a fixed baseline in a system.

fn now(&mut self) -> Self::Instant

Get the current time.

fn set_compare(&mut self, instant: Self::Instant)

Set the compare value of the timer interrupt.

fn clear_compare_flag(&mut self)

Clear the compare interrupt flag.

fn on_interrupt(&mut self)

Optional. Commonly used for performing housekeeping of a timer when it has been extended, e.g. a 16 bit timer extended to 32/64 bits. This will be called at the end of the interrupt handler after all other operations have finished.

fn zero() -> Self::Instant

The time at time zero. Used by RTIC before the monotonic has been initialized.

const DISABLE_INTERRUPT_ON_EMPTY_QUEUE: bool = true

This tells RTIC if it should disable the interrupt bound to the monotonic if there are no scheduled tasks. One may want to set this to false if one is using the on_interrupt method to perform housekeeping and need overflow interrupts to happen, such as when extending a 16 bit timer to 32/64 bits, even if there are no scheduled tasks.

fn enable_timer(&mut self)

Optional. This is used to save power, this is called when the Monotonic interrupt is enabled.

fn disable_timer(&mut self)

Optional. This is used to save power, this is called when the Monotonic interrupt is disabled.