Alarm
This module includes the platform abstraction for the alarm service.
Functions | |
void | otPlatAlarmMicroStartAt (otInstance *aInstance, uint32_t aT0, uint32_t aDt) |
Set the alarm to fire at aDt microseconds after aT0 . | |
void | otPlatAlarmMicroStop (otInstance *aInstance) |
Stop the alarm. | |
uint32_t | otPlatAlarmMicroGetNow (void) |
Get the current time. | |
void | otPlatAlarmMicroFired (otInstance *aInstance) |
Signal that the alarm has fired. | |
void | otPlatAlarmMilliStartAt (otInstance *aInstance, uint32_t aT0, uint32_t aDt) |
Set the alarm to fire at aDt milliseconds after aT0 . | |
void | otPlatAlarmMilliStop (otInstance *aInstance) |
Stop the alarm. | |
uint32_t | otPlatAlarmMilliGetNow (void) |
Get the current time. | |
void | otPlatAlarmMilliFired (otInstance *aInstance) |
Signal that the alarm has fired. | |
void | otPlatDiagAlarmFired (otInstance *aInstance) |
Signal diagnostics module that the alarm has fired. |
Detailed Description
This module includes the platform abstraction for the alarm service.
Function Documentation
◆ otPlatAlarmMicroFired()
void otPlatAlarmMicroFired | ( | otInstance * | aInstance | ) |
Signal that the alarm has fired.
- Parameters
-
[in] aInstance
The OpenThread instance structure.
◆ otPlatAlarmMicroGetNow()
uint32_t otPlatAlarmMicroGetNow | ( | void |
| ) |
Get the current time.
- 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
.
- 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.
- Parameters
-
[in] aInstance
The OpenThread instance structure.
◆ otPlatAlarmMilliFired()
void otPlatAlarmMilliFired | ( | otInstance * | aInstance | ) |
Signal that the alarm has fired.
- Parameters
-
[in] aInstance
The OpenThread instance structure.
◆ otPlatAlarmMilliGetNow()
uint32_t otPlatAlarmMilliGetNow | ( | void |
| ) |
Get the current time.
- 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
.
- 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.
- Parameters
-
[in] aInstance
The OpenThread instance structure.
◆ otPlatDiagAlarmFired()
void otPlatDiagAlarmFired | ( | otInstance * | aInstance | ) |
Signal diagnostics module that the alarm has fired.
- Parameters
-
[in] aInstance
The OpenThread instance structure.