Alarm

nRF5 SDK for Thread and Zigbee v4.2.0
Functions

This module includes the platform abstraction for the alarm service. More...

Functions

void otPlatAlarmMicroStartAt (otInstance *aInstance, uint32_t aT0, uint32_t aDt)
 
void otPlatAlarmMicroStop (otInstance *aInstance)
 
uint32_t otPlatAlarmMicroGetNow (void)
 
void otPlatAlarmMicroFired (otInstance *aInstance)
 
void otPlatAlarmMilliStartAt (otInstance *aInstance, uint32_t aT0, uint32_t aDt)
 
void otPlatAlarmMilliStop (otInstance *aInstance)
 
uint32_t otPlatAlarmMilliGetNow (void)
 
void otPlatAlarmMilliFired (otInstance *aInstance)
 
void otPlatDiagAlarmFired (otInstance *aInstance)
 

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]aInstanceThe 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]aInstanceThe OpenThread instance structure.
[in]aT0The reference time.
[in]aDtThe time delay in microseconds from aT0.

◆ otPlatAlarmMicroStop()

void otPlatAlarmMicroStop ( otInstance *  aInstance)

Stop the alarm.

Parameters
[in]aInstanceThe OpenThread instance structure.

◆ otPlatAlarmMilliFired()

void otPlatAlarmMilliFired ( otInstance *  aInstance)

Signal that the alarm has fired.

Parameters
[in]aInstanceThe 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]aInstanceThe OpenThread instance structure.
[in]aT0The reference time.
[in]aDtThe time delay in milliseconds from aT0.

◆ otPlatAlarmMilliStop()

void otPlatAlarmMilliStop ( otInstance *  aInstance)

Stop the alarm.

Parameters
[in]aInstanceThe OpenThread instance structure.

◆ otPlatDiagAlarmFired()

void otPlatDiagAlarmFired ( otInstance *  aInstance)

Signal diagnostics module that the alarm has fired.

Parameters
[in]aInstanceThe OpenThread instance structure.