commit 4f34a9141c30fe196bd6a1d1e3b52b261b1a013c
parent c19f56ed3386821c96ba15d85009f0d2c7f22095
Author: Martin Kloeckner <mjkloeckner@gmail.com>
Date: Wed, 5 Nov 2025 16:34:46 -0300
updated `README.md`
Diffstat:
| M | README.md | | | 36 | +++++++++++++++++++++++++++++++++--- |
1 file changed, 33 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -4,17 +4,47 @@ This is a simple program that implements a task scheduler. It executes a series
of tasks attached to the scheduler after their specified task period (in
milliseconds) has passed.
-In the example, four leds are controlled: two blink at different rates, and the
-other two controlled by buttons.
+In the example, four LEDs are controlled: two blink at different rates, and the
+other two following the states of two buttons (if the button is pressed the led
+is on, and if the button is not pressed the led is off).
+
+The tasks are assigned to the scheduler with the following statements:
+
+```c
+task_t tasks[] = {
+ // on_update period id
+ { toggle_led_1, 1000, TOGGLE_LED_1_ID },
+ { toggle_led_2, 500, TOGGLE_LED_2_ID },
+ { read_button_a, 0, READ_BTN_A_ID },
+ { read_button_b, 0, READ_BTN_B_ID }
+};
+
+scheduler_init(tasks, sizeof(tasks)/sizeof(tasks[0]));
+```
+
+The scheduler invokes the `on_update` field function when the specified period
+for that tasks has passed, the period being in milliseconds. When the period is
+zero, the function updates on every millisecond.
+
+The `scheduler_tick` must be called on every millisecond, this only signals the
+scheduler that a tick has passed, all the tasks execution happens when the
+`scheduler_update` function get called.
+
+> **NOTE**: tasks are executed sequentially, so if one task takes more than 1 ms
+> to execute and another task needs to run at the same time, the first task will
+> delay the other.
## Dependencies
+On Linux the following packages are needed to compile the code:
+
* `avr-gcc` and `avr-libc` to compile the code
* `avrdude` for uploading the program to the microcontroller
## Compile and upload to the board
-Having the dependencies installed, compile the code running `make` or:
+Having the dependencies installed, compile the code using `make` from a shell,
+as follows:
```console
$ make compile
