Full support (be and fe) for ramping duty

GuLinux · GuLinux · commit c2f264f4e65b · 2024-11-06T19:39:17.000Z
diff --git a/src/heater.cpp b/src/heater.cpp
@@ -18,7 +18,7 @@ APB::Heaters::Array &APB::Heaters::Instance = *new APB::Heaters::Array();
 struct APB::Heater::Private {
     APB::Heater *q;
     Heater::Mode mode{Heater::Mode::off};
-    float pwm;
+    float maxDuty;
     std::optional<float> temperature;
     float targetTemperature;
     float dewpointOffset;
@@ -99,8 +99,12 @@ const String APB::Heater::modeAsString() const
     return Private::modesToString[mode()];
 }
 
+float APB::Heater::maxDuty() const {
+    return d->maxDuty;
+}
+
 float APB::Heater::duty() const {
-    return d->pwm;
+    return d->getDuty();
 }
 
 bool APB::Heater::active() const {
@@ -109,7 +113,7 @@ bool APB::Heater::active() const {
 
 void APB::Heater::setDuty(float duty) {
     if(duty > 0) {
-        d->pwm = duty;
+        d->maxDuty = duty;
         d->mode = Heater::Mode::fixed;
     } else {
         d->mode = Heater::Mode::off;
@@ -128,7 +132,7 @@ bool APB::Heater::setTemperature(float targetTemperature, float maxDuty, float r
         return false;
     }
     d->targetTemperature = targetTemperature;
-    d->pwm = maxDuty;
+    d->maxDuty = maxDuty;
     d->mode = Heater::Mode::target_temperature;
     d->rampOffset = rampOffset >= 0 ? rampOffset : 0;
     d->loop();
@@ -146,7 +150,7 @@ bool APB::Heater::setDewpoint(float offset, float maxDuty, float rampOffset) {
     }
     d->dewpointOffset = offset;
     d->rampOffset = rampOffset >= 0 ? rampOffset : 0;
-    d->pwm = maxDuty;
+    d->maxDuty = maxDuty;
     d->mode = Heater::Mode::dewpoint;
     d->loop();
     return true;
@@ -198,7 +202,7 @@ void APB::Heater::Private::loop()
     }
 
     if(mode == Heater::Mode::fixed) {
-        writePinDuty(pwm);
+        writePinDuty(maxDuty);
         return;
     }
     if(mode == Heater::Mode::off) {
@@ -236,7 +240,7 @@ void APB::Heater::Private::loop()
             currentTemperature,
             dynamicTargetTemperature,
             rampOffset,
-            pwm,
+            maxDuty,
             rampFactor,
             targetPWM
         );
diff --git a/src/heater.h b/src/heater.h
@@ -27,6 +27,7 @@ class Heater {
     enum Mode { off, fixed, target_temperature, dewpoint };
     void setup(uint8_t index, Scheduler &scheduler);
     
+    float maxDuty() const;
     float duty() const;
     void setDuty(float duty);
     bool setTemperature(float targetTemperature, float maxDuty=1, float rampOffset=0);
diff --git a/src/webserver.cpp b/src/webserver.cpp
@@ -153,6 +153,7 @@ void APB::WebServer::onGetHeaters(AsyncWebServerRequest *request) {
 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()]["maxDuty"] = heater.maxDuty();
         heatersStatus[heater.index()]["duty"] = heater.duty();
         heatersStatus[heater.index()]["active"] = heater.active();
         heatersStatus[heater.index()]["has_temperature"] = heater.temperature().has_value();
@@ -205,12 +206,19 @@ void APB::WebServer::onGetMetrics(AsyncWebServerRequest *request) {
             .gauge("ambient", ambientReading->humidity, MetricsResponse::Labels().unit("%").field("humidity"), nullptr, false)
             .gauge("ambient", ambientReading->dewpoint(), MetricsResponse::Labels().unit("°C").field("dewpoint"), nullptr, false);
     }
+    std::for_each(Heaters::Instance.begin(), Heaters::Instance.end(), [index=0, &metricsResponse](const Heater &heater) mutable {
+        metricsResponse.gauge("heater", heater.maxDuty(), MetricsResponse::Labels()
+            .add("index", String(heater.index()).c_str())
+            .field("maxDuty")
+            .add("mode", heater.modeAsString().c_str()), nullptr, index++==0);
+    });
     std::for_each(Heaters::Instance.begin(), Heaters::Instance.end(), [index=0, &metricsResponse](const Heater &heater) mutable {
         metricsResponse.gauge("heater", heater.duty(), MetricsResponse::Labels()
             .add("index", String(heater.index()).c_str())
             .field("duty")
             .add("mode", heater.modeAsString().c_str()), nullptr, index++==0);
     });
+
     std::for_each(Heaters::Instance.begin(), Heaters::Instance.end(), [index=0, &metricsResponse](const Heater &heater) mutable {
         metricsResponse.gauge("heater", heater.active(), MetricsResponse::Labels()
             .add("index", String(heater.index()).c_str())
diff --git a/web/src/features/app/api.js b/web/src/features/app/api.js
@@ -1,10 +1,20 @@
+class FetchError extends Error {
+    constructor(message, request, response, options) {
+        super(message, options);
+        this.request = request;
+        this.response = response;
+    }
+}
 const fetchJson = async (path, init) => {
     let url = path;
     // console.log(process.env)
     if(process.env.NODE_ENV === 'development' && 'REACT_APP_ASTROPOWERBOX_API_HOST' in process.env) {
         url = `${process.env.REACT_APP_ASTROPOWERBOX_API_HOST}${path}`;
     }
     const response = await fetch(url, init)
+    if(!response.ok) {
+        throw new FetchError(`Response failed for ${path}`, { path, init}, response)
+    }
     return await response.json();
 }
 const payloadJson = async (path, method, payload) => {
diff --git a/web/src/features/sensors/heaters/Heaters.js b/web/src/features/sensors/heaters/Heaters.js
@@ -106,22 +106,43 @@ const SetHeaterModal = ({heater: originalHeater, show, onClose, index}) => {
                         <Form.Label>Duty</Form.Label>
                         <Badge className='float-end'><Number value={heater.duty} formatFunction={formatPercentage} decimals={1} /></Badge>
                         <Form.Range min={0} max={1} step={0.001} value={heater.duty} onChange={updateHeater('duty', parseFloat)} />
+                        { ['target_temperature', 'dewpoint'].includes(heater.mode) && 
+                        <Form.Text>When ramp is set to a non zero value, and mode is either <code>Dewpoint offset</code> or <code>Target temperature</code>,
+                        this will be a maximum value rather than the real duty.</Form.Text> }
                     </Form.Group>
                 </Collapse>
                 <Collapse in={heater.mode === 'target_temperature' && originalHeater.has_temperature}>
                     <Form.Group className='mb-3'>
                         <Form.Label>Target Temperature</Form.Label>
                         <Badge className='float-end'><Number value={heater.target_temperature} unit='°C'/></Badge>
                         <Form.Range min={-20} max={50} value={heater.target_temperature} onChange={updateHeater('target_temperature', parseFloat)}/>
+                        <Form.Text>When the temperature sensor will reach this temperature, the heater will turn off.</Form.Text>
                     </Form.Group>
                 </Collapse>
                 <Collapse in={heater.mode === 'dewpoint' && originalHeater.has_temperature}>
                     <Form.Group className='mb-3'>
                         <Form.Label>Dewpoint Offset</Form.Label>
                         <Badge className='float-end'><Number value={heater.dewpoint_offset} unit='°C' /></Badge>
                         <Form.Range min={-20} max={20} value={heater.dewpoint_offset} onChange={updateHeater('dewpoint_offset', parseFloat)}/>
+                        <Form.Text>
+                            Offset to the dewpoint temperature (either positive or negative).
+                            For instance, if the dewpoint is <code>10°C</code>, and the offset is set to <code>5°C</code>, the target temperature will be <code>15°C</code>.
+                        </Form.Text>
                     </Form.Group>
                 </Collapse>
+                <Collapse in={['dewpoint', 'target_temperature'].includes(heater.mode) && originalHeater.has_temperature}>
+                    <Form.Group className='mb-3'>
+                        <Form.Label>Ramp Offset</Form.Label>
+                        <Badge className='float-end'><Number value={heater.ramp_offset || 0} unit='°C' /></Badge>
+                        <Form.Range min={0} max={20} value={heater.ramp_offset || 0} onChange={updateHeater('ramp_offset', parseFloat)}/>
+                        <Form.Text>
+                            Set this to a number greater than <code>0</code> to start ramping down the duty proportionally to the difference with the target temperature.
+                            For instance, if set to <code>3°C</code>, with a target temperature of <code>25°C</code>, a current temperature of <code>24°C</code>
+                            and a maximum duty of <code>100%</code>, the actual duty will be <code>(25-24)/3 = 33%</code>.
+                        </Form.Text>
+                    </Form.Group>
+
+                </Collapse>
             </Form>
         </Modal.Body>
         <Modal.Footer>
diff --git a/web/src/features/sensors/heaters/heatersSlice.js b/web/src/features/sensors/heaters/heatersSlice.js
@@ -56,6 +56,7 @@ export const heatersSlice = createSlice({
     builder
       .addCase(getHeatersAsync.fulfilled, (state, action) => onHeatersReceived(state, action.payload))
       .addCase(setHeaterAsync.fulfilled, (state, action) => onHeatersReceived(state, action.payload))
+      .addCase(setHeaterAsync.rejected, (state, action) => console.log(action.error.response))
       .addCase(getHistoryAsync.fulfilled, (state, { payload }) => {
         if(!payload) {
           return;
