Automatic Water Pump [feature] (#1)

* More Logging and Bug fixes

Added more logging and bug fixes related to the water pump

Signed-off-by: Mpho Mphego <[email protected]>

Author: mmphego

Makefile

@@ -34,6 +34,7 @@ FILES=boot.py \
 	config.json \
 	main.py \
 	soil_moisture.py \
+	water_pump.py \
 	utils.py
 
 erase:

config.json

@@ -15,9 +15,16 @@
         "wet": 470,
         "Threshold": 70,
     },
+    "water_pump_time": {
+        "": 2
+    },
     "slack_auth": {
-        "app_id":"",
+        "app_id": "",
         "secret_id": "",
-        "token":""
+        "token": ""
+    },
+    "ubidots":{
+        "token": "",
+        "device": ""
     }
 }

main.py

@@ -4,5 +4,6 @@
 if __name__ == "__main__":
     filename = "config.json"
     config = read_config(filename)
-    moisture_Sensor = MoistureSensor(0, config)
+    moisture_Sensor = MoistureSensor(config)
+    print("[INFO] Running moisture_Sensor...")
     moisture_Sensor.run_timer(900)

soil_moisture.py

@@ -1,11 +1,19 @@
 import machine
 import utime
-
-from utils import MQTTWriter, Slack, Ubidots, current_time, force_garbage_collect
+from utils import (
+    MQTTWriter,
+    Slack,
+    Ubidots,
+    adc_map,
+    average,
+    current_time,
+    force_garbage_collect,
+)
+from water_pump import WaterPump
 
 
 class MoistureSensor(object):
-    def __init__(self, adc_pin, config_dict):
+    def __init__(self, config_dict):
         """
         Sensor calibration
         ######################
@@ -16,35 +24,55 @@ def __init__(self, adc_pin, config_dict):
         Expects a dict:
             config_dict = {"moisture_sensor_cal": {"dry": 841, "wet": 470}
         """
-        self.adc_pin = adc_pin
         self.config = config_dict
-        self.setup_adc
+        self._adc = None
+        self._mqtt = None
         self._slack = None
-        self.ubidots = Ubidots(
-            self.config["ubidots"]["token"], self.config["ubidots"]["device"]
-        )
-        # self._mqtt = None
+        self._ubidots = None
+        self._water_me = False
+        self._water_pump = None
+
+    @property
+    def ubidots(self):
+        if (self.config["ubidots"]["token"]) and (not self._ubidots):
+            self._ubidots = Ubidots(
+                self.config["ubidots"]["token"], self.config["ubidots"]["device"]
+            )
+        return self._ubidots
+
+    @property
+    def water_pump(self):
+        if (isinstance(self.config["Pin_Config"]["Water_Pump_Pin"], int)) and (
+            not self._water_pump
+        ):
+            self._water_pump = WaterPump(
+                self.config["Pin_Config"]["Water_Pump_Pin"],
+                self.config["water_pump_time"]["delay_pump_on"],
+            )
+        return self._water_pump
 
     @property
-    def setup_adc(self):
-        self.adc = machine.ADC(self.adc_pin)
+    def adc(self):
+        if (isinstance(self.config["Pin_Config"]["ADC_Pin"], int)) and (not self._adc):
+            self._adc = machine.ADC(self.config["Pin_Config"]["ADC_Pin"])
+        return self._adc
 
     @property
     def slack(self):
         """Slack message init"""
-        config = self.config["slack_auth"]
-        self._slack = Slack(config["app_id"], config["secret_id"], config["token"])
+        if (self.config["slack_auth"].get("app_id")) and (not self._slack):
+            self._slack = Slack(
+                self.config["slack_auth"]["app_id"],
+                self.config["slack_auth"]["secret_id"],
+                self.config["slack_auth"]["token"],
+            )
         return self._slack.slack_it
 
-    # @property
-    # def mqtt(self):
-    #     host = self.config["MQTT_config"]["Host"]
-    #     self._mqtt = MQTTWriter(host)
-    #     return self._mqtt
-
-    def average(self, samples):
-        ave = sum(samples, 0.0) / len(samples)
-        return ave if ave > 0 else 0
+    @property
+    def mqtt(self):
+        if (self.config["MQTT_config"].get("Host")) and (not self._mqtt):
+            self._mqtt = MQTTWriter(self.config["MQTT_config"]["Host"])
+        return self._mqtt
 
     def read_samples(self, n_samples=10, rate=0.5):
         sampled_adc = []
@@ -54,69 +82,62 @@ def read_samples(self, n_samples=10, rate=0.5):
         force_garbage_collect()
         return sampled_adc
 
-    def adc_map(self, current_val, fromLow, fromHigh, toLow, toHigh):
-        """
-        Re-maps a number from one range to another.
-        That is, a value of 'fromLow' would get mapped to 'toLow',
-        a value of 'fromHigh' to 'toHigh', values in-between to values in-between, etc.
-
-        Does not constrain values to within the range, because out-of-range values are
-        sometimes intended and useful.
-
-        y = adc_map(x, 1, 50, 50, 1);
-
-        The function also handles negative numbers well, so that this example
-
-        y = adc_map(x, 1, 50, 50, -100);
-
-        is also valid and works well.
-
-        The adc_map() function uses integer math so will not generate fractions,
-        when the math might indicate that it should do so.
-        Fractional remainders are truncated, and are not rounded or averaged.
-
-        Parameters
-        ----------
-        value: the number to map.
-        fromLow: the lower bound of the value’s current range.
-        fromHigh: the upper bound of the value’s current range.
-        toLow: the lower bound of the value’s target range.
-        toHigh: the upper bound of the value’s target range.
-
-        Adapted from https://www.arduino.cc/reference/en/language/functions/math/map/
-        """
-
-        return (current_val - fromLow) * (toHigh - toLow) / (fromHigh - fromLow) + toLow
+    def message_send(self, msg):
+        try:
+            print("[INFO] Sending message to SLACK")
+            self.slack(msg)
+            print("[INFO] Message sent...")
+        except Exception as exc:
+            print("[ERROR] Could not send SLACK message: %s" % str(exc))
+        finally:
+            print("[INFO] %s" % msg)
 
     def soil_sensor_check(self):
         try:
             samples = self.read_samples()
-            sampled_adc = self.average(samples)
-            SoilMoistPerc = self.adc_map(
+            sampled_adc = average(samples)
+            self._soilmoistperc = adc_map(
                 sampled_adc,
                 self.config["moisture_sensor_cal"]["dry"],
                 self.config["moisture_sensor_cal"]["wet"],
-                0,
-                100,
             )
-            self.ubidots.post_request({"soil_moisture": SoilMoistPerc})
-            if SoilMoistPerc <= self.config["moisture_sensor_cal"].get("Threshold", 15):
-                msg = "Soil Moisture Sensor: %.2f%% \t %s" % (
-                    SoilMoistPerc,
-                    current_time(),
+            self.ubidots.post_request({"soil_moisture": self._soilmoistperc})
+            if self._soilmoistperc <= self.config["moisture_sensor_cal"].get(
+                "Threshold", 50
+            ):
+                self._water_me = True
+                self.message_send(
+                    "[INFO] Soil Moisture Sensor: %.2f%% \t %s"
+                    % (self._soilmoistperc, current_time())
                 )
-                self.slack(msg)
-                print(msg)
-            elif SoilMoistPerc <= 70:
-                msg = "Soil Moisture is at 50% You should probably Water the plant."
-                self.slack(msg)
-                print(msg)
-            force_garbage_collect()
+            else:
+                self._water_me = False
         except Exception as exc:
             print("Exception: %s", exc)
+        finally:
+            force_garbage_collect()
 
     def run_timer(self, secs=60):
+        print("[INFO] Timer Initialised, callback will be ran every %s seconds!!!" % secs)
         while True:
             self.soil_sensor_check()
+            while self._water_me:
+                self.message_send(
+                    "Note: Automatically watering the plant(s):\t %s" % current_time()
+                )
+                if not self.water_pump.pump_status:
+                    self.water_pump.pump_on()
+                    print(
+                        "[DEBUG] Setting Pump ON as water is @ %.2f%%"
+                        % self._soilmoistperc
+                    )
+                if self.water_pump.pump_status:
+                    print("[DEBUG] Checking Soil Moisture Status...")
+                    self.soil_sensor_check()
+                    print("[DEBUG] Soil Moisture Percent @ %.2f%%" % self._soilmoistperc)
+                self.water_pump.pump_off()
+                print(
+                    "[DEBUG] Setting Pump OFF as water is @ %.2f%%" % self._soilmoistperc
+                )
+
             utime.sleep(secs)
-        print("Timer Initialised, callback will be ran every %s seconds!!!" % secs)