node-red-contrib-power-saver 3.2.0 → 3.3.0

package/src/general-add-tariff.js

@@ -1,8 +1,6 @@
 const cloneDeep = require("lodash.clonedeep");
-const { DateTime } = require("luxon");
-const { addTariffToPrices, buildAllHours } = require("./general-add-tariff-functions");
-const { roundPrice } = require("./utils");
-const { extractPlanForDate, getEffectiveConfig, validationFailure } = require("./utils");
+const { addTariffToPrices } = require("./general-add-tariff-functions");
+const { getEffectiveConfig } = require("./utils");
 
 module.exports = function (RED) {
   function PsGeneralAddTariffNode(config) {

package/src/handle-input.js

@@ -3,15 +3,22 @@ const { DateTime } = require("luxon");
 const { version } = require("../package.json");
 
 function handleStrategyInput(node, msg, doPlanning) {
-  node.schedulingTimeout = null;
-
   const effectiveConfig = getEffectiveConfig(node, msg);
 
   if (!validateInput(node, msg)) {
     return;
   }
-  const priceData = getPriceData(node, msg);
+  if (msg.payload.commands && msg.payload.commands.reset) {
+    node.warn("Resetting node context by command");
+    // Reset all saved data
+    node.context().set(["lastPlan", "lastPriceData", "lastSource"], [undefined, undefined, undefined]);
+    deleteSavedScheduleBefore(node, DateTime.now().plus({ days: 1 }), 100);
+  }
+  const { priceData, source } = getPriceData(node, msg);
   if (!priceData) {
+    const message = "No price data";
+    node.warn(message);
+    node.status({ fill: "yellow", shape: "dot", text: message });
     return;
   }
   const planFromTime = msg.payload.time ? DateTime.fromISO(msg.payload.time) : DateTime.now();
@@ -34,6 +41,8 @@ function handleStrategyInput(node, msg, doPlanning) {
   node.context().set("lastPlan", plan);
   dates.forEach((d) => saveDayData(node, d, extractPlanForDate(plan, d)));
 
+  const sentOnCommand = !!msg.payload.commands?.sendSchedule;
+
   // Prepare output
   let output1 = null;
   let output2 = null;
@@ -41,8 +50,9 @@ function handleStrategyInput(node, msg, doPlanning) {
     payload: {
       schedule: plan.schedule,
       hours: plan.hours,
-      source: msg.payload.source,
+      source,
       config: effectiveConfig,
+      sentOnCommand,
       time: planFromTime.toISO(),
       version,
     },
@@ -51,7 +61,7 @@ function handleStrategyInput(node, msg, doPlanning) {
   // Find current output, and set output (if configured to do)
   const pastSchedule = plan.schedule.filter((entry) => DateTime.fromISO(entry.time) <= planFromTime);
 
-  const sendNow = node.sendCurrentValueWhenRescheduling && pastSchedule.length > 0;
+  const sendNow = !!node.sendCurrentValueWhenRescheduling && pastSchedule.length > 0 && !sentOnCommand;
   const currentValue = pastSchedule[pastSchedule.length - 1]?.value;
   if (sendNow) {
     output1 = currentValue ? { payload: true } : null;
@@ -71,24 +81,28 @@ function handleStrategyInput(node, msg, doPlanning) {
 
 function getPriceData(node, msg) {
   const isConfigMsg = !!msg?.payload?.config;
+  const isCommandMsg = !!msg?.payload?.commands;
   const isPriceMsg = !!msg?.payload?.priceData;
-  if (isConfigMsg && !isPriceMsg) {
-    return node.context().get("lastPriceData");
+  if ((isConfigMsg || isCommandMsg) && !isPriceMsg) {
+    const priceData = node.context().get("lastPriceData");
+    const source = node.context().get("lastSource");
+    return { priceData, source };
   }
   const priceData = msg.payload.priceData;
+  const source = msg.payload.source;
   node.context().set("lastPriceData", priceData);
-  return priceData;
+  node.context().set("lastSource", source);
+  return { priceData, source };
 }
 
 function runSchedule(node, schedule, time, currentSent = false) {
-  let currentTime = time;
   let remainingSchedule = schedule.filter((entry) => {
-    return DateTime.fromISO(entry.time) > DateTime.fromISO(time);
+    return DateTime.fromISO(entry.time) > time;
   });
   if (remainingSchedule.length > 0) {
     const entry = remainingSchedule[0];
     const nextTime = DateTime.fromISO(entry.time);
-    const wait = nextTime - currentTime;
+    const wait = nextTime - time;
     const onOff = entry.value ? "on" : "off";
     node.log("Switching " + onOff + " in " + wait + " milliseconds");
     const statusMessage = `${remainingSchedule.length} changes - ${
@@ -109,12 +123,14 @@ function runSchedule(node, schedule, time, currentSent = false) {
   }
 }
 
-function deleteSavedScheduleBefore(node, day) {
+function deleteSavedScheduleBefore(node, day, checkDays = 0) {
   let date = day;
+  let count = 0;
   do {
     date = date.plus({ days: -1 });
     data = node.context().set(date.toISO(), undefined);
-  } while (data);
+    count++;
+  } while (data || count <= checkDays);
 }
 
 function saveDayData(node, date, plan) {
@@ -139,6 +155,9 @@ function validateInput(node, msg) {
   if (msg.payload.config !== undefined) {
     return true; // Got config msg
   }
+  if (msg.payload.commands !== undefined) {
+    return true; // Got command msg
+  }
   if (msg.payload.priceData === undefined) {
     validationFailure(node, "Payload is missing priceData");
     return;

package/src/strategy-best-save.html

@@ -26,11 +26,6 @@
         align: "left",
       },
       outputIfNoSchedule: { value: "true", required: true, align: "left" },
-      scheduleOnlyFromCurrentTime: {
-        value: "true",
-        required: true,
-        align: "left",
-      },
     },
     inputs: 1,
     outputs: 3,
@@ -52,17 +47,6 @@
           },
         ],
       });
-      $("#node-input-scheduleOnlyFromCurrentTime").typedInput({
-        types: [
-          {
-            value: "nowOrStart",
-            options: [
-              { value: "false", label: "Whole data set" },
-              { value: "true", label: "From current hour" },
-            ],
-          },
-        ],
-      });
     },
   });
 </script>
@@ -88,11 +72,6 @@
         <label for="node-input-minSaving"><i class="fa fa-eur"></i> Min saving</label>
         <input type="text" id="node-input-minSaving" placeholder="Minimum to save for turning off" style="width: 80px">
     </div>
-    <div class="form-row">
-      <label for="node-input-scheduleOnlyFromCurrentTime">Schedule for</label>
-      <input type="text" id="node-input-scheduleOnlyFromCurrentTime" style="width: 160px">
-      </label>
-  </div>
   <h3>Output</h3>
     <div class="form-row">
         <label for="node-input-sendCurrentValueWhenRescheduling" style="width:240px">

package/src/strategy-best-save.js

@@ -1,4 +1,4 @@
-const { countAtEnd, makeSchedule, getSavings, getStartAtIndex, getDiff } = require("./utils");
+const { countAtEnd, makeSchedule, getSavings, getDiff } = require("./utils");
 const { handleStrategyInput } = require("./handle-input");
 const { loadDayData } = require("./utils");
 
@@ -15,7 +15,6 @@ module.exports = function (RED) {
       minSaving: parseFloat(config.minSaving),
       sendCurrentValueWhenRescheduling: config.sendCurrentValueWhenRescheduling,
       outputIfNoSchedule: config.outputIfNoSchedule === "true",
-      scheduleOnlyFromCurrentTime: config.scheduleOnlyFromCurrentTime === "true",
     };
     node.context().set("config", originalConfig);
 
@@ -43,20 +42,18 @@ function adjustSavingsPassedHours(plan, includeFromLastPlanHours) {
   }
 }
 
-function loadDataJustBefore(node, dateDayBefore, dateToday, startAtIndex) {
+function loadDataJustBefore(node, dateDayBefore) {
   const dataDayBefore = loadDayData(node, dateDayBefore);
-  const dataToday = loadDayData(node, dateToday);
   return {
-    schedule: [...dataDayBefore.schedule, ...dataToday.schedule.slice(0, startAtIndex)],
-    hours: [...dataDayBefore.hours, ...dataToday.hours.slice(0, startAtIndex)],
+    schedule: [...dataDayBefore.schedule],
+    hours: [...dataDayBefore.hours],
   };
 }
 
-function doPlanning(node, effectiveConfig, priceData, planFromTime, dateDayBefore, dateToday) {
-  const startAtIndex = getStartAtIndex(effectiveConfig, priceData, planFromTime);
-  const dataJustBefore = loadDataJustBefore(node, dateDayBefore, dateToday, startAtIndex);
-  const values = priceData.map((d) => d.value).slice(startAtIndex);
-  const startTimes = priceData.map((d) => d.start).slice(startAtIndex);
+function doPlanning(node, _, priceData, _, dateDayBefore, _) {
+  const dataJustBefore = loadDataJustBefore(node, dateDayBefore);
+  const values = priceData.map((d) => d.value);
+  const startTimes = priceData.map((d) => d.start);
   const onOffBefore = dataJustBefore.hours.map((h) => h.onOff);
   const lastPlanHours = node.context().get("lastPlan")?.hours ?? [];
   const plan = makePlan(node, values, startTimes, onOffBefore);

package/test/commands-input.test.js

@@ -0,0 +1,47 @@
+const expect = require("expect");
+const helper = require("node-red-node-test-helper");
+const bestSave = require("../src/strategy-best-save.js");
+const prices = require("./data/converted-prices.json");
+const result = require("./data/best-save-result.json");
+const { testPlan, equalPlan } = require("./test-utils");
+const { makeFlow, makePayload } = require("./strategy-best-save-test-utils");
+
+helper.init(require.resolve("node-red"));
+
+describe("send command as input", () => {
+  beforeEach(function (done) {
+    helper.startServer(done);
+  });
+
+  afterEach(function (done) {
+    helper.unload().then(function () {
+      helper.stopServer(done);
+    });
+  });
+
+  it("should send output on command", function (done) {
+    const flow = makeFlow(3, 2, true);
+    let pass = 1;
+    helper.load(bestSave, flow, function () {
+      const n1 = helper.getNode("n1");
+      const n2 = helper.getNode("n2");
+      n1.sendCurrentValueWhenRescheduling = true;
+      n2.on("input", function (msg) {
+        switch (pass) {
+          case 1:
+            pass++;
+            expect(equalPlan(result, msg.payload)).toBeTruthy();
+            expect(msg.payload.sentOnCommand).toBeFalsy();
+            n1.receive({ payload: { commands: { sendSchedule: true } } });
+            break;
+          case 2:
+            expect(equalPlan(result, msg.payload)).toBeTruthy();
+            expect(msg.payload.sentOnCommand).toBeTruthy();
+            done();
+            break;
+        }
+      });
+      n1.receive({ payload: makePayload(prices, testPlan.time) });
+    });
+  });
+});

package/test/data/best-save-result.json

@@ -351,7 +351,6 @@
     "maxHoursToSaveInSequence": 3,
     "minHoursOnAfterMaxSequenceSaved": 2,
     "minSaving": 0.001,
-    "outputIfNoSchedule": false,
-    "scheduleOnlyFromCurrentTime": false
+    "outputIfNoSchedule": false
   }
 }

package/test/data/current-undefined-prices.json

@@ -0,0 +1,197 @@
+{
+  "priceData": [
+    {
+      "value": 1.792,
+      "start": "2022-01-12T00:00:00+01:00"
+    },
+    {
+      "value": 1.761,
+      "start": "2022-01-12T01:00:00+01:00"
+    },
+    {
+      "value": 1.744,
+      "start": "2022-01-12T02:00:00+01:00"
+    },
+    {
+      "value": 1.741,
+      "start": "2022-01-12T03:00:00+01:00"
+    },
+    {
+      "value": 1.752,
+      "start": "2022-01-12T04:00:00+01:00"
+    },
+    {
+      "value": 1.773,
+      "start": "2022-01-12T05:00:00+01:00"
+    },
+    {
+      "value": 1.773,
+      "start": "2022-01-12T06:00:00+01:00"
+    },
+    {
+      "value": 1.832,
+      "start": "2022-01-12T07:00:00+01:00"
+    },
+    {
+      "value": 1.863,
+      "start": "2022-01-12T08:00:00+01:00"
+    },
+    {
+      "value": 1.826,
+      "start": "2022-01-12T09:00:00+01:00"
+    },
+    {
+      "value": 1.795,
+      "start": "2022-01-12T10:00:00+01:00"
+    },
+    {
+      "value": 1.753,
+      "start": "2022-01-12T11:00:00+01:00"
+    },
+    {
+      "value": 1.75,
+      "start": "2022-01-12T12:00:00+01:00"
+    },
+    {
+      "value": 1.738,
+      "start": "2022-01-12T13:00:00+01:00"
+    },
+    {
+      "value": 1.717,
+      "start": "2022-01-12T14:00:00+01:00"
+    },
+    {
+      "value": 1.707,
+      "start": "2022-01-12T15:00:00+01:00"
+    },
+    {
+      "value": 1.708,
+      "start": "2022-01-12T16:00:00+01:00"
+    },
+    {
+      "value": 1.707,
+      "start": "2022-01-12T17:00:00+01:00"
+    },
+    {
+      "value": 1.692,
+      "start": "2022-01-12T18:00:00+01:00"
+    },
+    {
+      "value": 1.661,
+      "start": "2022-01-12T19:00:00+01:00"
+    },
+    {
+      "value": 1.64,
+      "start": "2022-01-12T20:00:00+01:00"
+    },
+    {
+      "value": 1.634,
+      "start": "2022-01-12T21:00:00+01:00"
+    },
+    {
+      "value": 1.614,
+      "start": "2022-01-12T22:00:00+01:00"
+    },
+    {
+      "value": 1.598,
+      "start": "2022-01-12T23:00:00+01:00"
+    },
+    {
+      "value": 1.569,
+      "start": "2022-01-13T00:00:00+01:00"
+    },
+    {
+      "value": 1.548,
+      "start": "2022-01-13T01:00:00+01:00"
+    },
+    {
+      "value": 1.518,
+      "start": "2022-01-13T02:00:00+01:00"
+    },
+    {
+      "value": 1.507,
+      "start": "2022-01-13T03:00:00+01:00"
+    },
+    {
+      "value": 1.501,
+      "start": "2022-01-13T04:00:00+01:00"
+    },
+    {
+      "value": 1.508,
+      "start": "2022-01-13T05:00:00+01:00"
+    },
+    {
+      "value": 1.544,
+      "start": "2022-01-13T06:00:00+01:00"
+    },
+    {
+      "value": 1.612,
+      "start": "2022-01-13T07:00:00+01:00"
+    },
+    {
+      "value": 1.646,
+      "start": "2022-01-13T08:00:00+01:00"
+    },
+    {
+      "value": 1.654,
+      "start": "2022-01-13T09:00:00+01:00"
+    },
+    {
+      "value": 1.656,
+      "start": "2022-01-13T10:00:00+01:00"
+    },
+    {
+      "value": 1.648,
+      "start": "2022-01-13T11:00:00+01:00"
+    },
+    {
+      "value": 1.617,
+      "start": "2022-01-13T12:00:00+01:00"
+    },
+    {
+      "value": 1.613,
+      "start": "2022-01-13T13:00:00+01:00"
+    },
+    {
+      "value": 1.612,
+      "start": "2022-01-13T14:00:00+01:00"
+    },
+    {
+      "value": 1.611,
+      "start": "2022-01-13T15:00:00+01:00"
+    },
+    {
+      "value": 1.618,
+      "start": "2022-01-13T16:00:00+01:00"
+    },
+    {
+      "value": 1.616,
+      "start": "2022-01-13T17:00:00+01:00"
+    },
+    {
+      "value": 1.617,
+      "start": "2022-01-13T18:00:00+01:00"
+    },
+    {
+      "value": 1.601,
+      "start": "2022-01-13T19:00:00+01:00"
+    },
+    {
+      "value": 1.568,
+      "start": "2022-01-13T20:00:00+01:00"
+    },
+    {
+      "value": 1.565,
+      "start": "2022-01-13T21:00:00+01:00"
+    },
+    {
+      "value": 1.506,
+      "start": "2022-01-13T22:00:00+01:00"
+    },
+    {
+      "value": 1.468,
+      "start": "2022-01-13T23:00:00+01:00"
+    }
+  ],
+  "source": "Nordpool"
+}

package/test/data/current-undefined-result.json

@@ -0,0 +1,208 @@
+{
+  "schedule": [
+    {
+      "time": "2022-01-12T18:00:00+01:00",
+      "value": true
+    },
+    {
+      "time": "2022-01-13T17:00:00+01:00",
+      "value": false
+    },
+    {
+      "time": "2022-01-13T23:00:00+01:00",
+      "value": true
+    }
+  ],
+  "hours": [
+    {
+      "price": 1.692,
+      "onOff": true,
+      "start": "2022-01-12T18:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.661,
+      "onOff": true,
+      "start": "2022-01-12T19:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.64,
+      "onOff": true,
+      "start": "2022-01-12T20:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.634,
+      "onOff": true,
+      "start": "2022-01-12T21:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.614,
+      "onOff": true,
+      "start": "2022-01-12T22:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.598,
+      "onOff": true,
+      "start": "2022-01-12T23:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.569,
+      "onOff": true,
+      "start": "2022-01-13T00:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.548,
+      "onOff": true,
+      "start": "2022-01-13T01:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.518,
+      "onOff": true,
+      "start": "2022-01-13T02:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.507,
+      "onOff": true,
+      "start": "2022-01-13T03:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.501,
+      "onOff": true,
+      "start": "2022-01-13T04:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.508,
+      "onOff": true,
+      "start": "2022-01-13T05:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.544,
+      "onOff": true,
+      "start": "2022-01-13T06:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.612,
+      "onOff": true,
+      "start": "2022-01-13T07:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.646,
+      "onOff": true,
+      "start": "2022-01-13T08:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.654,
+      "onOff": true,
+      "start": "2022-01-13T09:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.656,
+      "onOff": true,
+      "start": "2022-01-13T10:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.648,
+      "onOff": true,
+      "start": "2022-01-13T11:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.617,
+      "onOff": true,
+      "start": "2022-01-13T12:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.613,
+      "onOff": true,
+      "start": "2022-01-13T13:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.612,
+      "onOff": true,
+      "start": "2022-01-13T14:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.611,
+      "onOff": true,
+      "start": "2022-01-13T15:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.618,
+      "onOff": true,
+      "start": "2022-01-13T16:00:00+01:00",
+      "saving": null
+    },
+    {
+      "price": 1.616,
+      "onOff": false,
+      "start": "2022-01-13T17:00:00+01:00",
+      "saving": 0.148
+    },
+    {
+      "price": 1.617,
+      "onOff": false,
+      "start": "2022-01-13T18:00:00+01:00",
+      "saving": 0.149
+    },
+    {
+      "price": 1.601,
+      "onOff": false,
+      "start": "2022-01-13T19:00:00+01:00",
+      "saving": 0.133
+    },
+    {
+      "price": 1.568,
+      "onOff": false,
+      "start": "2022-01-13T20:00:00+01:00",
+      "saving": 0.1
+    },
+    {
+      "price": 1.565,
+      "onOff": false,
+      "start": "2022-01-13T21:00:00+01:00",
+      "saving": 0.097
+    },
+    {
+      "price": 1.506,
+      "onOff": false,
+      "start": "2022-01-13T22:00:00+01:00",
+      "saving": 0.038
+    },
+    {
+      "price": 1.468,
+      "onOff": true,
+      "start": "2022-01-13T23:00:00+01:00",
+      "saving": null
+    }
+  ],
+  "source": "Nordpool",
+  "config": {
+    "maxHoursToSaveInSequence": "6",
+    "minHoursOnAfterMaxSequenceSaved": "3",
+    "minSaving": 0.1,
+    "sendCurrentValueWhenRescheduling": true,
+    "outputIfNoSchedule": true
+  },
+  "time": "2022-01-12T17:29:33.411+01:00",
+  "version": "3.2.3"
+}

package/test/data/lowest-price-result-missing-end.json

@@ -313,7 +313,8 @@
       "sendCurrentValueWhenRescheduling": true,
       "outputIfNoSchedule": false,
       "outputOutsidePeriod": false
-    }
+    },
+    "sentOnCommand": false
   },
   "_msgid": "892aabf20811e69f"
 }