weAut_01 / weAutSys    R 2.2.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines
Data Fields
timer_t Struct Reference

Data Fields

ucnt32_t end
 The timer's end (lapse) time.
struct timer_tnext
 The next timer.
ucnt32_t period
 The timer's period.
uint8_t state
 The timer's state and type.

Detailed Description

The timer data type resp.

structure

This type defines weAutSys' timers of 32 bit resolution in ms or s.

Note:
All fields of a timer may be read by application software even if that makes only partial sense. But !
No field of a timer must directly be set by application software.
It's best to use only the timer functions for manipulating timers.
See also:
msClock(void)
s_time(void)
TIMER_LAPSED
Examples:
main.c.

Field Documentation

The timer's end (lapse) time.

For a ms resolution timer:
This is the end time of a running timer in the (absolute) scale of ref msClock "ms since" system reset / restart (msClock).
End time may be 28,6 days in the future for this timer type.

For a seconds resolution timer:
This is the end time of a running timer in the (absolute) scale of ref secClock "seconds since" system reset / restart (secClock) respectively seconds since March 2008 local time (secTime308Loc()).
End time may be 68 years in the future for this timer type.

See also:
TIMER_RUNNING

The timer's period.

This is the actual period for the timer's current run or next re-start.

See also:
msClock(void)
secClock
TIMER_RUNNING
uint8_t state
struct timer_t* next

The next timer.

This points to the next timer if this timer is in any system maintained list.

  • This is for system software only!

The value must not be modified by user software; see also warnings above.

The only exception is for user / application software that chooses to handle a pool of timers and if the state of a pool timer is TIMER_TYPE_FREE.


The documentation for this struct was generated from the following file: