Struct rp2040_hal::timer::Alarm1

pub struct Alarm1(/* private fields */);

An alarm that can be used to schedule events in the future. Alarms can also be configured to trigger interrupts.

Trait Implementations

impl Alarm for Alarm1

fn clear_interrupt(&mut self)

Clear the interrupt flag. This should be called after interrupt TIMER_IRQ_1 is called.

The interrupt is unable to trigger a 2nd time until this interrupt is cleared.

fn enable_interrupt(&mut self)

Enable this alarm to trigger an interrupt. This alarm will trigger TIMER_IRQ_1.

After this interrupt is triggered, make sure to clear the interrupt with clear_interrupt.

fn disable_interrupt(&mut self)

Disable this alarm, preventing it from triggering an interrupt.

fn schedule( &mut self, countdown: MicrosDurationU32 ) -> Result<(), ScheduleAlarmError>

Schedule the alarm to be finished after countdown. If enable_interrupt is called, this will trigger interrupt TIMER_IRQ_1 whenever this time elapses.

fn schedule_at(&mut self, timestamp: Instant) -> Result<(), ScheduleAlarmError>

Schedule the alarm to be finished at the given timestamp. If enable_interrupt is called, this will trigger interrupt TIMER_IRQ_1 whenever this timestamp is reached.

The RP2040 is unable to schedule an event taking place in more than u32::max_value() microseconds.

fn finished(&self) -> bool

Return true if this alarm is finished. The returned value is undefined if the alarm has not been scheduled yet.

fn cancel(&mut self) -> Result<(), ScheduleAlarmError>

Cancel an activated Alarm. No negative effects if it’s already disabled. Unlike timer::cancel trait, this only cancels the alarm and keeps the timer running if it’s already active.

impl Drop for Alarm1

fn drop(&mut self)

Executes the destructor for this type.