Timer Entity

See the Timer Entity for generic information.

group TimerEntity

The Timer Class provides access to a simple scheduler. The timer can set to fire only once, or to repeat at a certain interval. Additionally, a timer entity can execute custom Reflex routines upon firing.

void timer_getExpiration(unsigned int *id, struct Result *result, const int index)

Get the currently set expiration time in microseconds. This is not a “live” timer. That is, it shows the expiration time originally set with setExpiration; it does not “tick down” to show the time remaining before expiration.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

void timer_setExpiration(unsigned int *id, struct Result *result, const int index, const unsigned int usecDuration)

Set the expiration time for the timer entity. When the timer expires, it will fire the associated timer[index]() reflex.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

  • usecDuration – The duration before timer expiration in microseconds.

void timer_getMode(unsigned int *id, struct Result *result, const int index)

Get the mode of the timer which is either single or repeat mode.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code and the requested value if successful.

  • index – The index of the entity in question.

void timer_setMode(unsigned int *id, struct Result *result, const int index, const unsigned char mode)

Set the mode of the timer which is either single or repeat mode.

The result parameter will output the following fields:

Parameters:

  • id – ID assigned through “module_createStem”

  • result – Output object containing result code.

  • index – The index of the entity in question.

  • mode – The mode of the timer. aTIMER_MODE_REPEAT or aTIMER_MODE_SINGLE.