Improved MQTT setup and added support for digital switches as sensor input

Author: Manuel-Sensate

firmware-esp8266.ino

@@ -11,7 +11,7 @@
     SOURCE: https://github.com/sensate-io/firmware-esp8266.git
 
     @section  HISTORY
-    v33 - Improved MQTT Setup Routine
+    v33 - Added Digital Sensor Switch Support, Improved MQTT Setup Routine
     v32 - Added MQTT Support!
     v31 - Fixed an issue with DHT11 Sensors
     v30 - Added support for SSD1306 I2C Displays
@@ -30,11 +30,11 @@ Display* display = NULL;
 int currentVersion = 33; 
 boolean printMemory = false;
 
-// String board = "Generic";
-// char firmwareType[] = "ESP8266";
+String board = "Generic";
+char firmwareType[] = "ESP8266";
 
-String board = "NodeMCU";
-char firmwareType[] = "ESP8266-NodeMCU";
+// String board = "NodeMCU";
+// char firmwareType[] = "ESP8266-NodeMCU";
 
 // String board = "ESP12s";
 // char firmwareType[] = "ESP8266-ESP12s";

src/communication/Data.cpp

@@ -12,6 +12,7 @@
     SOURCE: https://github.com/sensate-io/firmware-esp8266.git
 
     @section  HISTORY
+    v33 - Added Digital Sensor Switch Support
     v32 - Added MQTT Support!
     v29 - First Public Release
 */
@@ -49,7 +50,13 @@ String Data::getRequestString() {
   else if(_type==2)
     returnString = returnString + String(_valueInt);
   else if(_type==3)
-    returnString = returnString + String(_valueBoolean);  
+  {
+    if(_valueBoolean)
+      returnString = returnString + "true";
+    else
+      returnString = returnString + "false";
+      
+  }
 
   return returnString+","+_unit;
 

src/communication/MQTT.cpp

@@ -11,6 +11,7 @@
     SOURCE: https://github.com/sensate-io/firmware-esp8266.git
 
     @section  HISTORY
+    v33 - Added Digital Sensor Switch Support
     v32 - Added MQTT Support!
 */
 /**************************************************************************/
@@ -90,15 +91,31 @@ bool MQTT::connect()
 
 void MQTT::publishForAutoDiscovery(Sensor* sensor)
 {
-    String pTopic = "homeassistant/sensor/"+clientId+"/"+String(sensor->getId())+"/config";
+    String pTopic;
+    
+    if(sensor->isBinary())
+    {
+        pTopic = "homeassistant/binary_sensor/"+clientId+"/"+String(sensor->getId())+"/config";
+    }
+    else
+     pTopic = "homeassistant/sensor/"+clientId+"/"+String(sensor->getId())+"/config";
+
     String category = sensor->getCategory();
     String pPayload;
 
     if(category==NULL)
         category = "Unnamed";
 
-    if(sensor->getMqttClass()=="resistance" || sensor->getMqttClass()=="altitude" || sensor->getMqttClass()=="flux" || sensor->getMqttClass()=="")
-        pPayload = "{\"name\": \""+sensor->getName()+"\", \"state_topic\": \"Sensate/"+category+"/"+sensor->getName()+"/value\", \"unit_of_measurement\": \""+sensor->getMqttUnit()+"\"}";
+    if(sensor->getMqttClass()=="resistance" || sensor->getMqttClass()=="altitude" || sensor->getMqttClass()=="flux" || sensor->getMqttClass()=="" || sensor->getMqttClass()=="raw")
+    {
+             pPayload = "{\"name\": \""+sensor->getName()+"\", \"state_topic\": \"Sensate/"+category+"/"+sensor->getName()+"/value\"";
+             if(sensor->isBinary())
+                pPayload = pPayload + ", \"payload_on\": \"1\", \"payload_off\": \"0\"}";
+             else
+             {
+                 pPayload = pPayload + ", \"unit_of_measurement\": \""+sensor->getMqttUnit()+"\"}";
+             }
+    }   
     else
         pPayload = "{\"name\": \""+sensor->getName()+"\", \"device_class\": \""+sensor->getMqttClass()+"\", \"state_topic\": \"Sensate/"+category+"/"+sensor->getName()+"/value\", \"unit_of_measurement\": \""+sensor->getMqttUnit()+"\"}";
 

src/controller/Bridge.cpp

@@ -11,6 +11,7 @@
     SOURCE: https://github.com/sensate-io/firmware-esp8266.git
 
     @section  HISTORY
+    v33 - Added Digital Sensor Switch Support
     v32 - Added MQTT Support!
     v29 - First Public Release
 */
@@ -707,7 +708,7 @@ void configurePort(int portNumber, JsonObject& portConfig) {
 
   Serial.println("Configure Onboard Port:" + port);
 
-  // portConfig.prettyPrintTo(Serial);
+  portConfig.prettyPrintTo(Serial);
 
   SensorCalculation* calc = NULL;
 
@@ -777,6 +778,15 @@ void configurePort(int portNumber, JsonObject& portConfig) {
       addSensor(new SensorAnalogue (portConfig["id"], portConfig["c"], portConfig["sn"], portConfig["n"], 0, refreshInterval, postDataInterval, portConfig["s"]["svt"], calc));
     }
   }
+  else
+  {
+    uint8_t intPort = translateGPIOPort(port);
+    if(intPort!=-1)
+    {
+      Serial.println("Setting up Digital Switch at Port: " + port);
+      addSensor(new SensorDigitalSwitch(portConfig["id"], portConfig["c"], portConfig["sn"], portConfig["n"], intPort, refreshInterval, postDataInterval, calc));
+    }
+  }
 }
 
 void addSensor(Sensor *sensor)

src/controller/Bridge.h

@@ -11,6 +11,7 @@
     SOURCE: https://github.com/sensate-io/firmware-esp8266.git
 
     @section  HISTORY
+    v33 - Added Digital Sensor Switch Support
     v32 - Added MQTT Support!
     v29 - First Public Release
 */
@@ -28,6 +29,7 @@
 #include "../communication/MQTT.h"
 #include "../input/Sensor.h"
 #include "../input/analog/SensorAnalogue.h"
+#include "../input/SensorDigitalSwitch.h"
 #include "../input/i2c/Ads1x15.h"
 #include "../input/i2c/SensorBMx280.h"
 #include "../input/i2c/SensorBME680.h"

src/input/Sensor.cpp

@@ -11,6 +11,7 @@
     SOURCE: https://github.com/sensate-io/firmware-esp8266.git
 
     @section  HISTORY
+    v33 - Changes for Digital Sensor Switch Support
     v32 - Added MQTT Support!
     v29 - First Public Release
 */
@@ -20,7 +21,7 @@
 
 extern unsigned long nextSensorDue;
 
-Sensor::Sensor (long id, String category, String shortName, String name, int refreshInterval, int postDataInterval, float smartValueThreshold, SensorCalculation* calculation) {
+Sensor::Sensor (long id, String category, String shortName, String name, int refreshInterval, int postDataInterval, float smartValueThreshold, SensorCalculation* calculation, bool binary) {
   lastTick = -1;
   lastPost = -1;
   _refreshInterval = refreshInterval;
@@ -31,6 +32,7 @@ Sensor::Sensor (long id, String category, String shortName, String name, int ref
   _id = id;
   _calculation = calculation;
   _smartValueThreshold = smartValueThreshold;
+  _binary = binary;
 }
 
 int Sensor::getRefreshInterval() {
@@ -68,6 +70,10 @@ String Sensor::getMqttUnit() {
   return _calculation->getValueUnit();
 }
 
+bool Sensor::isBinary() {
+  return _binary;
+}
+
 long Sensor::getId() {
   return _id;
 }

src/input/Sensor.h

@@ -11,6 +11,7 @@
     SOURCE: https://github.com/sensate-io/firmware-esp8266.git
 
     @section  HISTORY
+    v33 - Changes for Digital Sensor Switch Support
     v32 - Added MQTT Support!
     v29 - First Public Release
 */
@@ -38,10 +39,11 @@ class Sensor {
     String _shortName;
     long _id;
     SensorCalculation* _calculation;
+    bool _binary;
     virtual void preCycle(int);
     virtual Data* read(bool);
   public:
-    Sensor (long, String, String, String, int, int, float, SensorCalculation*);
+    Sensor (long, String, String, String, int, int, float, SensorCalculation*, bool binary);
     int getRefreshInterval(void);
     int getPostDataInterval(void);
     long getId(void);
@@ -50,6 +52,7 @@ class Sensor {
     String getCategory(void);
     String getMqttClass(void);
     String getMqttUnit(void);
+    bool isBinary();
     Data* trySensorRead(unsigned long, int);
     Data* forceSensorRead(unsigned long, int);
 };

src/input/SensorCalculation.cpp

@@ -11,6 +11,7 @@
     SOURCE: https://github.com/sensate-io/firmware-esp8266.git
 
     @section  HISTORY
+    v33 - Added Digital Sensor Switch Support
     v32 - Added MQTT Support!
     v29 - First Public Release
 */
@@ -35,6 +36,11 @@ String SensorCalculation::getValueUnit()
   return _valueUnit;
 }
 
+Data* SensorCalculation::calculate(Sensor* sensor, bool boolValue, bool postData)
+{  
+    return NULL;
+}
+
 SensorCalculationApproxQuad::SensorCalculationApproxQuad(double calcValue1, double calcValue2, double calcValue3, double calcValue4, int portNumber) : SensorCalculation()
 {
   _valueType = "temperature";
@@ -165,7 +171,7 @@ SensorCalculationRawToPercent::SensorCalculationRawToPercent(float calcValue1, f
 SensorCalculationRaw::SensorCalculationRaw(int portNumber) : SensorCalculation()
 {
   _valueType = "raw";
-  _valueUnit = "(raw))";
+  _valueUnit = "";
   _portNumber = portNumber;
 }
 
@@ -353,4 +359,13 @@ Data* SensorCalculationRaw::calculate(Sensor* sensor, float rawValue, bool postD
   if(!postData)
     return NULL;
   return new Data (sensor, rawValue, "UNKNOWN");
+}
+
+Data* SensorCalculationRaw::calculate(Sensor* sensor, bool boolValue, bool postData)
+{  
+  if(display!=NULL && _portNumber>=0)
+    display->drawValue(_portNumber, sensor->getName(), sensor->getShortName(), boolValue, "ON", "OFF");
+  if(!postData)
+    return NULL;
+  return new Data (sensor, boolValue, "NONE");
 }

src/input/SensorCalculation.h

@@ -11,6 +11,7 @@
     SOURCE: https://github.com/sensate-io/firmware-esp8266.git
 
     @section  HISTORY
+    v33 - Added Digital Sensor Switch Support
     v32 - Added MQTT Support!
     v29 - First Public Release
 */
@@ -38,6 +39,7 @@ class SensorCalculation {
     String getValueUnit();
     SensorCalculation();
     virtual Data* calculate(Sensor* sensor, float, bool);
+    virtual Data* calculate(Sensor* sensor, bool, bool);
 };
 
 class SensorCalculationApproxQuad : public SensorCalculation  {
@@ -148,6 +150,8 @@ class SensorCalculationRaw : public SensorCalculation  {
   public:
     SensorCalculationRaw(int);
     Data* calculate(Sensor* sensor, float, bool);
+    Data* calculate(Sensor* sensor, bool, bool);
 };
 
+
 #endif

src/input/SensorDigitalSwitch.cpp

@@ -0,0 +1,74 @@
+/**************************************************************************/
+/*!
+    @file     SensorDigitalSwitch.cpp
+    @author   M. Fegerl (Sensate Digital Solutions GmbH)
+    @license  GPL (see LICENSE file)
+    The Sensate ESP8266 firmware is used to connect ESP8266 based hardware 
+    with the Sensate Cloud and the Sensate apps.
+
+    ----> https://www.sensate.io
+
+    SOURCE: https://github.com/sensate-io/firmware-esp8266.git
+
+    @section  HISTORY
+    v33 - Added Digital Sensor Switch
+*/
+/**************************************************************************/
+
+#include "SensorDigitalSwitch.h"
+
+extern boolean isResetting;
+extern int powerMode;
+
+SensorDigitalSwitch::SensorDigitalSwitch (long id, String category, String shortName, String name, uint8_t port, int refreshInterval, int postDataInterval, SensorCalculation* calculation) : Sensor (id, category, shortName, name, refreshInterval, postDataInterval, 0.5, calculation, true) {
+
+    pinMode(port, INPUT);
+    _port = port;
+
+}
+
+void SensorDigitalSwitch::preCycle(int cycleId)
+{
+}
+
+Data* SensorDigitalSwitch::read(bool shouldPostData)
+{
+  if(!isResetting)
+  {
+    bool portState = digitalRead(_port);  
+    if(lastPostedValue!=portState)
+        shouldPostData = true;
+    
+    Data *data = _calculation->calculate(this, portState, shouldPostData);
+    
+    if(shouldPostData)
+        lastPostedValue = portState;
+    
+    return data;
+  }
+
+  return NULL;
+
+}
+
+boolean SensorDigitalSwitch::smartSensorCheck(float currentRawValue, float threshhold, boolean shouldPostData)
+{
+  if(powerMode == 3)
+  {
+    if(!shouldPostData)
+    {
+      if(!isnan(lastPostedValue))
+      {
+          if(lastPostedValue-currentRawValue>threshhold|| lastPostedValue-currentRawValue<-threshhold)
+          {
+            shouldPostData = true;
+          }
+      }
+    }
+
+    if(shouldPostData)
+      lastPostedValue = currentRawValue;
+  }
+
+  return shouldPostData;
+}