Struct esp32_simple::clock::Timer

pub struct Timer<'a, T: Trigger> { /* private fields */ }

Represents a timer that can be used for various operations.

Type Parameters

• 'a - Lifetime of the timer.
• T - The trigger type implementing the Trigger trait.

Implementations

impl<'a, T: Trigger> Timer<'a, T>

pub fn new(timer: TimerDriver<'a>) -> Result<Self>

Creates a new Timer instance.

Arguments

• timer - A timer driver instance.

Returns

A new Timer instance.

Errors

Returns an error if the timer cannot be initialized.

pub fn configure_interrupt( &mut self, freq: u64, notifier: Notifier<T>, trigger: &'static T, ) -> Result<()>

Configures the timer interrupt.

Arguments

• freq - Frequency of the timer interrupt in Hz.
• notifier - A notifier to send timer tick events.
• trigger - The trigger to emit when the timer ticks.

Returns

Ok(()) on success.

Errors

Returns an error if the interrupt cannot be configured.

pub fn on(&mut self) -> Result<()>

Turns on the timer.

Returns

Ok(()) on success.

Errors

Returns an error if the timer cannot be turned on.

pub fn off(&mut self) -> Result<()>

Turns off the timer.

Returns

Ok(()) on success.

Errors

Returns an error if the timer cannot be turned off.

pub async fn delay(&mut self, freq: u64) -> Result<()>

Delays execution for a period determined by the given frequency.

The delay duration is 1 / freq seconds (i.e., one period of the frequency).

Arguments

• freq - Frequency in Hz; the delay lasts one period of this frequency.

Returns

Ok(()) when the delay completes.

Errors

Returns an error if the delay cannot be performed.