initial commit

src/shower.cpp

@@ -0,0 +1,137 @@
+/*
+ * EMS-ESP - https://github.com/proddy/EMS-ESP
+ * Copyright 2019  Paul Derbyshire
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "shower.h"
+
+MAKE_PSTR(logger_name, "shower")
+
+namespace emsesp {
+
+uuid::log::Logger Shower::logger_{F_(logger_name), uuid::log::Facility::CONSOLE};
+
+void Shower::start() {
+    EMSESP::emsespSettingsService.read([&](EMSESPSettings & settings) {
+        shower_timer_ = settings.shower_timer;
+        shower_alert_ = settings.shower_alert;
+    });
+}
+
+void Shower::loop() {
+    if (!shower_timer_) {
+        return;
+    }
+
+    uint32_t time_now = uuid::get_uptime();
+
+    // if already in cold mode, ignore all this logic until we're out of the cold blast
+    if (!doing_cold_shot_) {
+        // is the hot water running?
+        if (EMSESP::tap_water_active()) {
+            // if heater was previously off, start the timer
+            if (timer_start_ == 0) {
+                // hot water just started...
+                timer_start_     = time_now;
+                timer_pause_     = 0; // remove any last pauses
+                doing_cold_shot_ = false;
+                duration_        = 0;
+                shower_on_       = false;
+            } else {
+                // hot water has been  on for a while
+                // first check to see if hot water has been on long enough to be recognized as a Shower/Bath
+                if (!shower_on_ && (time_now - timer_start_) > SHOWER_MIN_DURATION) {
+                    shower_on_ = true;
+                    Mqtt::publish("shower_active", (bool)true);
+                    LOG_DEBUG(F("[Shower] hot water still running, starting shower timer"));
+                }
+                // check if the shower has been on too long
+                else if ((((time_now - timer_start_) > SHOWER_MAX_DURATION) && !doing_cold_shot_) && shower_alert_) {
+                    shower_alert_start();
+                }
+            }
+        } else { // hot water is off
+            // if it just turned off, record the time as it could be a short pause
+            if ((timer_start_) && (timer_pause_ == 0)) {
+                timer_pause_ = time_now;
+            }
+
+            // if shower has been off for longer than the wait time
+            if ((timer_pause_) && ((time_now - timer_pause_) > SHOWER_PAUSE_TIME)) {
+                // it is over the wait period, so assume that the shower has finished and calculate the total time and publish
+                // because its unsigned long, can't have negative so check if length is less than OFFSET_TIME
+                if ((timer_pause_ - timer_start_) > SHOWER_OFFSET_TIME) {
+                    duration_ = (timer_pause_ - timer_start_ - SHOWER_OFFSET_TIME);
+                    if (duration_ > SHOWER_MIN_DURATION) {
+                        Mqtt::publish("shower_active", (bool)false);
+                        LOG_DEBUG(F("[Shower] finished with duration %d"), duration_);
+                        publish_values();
+                    }
+                }
+
+                // reset everything
+                timer_start_ = 0;
+                timer_pause_ = 0;
+                shower_on_   = false;
+                shower_alert_stop();
+            }
+        }
+    }
+}
+
+// turn back on the hot water for the shower
+void Shower::shower_alert_stop() {
+    if (doing_cold_shot_) {
+        LOG_DEBUG(F("Shower Alert stopped"));
+        // Boiler::set_tapwarmwater_activated(true);
+        doing_cold_shot_ = false;
+        // showerColdShotStopTimer.detach(); // disable the timer
+    }
+}
+
+// turn off hot water to send a shot of cold
+void Shower::shower_alert_start() {
+    if (shower_alert_) {
+        LOG_DEBUG(F("Shower Alert started!"));
+        // Boiler::set_tapwarmwater_activated(false);
+        doing_cold_shot_ = true;
+        // start the timer for n seconds which will reset the water back to hot
+        // showerColdShotStopTimer.attach(SHOWER_COLDSHOT_DURATION, _showerColdShotStop);
+    }
+}
+
+// Publish shower data
+// returns true if added to MQTT queue went ok
+void Shower::publish_values() {
+    StaticJsonDocument<90> doc;
+    doc["shower_timer"] = shower_timer_ ? "1" : "0";
+    doc["shower_alert"] = shower_alert_ ? "1" : "0";
+
+    // only publish shower duration if there is a value
+    char s[50];
+    if (duration_ > SHOWER_MIN_DURATION) {
+        char buffer[16] = {0};
+        strlcpy(s, Helpers::itoa(buffer, (uint8_t)((duration_ / (1000 * 60)) % 60), 10), 50);
+        strlcat(s, " minutes and ", 50);
+        strlcat(s, Helpers::itoa(buffer, (uint8_t)((duration_ / 1000) % 60), 10), 50);
+        strlcat(s, " seconds", 50);
+        doc["duration"] = s;
+    }
+
+    Mqtt::publish("shower_data", doc);
+}
+
+} // namespace emsesp