Add support for buzzer (#318)

Author: user2684

NodeManager.ino

@@ -366,7 +366,7 @@ void before() {
   Serial.begin(MY_BAUD_RATE);
 
 
-  
+    
   /*
   * Configure your sensors below
   */

NodeManagerLibrary.h

@@ -831,8 +831,10 @@ class SensorDigitalOutput: public Sensor {
     void setInputIsElapsed(bool value);
     // [107] optionally wait for the given number of milliseconds after changing the status (default: 0)
     void setWaitAfterSet(int value);
+    // [108] when switching on, turns the output off after the given number of milliseconds. For latching relay controls the pulse width (default: 0)
+    void setPulseWidth(int value);
     // manually switch the output to the provided value
-    void setStatus(Child* child, int value);
+    void setStatus(int value);
     // get the current state
     int getStatus();
     void onSetup();
@@ -844,9 +846,10 @@ class SensorDigitalOutput: public Sensor {
     bool _legacy_mode = false;
     bool _input_is_elapsed = false;
     int _wait_after_set = 0;
+    int _pulse_width = 0;
     Timer* _safeguard_timer;
     void _setupPin(Child* child, int pin);
-    virtual void _setStatus(Child* child, int value);
+    virtual void _setStatus(int value);
     int _getValueToWrite(int value);
 };
 
@@ -864,8 +867,6 @@ class SensorRelay: public SensorDigitalOutput {
 class SensorLatchingRelay: public SensorRelay {
   public:
     SensorLatchingRelay(NodeManager& node_manager, int pin, int child_id = -255);
-    // [201] set the duration of the pulse to send in ms to activate the relay (default: 50)
-    void setPulseWidth(int value);
     // [202] set the pin which turns the relay off (default: the pin provided while registering the sensor)
     void setPinOff(int value);
     // [203] set the pin which turns the relay on (default: the pin provided while registering the sensor + 1)
@@ -875,8 +876,7 @@ class SensorLatchingRelay: public SensorRelay {
   protected:
     int _pin_on;
     int _pin_off;
-    int _pulse_width = 50;
-    void _setStatus(Child* child, int value);
+    void _setStatus(int value);
 };
 #endif
 

NodeManagerLibrary.ino

@@ -1223,6 +1223,9 @@ void SensorDigitalOutput::setInputIsElapsed(bool value) {
 void SensorDigitalOutput::setWaitAfterSet(int value) {
   _wait_after_set = value;
 }
+void SensorDigitalOutput::setPulseWidth(int value) {
+  _pulse_width = value;
+}
 
 // main task
 void SensorDigitalOutput::onLoop(Child* child) {
@@ -1231,7 +1234,7 @@ void SensorDigitalOutput::onLoop(Child* child) {
     // update the timer
     _safeguard_timer->update();
     // if the time is over, turn the output off
-    if (_safeguard_timer->isOver()) setStatus(child,OFF);
+    if (_safeguard_timer->isOver()) setStatus(OFF);
   }
 }
 
@@ -1242,7 +1245,7 @@ void SensorDigitalOutput::onReceive(MyMessage* message) {
   // by default handle a SET message but when legacy mode is set when a REQ message is expected instead
   if ( (message->getCommand() == C_SET && ! _legacy_mode) || (message->getCommand() == C_REQ && _legacy_mode)) {
     // switch the output
-    setStatus(child, message->getInt());
+    setStatus(message->getInt());
   }
   if (message->getCommand() == C_REQ && ! _legacy_mode) {
     // just return the current status
@@ -1251,7 +1254,7 @@ void SensorDigitalOutput::onReceive(MyMessage* message) {
 }
 
 // write the value to the output
-void SensorDigitalOutput::setStatus(Child* child, int value) {
+void SensorDigitalOutput::setStatus(int value) {
   // pre-process the input value
   if (_input_is_elapsed) {
     // the input provided is an elapsed time
@@ -1269,12 +1272,12 @@ void SensorDigitalOutput::setStatus(Child* child, int value) {
     // if turning the output on and a safeguard timer is configured, start it
     if (value == ON && _safeguard_timer->isConfigured() && ! _safeguard_timer->isRunning()) _safeguard_timer->start();
   }
-  _setStatus(child, value);
+  _setStatus(value);
   // wait if needed for relay drawing a lot of current
   if (_wait_after_set > 0) _node->sleepOrWait(_wait_after_set);
   // store the new status so it will be sent to the controller
   _status = value;
-  ((ChildInt*)child)->setValueInt(value);
+  ((ChildInt*)children.get(1))->setValueInt(value);
 }
 
 // setup the provided pin for output
@@ -1289,19 +1292,24 @@ void SensorDigitalOutput::_setupPin(Child* child, int pin) {
 }
 
 // switch to the requested status
-void SensorDigitalOutput::_setStatus(Child* child, int value) {
+void SensorDigitalOutput::_setStatus(int value) {
   int value_to_write = _getValueToWrite(value);
   // set the value to the pin
   digitalWrite(_pin, value_to_write);
   #if FEATURE_DEBUG == ON
     Serial.print(_name);
     Serial.print(F(" I="));
-    Serial.print(child->child_id);
+    Serial.print(children.get(1)->child_id);
     Serial.print(F(" P="));
     Serial.print(_pin);
     Serial.print(F(" V="));
     Serial.println(value_to_write);
   #endif
+  // if pulse width is set and status is on, turn it off after the configured interval
+  if (_pulse_width > 0 && value == ON) {
+    _node->sleepOrWait(_pulse_width);
+    digitalWrite(_pin, !value_to_write);
+  }
 }
 
 // reverse the value if needed based on the _on_value
@@ -1338,12 +1346,11 @@ SensorLatchingRelay::SensorLatchingRelay(NodeManager& node_manager, int pin, int
   _pin_on = pin;
   _pin_off = pin + 1;
   children.get(1)->description = _name;
+  // set pulse duration
+  _pulse_width = 50;
 }
 
 // setter/getter
-void SensorLatchingRelay::setPulseWidth(int value) {
-  _pulse_width = value;
-}
 void SensorLatchingRelay::setPinOn(int value) {
   _pin_on = value;
 }
@@ -1358,7 +1365,7 @@ void SensorLatchingRelay::onSetup() {
 }
 
 // switch to the requested status
-void SensorLatchingRelay::_setStatus(Child* child, int value) {
+void SensorLatchingRelay::_setStatus(int value) {
   // select the right pin to send the pulse to
   int pin = value == OFF ? _pin_off : _pin_on;
   // set the value
@@ -1367,8 +1374,9 @@ void SensorLatchingRelay::_setStatus(Child* child, int value) {
   _node->sleepOrWait(_pulse_width);
   digitalWrite(pin, ! _on_value);
   #if FEATURE_DEBUG == ON
-    Serial.print(F("LAT I="));
-    Serial.print(child->child_id);
+    Serial.print(_name);
+    Serial.print(F(" I="));
+    Serial.print(children.get(1)->child_id);
     Serial.print(F(" P="));
     Serial.print(pin);
     Serial.print(F(" S="));
@@ -4159,12 +4167,12 @@ void SensorConfiguration::onReceive(MyMessage* message) {
             case 105: custom_sensor->setSafeguard(request.getValueInt()); break;
             case 106: custom_sensor->setInputIsElapsed(request.getValueInt()); break;
             case 107: custom_sensor->setWaitAfterSet(request.getValueInt()); break;
+            case 108: custom_sensor->setPulseWidth(request.getValueInt()); break;
           default: return;
         }
         if (function > 200 && strcmp(sensor->getName(),"LATCHING") == 0) {
           SensorLatchingRelay* custom_sensor_2 = (SensorLatchingRelay*)sensor;
           switch(function) {
-            case 201: custom_sensor_2->setPulseWidth(request.getValueInt()); break;
             case 202: custom_sensor_2->setPinOff(request.getValueInt()); break;
             case 203: custom_sensor_2->setPinOn(request.getValueInt()); break;
             default: return;

README.md

@@ -491,12 +491,12 @@ Each sensor class exposes additional methods.
     void setInputIsElapsed(bool value);
     // [107] optionally wait for the given number of milliseconds after changing the status (default: 0)
     void setWaitAfterSet(int value);
+    // [108] when switching on, turns the output off after the given number of milliseconds. For latching relay controls the pulse width (default: 0)
+    void setPulseWidth(int value);
 ~~~
 
 * SensorLatchingRelay (in addition to those available for SensorDigitalOutput / SensorRelay)
 ~~~c
-    // [201] set the duration of the pulse to send in ms to activate the relay (default: 50)
-    void setPulseWidth(int value);
     // [202] set the pin which turns the relay off (default: the pin provided while registering the sensor)
     void setPinOff(int value);
     // [203] set the pin which turns the relay on (default: the pin provided while registering the sensor + 1)