Skip to content

Commit fa295aa

Browse files
committed
Updated README
1 parent 12bff32 commit fa295aa

File tree

3 files changed

+9
-11
lines changed

3 files changed

+9
-11
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
<img src="https://github.com/vishnumaiea/ptScheduler/blob/main/assets/ptScheduler-Feature-Image-1_3-1.png" alt="ptScheduler" width="500"/>
22

33
# Pretty tiny Scheduler
4-
**Pretty tiny Scheduler** or **ptScheduler** is a non-preemptive task scheduler library for **Arduino** that helps you to write **non-blocking periodic tasks** easily and effectively without using ordinary delay routines or using `millis()` function on your own.
4+
**Pretty tiny Scheduler** or **ptScheduler** is a non-preemptive task scheduler and a timing library for **Arduino** that helps you to write **non-blocking periodic tasks** easily and effectively without using ordinary delay routines or using `millis()` or `micros()` functions.
55

6-
You won't have to use **delay()** or **millis()** functions again.
7-
8-
Under the hood, ptScheduler uses the native `millis()` implementation. The `millis()` function is a hardware timer based **ISR** that increments a global counter variable (unsigned integer) every millisecond.
6+
Under the hood, ptScheduler uses the native `micros()` implementation. The `micros()` function is a hardware timer based **ISR** that increments a global counter variable (unsigned integer) every microsecond.
97

108
When you create a new ptScheduler object, you can specify the **time intervals** and **execution modes**. All the class member variables and functions are public and therefore gives you full control over your tasks, allowing dynamically changing the behavior of the task.
119

12-
To run a task, just enclose the **`call()`** function inside any **conditional statements**, either inside your infinite loop or inside a function. Every time you invoke the `call()` function, it checks if the elapsed time is larger than the preset interval. If yes, it will return `true` and cause the code under the conditional block to be executed once.
10+
To run a task, just enclose the **`call()`** function inside any **conditional statements**, either inside your infinite loop or inside a function. Every time you invoke the `call()` function, it checks if the elapsed time is larger than the preset interval. If yes, it will return `true` and cause the code under the conditional block to be executed.
1311

14-
ptScheduler is good mainly for **control applications** that require the periodic polling of sensors, GPIOs and other IO devices. ptScheduler tasks can coexist with preemptive tasks such as **FreeRTOS** tasks.
12+
ptScheduler is good for **control applications** that require periodic polling of sensors, GPIOs and other IO devices. ptScheduler tasks can coexist with preemptive tasks such as **FreeRTOS** tasks.
1513

1614
## Hello World
1715

@@ -21,7 +19,7 @@ Here is the basic `Hello World` example.
2119
#include "ptScheduler.h"
2220

2321
//create tasks
24-
ptScheduler sayHello = ptScheduler(1000);
22+
ptScheduler sayHello = ptScheduler(1000000); //time in microseconds
2523

2624
//setup function runs once
2725
void setup() {

library.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "ptScheduler",
33
"keywords": "timer, timing, scheduler, tasks, delay",
4-
"description": "Arduino library for writing non-blocking periodic tasks without using delay or millis routines.",
4+
"description": "Arduino timing library for writing non-blocking periodic tasks without using delay or millis routines.",
55
"repository":
66
{
77
"type": "git",
@@ -13,7 +13,7 @@
1313
"url": "https://github.com/vishnumaiea",
1414
"maintainer": true
1515
},
16-
"version": "2.0.0",
16+
"version": "2.1.0",
1717
"license": "MIT",
1818
"frameworks": "arduino",
1919
"platforms": "*"

library.properties

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
name=ptScheduler
2-
version=2.0.0
2+
version=2.1.0
33
author=Vishnu Mohanan
44
maintainer=Vishnu Mohanan
5-
sentence=Arduino library for writing non-blocking periodic tasks without using delay or millis routines.
5+
sentence=Arduino timing library for writing non-blocking periodic tasks without using delay or millis routines.
66
paragraph=Run multiple tasks periodically without blocking other tasks. Write intuitive code with great flexibility over timing and logic.
77
category=Timing
88
url=https://github.com/vishnumaiea/ptScheduler

0 commit comments

Comments
 (0)