Skip to content

Commit c54703e

Browse files
committed
README: document tick() return value
tick() now returns the number of ticks until the next event, or 0 if no events are pending.
1 parent 7d1078f commit c54703e

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ Timer<10, micros> timer; // timer with 10 task slots and microsecond resolution
7272
bool handler(void *argument);
7373
7474
/* Timer Methods */
75-
/* Ticks the timer forward - call this function in loop() */
76-
void tick();
75+
/* Ticks the timer forward, returns the ticks until next event, or 0 if none */
76+
unsigned int tick(); // call this function in loop()
7777
7878
/* Calls handler with opaque as argument in delay units of time */
7979
bool in(unsigned long delay, handler_t handler, void *opaque = NULL);

0 commit comments

Comments
 (0)