run() removed to improve compatibility - call loop() repeatedly instead

Author: joysfera

README.md

@@ -12,7 +12,7 @@ started (in what time since now) and how many times they should be invoked
 (only once, X times or forever).
 
 The "co-operation" is best achieved by creating small, short running tasks.
-Basically wherever you'd need to include the infamous *delay()* call in your Arduino program
+Basically wherever you'd need to include the infamous <code>delay()</code> call in your Arduino program
 that's the place where you actually want to break the code flow, split
 the source code into separate functions and let Tasker run them as separate tasks.
 
@@ -31,8 +31,12 @@ illustrates the whole API and its best usage.
 ChangeLog
 ---------
 * version 1.1 adds clear example of DS18B20 handling
+
 * version 1.2 adds optional priorities when defining tasks
 
+* version 1.3 removes the <code>run()</code> function - please call <code>tasker.loop()</code> in your Arduino <code>loop()</code> function instead. This makes **Tasker** much more Arduino friendly and compatible with far more platforms where the Arduino 'kernel' does some housekeeping behind the scenes and needs the <code>loop()</code> to be running for it. It also allowed me to remove the <code>yield()</code> call that didn't really bring anything but issues in compiling on some platforms.
+
+
 How to use
 ----------
 
@@ -70,24 +74,8 @@ Tasker API
   May pass the <code>optional_int</code> parameter into the called function.
   When the task finishes (after its last iteration) its Tasker slot is made available for new tasks.
 
-* <code>run()</code> when called it starts the Tasker scheduler and will never return.
-  Best to be called as the very last command of the Arduino's <code>setup()</code> function:
-
-```cpp
-	void setup() {
-		tasker.setInterval(...);
-		tasker.run();	// will not return
-	}
-
-	void loop() {
-		// unused, never called
-	}
-```
-
-* optional: if you, for whatever reason, don't want to let the <code>Tasker.run()</code>
-  govern all of your running code and wish to run Tasker together with some
-  existing code you can omit the <code>run()</code> and call the <code>Tasker.loop()</code>
-  repeatedly instead.
+* <code>loop()</code> when called it runs the Tasker scheduler and process all waiting tasks, then ends.
+  Best to be called as often as possible, ideally in the Arduino's <code>loop()</code> function:
 
 ```cpp
 	void setup() {
@@ -96,7 +84,6 @@ Tasker API
 
 	void loop() {
 		tasker.loop();	// needs to be called as often as possible
-		// legacy code here
 	}
 ```
 

Tasker.h

@@ -23,7 +23,6 @@ class Tasker
 	bool setInterval(TaskCallback func, unsigned long interval, int param = 0, byte prio = TASKER_MAX_TASKS);
 	bool setRepeated(TaskCallback func, unsigned long interval, unsigned int repeat, int param = 0, byte prio = TASKER_MAX_TASKS);
 	void loop(void);
-	void run(void) { while(true) { loop(); yield(); } }
 private:
 	struct TASK {
 		TaskCallback call;
@@ -90,7 +89,6 @@ void Tasker::loop(void)
 			}
 			if (t_prioritized)
 				break;
-			yield();
 			now = millis();
 		}
 		if (inc)

examples/DallasTemperature/DallasTemperature.ino

@@ -29,7 +29,8 @@ void setup() {
     sensor.setWaitForConversion(false);
     // read temperature every 5 seconds
     tasker.setInterval(startConversion, 5000);
-    tasker.run();
 }
 
-void loop() { }
+void loop() {
+    tasker.loop();
+}

examples/MultiBlink/MultiBlink.ino

@@ -42,11 +42,10 @@ void setup()
     tasker.setInterval(blink2, 750, 12);
     // called every 1000 milliseconds 10 times, with optional parameter pin = 11
     tasker.setRepeated(blink2, 1000, 10, 11);
-
-    tasker.run(); // never returns
 }
 
 void loop()
 {
+    tasker.loop();
 }
 

keywords.txt

@@ -3,4 +3,5 @@ Tasker		KEYWORD1
 setTimeout	KEYWORD2
 setInterval	KEYWORD2
 setRepeated	KEYWORD2
-TASKER_MAX_TASKS	KEYWORD2
+loop		KEYWORD2
+TASKER_MAX_TASKS	LITERAL1