Struct Alarm

pub struct Alarm<'d, MODE, DM, COMP = AnyComparator<'d>, UNIT = AnyUnit<'d>>
where
    DM: Mode,
{ /* private fields */ }

A single alarm.

Implementations

impl<'d, T, COMP: Comparator, UNIT: Unit> Alarm<'d, T, Blocking, COMP, UNIT>

pub fn new(comparator: COMP, unit: &FrozenUnit<'d, UNIT>) -> Self

Creates a new alarm from a comparator and unit, in blocking mode.

impl<'d, T, COMP: Comparator, UNIT: Unit> Alarm<'d, T, Async, COMP, UNIT>

pub fn new_async(comparator: COMP, unit: &FrozenUnit<'d, UNIT>) -> Self

Creates a new alarm from a comparator and unit, in async mode.

impl<'d, DM, COMP: Comparator, UNIT: Unit> Alarm<'d, Target, DM, COMP, UNIT>

where DM: Mode,

pub fn set_target(&self, timestamp: u64)

Set the target value of this Alarm

pub fn wait_until(&self, timestamp: u64)

Block waiting until the timer reaches the timestamp

pub fn into_periodic(self) -> Alarm<'d, Periodic, DM, COMP, UNIT>

Converts this Alarm into Periodic mode

impl<'d, DM, COMP: Comparator, UNIT: Unit> Alarm<'d, Periodic, DM, COMP, UNIT>

where DM: Mode,

pub fn set_period(&self, period: MicrosDurationU32)

Set the period of this Alarm

pub fn into_target(self) -> Alarm<'d, Target, DM, COMP, UNIT>

Converts this Alarm into Target mode

Trait Implementations

impl<T, DM, COMP: Comparator, UNIT: Unit> Debug for Alarm<'_, T, DM, COMP, UNIT>

where DM: Mode,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<COMP: Comparator, UNIT: Unit> DelayNs for Alarm<'_, Target, Async, COMP, UNIT>

async fn delay_ns(&mut self, nanos: u32)

Pauses execution for at minimum ns nanoseconds. Pause can be longer if the implementation requires it due to precision/timing issues.

async fn delay_ms(&mut self, ms: u32)

Pauses execution for at minimum ms milliseconds. Pause can be longer if the implementation requires it due to precision/timing issues.

async fn delay_us(&mut self, us: u32)

Pauses execution for at minimum us microseconds. Pause can be longer if the implementation requires it due to precision/timing issues.

impl From<Alarm<'static, Periodic, Blocking>> for AnyTimer

fn from(value: Alarm<'static, Periodic, Blocking>) -> Self

Converts to this type from the input type.

impl From<Alarm<'static, Target, Blocking>> for AnyTimer

fn from(value: Alarm<'static, Target, Blocking>) -> Self

Converts to this type from the input type.

impl<T, COMP: Comparator, UNIT: Unit> InterruptConfigurable for Alarm<'_, T, Blocking, COMP, UNIT>

fn set_interrupt_handler(&mut self, handler: InterruptHandler)

Set the interrupt handler

impl<T, DM, COMP: Comparator, UNIT: Unit> Peripheral for Alarm<'_, T, DM, COMP, UNIT>

where DM: Mode,

type P = Alarm<'_, T, DM, COMP, UNIT>

Peripheral singleton type

unsafe fn clone_unchecked(&self) -> Self::P

Unsafely clone (duplicate) a peripheral singleton.

fn into_ref<'a>(self) -> PeripheralRef<'a, Self::P>

where Self: 'a,

Convert a value into a PeripheralRef.

fn map_into<U>(self) -> U

where Self::P: Into<U>, U: Peripheral<P = U>,

Map the peripheral using Into.

impl<T, DM, COMP: Comparator, UNIT: Unit> Timer for Alarm<'_, T, DM, COMP, UNIT>

where DM: Mode,

fn start(&self)

Start the timer.

fn stop(&self)

Stop the timer.

fn reset(&self)

Reset the timer value to 0.

fn is_running(&self) -> bool

Is the timer running?

fn now(&self) -> Instant<u64, 1, 1_000_000>

The current timer value.

fn load_value(&self, value: MicrosDurationU64) -> Result<(), Error>

Load a target value into the timer.

fn enable_auto_reload(&self, auto_reload: bool)

Enable auto reload of the loaded value.

fn enable_interrupt(&self, state: bool)

Enable or disable the timer’s interrupt.

fn clear_interrupt(&self)

Clear the timer’s interrupt.

fn is_interrupt_set(&self) -> bool

Has the timer triggered?

fn set_interrupt_handler(&self, handler: InterruptHandler)

Set the interrupt handler