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

package/docs/.vuepress/config.js

@@ -19,6 +19,10 @@ module.exports = {
         text: "Examples",
         link: "/examples/",
       },
+      {
+        text: "FAQ",
+        link: "/faq/",
+      },
       {
         text: "Contribute",
         link: "/contribute/",

package/docs/changelog/README.md

@@ -6,6 +6,15 @@ sidebar: "auto"
 
 List the most significant changes, starting in version 1.0.9.
 
+## 3.3.0
+
+- Remove the config option to schedule from the current hour. The feature did not work, and it was not clear how it should work.
+- Added a dynamic command feature to make it possible to dynamically
+  1. Tell the node to send the schedule to output 3.
+  2. Reset saved data making the next schedule to start without historical data.
+- Fix node status so it says "No price data" when there is no price data available.
+- Added an FAQ section to the doc.
+
 ## 3.2.3
 
 - Remove unused imports

package/docs/examples/example-nordpool-current-state.md

@@ -154,7 +154,6 @@ In this example, data is read from the Nord Pool sensor in HA via the `current s
         "minSaving": "0.03",
         "sendCurrentValueWhenRescheduling": true,
         "outputIfNoSchedule": "true",
-        "scheduleOnlyFromCurrentTime": "false",
         "x": 630,
         "y": 380,
         "wires": [

package/docs/examples/example-tibber-mqtt.md

@@ -120,7 +120,6 @@ In this example, data is read from Tibber and used to turn on/off a switch, sche
     "minSaving": "0.05",
     "sendCurrentValueWhenRescheduling": true,
     "outputIfNoSchedule": "true",
-    "scheduleOnlyFromCurrentTime": "false",
     "x": 490,
     "y": 160,
     "wires": [["467a5fe.d0bbba", "5e485ff7.db156"], ["9c978d1c.ee76", "467a5fe.d0bbba"], ["42d8b632.402e38"]]

package/docs/faq/README.md

@@ -12,7 +12,7 @@ Why does it not save the most expensive period?
 
 If you move the saving-period 4-5 hours earlier, the most expensive hours would have been saved. Why is this not better?
 
-Remember that the power that is not used during the saving-period, will be used immediately after. At least, that is the idea, and the normal behaviour if the power consumer is a water heater or another heater controlled by a thermostat. So, then the power would be used one of the blue hours in stead of the green cheaper hour.
+Remember that the power that is not used during the saving-period, will be used immediately after. At least, that is the idea, and the normal behavior if the power consumer is a water heater or another heater controlled by a thermostat. So, then the power would be used one of the blue hours in stead of the green cheaper hour.
 
 Also remember that when saving, you do not save the full price. You only save what is the difference between the price during the saved hours and the price the hour immediately after.
 
@@ -21,3 +21,7 @@ So the best saving is found where this difference is the largest, and that is no
 Of course, if you expand the saving period from 5 to 10 hours you would save even more, but that would be a different case, and you can do that if it is ok for you to turn off for that long time.
 
 Another alternative is to reduce the minimum saving from 0.05 to 0.001. Then the 3 first red hours would be turned off, but the last red would have to be on, in order to get one hour on until the next 5-hour period off. This would however not save you for much money, since the hour that is on is almost as expensive as the hours you would turn off.
+
+## Can we get Legionella bacteria when turning off the water heater?
+
+Many people ask if there is a danger that legionella bacteria will grow and become dangerous when the temperature of the water heater is lowered. As long as the water is heated to at least 65 °C every day, or at least every week, the risk of infection is not considered significant, according to the norwegian [FHI](https://www.fhi.no/nettpub/legionellaveilederen/).

package/docs/nodes/ps-strategy-best-save.md

@@ -19,7 +19,6 @@ The picture at the bottom of the page, under [Integration with MagicMirror](#int
 | Max per sequence       | Maximum number of hours to turn off in a sequence.                                                                                                                   |
 | Min recover            | Minimum hours to turn on immediately after a period when turned off the maximum number of hours that is allowed to be turned off                                     |
 | Min saving             | Minimum amount to save per kWh in order to bother turning it off. It is recommended to have some amount here, e.g. 2 cents / 2 øre. No point in saving 0.001, is it? |
-| Schedule for           | Select to schedule for the whole data set or only from the current hour.                                                                                             |
 | Send when rescheduling | Check this to make sure on or off output is sent immediately after rescheduling                                                                                      |
 | If no schedule, send   | What to do if there is no valid schedule any more (turn on or off).                                                                                                  |
 
@@ -27,10 +26,6 @@ The picture at the bottom of the page, under [Integration with MagicMirror](#int
 NB! The `Min recover` only has effect if the previous save-period is of length `Max per sequence`. If the save-period is shorter, the following on-period may be as short as one hour.
 :::
 
-::: tip Legionella
-Many people ask if there is a danger that legionella bacteria will grow and become dangerous when the temperature of the water heater is lowered. As long as the water is heated to at least 65 °C every day, or at least every week, the risk of infection is not considered significant, according to the norwegian [FHI](https://www.fhi.no/nettpub/legionellaveilederen/).
-:::
-
 ### Dynamic config
 
 It is possible to change config dynamically by sending a config message to the node. The config messages has a payload with a config object like this example:
@@ -43,7 +38,6 @@ It is possible to change config dynamically by sending a config message to the n
     "minSaving": 0.02,
     "sendCurrentValueWhenRescheduling": true,
     "outputIfNoSchedule": true,
-    "scheduleOnlyFromCurrentTime": false
   }
 }
 ```
@@ -54,11 +48,58 @@ The config sent like this will be valid until a new config is sent the same way,
 
 When a config is sent like this, and without price data, the schedule will be replanned based on the last previously received price data. If no price data has been received, no scheduling is done.
 
-However, you can send config and price data in the same message. Then both will be used .
+However, you can send config and price data in the same message. Then both will be used.
+
+### Dynamic commands
+
+You can dynamically send some commands to the node via its input, by using a `commands` object in the payload as described below.
+
+Commands can be sent together with config and/or price data, but the exact behavior is not defined.
+
+#### sendSchedule
+
+You can get the schedule sent to output 3 any time by sending a message like this to the node:
+
+```json
+"payload": {
+  "commands": {
+    "sendSchedule": true,
+  }
+}
+```
+
+When you do this, the current schedule is actually recalculated based on the last received data, and then sent to output 3 the same way as when it was originally planned.
+
+#### reset
+
+You can reset data the node has saved in context by sending this message:
+
+```json
+"payload": {
+  "commands": {
+    "reset": true,
+  }
+}
+```
+
+When you do this, all historical data the node has saved is deleted, including the current schedule, so the result will be
+that the node shows status "No price data". When new price data is received, a schedule is calculated without considering any history.
+
+The nodes config is not deleted, as the node depends on it to work.
+
+::: warning
+This operation cannot be undone.
+
+However, it is normally not a big loss, as you can just feed the node with new price data and start from scratch.
+:::
 
 ## Input
 
-The input is the [common strategy input format](./strategy-input.md)
+The input is the [common strategy input format](./strategy-input.md).
+
+In addition to the prices sent as input,
+the node is using the schedule for the day before it receives data for,
+so that it can calculate the schedule in the beginning of the day according to the configured rules. This requires of course that the node was run the day before.
 
 ## Output
 
@@ -125,6 +166,12 @@ Example of output:
 
 The `schedule` array shows every time the switch is turned on or off. The `hours` array shows values per hour containing the price (received as input), whether that hour is on or off, the start time of the hour and the amount per kWh that is saved on hours that are turned off, compared to the next hour that is on.
 
+### Data saved in context
+
+The node saves some data in the nodes context, so that it can be used on restarts and also taken into consideration when calculating the schedule over midnight.
+
+You can see the saved data if you select the node in Node-RED, and view "Context data", and refresh the Node context.
+
 ## Algorithm
 
 The calculation that decides what hours to turn off works as follows:
@@ -139,6 +186,28 @@ The calculation that decides what hours to turn off works as follows:
 
 I say "in most cases", because there is a chance that a group of two or more sequences combined can give a better plan than a single sequence preceeding those two, but where the selection of the one sequence causes the group to be discarded. If anyone encounters this situation, I would be happy to receive the price data set, and try to improve the algorithm even further.
 
+## Data used for calculation
+
+Normally data is received for one or two whole days, and all this data is used to do the calculation. In addition, if the node has run before, so there is historical data, the last period on or off before the period data is received for, is considered in the calculation, so that the rules in the configuration are followed also between days.
+
+## Restarts
+
+The node saves data in the nodes context, so if Node-RED is configured to save context between restarts, the node will replan with the last received data when it restarts.
+
+::: warning
+In Home Assistant, Node-RED is by default configured to save context between restarts. However, if you run Node-RED another way, this may not be the case by default. If context is only stored in memory, it is lost between restarts, and even between re-deployments. This can be changed in the `settings.js` file for Node-RED like this:
+
+```js
+contextStorage: {
+   default: {
+       module: "localfilesystem"
+   }
+}
+```
+
+Please read the [Node-RED documentation](https://nodered.org/docs/user-guide/context) for more details about this.
+:::
+
 ## Integration with MagicMirror
 
 Are you using [MagicMirror](https://magicmirror.builders/)? Are you also using [Tibber](https://tibber.com/)? If so, there is a module for MM called [MMM-Tibber](https://github.com/ottopaulsen/MMM-Tibber), that easily can be used to show savings from this node.

package/docs/nodes/ps-strategy-lowest-price.md

@@ -74,6 +74,49 @@ When a config is sent like this, and without price data, the schedule will be re
 
 However, you can send config and price data in the same message. Then both will be used .
 
+### Dynamic commands
+
+You can dynamically send some commands to the node via its input, by using a `commands` object in the payload as described below.
+
+Commands can be sent together with config and/or price data, but the exact behavior is not defined.
+
+#### sendSchedule
+
+You can get the schedule sent to output 3 any time by sending a message like this to the node:
+
+```json
+"payload": {
+  "commands": {
+    "sendSchedule": true,
+  }
+}
+```
+
+When you do this, the current schedule is actually recalculated based on the last received data, and then sent to output 3 the same way as when it was originally planned.
+
+#### reset
+
+You can reset data the node has saved in context by sending this message:
+
+```json
+"payload": {
+  "commands": {
+    "reset": true,
+  }
+}
+```
+
+When you do this, all historical data the node has saved is deleted, including the current schedule, so the result will be
+that the node shows status "No price data". When new price data is received, a schedule is calculated without considering any history.
+
+The nodes config is not deleted, as the node depends on it to work.
+
+::: warning
+This operation cannot be undone.
+
+However, it is normally not a big loss, as you can just feed the node with new price data and start from scratch.
+:::
+
 ## Input
 
 The input is the [common strategy input format](./strategy-input.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-power-saver",
-  "version": "3.2.3",
+  "version": "3.3.0",
   "description": "A module for Node-RED that you can use to turn on and off a switch based on power prices",
   "main": "index.js",
   "scripts": {

package/src/handle-input.js

@@ -8,8 +8,17 @@ function handleStrategyInput(node, msg, doPlanning) {
   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();
@@ -32,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;
@@ -39,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,
     },
@@ -49,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;
@@ -69,13 +81,18 @@ 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) {
@@ -106,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) {
@@ -136,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
   }
 }