Introducing init() method for initializing tasks.

Author: prampec

examples/SoftTimer6Debouncer1/SoftTimer6Debouncer1.ino

@@ -14,6 +14,7 @@ Debouncer debouncer(INPUT_PIN, MODE_CLOSE_ON_PUSH, onPressed, onReleased);
 
 void setup() {
   Serial.begin(9800);
+  debouncer.init();
   PciManager.registerListener(INPUT_PIN, &debouncer);
   Serial.println("Ready.");
 }
@@ -24,4 +25,4 @@ void onPressed() {
 void onReleased(unsigned long pressTimespan) {
   Serial.print(pressTimespan);
   Serial.println(" - released");
-}
+}

examples/SoftTimer6Debouncer2/SoftTimer6Debouncer2.ino

@@ -21,6 +21,7 @@ Debouncer debouncer(INPUT_PIN, MODE_CLOSE_ON_PUSH, onPressed, onReleased);
 
 void setup() {
   Serial.begin(9800);
+  debouncer.init();
   // -- Setup external pin change interrupt for the pin.
   setupInterrupts(INPUT_PIN);
   Serial.println("Ready.");

examples/SoftTimer6Rotary/SoftTimer6Rotary.ino

@@ -16,6 +16,8 @@ Debouncer rotPushDebouncer(ROT_PUSH, MODE_CLOSE_ON_PUSH, onRotPushPress, onRotPu
 
 void setup() {
   Serial.begin(9600);
+  rotPushDebouncer.init();
+  r.init();
   PciManager.registerListener(ROT_PUSH, &rotPushDebouncer);
 
   Serial.println("Ready.");

examples/SoftTimer8Dimmer/SoftTimer8Dimmer.ino

@@ -21,6 +21,7 @@ SoftPwmTask pwm(OUT_PIN);
 Dimmer dimmer(&pwm, 1500);
 
 void setup() {
+  dimmer.init();
   PciManager.registerListener(INPUT_PIN, &debouncer);
 }
 
@@ -38,4 +39,4 @@ void onReleased(unsigned long pressTimespan) {
   }
 }
 
-
+

examples/SoftTimer9FrequencyTask/SoftTimer9FrequencyTask.ino

@@ -19,6 +19,9 @@ Task stateStepTask(3000, stateStep);
 int state = 0;
 
 void setup() {
+  f1.init();
+  f2.init();
+  f3.init();
   SoftTimer.add(&stateStepTask);
 }
 
@@ -48,4 +51,4 @@ void stateStep(Task* task) {
     SoftTimer.remove(&f1);
     state = 0;
   }
-}
+}

library.properties

@@ -1,5 +1,5 @@
 name=SoftTimer
-version=3.1.5
+version=3.2.0
 author=Balazs Kelemen <[email protected]>
 maintainer=Balazs Kelemen <[email protected]>
 sentence=SoftTimer is a lightweight pseudo multitasking solution for Arduino.

src/BlinkTask.cpp

@@ -31,37 +31,48 @@
 #define BLINK_STATE_ON   1
 #define BLINK_STATE_WAIT 2
 
-void BlinkTask::init(byte outPin, unsigned long onMs, unsigned long offMs, byte count, unsigned long delayMs) {
+void BlinkTask::setupProperties(byte outPin, unsigned long onMs, unsigned long offMs, byte count, unsigned long delayMs) {
+  this->_outPin = outPin;
   this->onMs = onMs;
   this->offMs = offMs;
   this->count = count;
   this->delayMs = delayMs;
+  this->onLevel = HIGH;
+}
 
-  pinMode(outPin, OUTPUT);
-  this->_bitMask = digitalPinToBitMask(outPin);
-  this->_portRegister = portOutputRegister(digitalPinToPort(outPin));
+void BlinkTask::init() {
+  pinMode(this->_outPin, OUTPUT);
+  this->_bitMask = digitalPinToBitMask(this->_outPin);
+  this->_portRegister = portOutputRegister(digitalPinToPort(this->_outPin));
 
-  this->onLevel = HIGH;
+  // -- Turn off.
+  if(this->onLevel == HIGH) {
+    *this->_portRegister &= ~this->_bitMask;
+  } else {  
+    *this->_portRegister |= this->_bitMask;
+  }
+  Task::init();
 }
 
 BlinkTask::BlinkTask(byte outPin, unsigned long onOffMs) : Task(onOffMs, &(BlinkTask::stepState)) {
-  this->init(outPin, onOffMs, onOffMs, 0, 0);
+  this->setupProperties(outPin, onOffMs, onOffMs, 0, 0);
 }
 
 BlinkTask::BlinkTask(byte outPin, unsigned long onMs, unsigned long offMs) : Task(onMs, &(BlinkTask::stepState)) {
-  this->init(outPin, onMs, offMs, 0, 0);
+  this->setupProperties(outPin, onMs, offMs, 0, 0);
 }
 
 BlinkTask::BlinkTask(byte outPin, unsigned long onMs,unsigned long offMs, byte count) : Task(onMs, &(BlinkTask::stepState)) {
-  this->init(outPin, onMs, offMs, count, 0);
-  this->stop();
+  this->setupProperties(outPin, onMs, offMs, count, 0);
 }
 
-BlinkTask::BlinkTask(byte outPin, unsigned long onMs, unsigned long offMs, byte count, unsigned long delayMs) : Task(onMs, &(BlinkTask::stepState)) {
-  this->init(outPin, onMs, offMs, count, delayMs);
+BlinkTask::BlinkTask(byte outPin, unsigned long onMs, unsigned long offMs, byte count, unsigned long delayMs)
+  : Task(onMs, &(BlinkTask::stepState)) {
+  this->setupProperties(outPin, onMs, offMs, count, delayMs);
 }
 
 void BlinkTask::start() {
+  this->init();
   this->_state = BLINK_STATE_OFF;
   this->_counter = 0;
   this->setPeriodMs(0);

src/BlinkTask.h

@@ -27,8 +27,7 @@
 #ifndef BLINKTASK_H
 #define BLINKTASK_H
 
-#include <inttypes.h>
-#include "Arduino.h"
+#include <Arduino.h>
 #include "Task.h"
 
 class BlinkTask : public Task
@@ -69,6 +68,8 @@ class BlinkTask : public Task
      */
     BlinkTask(byte outPin, unsigned long onMs, unsigned long offMs, byte count, unsigned long delayMs);
 
+    void init() override;
+
     /**
      * Register the blink Task to the Timer Manager: start blinking.
      */
@@ -102,12 +103,13 @@ class BlinkTask : public Task
     byte onLevel;
 
   private:
-    void init(byte outPin, unsigned long onMs, unsigned long offMs, byte count, unsigned long delayMs);
+    void setupProperties(byte outPin, unsigned long onMs, unsigned long offMs, byte count, unsigned long delayMs);
     static void stepState(Task* me);
     byte _counter;
     /** Can be STATE_OFF, STATE_ON, STATE_WAIT */
     byte _state;
 
+    byte _outPin;
     uint8_t _bitMask;
 #ifndef ESP8266
     volatile uint8_t *_portRegister;

src/Debouncer.cpp

@@ -36,14 +36,20 @@ Debouncer::Debouncer(int pin, int pushMode, void (*onPressed)(), void (*onReleas
   this->_onLevel = pushMode;
   this->_onPressed = onPressed;
   this->_onReleased = onReleased;
-  
-  if(pullUp) {
-    pinMode(pin, INPUT_PULLUP);
+  this->_pullUp = pullUp;
+}
+
+void Debouncer::init()
+{
+  if(this->_pullUp) {
+    pinMode(this->_pin, INPUT_PULLUP);
   } else {
-    pinMode(pin, INPUT);
+    pinMode(this->_pin, INPUT);
   }
   this->_state = digitalRead(this->_pin) == this->_onLevel ? STATE_ON : STATE_OFF;
 
+  Task::init();
+
   SoftTimer.add(this);
 }
 

src/Debouncer.h

@@ -60,6 +60,8 @@ class Debouncer : public PciListener, public Task
       *   it was released.
       */
     Debouncer(int pin, int pushMode, void (*onPressed)(), void (*onReleased)(unsigned long pressTimespan), bool pullUp=false);
+
+    void init() override;
 
     /**
      * Please call this function on interrupt.
@@ -74,8 +76,9 @@ class Debouncer : public PciListener, public Task
   private:
     int _pin;
     int _onLevel;
+    bool _pullUp;
     volatile int _state; // 0=off, 1=bouncing, 2=pressing
-    unsigned long _pressStart;
+    volatile unsigned long _pressStart;
     void (*_onPressed)();
     void (*_onReleased)(unsigned long pressTimespan);
     static void step(Task* me);

src/Dimmer.cpp

@@ -32,12 +32,16 @@ Dimmer::Dimmer(SoftPwmTask* pwm, int frequencyMs, byte stepCount) : Task(10, &(D
   this->_pwm = pwm;
   this->direction = DIMMER_DIRECTION_HIGH;
   this->value = 0;
-  this->_pwm->analogWrite((byte)this->value);
   this->stepCount = stepCount;
 
   this->setFrequency(frequencyMs);
 }
 
+void Dimmer::init()
+{
+  this->_pwm->analogWrite((byte)this->value);
+  Task::init();
+}
 
 void Dimmer::start(boolean stopOnLimit) {
   this->stopOnLimit = stopOnLimit;

src/Dimmer.h

@@ -47,6 +47,8 @@ class Dimmer : public Task
      */
     Dimmer(SoftPwmTask* pwm, int frequencyMs, byte stepCount = DEFAULT_STEP_COUNT);
 
+    void init() override;
+
     /**
      * Start an unlimited pulsation from the current value on, in the current direction.
      */

src/FrequencyTask.cpp

@@ -29,14 +29,20 @@
 
 FrequencyTask::FrequencyTask(int outPin, float freq) : Task(0, &(FrequencyTask::step))
 {
-  pinMode(outPin, OUTPUT);
-  
+  this->_outPin = outPin;
+
   _bitMask = digitalPinToBitMask(outPin);
   _portRegister = portOutputRegister(digitalPinToPort(outPin));
 
   this->setFrequency(freq);
 }
 
+void FrequencyTask::init()
+{
+  pinMode(this->_outPin, OUTPUT);
+  
+  Task::init();
+}
 
 void FrequencyTask::setFrequency(float freq) {
   this->periodMicros = 500000.0 / freq;
@@ -55,4 +61,4 @@ void FrequencyTask::step(Task* task)
 
   ft->_stateOn = !ft->_stateOn;
 }
-
+

src/FrequencyTask.h

@@ -42,12 +42,15 @@ class FrequencyTask : public Task
      */
     FrequencyTask(int outPin, float freq);
 
+    void init() override;
+
     /**
      * Adjust the frequency.
      */
     void setFrequency(float freq);
 
   private:
+    int _outPin;
     boolean _stateOn;
     uint8_t _bitMask;
 #ifndef ESP8266
@@ -59,4 +62,4 @@ class FrequencyTask : public Task
 };
 
 #endif
-
+

src/Rotary.cpp

@@ -38,16 +38,24 @@
 
 Rotary::Rotary(int pinA, int pinB, void (*onRotation)(short direction, Rotary* rotary), bool pullUp)
     : Task(IDDLE_TIME_MICROS, &(Rotary::step)) {
-  this->_listenerA.init(pinA, this, pullUp);
-  this->_listenerB.init(pinB, this, pullUp);
+  this->_pinA = pinA;
+  this->_pinB = pinB;
+  this->_pullUp = pullUp;
   this->_stateCW = EVENT_NOTIFIED;
   this->_stateCCW = EVENT_NOTIFIED;
   this->_onRotation = onRotation;
-  
-  PciManager.registerListener(pinA, &this->_listenerA);
-  PciManager.registerListener(pinB, &this->_listenerB);
+}
+
+void Rotary::init()
+{
+  this->_listenerA.init(this->_pinA, this, this->_pullUp);
+  this->_listenerB.init(this->_pinB, this, this->_pullUp);
+
+  PciManager.registerListener(this->_pinA, &this->_listenerA);
+  PciManager.registerListener(this->_pinB, &this->_listenerB);
 
   SoftTimer.add(this);
+  Task::init();
 }
 
 void Rotary::pciHandleChange(byte changedTo, PciListenerImp2* listener) {

src/Rotary.h

@@ -52,6 +52,8 @@ class Rotary : public Task, public IPciChangeHandler
       *   it was released.
       */
     Rotary(int pinA, int pinB, void (*onRotation)(short direction, Rotary* rotary), bool pullUp=false);
+
+    void init() override;
 
     /**
      * Please call this function on interrupt.
@@ -63,6 +65,10 @@ class Rotary : public Task, public IPciChangeHandler
     PciListenerImp2 _listenerB = PciListenerImp2();
     volatile int _stateCW;
     volatile int _stateCCW;
+    int _pinA;
+    int _pinB;
+    boolean _pullUp;
+
     void (*_onRotation)(short direction, Rotary* rotary);
     static void step(Task* me);
 };

src/SoftPwmTask.cpp

@@ -33,13 +33,16 @@ SoftPwmTask::SoftPwmTask(int pin) : Task(0, &(SoftPwmTask::step))
   _value = 0;
   _counter = 0;
   upperLimit = 255;
-  pinMode(_outPin, OUTPUT);
   this->periodMicros = 30;
 
   _bitMask = digitalPinToBitMask(pin);
   _portRegister = portOutputRegister(digitalPinToPort(pin));
 }
 
+void SoftPwmTask::init() {
+  pinMode(this->_outPin, OUTPUT);
+  Task::init();
+}
 
 void SoftPwmTask::analogWrite(byte value) {
   this->_value = value;

src/SoftPwmTask.h

@@ -37,6 +37,8 @@ class SoftPwmTask : public Task
      * We would like to do pwn on the given pin.
      */
     SoftPwmTask(int pin);
+
+    void init() override;
 
     /**
      * Just like in the Arduino implementation this method will set the duty level of the pin.

src/SoftTimer.cpp

@@ -24,22 +24,25 @@
 
 */
 
-#include "Arduino.h"
 #include "SoftTimer.h"
 
 /**
  * The main loop is implemented here. You do not ever need to implement this function
  * if you think in event driven programing.
  */
 void loop() {
-  SoftTimer.run(); // -- run() will never return, if PREVENT_LOOP_ITERATION macro is defined.
+  SoftTimer.run(); // -- run() will never return, unless ENABLE_LOOP_ITERATION macro is defined.
 }
 
-
 /**
  * Register a task in the timer manager.
  */
 void SoftTimerClass::add(Task* task) {
+  // -- If a task is not initialized, we should do in now.
+  if (!task->initialized)
+  {
+    task->init();
+  }
 
   // -- A task should be registered only once.
   this->remove(task);