Move objects serialization from webserver into their own classes

Author: GuLinux

src/ambient/ambient.cpp

@@ -1,4 +1,5 @@
 #include "ambient-p.h"
+#include "ambient.h"
 
 APB::Ambient &APB::Ambient::Instance = *new APB::Ambient();
 
@@ -35,5 +36,10 @@ float APB::Ambient::calculateDewpoint(float temperature, float humidity) {
   static const float dewpointB = 243.12;
   const float a_t_rh = log(humidity / 100.0) + (dewpointA * temperature / (dewpointB + temperature));
   return (dewpointB * a_t_rh) / (dewpointA - a_t_rh);
+}
 
+void APB::Ambient::toJson(JsonObject ambientStatus) {
+    ambientStatus["temperature"] = _reading->temperature;
+    ambientStatus["humidity"] = _reading->humidity;
+    ambientStatus["dewpoint"] = _reading->dewpoint();
 }

src/ambient/ambient.h

@@ -3,6 +3,7 @@
 
 #include <TaskSchedulerDeclarations.h>
 #include <optional>
+#include <ArduinoJson.h>
 
 #include "configuration.h"
 
@@ -28,6 +29,7 @@ class Ambient {
     void readSensor();
     std::optional<Reading> _reading;
     static float calculateDewpoint(float temperature, float humidity);
+    void toJson(JsonObject ambientStatus);
 };
 
 }

src/heater.cpp

@@ -9,6 +9,8 @@
 #include <SmoothThermistor.h>
 #endif
 
+#include "utils.h"
+
 
 static const char *TEMPERATURE_NOT_FOUND_WARNING_LOG = "%s Cannot set heater temperature without temperature sensor";
 static const char *AMBIENT_NOT_FOUND_WARNING_LOG = "%s Cannot set heater temperature without ambient sensor";
@@ -80,7 +82,21 @@ void APB::Heater::setup(uint8_t index, Scheduler &scheduler) {
     Log.infoln("%s Heater initialised", d->log_scope);
 
 }
-std::forward_list<String> APB::Heater::validModes() {
+void APB::Heater::toJson(JsonObject heaterStatus) {
+    heaterStatus["mode"] = modeAsString(),
+    heaterStatus["max_duty"] = maxDuty();
+    heaterStatus["duty"] = duty();
+    heaterStatus["active"] = active();
+    heaterStatus["has_temperature"] = temperature().has_value();
+    optional::if_present(rampOffset(), [&](float v){ heaterStatus["ramp_offset"] = v; });
+    optional::if_present(minDuty(), [&](float v){ heaterStatus["min_duty"] = v; });
+    optional::if_present(temperature(), [&](float v){ heaterStatus["temperature"] = v; });
+    optional::if_present(targetTemperature(), [&](float v){ heaterStatus["target_temperature"] = v; });
+    optional::if_present(dewpointOffset(), [&](float v){ heaterStatus["dewpoint_offset"] = v; });
+}
+
+std::forward_list<String> APB::Heater::validModes()
+{
     static std::forward_list<String> keys;
     if(keys.empty())
         std::transform(Private::modesToString.begin(), Private::modesToString.end(), std::front_inserter(keys), [](const auto &i) { return i.second; });
@@ -308,4 +324,10 @@ void APB::Heater::Private::writePinDuty(float pwm) {
     }
 }
 
-#endif
+#endif
+
+void APB::Heaters::toJson(JsonArray heatersStatus) {
+    std::for_each(Heaters::Instance.begin(), Heaters::Instance.end(), [heatersStatus](Heater &heater) {
+        heater.toJson(heatersStatus[heater.index()]);
+    });
+}

src/heater.h

@@ -6,6 +6,7 @@
 #include <TaskSchedulerDeclarations.h>
 #include <forward_list>
 #include <unordered_map>
+#include <ArduinoJson.h>
 
 #include "configuration.h"
 #include "ambient/ambient.h"
@@ -16,6 +17,7 @@ class Heater;
 namespace Heaters {
     using Array = std::array<APB::Heater, APB_HEATERS_SIZE>;
     extern Array &Instance;
+    void toJson(JsonArray heatersStatus);
 }
 
 
@@ -26,6 +28,8 @@ class Heater {
     ~Heater();
     enum Mode { off, fixed, target_temperature, dewpoint };
     void setup(uint8_t index, Scheduler &scheduler);
+
+    void toJson(JsonObject heaterStatus);
 
     float maxDuty() const;
     float duty() const;

src/powermonitor.cpp

@@ -50,7 +50,16 @@ void APB::PowerMonitor::setup(Scheduler &scheduler) {
     }
 }
 
-void APB::PowerMonitor::setCharge() {
+void APB::PowerMonitor::toJson(JsonObject powerStatus) {
+    powerStatus["busVoltage"] = _status.busVoltage;
+    powerStatus["current"] = _status.current;
+    powerStatus["power"] = _status.power;
+    powerStatus["shuntVoltage"] = _status.shuntVoltage;
+    powerStatus["charge"] = _status.charge;
+}
+
+void APB::PowerMonitor::setCharge()
+{
     switch (Settings::Instance.powerSource()) {
     case LipoBattery3C:
         _status.charge = lipoBatteryCharge(3, _status.busVoltage);
@@ -60,7 +69,6 @@ void APB::PowerMonitor::setCharge() {
     }
 }
 
-
 float lipoBatteryCharge(uint8_t cells, float voltage) {
     float singleCellVoltage = voltage / static_cast<float>(cells);
     using RefPair = std::pair<float, float>;

src/powermonitor.h

@@ -4,6 +4,7 @@
 #include <optional>
 #include <memory>
 #include <TaskSchedulerDeclarations.h>
+#include <ArduinoJson.h>
 
 #include "configuration.h"
 #include <INA219.h>
@@ -30,6 +31,7 @@ class PowerMonitor {
         LipoBattery3C = 1,
     };
     Status status() const { return _status; }
+    void toJson(JsonObject powerStatus);
 private:
     INA219 _ina219{APB_INA1219_ADDRESS};
     PowerMonitor::Status _status;

src/webserver.cpp

@@ -19,8 +19,7 @@ using namespace GuLinux;
 
 APB::WebServer::WebServer(Scheduler &scheduler) : AsyncWebServerBase{},
     events("/api/events"),
-    scheduler(scheduler)
-{
+    scheduler(scheduler) {
 }
 
 
@@ -69,13 +68,13 @@ void APB::WebServer::setup() {
     new Task(1000, TASK_FOREVER, [this](){
         eventsDocument.clear();
         if(Ambient::Instance.reading().has_value()) {
-            populateAmbientStatus(eventsDocument["ambient"].to<JsonObject>());
+            Ambient::Instance.toJson(eventsDocument["ambient"].to<JsonObject>());
         } else {
             eventsDocument["ambient"] = static_cast<char*>(0);
         }
 
-        populatePowerStatus(eventsDocument["power"].to<JsonObject>());
-        populateHeatersStatus(eventsDocument["heaters"].to<JsonArray>());
+        PowerMonitor::Instance.toJson(eventsDocument["power"].to<JsonObject>());
+        Heaters::toJson(eventsDocument["heaters"].to<JsonArray>());
         eventsDocument["app"]["uptime"] = esp_timer_get_time() / 1000'000.0;
         serializeJson(eventsDocument, eventsString.data(), eventsString.size());
         this->events.send(eventsString.data(), "status", millis(), 5000);
@@ -135,55 +134,23 @@ void APB::WebServer::onGetAmbient(AsyncWebServerRequest *request) {
         return;
     }
     JsonResponse response(request);
-    populateAmbientStatus(response.root().to<JsonObject>());
+    Ambient::Instance.toJson(response.root().to<JsonObject>());
 }
 
 
 
 void APB::WebServer::onGetHeaters(AsyncWebServerRequest *request) {
     JsonResponse response(request);
-    populateHeatersStatus(response.root().to<JsonArray>());
+    Heaters::toJson(response.root().to<JsonArray>());
 }
 
-void APB::WebServer::populateHeatersStatus(JsonArray heatersStatus) {
-    std::for_each(Heaters::Instance.begin(), Heaters::Instance.end(), [heatersStatus](Heater &heater) {
-        heatersStatus[heater.index()]["mode"] = heater.modeAsString(),
-        heatersStatus[heater.index()]["max_duty"] = heater.maxDuty();
-        heatersStatus[heater.index()]["duty"] = heater.duty();
-        heatersStatus[heater.index()]["active"] = heater.active();
-        heatersStatus[heater.index()]["has_temperature"] = heater.temperature().has_value();
-        optional::if_present(heater.rampOffset(), [&](float v){ heatersStatus[heater.index()]["ramp_offset"] = v; });
-        optional::if_present(heater.minDuty(), [&](float v){ heatersStatus[heater.index()]["min_duty"] = v; });
-        optional::if_present(heater.temperature(), [&](float v){ heatersStatus[heater.index()]["temperature"] = v; });
-        optional::if_present(heater.targetTemperature(), [&](float v){ heatersStatus[heater.index()]["target_temperature"] = v; });
-        optional::if_present(heater.dewpointOffset(), [&](float v){ heatersStatus[heater.index()]["dewpoint_offset"] = v; });
-    });
-}
-
-void APB::WebServer::populateAmbientStatus(JsonObject ambientStatus) {
-    ambientStatus["temperature"] = Ambient::Instance.reading()->temperature;
-    ambientStatus["humidity"] = Ambient::Instance.reading()->humidity;
-    ambientStatus["dewpoint"] = Ambient::Instance.reading()->dewpoint();
-}
-
-
-void APB::WebServer::populatePowerStatus(JsonObject powerStatus) {
-    powerStatus["busVoltage"] = PowerMonitor::Instance.status().busVoltage;
-    powerStatus["current"] = PowerMonitor::Instance.status().current;
-    powerStatus["power"] = PowerMonitor::Instance.status().power;
-    powerStatus["shuntVoltage"] = PowerMonitor::Instance.status().shuntVoltage;
-    powerStatus["charge"] = PowerMonitor::Instance.status().charge;
-}
-
-
-
 void APB::WebServer::onGetPower(AsyncWebServerRequest *request) {
     if(!PowerMonitor::Instance.status().initialised) {
         JsonResponse::error(500, "Power reading not available", request);
         return;
     }
     JsonResponse response(request);
-    populatePowerStatus(response.root().to<JsonObject>());
+    PowerMonitor::Instance.toJson(response.root().to<JsonObject>());
 }
 
 void APB::WebServer::onGetMetrics(AsyncWebServerRequest *request) {

src/webserver.h

@@ -41,12 +41,6 @@ class WebServer : public AsyncWebServerBase {
     void onPostSetHeater(AsyncWebServerRequest *request, JsonVariant &json);
     void onConfigStatusLedDuty(AsyncWebServerRequest *request, JsonVariant &json);
     void onConfigPowerSourceType(AsyncWebServerRequest *request, JsonVariant &json);
-    
-
-    void populateHeatersStatus(JsonArray heatersStatus);
-    void populateAmbientStatus(JsonObject ambientStatus);
-    void populatePowerStatus(JsonObject powerStatus);
-
 };
 }