#44 one time long schedule support

Author: davetcc

examples/longSchedule/longSchedule.ino

@@ -10,6 +10,7 @@
 #include <TaskManagerIO.h>
 #include <TmLongSchedule.h>
 #include <Wire.h>
+#include <IoLogging.h>
 
 //
 // Here we create an OO task (a task that is actually a class instance). In this case the exec() method will be
@@ -35,6 +36,7 @@ public:
 
 // Forward references
 void dailyScheduleFn();
+void fiveMinsOnceFn();
 
 //
 // Here we create two schedules to be registered with task manager later. One will fire every days and one will fire
@@ -43,28 +45,29 @@ void dailyScheduleFn();
 //
 TmLongSchedule hourAndHalfSchedule(makeHourSchedule(1, 30), &myTaskExec);
 TmLongSchedule onceADaySchedule(makeDaySchedule(1), dailyScheduleFn);
+TmLongSchedule fiveMinsOnceSchedule(makeHourSchedule(0, 5), fiveMinsOnceFn, true);
 
 void setup() {
-    Serial.begin(115200);
+    //Serial.begin(115200);
+    Serial1.begin(115200);
 
-    Serial.println("Started long schedule example");
+    serdebugF("Started long schedule example");
 
     // First two long schedules are global variables.
     // IMPORTANT NOTE: If you use references to a variable like this THEY MUST BE GLOBAL
     taskManager.registerEvent(&hourAndHalfSchedule);
     taskManager.registerEvent(&onceADaySchedule);
+    taskManager.registerEvent(&fiveMinsOnceSchedule);
 
     // this shows how to create a long schedule event using the new operator, make sure the second parameter is true
     // as this will delete the event when it completes.
     taskManager.registerEvent(new TmLongSchedule(makeHourSchedule(0, 15), [] {
-        Serial.print(millis());
-        Serial.println(": Fifteen minutes passed");
+        serdebugF(": Fifteen minutes passed");
     }), true);
 
     // lastly we show the regular event creation method, this task is enabled and disabled by the OO task.
     auto taskId = taskManager.scheduleFixedRate(120, [] {
-        Serial.print(millis());
-        Serial.println(": Two minutes");
+        serdebugF(": Two minutes");
     }, TIME_SECONDS);
 
     myTaskExec.setTaskToSuspend(taskId);
@@ -75,6 +78,9 @@ void loop() {
 }
 
 void dailyScheduleFn() {
-    Serial.print(millis());
-    Serial.println(": Daily schedule");
+    serdebugF("Daily schedule");
+}
+
+void fiveMinsOnceFn() {
+    serdebugF("Five mins once, should not occur again");
 }

src/TmLongSchedule.cpp

@@ -17,11 +17,11 @@ uint32_t makeDaySchedule(int days, int hours) {
     return (days * 24UL * HOURS_TO_MILLIS) + (hours * MINUTES_TO_MILLIS);
 }
 
-TmLongSchedule::TmLongSchedule(uint32_t milliScheduleNext, Executable* toExecute) : milliSchedule(milliScheduleNext),
-        fnCallback(nullptr), theExecutable(toExecute), lastScheduleTime(0) { }
+TmLongSchedule::TmLongSchedule(uint32_t milliScheduleNext, Executable* toExecute, bool oneTime) : milliSchedule(milliScheduleNext),
+        fnCallback(nullptr), theExecutable(toExecute), lastScheduleTime(0), oneTime(oneTime) { }
 
-TmLongSchedule::TmLongSchedule(uint32_t milliScheduleNext, TimerFn toExecute) : milliSchedule(milliScheduleNext),
-        fnCallback(toExecute), theExecutable(nullptr), lastScheduleTime(0) { }
+TmLongSchedule::TmLongSchedule(uint32_t milliScheduleNext, TimerFn toExecute, bool oneTime) : milliSchedule(milliScheduleNext),
+        fnCallback(toExecute), theExecutable(nullptr), lastScheduleTime(0), oneTime(oneTime) { }
 
 void TmLongSchedule::exec() {
     lastScheduleTime = millis();
@@ -36,6 +36,7 @@ void TmLongSchedule::exec() {
         fnCallback();
     }
 
+    setCompleted(oneTime);
 }
 
 uint32_t TmLongSchedule::timeOfNextCheck() {

src/TmLongSchedule.h

@@ -18,18 +18,19 @@ class TmLongSchedule : public BaseEvent {
     const TimerFn fnCallback;
     Executable *const theExecutable;
     uint32_t lastScheduleTime;
+    bool oneTime;
 public:
     /** Create a schedule that will call back a TimerFn functional callback.
      * @param milliSchedule the schedule to call back on
      * @param callee the functional callback
      */
-    TmLongSchedule(uint32_t milliSchedule, TimerFn callee);
+    TmLongSchedule(uint32_t milliSchedule, TimerFn callee, bool oneTime = false);
     /**
      * Create schedule that will call the exec() method on an Executable
      * @param milliSchedule the schedule to call back on
      * @param callee the object extending from Executable
      */
-    TmLongSchedule(uint32_t milliSchedule, Executable* callee);
+    TmLongSchedule(uint32_t milliSchedule, Executable* callee, bool oneTime = false);
 
     void exec() override;