Fine tune Dimmer for more convenient usage.

Author: prampec

src/Dimmer.cpp

@@ -27,20 +27,20 @@
 #include "SoftTimer.h"
 #include "Dimmer.h"
 
-Dimmer::Dimmer(SoftPwmTask* pwm, int frequencyMs) : Task(10, &(Dimmer::step))
+Dimmer::Dimmer(SoftPwmTask* pwm, int frequencyMs, byte stepCount) : Task(10, &(Dimmer::step))
 {
   this->_pwm = pwm;
   this->direction = DIMMER_DIRECTION_HIGH;
   this->value = 0;
   this->_pwm->analogWrite((byte)this->value);
-  this->stepCount = DEFAULT_STEP_COUNT;
+  this->stepCount = stepCount;
 
   this->setFrequency(frequencyMs);
 }
 
 
-void Dimmer::startPulsate() {
-  this->stopOnLimit = false;
+void Dimmer::start(boolean stopOnLimit) {
+  this->stopOnLimit = stopOnLimit;
   SoftTimer.add(this->_pwm);
   SoftTimer.add(this);
 }
@@ -52,8 +52,16 @@ void Dimmer::hold() {
 void Dimmer::off() {
   this->hold();
   this->_pwm->off();
-  SoftTimer.remove(this);
+  this->value = 0;
   SoftTimer.remove(this->_pwm);
+  this->direction = DIMMER_DIRECTION_HIGH;
+}
+
+void Dimmer::on() {
+  this->hold();
+  this->value = this->_pwm->upperLimit;
+  this->_pwm->analogWrite(this->_pwm->upperLimit);
+  this->direction = DIMMER_DIRECTION_LOW;
 }
 
 void Dimmer::revertDirection() {
@@ -63,7 +71,6 @@ void Dimmer::revertDirection() {
 void Dimmer::setFrequency(int frequencyMs) {
   this->_stepLevel = (float)this->_pwm->upperLimit / (float)this->stepCount;
   this->periodMicros = (float)frequencyMs * 500.0 / (float)this->stepCount;
-  
 }
 
 byte Dimmer::getUpperLimit() {
@@ -95,4 +102,4 @@ void Dimmer::step(Task* task)
   }
 
 }
-
+

src/Dimmer.h

@@ -43,23 +43,36 @@ class Dimmer : public Task
      * We use the SoftPwmTask for dimming.
      *  pwm - The predefined SoftPwm task.
      *  frequencyMs - Milliseconds will be passed in the OFF->ON->OFF cicle.
+     *  stepCount - Steps should be perform between a full ON-OFF state.
      */
-    Dimmer(SoftPwmTask* pwm, int frequencyMs);
+    Dimmer(SoftPwmTask* pwm, int frequencyMs, byte stepCount = DEFAULT_STEP_COUNT);
 
     /**
      * Start an unlimited pulsation from the current value on, in the current direction.
      */
-    void startPulsate();
+    void start(byte direction, byte stopOnLimit);
+    
+    /**
+     * Start dimming from the current value on, in the current direction.
+     *  stopOnLimit - An unlimited pulsation is starting.
+     */
+    void start(boolean stopOnLimit);
+    void startPulsate() { this->start(false); }
 
     /**
      * Hold current PWM value on the output.
      */
     void hold();
 
+   /**
+    * Stop PWM, and set output to LOW.
+    */
+   void off();
+   
     /**
-     * Stop PWM, and set output to LOW.
+     * Stop PWM, and set output to pwm->upperLimit.
      */
-    void off();
+    void on();
 
     /**
      * Make the dimming to change direction.
@@ -103,4 +116,4 @@ class Dimmer : public Task
 };
 
 #endif
-
+

src/SoftPwmTask.h

@@ -48,13 +48,17 @@ class SoftPwmTask : public Task
      * Turns the output to low.
      */
     void off();
+    
+   /**
+    * Sets the PWM frequency (count of ON-OFFs per second).
+    */
     void setFrequency(unsigned long freq);
 
     /**
      * The "always on" level of the PWM. The default is 255.
      */
     byte upperLimit;
-	  
+    
   private:
     int _outPin;
     byte _value;