From aa097e9034cea4cf7aac171e842a06415767e165 Mon Sep 17 00:00:00 2001
From: Paul Blacknell <blacknell@users.noreply.github.com>
Date: Wed, 16 Aug 2023 10:17:54 +0100
Subject: [PATCH] add: shutdown command for PID controller (#19318)

---
 tasmota/tasmota_xdrv_driver/xdrv_49_pid.ino | 31 +++++++++++++++++----
 1 file changed, 26 insertions(+), 5 deletions(-)

diff --git a/tasmota/tasmota_xdrv_driver/xdrv_49_pid.ino b/tasmota/tasmota_xdrv_driver/xdrv_49_pid.ino
index 1826d56c2d7e..72b57dc957ff 100644
--- a/tasmota/tasmota_xdrv_driver/xdrv_49_pid.ino
+++ b/tasmota/tasmota_xdrv_driver/xdrv_49_pid.ino
@@ -197,6 +197,7 @@
 #define D_CMND_PID_SETMANUAL_POWER "ManualPower"
 #define D_CMND_PID_SETMAX_INTERVAL "MaxInterval"
 #define D_CMND_PID_SETUPDATE_SECS "UpdateSecs"
+#define D_CMND_PID_SETSHUTDOWN "Shutdown"
 
 const char kPIDCommands[] PROGMEM = D_PRFX_PID "|" // Prefix
   D_CMND_PID_SETPV "|"
@@ -209,7 +210,8 @@ const char kPIDCommands[] PROGMEM = D_PRFX_PID "|" // Prefix
   D_CMND_PID_SETAUTO "|"
   D_CMND_PID_SETMANUAL_POWER "|"
   D_CMND_PID_SETMAX_INTERVAL "|"
-  D_CMND_PID_SETUPDATE_SECS;
+  D_CMND_PID_SETUPDATE_SECS "|"
+  D_CMND_PID_SETSHUTDOWN;
   ;
 
 void (* const PIDCommand[])(void) PROGMEM = {
@@ -223,7 +225,8 @@ void (* const PIDCommand[])(void) PROGMEM = {
   &CmndSetAuto,
   &CmndSetManualPower,
   &CmndSetMaxInterval,
-  &CmndSetUpdateSecs
+  &CmndSetUpdateSecs,
+  &CmndSetShutdown
   };
 
 struct {
@@ -233,6 +236,7 @@ struct {
   unsigned long last_pv_update_secs = 0;
   bool run_pid_now = false;     // tells PID_Every_Second to run the pid algorithm
   long current_time_secs = 0;  // a counter that counts seconds since initialisation
+  bool shutdown = false;        // power commands will be ignored when true
 } Pid;
 
 void PIDInit()
@@ -351,16 +355,20 @@ void CmndSetDSmooth(void) {
 
 void CmndSetAuto(void) {
   if (XdrvMailbox.payload >= 0) {
-    Pid.pid.setAuto(XdrvMailbox.payload);
+    if(!Pid.shutdown) {
+      Pid.pid.setAuto(XdrvMailbox.payload);
+    }
   }
   ResponseCmndNumber(Pid.pid.getAuto());
 }
 
 void CmndSetManualPower(void) {
   if (XdrvMailbox.data_len > 0) {
-    Pid.pid.setManualPower(CharToFloat(XdrvMailbox.data));
+    if(!Pid.shutdown) {
+      Pid.pid.setManualPower(CharToFloat(XdrvMailbox.data));
+    }
   }
-  ResponseCmndFloat(Pid.pid.getManualPower(), 1);
+  ResponseCmndFloat(Pid.pid.getManualPower(), 2);
 }
 
 void CmndSetMaxInterval(void) {
@@ -381,6 +389,18 @@ void CmndSetUpdateSecs(void) {
   ResponseCmndNumber(Pid.update_secs);
 }
 
+void CmndSetShutdown(void) {
+  if (XdrvMailbox.payload >= 0) {
+    AddLog(LOG_LEVEL_INFO, PSTR("PID: Shutdown mode %s"), XdrvMailbox.payload>0 ? "activated" : "cleared");
+    Pid.shutdown = (XdrvMailbox.payload>0);
+    if(Pid.shutdown) {
+      Pid.pid.setAuto(0);
+      Pid.pid.setManualPower(0.0);
+    }
+  }
+  ResponseCmndNumber(Pid.shutdown);
+}
+
 void PIDShowValues(void) {
   char str_buf[FLOATSZ];
   char chr_buf;
@@ -394,6 +414,7 @@ void PIDShowValues(void) {
   d_buf = Pid.pid.getSp();
   dtostrfd(d_buf, 2, str_buf);
   ResponseAppend_P(PSTR("\"PidSp\":%s,"), str_buf);
+  ResponseAppend_P(PSTR("\"PidShutdown\":%d,"), Pid.shutdown);
 
 #if PID_REPORT_MORE_SETTINGS
   d_buf = Pid.pid.getPb();