Struct esp32_hal::timer::Timer

pub struct Timer<TIMG: TimerGroup, INST: TimerInst> { /* fields omitted */ }

Hardware timers

The timers can be programmed in a high level way via start, wait, cancel.

Lower level access is provided by the other functions.

Implementations

impl<TIMG: TimerGroup> Timer<TIMG, Timer0>

pub fn new(
    timg: TIMG,
    clock_control_config: ClockControlConfig
) -> (Timer<TIMG, Timer0>, Timer<TIMG, Timer1>, Timer<TIMG, TimerLact>, Watchdog<TIMG>)

Create new timer resources

This function will create 2 timers and 1 watchdog for a timer group. It uses the clock_control_config for obtaining the clock configuration.

Note: time to clock tick conversions are done with the clock frequency when the start function is called. The clock frequency is not locked.

impl<INST: TimerInst> Timer<TIMG0, INST>

pub fn release(
    _timer0: Timer<TIMG0, Timer0>,
    _timer1: Timer<TIMG0, Timer1>,
    _timer2: Timer<TIMG0, TimerLact>
) -> TIMG0

Releases the timer resources. Requires to release all timers and watchdog belonging to the same group at once.

impl<INST: TimerInst> Timer<TIMG1, INST>

pub fn release(
    _timer0: Timer<TIMG1, Timer0>,
    _timer1: Timer<TIMG1, Timer1>,
    _timer2: Timer<TIMG1, TimerLact>
) -> TIMG1

Releases the timer resources. Requires to release all timers and watchdog belonging to the same group at once.

Trait Implementations

impl<TIMG: TimerGroup> Cancel for Timer<TIMG, Timer0>

type Error = Error

Error returned when a countdown can't be canceled.

fn cancel(&mut self) -> Result<(), Self::Error>

Cancel running timer.

This will stop the timer if running and returns error when not running.

impl<TIMG: TimerGroup> Cancel for Timer<TIMG, Timer1>

type Error = Error

Error returned when a countdown can't be canceled.

fn cancel(&mut self) -> Result<(), Self::Error>

Cancel running timer.

This will stop the timer if running and returns error when not running.

impl<TIMG: TimerGroup> Cancel for Timer<TIMG, TimerLact>

type Error = Error

Error returned when a countdown can't be canceled.

fn cancel(&mut self) -> Result<(), Self::Error>

Cancel running timer.

This will stop the timer if running and returns error when not running.

impl<TIMG: TimerGroup> CountDown for Timer<TIMG, Timer0>

type Time = NanoSecondsU64

The unit of time used by this timer

fn start<T: Into<Self::Time>>(&mut self, timeout: T)

Start timer

fn wait(&mut self) -> Result<(), Void>

Wait for timer to finish

Note: if the timeout is handled via an interrupt, this will never return.

impl<TIMG: TimerGroup> CountDown for Timer<TIMG, Timer1>

type Time = NanoSecondsU64

The unit of time used by this timer

fn start<T: Into<Self::Time>>(&mut self, timeout: T)

Start timer

fn wait(&mut self) -> Result<(), Void>

Wait for timer to finish

Note: if the timeout is handled via an interrupt, this will never return.

impl<TIMG: TimerGroup> CountDown for Timer<TIMG, TimerLact>

type Time = NanoSecondsU64

The unit of time used by this timer

fn start<T: Into<Self::Time>>(&mut self, timeout: T)

Start timer

fn wait(&mut self) -> Result<(), Void>

Wait for timer to finish

Note: if the timeout is handled via an interrupt, this will never return.

impl<TIMG: TimerGroup> Periodic for Timer<TIMG, Timer0>

impl<TIMG: TimerGroup> Periodic for Timer<TIMG, Timer1>

impl<TIMG: TimerGroup> Periodic for Timer<TIMG, TimerLact>

impl<TIMG: TimerGroup, INST: TimerInst> Send for Timer<TIMG, INST>

impl<TIMG: TimerGroup> TimerWithInterrupt for Timer<TIMG, Timer0>

fn listen(&mut self, event: Event)

Starts listening for an event

fn unlisten(&mut self, event: Event)

Stops listening for an event

fn clear_interrupt(&mut self) -> &mut Self

Clear interrupt once fired

fn set_value<T: Into<TicksU64>>(&mut self, value: T) -> &mut Self

Set timer value

fn get_value(&self) -> TicksU64

Get timer value

fn get_value_in_ns(&self) -> NanoSecondsU64

Get timer value in ns

fn get_alarm(&self) -> TicksU64

Get alarm value

fn get_alarm_in_ns(&self) -> NanoSecondsU64

Get alarm value in ns

fn set_alarm<T: Into<TicksU64>>(&mut self, value: T) -> &mut Self

Set alarm value

Note: timer is not disabled, so there is a risk for false triggering between setting upper and lower 32 bits.

fn set_alarm_in_ns<T: Into<NanoSecondsU64>>(&mut self, value: T) -> &mut Self

Set alarm value in ns

Note: timer is not disabled, so there is a risk for false triggering between setting upper and lower 32 bits.

fn enable(&mut self, enable: bool) -> &mut Self

Enable or disables the timer

fn is_enabled(&mut self) -> bool

Enable or disables the timer

fn stop(&mut self)

Stop the timer

fn increasing(&mut self, enable: bool) -> &mut Self

Set to true to increase the timer value on each tick, set to false to decrease the timer value on each tick.

fn is_increasing(&mut self) -> bool

Returns true if the timer is increasing, otherwise decreasing

fn auto_reload(&mut self, enable: bool) -> &mut Self

Set to true if the timer needs to be reloaded to initial value once the alarm is reached.

fn enable_alarm(&mut self, enable: bool) -> &mut Self

Enable alarm triggering

fn alarm_active(&mut self) -> bool

Is the alarm active

fn set_divider(&mut self, divider: u32) -> Result<&mut Self, Error>

Set clock divider.

Value must be between 2 and 65536 inclusive for Timer 0 and 1 and between 3 and 65535 for TimerLact.

fn get_divider(&self) -> u32

Get the current clock divider

impl<TIMG: TimerGroup> TimerWithInterrupt for Timer<TIMG, Timer1>

fn listen(&mut self, event: Event)

Starts listening for an event

fn unlisten(&mut self, event: Event)

Stops listening for an event

fn clear_interrupt(&mut self) -> &mut Self

Clear interrupt once fired

fn set_value<T: Into<TicksU64>>(&mut self, value: T) -> &mut Self

Set timer value

fn get_value(&self) -> TicksU64

Get timer value

fn get_value_in_ns(&self) -> NanoSecondsU64

Get timer value in ns

fn get_alarm(&self) -> TicksU64

Get alarm value

fn get_alarm_in_ns(&self) -> NanoSecondsU64

Get alarm value in ns

fn set_alarm<T: Into<TicksU64>>(&mut self, value: T) -> &mut Self

Set alarm value

Note: timer is not disabled, so there is a risk for false triggering between setting upper and lower 32 bits.

fn set_alarm_in_ns<T: Into<NanoSecondsU64>>(&mut self, value: T) -> &mut Self

Set alarm value in ns

Note: timer is not disabled, so there is a risk for false triggering between setting upper and lower 32 bits.

fn enable(&mut self, enable: bool) -> &mut Self

Enable or disables the timer

fn is_enabled(&mut self) -> bool

Enable or disables the timer

fn stop(&mut self)

Stop the timer

fn increasing(&mut self, enable: bool) -> &mut Self

Set to true to increase the timer value on each tick, set to false to decrease the timer value on each tick.

fn is_increasing(&mut self) -> bool

Returns true if the timer is increasing, otherwise decreasing

fn auto_reload(&mut self, enable: bool) -> &mut Self

Set to true if the timer needs to be reloaded to initial value once the alarm is reached.

fn enable_alarm(&mut self, enable: bool) -> &mut Self

Enable alarm triggering

fn alarm_active(&mut self) -> bool

Is the alarm active

fn set_divider(&mut self, divider: u32) -> Result<&mut Self, Error>

Set clock divider.

Value must be between 2 and 65536 inclusive for Timer 0 and 1 and between 3 and 65535 for TimerLact.

fn get_divider(&self) -> u32

Get the current clock divider

impl<TIMG: TimerGroup> TimerWithInterrupt for Timer<TIMG, TimerLact>

fn listen(&mut self, event: Event)

Starts listening for an event

fn unlisten(&mut self, event: Event)

Stops listening for an event

fn clear_interrupt(&mut self) -> &mut Self

Clear interrupt once fired

fn set_value<T: Into<TicksU64>>(&mut self, value: T) -> &mut Self

Set timer value

fn get_value(&self) -> TicksU64

Get timer value

fn get_value_in_ns(&self) -> NanoSecondsU64

Get timer value in ns

fn get_alarm(&self) -> TicksU64

Get alarm value

fn get_alarm_in_ns(&self) -> NanoSecondsU64

Get alarm value in ns

fn set_alarm<T: Into<TicksU64>>(&mut self, value: T) -> &mut Self

Set alarm value

Note: timer is not disabled, so there is a risk for false triggering between setting upper and lower 32 bits.

fn set_alarm_in_ns<T: Into<NanoSecondsU64>>(&mut self, value: T) -> &mut Self

Set alarm value in ns

Note: timer is not disabled, so there is a risk for false triggering between setting upper and lower 32 bits.

fn enable(&mut self, enable: bool) -> &mut Self

Enable or disables the timer

fn is_enabled(&mut self) -> bool

Enable or disables the timer

fn stop(&mut self)

Stop the timer

fn increasing(&mut self, enable: bool) -> &mut Self

Set to true to increase the timer value on each tick, set to false to decrease the timer value on each tick.

fn is_increasing(&mut self) -> bool

Returns true if the timer is increasing, otherwise decreasing

fn auto_reload(&mut self, enable: bool) -> &mut Self

Set to true if the timer needs to be reloaded to initial value once the alarm is reached.

fn enable_alarm(&mut self, enable: bool) -> &mut Self

Enable alarm triggering

fn alarm_active(&mut self) -> bool

Is the alarm active

fn set_divider(&mut self, divider: u32) -> Result<&mut Self, Error>

Set clock divider.

Value must be between 2 and 65536 inclusive for Timer 0 and 1 and between 3 and 65535 for TimerLact.

fn get_divider(&self) -> u32

Get the current clock divider