Skip to content

Many changes to timer. #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Many changes to timer. #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ void loop() {

Make a function to call when the *Timer* expires
```cpp
bool function_to_call(void *argument /* optional argument given to in/at/every */) {
bool function_to_call(void *argument /* optional argument given to in/at/every */
long overdue_by /* difference between the desired and requested time */) {
return true; // to repeat the action - false to stop
}
```
Expand Down Expand Up @@ -57,8 +58,8 @@ timer.cancel(task);

Be fancy with **lambdas**
```cpp
timer.in(1000, [](void*) -> bool { return false; });
timer.in(1000, [](void *argument) -> bool { return argument; }, argument);
timer.in(1000, [](void*, long) -> bool { return false; });
timer.in(1000, [](void *argument, long overdue_by) -> bool { return argument; }, argument);
```

### API
Expand All @@ -75,7 +76,7 @@ Timer<10> timer; // Timer with 10 task slots
Timer<10, micros> timer; // timer with 10 task slots and microsecond resolution

/* Signature for handler functions */
bool handler(void *argument);
bool handler(void *argument, long overdue_by);

/* Timer Methods */
/* Ticks the timer forward, returns the ticks until next event, or 0 if none */
Expand All @@ -93,8 +94,8 @@ at(unsigned long time, handler_t handler, void *opaque = NULL);
Timer<>::Task
every(unsigned long interval, handler_t handler, void *opaque = NULL);

/* Cancel a timer task */
void cancel(Timer<>::Task &task);
/* Cancel a timer task. returns true if uncompleted task was found. */
bool cancel(Timer<>::Task task);
```

### Installation
Expand All @@ -114,7 +115,7 @@ The simplest example, blinking an LED every second *(from examples/blink)*:

auto timer = timer_create_default(); // create a timer with default settings

bool toggle_led(void *) {
bool toggle_led(void *, long) {
digitalWrite(LED_BUILTIN, !digitalRead(LED_BUILTIN)); // toggle the LED
return true; // keep timer active? true
}
Expand All @@ -141,7 +142,7 @@ Currently only a software timer. Any blocking code delaying *timer*.**tick()** w

The library does not do any dynamic memory allocation.

The number of concurrent tasks is a compile time constant, meaning there is a limit to the number of concurrent tasks. The **in / at / every** functions return **NULL** if the *Timer* is full.
The number of concurrent tasks is a compile time constant, meaning there is a limit to the number of concurrent tasks. The **in / at / every** functions return **0** if the *Timer* is full.

A *Task* value is valid only for the timer that created it, and only for the lifetime of that timer.

Expand Down
Loading