Alarm

This module includes the platform abstraction for the alarm service.

Summary

Functions
`otPlatAlarmMicroFired(otInstance *aInstance)`	`void` Signal that the alarm has fired.
`otPlatAlarmMicroGetNow(void)`	`uint32_t` Get the current time.
`otPlatAlarmMicroStartAt(otInstance *aInstance, uint32_t aT0, uint32_t aDt)`	`void` Set the alarm to fire at `aDt` microseconds after `aT0`.
`otPlatAlarmMicroStop(otInstance *aInstance)`	`void` Stop the alarm.
`otPlatAlarmMilliFired(otInstance *aInstance)`	`void` Signal that the alarm has fired.
`otPlatAlarmMilliGetNow(void)`	`uint32_t` Get the current time.
`otPlatAlarmMilliStartAt(otInstance *aInstance, uint32_t aT0, uint32_t aDt)`	`void` Set the alarm to fire at `aDt` milliseconds after `aT0`.
`otPlatAlarmMilliStop(otInstance *aInstance)`	`void` Stop the alarm.
`otPlatDiagAlarmFired(otInstance *aInstance)`	`void` Signal diagnostics module that the alarm has fired.

Functions

otPlatAlarmMicroFired

void otPlatAlarmMicroFired(
  otInstance *aInstance
)

Signal that the alarm has fired.

Details

Parameters

[in] aInstance

The OpenThread instance structure.

otPlatAlarmMicroGetNow

uint32_t otPlatAlarmMicroGetNow(
  void
)

Get the current time.

The current time MUST represent a free-running timer. When maintaining current time, the time value MUST utilize the entire range [0, 2^32-1] and MUST NOT wrap before 2^32.

Details
Returns	The current time in microseconds.

otPlatAlarmMicroStartAt

void otPlatAlarmMicroStartAt(
  otInstance *aInstance,
  uint32_t aT0,
  uint32_t aDt
)

Set the alarm to fire at aDt microseconds after aT0.

For aT0, the platform MUST support all values in [0, 2^32-1]. For aDt, the platform MUST support all values in [0, 2^31-1].

Details

Parameters

`[in] aInstance`	The OpenThread instance structure.
`[in] aT0`	The reference time.
`[in] aDt`	The time delay in microseconds from `aT0`.

otPlatAlarmMicroStop

void otPlatAlarmMicroStop(
  otInstance *aInstance
)

Stop the alarm.

Details

Parameters

[in] aInstance

The OpenThread instance structure.

otPlatAlarmMilliFired

void otPlatAlarmMilliFired(
  otInstance *aInstance
)

Signal that the alarm has fired.

Details

Parameters

[in] aInstance

The OpenThread instance structure.

otPlatAlarmMilliGetNow

uint32_t otPlatAlarmMilliGetNow(
  void
)

Get the current time.

The current time MUST represent a free-running timer. When maintaining current time, the time value MUST utilize the entire range [0, 2^32-1] and MUST NOT wrap before 2^32.

Details
Returns	The current time in milliseconds.

otPlatAlarmMilliStartAt

void otPlatAlarmMilliStartAt(
  otInstance *aInstance,
  uint32_t aT0,
  uint32_t aDt
)

Set the alarm to fire at aDt milliseconds after aT0.

For aT0 the platform MUST support all values in [0, 2^32-1]. For aDt, the platform MUST support all values in [0, 2^31-1].

Details

Parameters

`[in] aInstance`	The OpenThread instance structure.
`[in] aT0`	The reference time.
`[in] aDt`	The time delay in milliseconds from `aT0`.

otPlatAlarmMilliStop

void otPlatAlarmMilliStop(
  otInstance *aInstance
)

Stop the alarm.

Details

Parameters

[in] aInstance

The OpenThread instance structure.

otPlatDiagAlarmFired

void otPlatDiagAlarmFired(
  otInstance *aInstance
)

Signal diagnostics module that the alarm has fired.

Details

Parameters

[in] aInstance

The OpenThread instance structure.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.