Merge pull request #213 from OpenEVSE/jeremypoulter/issue192

jeremypoulter · web-flow · commit 796e142e4398 · 2021-07-19T22:13:58.000+01:00
Fix for operation with both timer and PV Divert active
diff --git a/src/divert.cpp b/src/divert.cpp
@@ -92,7 +92,7 @@ void divertmode_update(byte newmode)
         event["smoothed_available_current"] = smoothed_available_current = 0;
 
         EvseProperties props(EvseState::Disabled);
-        evse.claim(EvseClient_OpenEVSE_Divert, EvseManager_Priority_Divert, props);
+        evse.claim(EvseClient_OpenEVSE_Divert, EvseManager_Priority_Default, props);
       } break;
 
       default:
@@ -208,7 +208,7 @@ void divert_update_state()
         if(divert_active && divertmode_get_time() >= min_charge_end)
         {
           EvseProperties props(EvseState::Disabled);
-          evse.claim(EvseClient_OpenEVSE_Divert, EvseManager_Priority_Divert, props);
+          evse.claim(EvseClient_OpenEVSE_Divert, EvseManager_Priority_Default, props);
 
           if(previousState != evse.getState())
           {
diff --git a/src/evse_man.cpp b/src/evse_man.cpp
@@ -109,11 +109,19 @@ EvseManager::Claim::Claim() :
 {
 }
 
-void EvseManager::Claim::claim(EvseClient client, int priority, EvseProperties &target)
+bool EvseManager::Claim::claim(EvseClient client, int priority, EvseProperties &target)
 {
-  _client = client;
-  _priority = priority;
-  _properties = target;
+  if(_client != client ||
+     _priority != priority ||
+     _properties != target)
+  {
+    _client = client;
+    _priority = priority;
+    _properties = target;
+    return true;
+  }
+
+  return false;
 }
 
 void EvseManager::Claim::release()
@@ -385,7 +393,7 @@ bool EvseManager::claim(EvseClient client, int priority, EvseProperties &target)
 {
   Claim *slot = NULL;
 
-  DBUGF("New claim from 0x%08x, priority %d, %s", client, priority, target.getState().toString());
+  DBUGF("Claim from 0x%08x, priority %d, %s", client, priority, target.getState().toString());
 
   for (size_t i = 0; i < EVSE_MANAGER_MAX_CLIENT_CLAIMS; i++)
   {
@@ -400,10 +408,13 @@ bool EvseManager::claim(EvseClient client, int priority, EvseProperties &target)
 
   if(slot)
   {
-    DBUGF("Found slot, waking task");
-    slot->claim(client, priority, target);
-    _evaluateClaims = true;
-    MicroTask.wakeTask(this);
+    DBUGF("Found slot");
+    if(slot->claim(client, priority, target))
+    {
+      DBUGF("Claim added/updated, waking task");
+      _evaluateClaims = true;
+      MicroTask.wakeTask(this);
+    }
     return true;
   }
 
@@ -524,3 +535,41 @@ uint32_t EvseManager::getTimeLimit(EvseClient client)
 {
   return getClaimProperties(client).getTimeLimit();
 }
+
+bool EvseManager::isRapiCommandBlocked(String rapi)
+{
+  return rapi.startsWith("$ST");
+}
+
+bool EvseManager::serializeClaims(DynamicJsonDocument &doc)
+{
+  doc.to<JsonArray>();
+
+  for(size_t i = 0; i < EVSE_MANAGER_MAX_CLIENT_CLAIMS; i++)
+  {
+    Claim &claim = _clients[i];
+    if(claim.isValid())
+    {
+      JsonObject obj = doc.createNestedObject();
+      obj["client"] = claim.getClient();
+      obj["priority"] = claim.getPriority();
+      claim.getProperties().serialize(obj);
+    }
+  }
+
+  return true;
+}
+
+bool EvseManager::serializeClaim(DynamicJsonDocument &doc, EvseClient client)
+{
+  Claim *claim;
+
+  if(findClaim(client, &claim))
+  {
+    doc["priority"] = claim->getPriority();
+    claim->getProperties().serialize(doc);
+    return true;
+  }
+
+  return false;
+}
diff --git a/src/evse_man.h b/src/evse_man.h
@@ -39,6 +39,7 @@ typedef uint32_t EvseClient;
 #define EvseManager_Priority_Divert     50
 #define EvseManager_Priority_Timer     100
 #define EvseManager_Priority_Boost     200
+#define EvseManager_Priority_API       500
 #define EvseManager_Priority_Ohm       500
 #define EvseManager_Priority_Manual   1000
 #define EvseManager_Priority_Ocpp     1050
@@ -163,6 +164,34 @@ class EvseProperties : virtual public JsonSerialize<512>
       return *this;
     }
 
+    bool equals(EvseProperties &rhs) {
+      return this->_state == rhs._state &&
+             this->_charge_current == rhs._charge_current &&
+             this->_max_current == rhs._max_current &&
+             this->_energy_limit == rhs._energy_limit &&
+             this->_time_limit == rhs._time_limit &&
+             this->_auto_release == rhs._auto_release;
+
+    }
+    bool equals(EvseState &rhs) {
+      return this->_state == rhs;
+    }
+
+    bool operator == (EvseProperties &rhs) {
+      return this->equals(rhs);
+    }
+    bool operator == (EvseState &rhs) {
+      return this->equals(rhs);
+    }
+
+    bool operator != (EvseProperties &rhs) {
+      return !equals(rhs);
+    }
+    bool operator != (EvseState &rhs) {
+      return !equals(rhs);
+    }
+
+
     using JsonSerialize::deserialize;
     virtual bool deserialize(JsonObject &obj);
     using JsonSerialize::serialize;
@@ -182,7 +211,7 @@ class EvseManager : public MicroTasks::Task
       public:
         Claim();
 
-        void claim(EvseClient client, int priority, EvseProperties &target);
+        bool claim(EvseClient client, int priority, EvseProperties &target);
         void release();
 
         bool isValid() {
@@ -279,6 +308,9 @@ class EvseManager : public MicroTasks::Task
     uint32_t getEnergyLimit(EvseClient client = EvseClient_NULL);
     uint32_t getTimeLimit(EvseClient client = EvseClient_NULL);
 
+    bool serializeClaims(DynamicJsonDocument &doc);
+    bool serializeClaim(DynamicJsonDocument &doc, EvseClient client);
+
     // Evse Status
     bool isConnected() {
       return OpenEVSE.isConnected();
@@ -398,6 +430,8 @@ class EvseManager : public MicroTasks::Task
     void onSessionComplete(MicroTasks::EventListener *listner) {
       _monitor.onSessionComplete(listner);
     }
+
+    bool isRapiCommandBlocked(String rapi);
 };
 
 #endif // !_OPENEVSE_EVSE_MAN_H
diff --git a/src/main.cpp b/src/main.cpp
@@ -198,9 +198,8 @@ loop() {
     // -------------------------------------------------------------------
     // Do these things once every 30 seconds
     // -------------------------------------------------------------------
-    if ((millis() - Timer1) >= 30000) {
-      DBUGLN("Time1");
-
+    if ((millis() - Timer1) >= 30000)
+    {
       if(!Update.isRunning())
       {
         if(config_ohm_enabled()) {
diff --git a/src/mqtt.cpp b/src/mqtt.cpp
@@ -95,16 +95,19 @@ void mqttmsg_callback(MongooseString topic, MongooseString payload) {
         cmd += " "+payload_str;
       }
 
-      rapiSender.sendCmd(cmd, [](int ret)
+      if(!evse.isRapiCommandBlocked(cmd))
       {
-        if (RAPI_RESPONSE_OK == ret || RAPI_RESPONSE_NK == ret)
+        rapiSender.sendCmd(cmd, [](int ret)
         {
-          String rapiString = rapiSender.getResponse();
-          String mqtt_data = rapiString;
-          String mqtt_sub_topic = mqtt_topic + "/rapi/out";
-          mqttclient.publish(mqtt_sub_topic, mqtt_data);
-        }
-      });
+          if (RAPI_RESPONSE_OK == ret || RAPI_RESPONSE_NK == ret)
+          {
+            String rapiString = rapiSender.getResponse();
+            String mqtt_data = rapiString;
+            String mqtt_sub_topic = mqtt_topic + "/rapi/out";
+            mqttclient.publish(mqtt_sub_topic, mqtt_data);
+          }
+        });
+      }
     }
   }
 } //end call back
diff --git a/src/scheduler.cpp b/src/scheduler.cpp
@@ -204,7 +204,9 @@ unsigned long Scheduler::loop(MicroTasks::WakeReason reason)
       DBUGF("Starting %s claim",
         currentEvent.getState().toString());
       EvseProperties properties(currentEvent.getState());
-      _evse->claim(EvseClient_OpenEVSE_Schedule, EvseManager_Priority_Timer, properties);
+      _evse->claim(EvseClient_OpenEVSE_Schedule,
+        EvseState::Active == currentEvent.getState() ? EvseManager_Priority_Timer : EvseManager_Priority_Default,
+        properties);
     } else {
       // No scheduled events, release any claims
       DBUGLN("releasing claims");
diff --git a/src/web_server.cpp b/src/web_server.cpp
@@ -58,6 +58,10 @@ const char _CONTENT_TYPE_JPEG[] PROGMEM = "image/jpeg";
 const char _CONTENT_TYPE_PNG[] PROGMEM = "image/png";
 const char _CONTENT_TYPE_SVG[] PROGMEM = "image/svg+xml";
 
+#define RAPI_RESPONSE_BLOCKED             -300
+
+void handleEvseClaims(MongooseHttpServerRequest *request);
+
 void dumpRequest(MongooseHttpServerRequest *request)
 {
 #ifdef ENABLE_DEBUG_WEB_REQUEST
@@ -119,7 +123,7 @@ void dumpRequest(MongooseHttpServerRequest *request)
 // -------------------------------------------------------------------
 // Helper function to perform the standard operations on a request
 // -------------------------------------------------------------------
-bool requestPreProcess(MongooseHttpServerRequest *request, MongooseHttpServerResponseStream *&response, fstr_t contentType = CONTENT_TYPE_JSON)
+bool requestPreProcess(MongooseHttpServerRequest *request, MongooseHttpServerResponseStream *&response, fstr_t contentType)
 {
   dumpRequest(request);
 
@@ -587,6 +591,8 @@ handleStatus(MongooseHttpServerRequest *request) {
 
   create_rapi_json(doc);
 
+  doc["status"] = evse.getState().toString();
+
   doc["elapsed"] = evse.getSessionElapsed();
   doc["wattsec"] = evse.getSessionEnergy() * SESSION_ENERGY_SCALE_FACTOR;
   doc["watthour"] = evse.getTotalEnergy() * TOTAL_ENERGY_SCALE_FACTOR;
@@ -1097,12 +1103,18 @@ handleRapi(MongooseHttpServerRequest *request) {
   if (request->hasParam("rapi"))
   {
     String rapi = request->getParam("rapi");
+    int ret = RAPI_RESPONSE_NK;
 
-    // BUG: Really we should do this in the main loop not here...
-    RAPI_PORT.flush();
-    DBUGVAR(rapi);
-    int ret = rapiSender.sendCmdSync(rapi);
-    DBUGVAR(ret);
+    if(!evse.isRapiCommandBlocked(rapi))
+    {
+      // BUG: Really we should do this in the main loop not here...
+      RAPI_PORT.flush();
+      DBUGVAR(rapi);
+      ret = rapiSender.sendCmdSync(rapi);
+      DBUGVAR(ret);
+    } else {
+      ret = RAPI_RESPONSE_BLOCKED;
+    }
 
     if(RAPI_RESPONSE_OK == ret ||
        RAPI_RESPONSE_NK == ret)
@@ -1158,6 +1170,7 @@ handleRapi(MongooseHttpServerRequest *request) {
         RAPI_RESPONSE_BAD_CHECKSUM == ret ? F("RAPI_RESPONSE_BAD_CHECKSUM") :
         RAPI_RESPONSE_BAD_SEQUENCE_ID == ret ? F("RAPI_RESPONSE_BAD_SEQUENCE_ID") :
         RAPI_RESPONSE_ASYNC_EVENT == ret ? F("RAPI_RESPONSE_ASYNC_EVENT") :
+        RAPI_RESPONSE_BLOCKED == ret ? F("RAPI_RESPONSE_BLOCKED") :
         F("UNKNOWN");
 
       if (json) {
@@ -1168,7 +1181,7 @@ handleRapi(MongooseHttpServerRequest *request) {
         s += errorString;
       }
 
-      code = 500;
+      code = RAPI_RESPONSE_BLOCKED == ret ? 400 : 500;
     }
   }
   if (false == json) {
@@ -1251,6 +1264,8 @@ web_server_setup() {
   server.on("/schedule/plan$", handleSchedulePlan);
   server.on("/schedule", handleSchedule);
 
+  server.on("/claims", handleEvseClaims);
+
   server.on("/override$", handleOverride);
 
   // Simple Firmware Update Form
diff --git a/src/web_server.h b/src/web_server.h
@@ -36,6 +36,9 @@ extern void web_server_loop();
 
 extern void web_server_event(JsonDocument &event);
 
+typedef const __FlashStringHelper *fstr_t;
+
+bool requestPreProcess(MongooseHttpServerRequest *request, MongooseHttpServerResponseStream *&response, fstr_t contentType = CONTENT_TYPE_JSON);
 void dumpRequest(MongooseHttpServerRequest *request);
 
 #endif // _EMONESP_WEB_SERVER_H
diff --git a/src/web_server_claims.cpp b/src/web_server_claims.cpp
diff --git a/test/claims.http b/test/claims.http

Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ void divertmode_update(byte newmode)`
`92`	`92`	`event["smoothed_available_current"] = smoothed_available_current = 0;`
`93`	`93`
`94`	`94`	`EvseProperties props(EvseState::Disabled);`
`95`		`- evse.claim(EvseClient_OpenEVSE_Divert, EvseManager_Priority_Divert, props);`
	`95`	`+ evse.claim(EvseClient_OpenEVSE_Divert, EvseManager_Priority_Default, props);`
`96`	`96`	`} break;`
`97`	`97`
`98`	`98`	`default:`
`@@ -208,7 +208,7 @@ void divert_update_state()`
`208`	`208`	`if(divert_active && divertmode_get_time() >= min_charge_end)`
`209`	`209`	`{`
`210`	`210`	`EvseProperties props(EvseState::Disabled);`
`211`		`- evse.claim(EvseClient_OpenEVSE_Divert, EvseManager_Priority_Divert, props);`
	`211`	`+ evse.claim(EvseClient_OpenEVSE_Divert, EvseManager_Priority_Default, props);`
`212`	`212`
`213`	`213`	`if(previousState != evse.getState())`
`214`	`214`	`{`
Original file line number	Diff line number	Diff line change
`@@ -95,16 +95,19 @@ void mqttmsg_callback(MongooseString topic, MongooseString payload) {`
`95`	`95`	`cmd += " "+payload_str;`
`96`	`96`	`}`
`97`	`97`
`98`		`- rapiSender.sendCmd(cmd, [](int ret)`
	`98`	`+ if(!evse.isRapiCommandBlocked(cmd))`
`99`	`99`	`{`
`100`		`- if (RAPI_RESPONSE_OK == ret \|\| RAPI_RESPONSE_NK == ret)`
	`100`	`+ rapiSender.sendCmd(cmd, [](int ret)`
`101`	`101`	`{`
`102`		`- String rapiString = rapiSender.getResponse();`
`103`		`- String mqtt_data = rapiString;`
`104`		`- String mqtt_sub_topic = mqtt_topic + "/rapi/out";`
`105`		`- mqttclient.publish(mqtt_sub_topic, mqtt_data);`
`106`		`- }`
`107`		`- });`
	`102`	`+ if (RAPI_RESPONSE_OK == ret \|\| RAPI_RESPONSE_NK == ret)`
	`103`	`+ {`
	`104`	`+ String rapiString = rapiSender.getResponse();`
	`105`	`+ String mqtt_data = rapiString;`
	`106`	`+ String mqtt_sub_topic = mqtt_topic + "/rapi/out";`
	`107`	`+ mqttclient.publish(mqtt_sub_topic, mqtt_data);`
	`108`	`+ }`
	`109`	`+ });`
	`110`	`+ }`
`108`	`111`	`}`
`109`	`112`	`}`
`110`	`113`	`} //end call back`