Merge branch 'jeremypoulter/issue147' into jeremypoulter/issue192

Author: jeremypoulter

platformio.ini

@@ -39,7 +39,7 @@ lib_deps =
   [email protected]
   [email protected]
   [email protected]
-  [email protected].1
+  [email protected].2
   ESP32 [email protected]
   lorol/[email protected]
 extra_scripts = scripts/extra_script.py

src/evse_man.cpp

@@ -529,3 +529,36 @@ 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;
+}

src/evse_man.h

@@ -38,6 +38,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_Limit    1100
@@ -277,6 +278,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();

src/main.cpp

@@ -192,9 +192,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()) {

src/web_server.cpp

@@ -58,6 +58,8 @@ 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 +121,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);
 
@@ -585,6 +587,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;
@@ -1256,6 +1260,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

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

src/web_server_claims.cpp

@@ -0,0 +1,116 @@
+#if defined(ENABLE_DEBUG) && !defined(ENABLE_DEBUG_WEB)
+#undef ENABLE_DEBUG
+#endif
+
+#include <Arduino.h>
+
+typedef const __FlashStringHelper *fstr_t;
+
+#include "emonesp.h"
+#include "web_server.h"
+#include "evse_man.h"
+#include "input.h"
+
+// -------------------------------------------------------------------
+//
+// url: /claims
+// -------------------------------------------------------------------
+void
+handleEvseClaimsGet(MongooseHttpServerRequest *request, MongooseHttpServerResponseStream *response, uint32_t client)
+{
+  const size_t capacity = JSON_OBJECT_SIZE(40) + 1024;
+  DynamicJsonDocument doc(capacity);
+
+  bool success = (EvseClient_NULL == client) ?
+    evse.serializeClaims(doc) :
+    evse.serializeClaim(doc, client);
+
+  if(success) {
+    response->setCode(200);
+    serializeJson(doc, *response);
+  } else {
+    response->setCode(404);
+    response->print("{\"msg\":\"Not found\"}");
+  }
+}
+
+void
+handleEvseClaimsPost(MongooseHttpServerRequest *request, MongooseHttpServerResponseStream *response, uint32_t client)
+{
+  String body = request->body().toString();
+
+  if(EvseClient_NULL == client)
+  {
+    EvseProperties properties;
+    if(properties.deserialize(body))
+    {
+      int priority = 500;
+      if(evse.claim(client, EvseManager_Priority_API, properties)) {
+        response->setCode(200);
+        response->print("{\"msg\":\"done\"}");
+      } else {
+        response->setCode(400);
+        response->print("{\"msg\":\"Could not make claim\"}");
+      }
+    } else {
+      response->setCode(400);
+      response->print("{\"msg\":\"Could not parse JSON\"}");
+    }
+  } else {
+    response->setCode(405);
+    response->print("{\"msg\":\"Method not allowed\"}");
+  }
+}
+
+void
+handleEvseClaimsDelete(MongooseHttpServerRequest *request, MongooseHttpServerResponseStream *response, uint32_t client)
+{
+  if(EvseClient_NULL != client)
+  {
+    if(evse.release(client)) {
+      response->setCode(200);
+      response->print("{\"msg\":\"done\"}");
+    } else {
+      response->setCode(404);
+      response->print("{\"msg\":\"Not found\"}");
+    }
+  } else {
+    response->setCode(405);
+    response->print("{\"msg\":\"Method not allowed\"}");
+  }
+}
+
+#define EVSE_CLAIM_PATH_LEN (sizeof("/claims/") - 1)
+
+void
+handleEvseClaims(MongooseHttpServerRequest *request)
+{
+  MongooseHttpServerResponseStream *response;
+  if(false == requestPreProcess(request, response)) {
+    return;
+  }
+
+  uint32_t client = EvseClient_NULL;
+
+  String path = request->uri();
+  if(path.length() > EVSE_CLAIM_PATH_LEN) {
+    String clientStr = path.substring(EVSE_CLAIM_PATH_LEN);
+    DBUGVAR(clientStr);
+    client = clientStr.toInt();
+  }
+
+  DBUGVAR(client, HEX);
+
+  if(HTTP_GET == request->method()) {
+    handleEvseClaimsGet(request, response, client);
+  } else if(HTTP_POST == request->method()) {
+    handleEvseClaimsPost(request, response, client);
+  } else if(HTTP_DELETE == request->method()) {
+    handleEvseClaimsDelete(request, response, client);
+  } else {
+    response->setCode(405);
+    response->print("{\"msg\":\"Method not allowed\"}");
+  }
+
+  request->send(response);
+}

test/claims.http

@@ -0,0 +1,20 @@
+# Name: REST Client
+# Id: humao.rest-client
+# Description: REST Client for Visual Studio Code
+# Version: 0.21.3
+# Publisher: Huachao Mao
+# VS Marketplace Link: https://marketplace.visualstudio.com/items?itemName=humao.rest-client
+
+# You should use environment vars (https://marketplace.visualstudio.com/items?itemName=humao.rest-client#environment-variables) for these
+# but you can also set here if needed (just don't check in!)
+
+#@baseUrl = http://openevse.local
+
+#@ssid = your_ssid
+#@pass = your_password
+#@apikey = your_key
+
+###
+
+# Get the EVSE claims
+GET {{baseUrl}}/claims HTTP/1.1