eLua reference manual - tmr module
Overview
This module contains functions for accessing the hardware timers of the eLua CPU. In addition, if virtual timers are enabled (see here and here for details), they can be used just like the "regular" (hardware) timers with a single exception: you can't set the clock of a virtual timer (using tmr.setclock). To use virtual timers with this module, specify tmr.VIRTx as the timer ID instead of a number. For example, if the eLua image was configured to support 4 virtual timers, they will be available by using tmr.VIRT0 to tmr.VIRT3 as timer IDs. The system timer can also be used with any of these functions by omitting the timer ID or specifying it as tmr.SYS_TIMER.
All "time units" (delays, differences in time) in this module, as well as in other parts of eLua (timeouts) are expressed in microseconds. However, please keep in mind that the actual timer resolution depends on many factors. For example, it's very likely that the tmr.delay function won't be able to delay for the exact amount you specify (in us), as the real delay depends on a number of variables, most notably the base clock of the timer and the size of the timer counter register (32 bits on some platforms, 16 bits on most platforms, other values are less common). To ensure that the delay you're requesting is achievable, use tmr.getmindelay and tmr.getmaxdelay to obtain the maximum and the minimum achievable wait times on your timer, respectively. Even if your delay is within these limits, the precision of this function still varies a lot, mainly as a function of the timer base clock. Using the system timer is highly encouraged if it is available on the platform as it can eliminate the forementioned problems.
Functions
tmr.delay( id, period )
Waits for the specified period, then returns.
Arguments:
- id - the timer ID. Use nil or tmr.SYS_TIMER to specify the system timer.
- period - how long to wait (in us).
Returns: nothing.
counter = tmr.read( [id] )
Reads the timer counter register.
Arguments: id (optional) - the timer ID. Use nil or tmr.SYS_TIMER to specify the system timer. Defaults to nil if not specified.
Returns: The value of the timer counter register.
counter = tmr.start( [id] )
Starts the specified timer.
Arguments: id (optional) - the timer ID. Use nil or tmr.SYS_TIMER to specify the system timer. Defaults to nil if not specified.
Returns: The value of the timer counter register when the timer started.
delta = tmr.gettimediff( id, start, end )
Computes the time difference between two timer counter values (obtained by calling tmr.read or tmr.start). NOTE: the order of start and end is important. end must correspond to a moment in time which came after start. The function knows how to deal with a single timer overflow condition (end is less than start); if the timer overflowed 2 or more times between start and end the result of this function will be incorrect.
Arguments:
- id - the timer ID. Use nil or tmr.SYS_TIMER to specify the system timer.
- start - the initial counter value.
- end - the final counter value.
Returns: The time difference (in us).
delta = tmr.getdiffnow( id, start )
Computes the time difference between a counter value from the past (obtained by calling tmr.read or tmr.start) and the counter value corresponding to the current time.
Arguments:
- id - the timer ID. Use nil or tmr.SYS_TIMER to specify the system timer.
- start - the initial counter value.
Returns: The time difference (in us).
mindelay = tmr.getmindelay( [id] )
Get the minimum achievable delay on the specified timer.
Arguments: id (optional) - the timer ID. Use nil or tmr.SYS_TIMER to specify the system timer. Defaults to nil if not specified.
Returns: The minimum achievable delay on the specified timer (in us).
maxdelay = tmr.getmaxdelay( [id] )
Get the maximum achievable delay on the specified timer.
Arguments: id (optional) - the timer ID. Use nil or tmr.SYS_TIMER to specify the system timer. Defaults to nil if not specified.
Returns: The maximum achievable delay on the specified timer (in us).
clock = tmr.setclock( id, clock )
Set the timer clock (the clock used to increment the timer counter register).
Arguments:
- id - the timer ID. Use nil or tmr.SYS_TIMER to specify the system timer.
- clock - the timer clock (in Hz).
Returns: The actual clock set on the timer (in Hz). Depending on the hardware, this might have a different value than the clock argument. NOTE: this function does not work with virtual timers or the system timer.
clock = tmr.getclock( [id] )
Get the timer clock (the clock used to increment the timer counter register).
Arguments: id (optional) - the timer ID. Use nil or tmr.SYS_TIMER to specify the system timer. Defaults to nil if not specified.
Returns: The timer clock (in Hz).
tmr.set_match_int( id, period, type )
Setup the timer match interrupt. Only available if interrupt support is enabled, check here for details.
Arguments:
- id - the timer ID. If nil it defaults to the system timer (but note that this happens only for consistency, as the system timer can't generate interrupts).
- period - the interrupt period in microseconds. Setting this to 0 disabled the timer match interrupt.
- type - tmr.INT_ONESHOT to generate a single interrupt after period microseconds, or tmr.INT_CYCLIC to generate interrupts every period microseconds.
Returns: nothing.