allow sensor type selection per plant, changed calculations to use PCT values, due to different raw value meaning

esp32/include/ControllerConfiguration.h

@@ -93,6 +93,9 @@
 #define MOIST_SENSOR_MAX_FRQ               10000 // 10kHz (as never more then 3000 was measured)
 #define MOIST_SENSOR_MIN_FRQ                1000 // 1kHz (500Hz margin)
 
+#define ANALOG_SENSOR_MAX_MV                1000
+#define ANALOG_SENSOR_MIN_MV                100
+
 #define SOLAR_VOLT_FACTOR           11
 #define BATTSENSOR_INDEX_SOLAR      0
 #define BATTSENSOR_INDEX_BATTERY    1

esp32/include/HomieConfiguration.h

@@ -101,6 +101,7 @@ HomieSetting<const char *> ntpServer("ntpServer", "NTP server (pool.ntp.org as d
 
 #define GENERATE_PLANT(plant, strplant)                                                                                                                                                                        \
         HomieSetting<double> mSensorDry##plant = HomieSetting<double>("dry" strplant, "Plant " strplant "- Moist sensor dry %");                                                                      \
+        HomieSetting<long> pSensorType##plant = HomieSetting<long>("sensoryType" strplant, "sensor" strplant " - sensortype");                      \
         HomieSetting<long> mPumpAllowedHourRangeStart##plant = HomieSetting<long>("hourstart" strplant, "Plant" strplant " - Range pump allowed hour start (0-23)");                                      \
         HomieSetting<long> mPumpAllowedHourRangeEnd##plant = HomieSetting<long>("hourend" strplant, "Plant" strplant " - Range pump allowed hour end (0-23)");                                            \
         HomieSetting<bool> mPumpOnlyWhenLowLight##plant = HomieSetting<bool>("lowLight" strplant, "Plant" strplant " - Enable the Pump only, when there is no sunlight"); \
@@ -108,7 +109,7 @@ HomieSetting<const char *> ntpServer("ntpServer", "NTP server (pool.ntp.org as d
         HomieSetting<long> pPumpDuration##plant = HomieSetting<long>("pumpDuration" strplant, "Plant" strplant " - time seconds to water when pump is active");                      \
         HomieSetting<long> pPumpMl##plant = HomieSetting<long>("pumpAmount" strplant, "Plant" strplant " - ml (if using flowmeter) to water when pump is active");                      \
         HomieSetting<long> pPowerLevel##plant = HomieSetting<long>("powerLevel" strplant, "Plant" strplant " - pwm duty cycle in percent");                      \
-        PlantSettings_t mSetting##plant = {&mSensorDry##plant, &mPumpAllowedHourRangeStart##plant, &mPumpAllowedHourRangeEnd##plant, &mPumpOnlyWhenLowLight##plant, &mPumpCooldownInMinutes##plant, &pPumpDuration##plant, &pPowerLevel##plant, &pPumpMl##plant}; \
+        PlantSettings_t mSetting##plant = {&mSensorDry##plant, &pSensorType##plant, &mPumpAllowedHourRangeStart##plant, &mPumpAllowedHourRangeEnd##plant, &mPumpOnlyWhenLowLight##plant, &mPumpCooldownInMinutes##plant, &pPumpDuration##plant, &pPowerLevel##plant, &pPumpMl##plant}; \
         /**< Generate all settings for one plant \
          * \
          * Feature to start pumping only at morning: @link{SOLAR_CHARGE_MIN_VOLTAGE} and @link{SOLAR_CHARGE_MAX_VOLTAGE} \

esp32/include/HomieTypes.h

@@ -13,6 +13,10 @@
 
 #include <Homie.h>
 
+#define SENSOR_NONE 0
+#define SENSOR_CAPACITIVE_FREQUENCY_MOD 1
+#define SENSOR_ANALOG_RESISTANCE_PROBE 2
+
 //plant pump is deactivated, but sensor values are still recorded and published
 #define DEACTIVATED_PLANT -1
 //special value to indicate a missing sensor when the plant is not deactivated but no valid sensor value was read
@@ -23,6 +27,7 @@
 typedef struct PlantSettings_t
 {
     HomieSetting<double> *pSensorDry;
+    HomieSetting<long> *pSensorMode;
     HomieSetting<long> *pPumpAllowedHourRangeStart;
     HomieSetting<long> *pPumpAllowedHourRangeEnd;
     HomieSetting<bool> *pPumpOnlyWhenLowLight;

esp32/include/LogDefines.h

@@ -21,6 +21,9 @@
 #define LOG_HARDWARECOUNTER_ERROR_MESSAGE "PCNR returned error"
 #define LOG_HARDWARECOUNTER_ERROR_CODE -4
 
+#define LOG_SENSORMODE_UNKNOWN "Unknown sensor mode requested"
+#define LOG_SENSORMODE_UNKNOWN_CODE -5
+
 #define LOG_PUMP_AND_DOWNLOADMODE "Download mode, ignoring pump request"
 #define LOG_PUMP_AND_DOWNLOADMODE_CODE 2
 

esp32/include/MathUtils.h

@@ -3,5 +3,6 @@
 
 
 bool equalish(double x, double y);
+double mapf(double x, double in_min, double in_max, double out_min, double out_max);
 
 #endif

esp32/include/PlantCtrl.h

@@ -17,19 +17,21 @@
 #include "ControllerConfiguration.h"
 #include "RunningMedian.h"
 #include "MathUtils.h"
+#include "MQTTUtils.h"
+#include "LogDefines.h"
 
+#define ANALOG_REREADS 5
 #define MOISTURE_MEASUREMENT_DURATION 400 /** ms */
 #define PWM_FREQ 50000
 #define PWM_BITS 8
 
-
 class Plant
 {
 
 private:
     HomieNode *mPlant = NULL;
     HomieInternals::PropertyInterface mPump;
-    int32_t mMoisture_freq = 0;
+    RunningMedian mMoisture_raw = RunningMedian(ANALOG_REREADS);
     int mPinSensor = 0; /**< Pin of the moist sensor */
     int mPinPump = 0;   /**< Pin of the pump */
     bool mConnected = false;
@@ -52,10 +54,9 @@ public:
 
     void advertise(void);
 
-    /**
+    //for sensor that might take any time
-     * @brief Measure a new analog moister value
+    void blockingMoistureMeasurement(void);
-     * 
+    //for sensor that need a start and a end in defined timing
-     */
     void startMoistureMeasurement(void);
     void stopMoistureMeasurement(void);
 
@@ -63,12 +64,17 @@ public:
 
     void activatePump(void);
 
-
+    bool isHydroponic()
-    bool isHydroponic(){
+    {
         long current = this->mSetting->pSensorDry->get();
         return equalish(current, HYDROPONIC_MODE);
     }
 
+    long isSensorMode(int sensorMode)
+    {
+        return this->mSetting->pSensorMode->get() == sensorMode;
+    }
+
     /**
      * @brief Check if a plant is too dry and needs some water.
      * 
@@ -77,11 +83,12 @@ public:
      */
     bool isPumpRequired()
     {
-        if(isHydroponic()){
+        if (isHydroponic())
+        {
             //hydroponic only uses timer based controll
             return true;
         }
-        bool isDry = getCurrentMoisture() > getSetting2Moisture();
+        bool isDry = getCurrentMoisturePCT() < getTargetMoisturePCT();
         bool isActive = isPumpTriggerActive();
         return isDry && isActive;
     }
@@ -92,21 +99,11 @@ public:
         return !equalish(current, DEACTIVATED_PLANT);
     }
 
-    float getCurrentMoisture()
+    float getTargetMoisturePCT()
     {
-        if(mMoisture_freq < MOIST_SENSOR_MIN_FRQ){
+        if (isPumpTriggerActive())
-            return MISSING_SENSOR;
-        }
-        return mMoisture_freq;
-    }
-
-    long getSetting2Moisture()
         {
-        if (this->mSetting->pSensorDry != NULL)
+            return this->mSetting->pSensorDry->get();
-        {
-            //1 is totally wet, 0 is try, 0 is MOIST_SENSOR_MAX_FRQ, 1 is MOIST_SENSOR_MIN_FRQ
-            float factor = (this->mSetting->pSensorDry->get());
-            return map(factor,0,100,MOIST_SENSOR_MAX_FRQ,MOIST_SENSOR_MIN_FRQ);
         }
         else
         {
@@ -114,6 +111,38 @@ public:
         }
     }
 
+    float getCurrentMoisturePCT()
+    {
+        if (isSensorMode(SENSOR_NONE))
+        {
+            return DEACTIVATED_PLANT;
+        }
+        if (isSensorMode(SENSOR_CAPACITIVE_FREQUENCY_MOD))
+        {
+              return mapf(mMoisture_raw.getMedian(), MOIST_SENSOR_MAX_FRQ, MOIST_SENSOR_MIN_FRQ, 0, 100);
+        }
+        else if (isSensorMode(SENSOR_ANALOG_RESISTANCE_PROBE))
+        {
+            return mapf(mMoisture_raw.getMedian(), ANALOG_SENSOR_MAX_MV, ANALOG_SENSOR_MIN_MV, 0, 100);
+        } else {
+            log(LOG_LEVEL_ERROR, LOG_SENSORMODE_UNKNOWN, LOG_SENSORMODE_UNKNOWN_CODE);
+            return DEACTIVATED_PLANT;
+        }
+    }
+
+    float getCurrentMoistureRaw()
+    {
+        if (isSensorMode(SENSOR_CAPACITIVE_FREQUENCY_MOD))
+        {
+            if (mMoisture_raw.getMedian() < MOIST_SENSOR_MIN_FRQ)
+            {
+                return MISSING_SENSOR;
+            }
+        }
+
+        return mMoisture_raw.getMedian();
+    }
+
     HomieInternals::SendingPromise &setProperty(const String &property) const
     {
         return mPlant->setProperty(property);
@@ -121,7 +150,8 @@ public:
 
     void init(void);
 
-    long getCooldownInSeconds() {
+    long getCooldownInSeconds()
+    {
         return this->mSetting->pPumpCooldownInSeconds->get();
     }
 
@@ -130,7 +160,8 @@ public:
      * 
      * @return hour 
      */
-    int getHoursStart() {
+    int getHoursStart()
+    {
         return this->mSetting->pPumpAllowedHourRangeStart->get();
     }
 
@@ -139,13 +170,15 @@ public:
      * 
      * @return hour 
      */
-    int getHoursEnd() {
+    int getHoursEnd()
+    {
         return this->mSetting->pPumpAllowedHourRangeEnd->get();
     }
 
     bool isAllowedOnlyAtLowLight(void)
     {
-        if(this->isHydroponic()){
+        if (this->isHydroponic())
+        {
             return false;
         }
         return this->mSetting->pPumpOnlyWhenLowLight->get();
@@ -157,7 +190,8 @@ public:
 
     void setSwitchHandler(HomieInternals::PropertyInputHandler f);
 
-    long getPumpDuration() {
+    long getPumpDuration()
+    {
         return this->mSetting->pPumpDuration->get();
     }
 };

esp32/src/MathUtil.cpp

@@ -5,3 +5,8 @@ bool equalish(double x, double y)
 {
         return (abs(x - y) < 0.5);
 }
+
+double mapf(double x, double in_min, double in_max, double out_min, double out_max)
+{
+    return (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min;
+}

esp32/src/PlantCtrl.cpp

@@ -9,18 +9,11 @@
  * 
 
  */
-
 #include "PlantCtrl.h"
 #include "ControllerConfiguration.h"
 #include "TimeUtils.h"
-#include "MathUtils.h"
 #include "driver/pcnt.h" 
 
-double mapf(double x, double in_min, double in_max, double out_min, double out_max)
-{
-    return (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min;
-}
-
 Plant::Plant(int pinSensor, int pinPump, int plantId, HomieNode *plant, PlantSettings_t *setting)
 {
     this->mPinSensor = pinSensor;
@@ -37,6 +30,12 @@ void Plant::init(void)
     this->mSetting->pSensorDry->setValidator([](long candidate) {
         return (((candidate >= 0.0) && (candidate <= 100.0)) || equalish(candidate,DEACTIVATED_PLANT) || equalish(candidate,HYDROPONIC_MODE));
     });
+
+    this->mSetting->pSensorMode->setDefaultValue(SENSOR_NONE);
+    this->mSetting->pSensorMode->setValidator([](long candidate) {
+        return candidate == SENSOR_NONE || candidate == SENSOR_CAPACITIVE_FREQUENCY_MOD || candidate == SENSOR_ANALOG_RESISTANCE_PROBE;
+    });
+
     this->mSetting->pPumpAllowedHourRangeStart->setDefaultValue(8); // start at 8:00
     this->mSetting->pPumpAllowedHourRangeStart->setValidator([](long candidate) {
         return ((candidate >= 0) && (candidate <= 23));
@@ -76,6 +75,9 @@ void Plant::init(void)
     Serial.flush();
     pinMode(this->mPinSensor, INPUT);
 
+    if(isSensorMode(SENSOR_CAPACITIVE_FREQUENCY_MOD)){
+
+
         pcnt_unit_t unit = (pcnt_unit_t) (PCNT_UNIT_0 + this->mPlantId);
         pcnt_config_t pcnt_config = { };                                        // Instancia PCNT config
 
@@ -95,28 +97,60 @@ void Plant::init(void)
         pcnt_counter_clear(unit);    // Zera o contador PCNT
 
         Serial.println("Setup Counter " + String(mPinPump) + "=" + String(LOW));
+    } else if (isSensorMode(SENSOR_ANALOG_RESISTANCE_PROBE)){
+        adcAttachPin(this->mPinSensor);
+    } else if (isSensorMode(SENSOR_NONE)){
+        //nothing to do here
+    } else {
+        log(LOG_LEVEL_ERROR, LOG_SENSORMODE_UNKNOWN, LOG_SENSORMODE_UNKNOWN_CODE);
     }
    
+}
+
+void Plant::blockingMoistureMeasurement(void) {
+    if(isSensorMode(SENSOR_ANALOG_RESISTANCE_PROBE)){
+        for(int i = 0;i<ANALOG_REREADS;i++){
+            this->mMoisture_raw.add(analogReadMilliVolts(this->mPinSensor));    
+            delay(5);
+        }
+    }else if(isSensorMode(SENSOR_CAPACITIVE_FREQUENCY_MOD) || isSensorMode(SENSOR_NONE)){
+        //nothing to do here
+    } else {
+        log(LOG_LEVEL_ERROR, LOG_SENSORMODE_UNKNOWN, LOG_SENSORMODE_UNKNOWN_CODE);
+    }
+}
+
+
 void Plant::startMoistureMeasurement(void) {
+    if(isSensorMode(SENSOR_CAPACITIVE_FREQUENCY_MOD)){
         pcnt_unit_t unit = (pcnt_unit_t) (PCNT_UNIT_0 + this->mPlantId);
         pcnt_counter_resume(unit);
+    } else if (isSensorMode(SENSOR_ANALOG_RESISTANCE_PROBE) || isSensorMode(SENSOR_NONE)){
+        //nothing to do here
+    } else {
+        log(LOG_LEVEL_ERROR, LOG_SENSORMODE_UNKNOWN, LOG_SENSORMODE_UNKNOWN_CODE);
+    }
 }
 
 void Plant::stopMoistureMeasurement(void) {
+    if(isSensorMode(SENSOR_CAPACITIVE_FREQUENCY_MOD)){
         int16_t pulses;
         pcnt_unit_t unit = (pcnt_unit_t) (PCNT_UNIT_0 + this->mPlantId);
         pcnt_counter_pause(unit); 
         esp_err_t result = pcnt_get_counter_value(unit, &pulses);
         pcnt_counter_clear(unit);
- 
-
         if(result != ESP_OK){
-      //FIXME log(LOG_LEVEL_ERROR, LOG_HARDWARECOUNTER_ERROR_MESSAGE, LOG_HARDWARECOUNTER_ERROR_CODE);
+            log(LOG_LEVEL_ERROR, LOG_HARDWARECOUNTER_ERROR_MESSAGE, LOG_HARDWARECOUNTER_ERROR_CODE);
-      this -> mMoisture_freq = -1;
+            this-> mMoisture_raw.clear();
+            this -> mMoisture_raw.add(-1);
         } else {
-        this->mMoisture_freq = pulses * (1000 / MOISTURE_MEASUREMENT_DURATION);
+            this->mMoisture_raw.add(pulses * (1000 / MOISTURE_MEASUREMENT_DURATION));
+        }
+    }else if (isSensorMode(SENSOR_ANALOG_RESISTANCE_PROBE) || isSensorMode(SENSOR_NONE)){
+        //nothing to do here
+    }  else {
+        log(LOG_LEVEL_ERROR, LOG_SENSORMODE_UNKNOWN, LOG_SENSORMODE_UNKNOWN_CODE);
     }
-
 }
 
 void Plant::postMQTTconnection(void)
@@ -125,8 +159,10 @@ void Plant::postMQTTconnection(void)
     this->mConnected = true;
     this->mPlant->setProperty("switch").send(OFF);
 
-    long raw = getCurrentMoisture();
+    float pct = getCurrentMoisturePCT();
-    double pct = mapf(raw, MOIST_SENSOR_MIN_FRQ, MOIST_SENSOR_MAX_FRQ, 100, 0);
+    float raw = getCurrentMoistureRaw();
+    Serial.println(pct);
+    Serial.println("..................");
     if (equalish(raw, MISSING_SENSOR))
     {
       pct = 0;
@@ -140,9 +176,9 @@ void Plant::postMQTTconnection(void)
       pct = 100;
     }
 
-    this->mPlant->setProperty("moist").send(String(round(pct*10)/10));
+    this->mPlant->setProperty("moist").send(String(pct));
     this->mPlant->setProperty("moistraw").send(String(raw));
-    this->mPlant->setProperty("moisttrigger").send(String(getSetting2Moisture()));
+    this->mPlant->setProperty("moisttrigger").send(String(getTargetMoisturePCT()));
 }
 
 void Plant::deactivatePump(void)

esp32/src/main.cpp

@@ -269,7 +269,27 @@ void readPowerSwitchedSensors()
 
   for (int i = 0; i < MAX_PLANTS; i++)
   {
-    Serial << "Plant " << i << " measurement: " << mPlants[i].getCurrentMoisture() << " hz" << endl;
+    mPlants[i].blockingMoistureMeasurement();
+  }
+
+  for (int i = 0; i < MAX_PLANTS; i++)
+  {
+    if (mPlants[i].isSensorMode(SENSOR_CAPACITIVE_FREQUENCY_MOD))
+    {
+      Serial << "Plant " << i << " measurement: " << mPlants[i].getCurrentMoistureRaw() << " hz" << endl;
+    }
+    else if (mPlants[i].isSensorMode(SENSOR_ANALOG_RESISTANCE_PROBE))
+    {
+      Serial << "Plant " << i << " measurement: " << mPlants[i].getCurrentMoistureRaw() << " mV" << endl;
+    }
+    else if (mPlants[i].isSensorMode(SENSOR_NONE))
+    {
+      Serial << "Plant " << i << " measurement: no sensor configured" << endl;
+    }
+    else
+    {
+      log(LOG_LEVEL_ERROR, LOG_SENSORMODE_UNKNOWN, LOG_SENSORMODE_UNKNOWN_CODE);
+    }
   }
 
   waterRawSensor.clear();
@@ -408,7 +428,7 @@ int determineNextPump(bool isLowLight)
     }
     if (!plant.isHydroponic())
     {
-      if (equalish(plant.getCurrentMoisture(), MISSING_SENSOR))
+      if (equalish(plant.getCurrentMoistureRaw(), MISSING_SENSOR))
       {
         plant.publishState("nosensor");
         log(LOG_LEVEL_ERROR, String(String(i) + " No pump possible: missing sensor"), LOG_MISSING_PUMP);
@@ -704,32 +724,6 @@ void safeSetup()
     return;
   }
 
-  /************************* Start One-Wire bus ***************/
-  int tempInitStartTime = millis();
-  uint8_t sensorCount = 0U;
-
-  /* Required to read the temperature at least once */
-  while ((sensorCount == 0 || !battery.isFound()) && millis() < tempInitStartTime + TEMPERATUR_TIMEOUT)
-  {
-    sensors.begin();
-    battery.begin();
-    sensorCount = sensors.getDS18Count();
-    delay(50);
-  }
-
-  Serial << "DS18S20 count: " << sensorCount << " found in " << (millis() - tempInitStartTime) << " ms" << endl;
-  Serial.flush();
-  /* Measure temperature TODO idea: move this into setup */
-  if (sensorCount > 0)
-  {
-    //sensors.setResolution(DS18B20_RESOLUTION);
-    sensors.requestTemperatures();
-  }
-  Serial << "Reading sensors start" << endl;
-  Serial.flush();
-  readPowerSwitchedSensors();
-  Serial << "Reading sensors end" << endl;
-  Serial.flush();
    /************************* Start Homie Framework ***************/
   Homie_setFirmware("PlantControl", FIRMWARE_VERSION);
   Homie.disableLedFeedback();
@@ -766,9 +760,36 @@ void safeSetup()
 
   Homie.setup();
 
+ /************************* Start One-Wire bus ***************/
+  int tempInitStartTime = millis();
+  uint8_t sensorCount = 0U;
+
+  /* Required to read the temperature at least once */
+  while ((sensorCount == 0 || !battery.isFound()) && millis() < tempInitStartTime + TEMPERATUR_TIMEOUT)
+  {
+    sensors.begin();
+    battery.begin();
+    sensorCount = sensors.getDS18Count();
+    delay(50);
+  }
+
+  Serial << "DS18S20 count: " << sensorCount << " found in " << (millis() - tempInitStartTime) << " ms" << endl;
+  Serial.flush();
+  /* Measure temperature TODO idea: move this into setup */
+  if (sensorCount > 0)
+  {
+    //sensors.setResolution(DS18B20_RESOLUTION);
+    sensors.requestTemperatures();
+  }
+
   mConfigured = Homie.isConfigured();
   if (mConfigured)
   {
+    Serial << "Reading sensors start" << endl;
+    Serial.flush();
+    readPowerSwitchedSensors();
+    Serial << "Reading sensors end" << endl;
+    Serial.flush();
     for (int i = 0; i < MAX_PLANTS; i++)
     {
       mPlants[i].advertise();