node-red-contrib-power-saver 3.0.6 → 3.0.10

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

@@ -12,7 +12,7 @@ The picture at the bottom of the page, under [Integration with MagicMirror](#int
 
 ## Configuration
 
-![Best Save Config](/best-save-config.png)
+![Best Save Config](../images/best-save-config.png)
 
 | Value                  | Description                                                                                                                                                          |
 | ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -27,6 +27,10 @@ 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:

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

@@ -10,11 +10,11 @@ Strategy node to turn on power the hours when the price is lowest during a given
 
 ## Description
 
-The node can work on a specific period from 1 to 24 hours during a 24 hour period. Inside this period, you can decide how many hours that shall be on. The rest of the period will be off. Outside the peiod, you can select that the output shall be either on or off. You can also decide that the hours on shall be consequtive (one continuous period) or spread around in multiple on-periods.
+The node can work on a specific period from 1 to 24 hours during a 24 hour period. Inside this period, you can decide how many hours that shall be on. The rest of the period will be off. Outside the period, you can select that the output shall be either on or off. You can also decide that the hours on shall be consecutive (one continuous period) or spread around in multiple on-periods.
 
 ## Configuration
 
-![Node Configuration](/lowest-price-config.png)
+![Node Configuration](../images/lowest-price-config.png)
 
 | Value                  | Description                                                                      |
 | ---------------------- | -------------------------------------------------------------------------------- |
@@ -26,7 +26,7 @@ The node can work on a specific period from 1 to 24 hours during a 24 hour perio
 | If No Schedule, Send   | What to do if there is no valid schedule any more (turn on or off).              |
 | Outside Period, Send   | Select the value to send outside the selected period.                            |
 
-If you want to use a period of 24 hours, set the From Time and To Time to the same value. The time you select is signficant in the way that it decides which 24 hours that are considered when finding the hours with lowest price.
+If you want to use a period of 24 hours, set the From Time and To Time to the same value. The time you select is significant in the way that it decides which 24 hours that are considered when finding the hours with lowest price.
 
 ::: tip Example with Consecutive On-Period
 One example to need a consecutive on-period can be if you want to control the washing machine. Let's say it needs 3 hours, and you want it to run between 22:00 and 06:00. Set `From Time = 22:00`, `To Time = 06:00` and check the `Consecutive On-Period` flag. This will turn on the cheapest 3-hour period from 22:00 to 06:00.

package/docs/nodes/strategy-input.md

@@ -1,6 +1,6 @@
 # Strategy input format
 
-The common input for strategy nodes is a payload with a `priceData` array containing an object for each hour. Each object has a `value` wich is the price, and a `start` wich is the start time for the hour.
+The common input for strategy nodes is a payload with a `priceData` array containing an object for each hour. Each object has a `value` which is the price, and a `start` which is the start time for the hour.
 
 Example:
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-power-saver",
-  "version": "3.0.6",
+  "version": "3.0.10",
   "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/elvia/elvia-add-tariff.js

@@ -6,25 +6,26 @@ module.exports = function (RED) {
   function PsElviaAddTariffNode(config) {
     RED.nodes.createNode(this, config);
     this.elviaConfig = RED.nodes.getNode(config.elviaConfig);
+    const key = this.elviaConfig.credentials.elviaSubscriptionKey;
     this.tariffKey = config.tariffKey;
     this.range = config.range;
     const node = this;
-
-    const configList = node.context().global.get("elviaConfigList") || [];
-    const key = configList.find((c) => c.id == node.elviaConfig.id)?.elviaSubscriptionKey;
     ping(node, key);
 
     node.on("input", function (msg) {
       const prices = msg.payload.priceData;
+      if (!prices) {
+        node.warn(
+          "No price data received on input. Did you use the ps-receive-price node or convert to correct format otherwise?"
+        );
+        return;
+      }
       const fromTime = prices[0].start.substr(0, 19);
       const toTime = DateTime.fromISO(prices[prices.length - 1].start)
         .plus({ hours: 1 })
         .toISO()
         .substr(0, 19);
 
-      const configList = node.context().global.get("elviaConfigList") || [];
-      const key = configList.find((c) => c.id == node.elviaConfig.id)?.elviaSubscriptionKey;
-
       getTariffForPeriod(node, key, node.tariffKey, fromTime, toTime).then((json) => {
         const tariff = json;
         const priceInfo = tariff.gridTariff.tariffPrice.priceInfo;

package/src/handle-input.js

@@ -1,5 +1,4 @@
-const { getEffectiveConfig } = require("./utils");
-const { extractPlanForDate } = require("./utils");
+const { extractPlanForDate, getEffectiveConfig, validationFailure } = require("./utils");
 const { DateTime } = require("luxon");
 
 function handleStrategyInput(node, msg, doPlanning) {
@@ -152,11 +151,6 @@ function validateInput(node, msg) {
   return true;
 }
 
-function validationFailure(node, message, status = null) {
-  node.status({ fill: "red", shape: "ring", text: status ?? message });
-  node.warn(message);
-}
-
 module.exports = {
   handleStrategyInput,
 };

package/src/power-saver.js

@@ -8,6 +8,7 @@ const {
   getStartAtIndex,
   loadDayData,
   makeSchedule,
+  validationFailure,
 } = require("./utils");
 const { convertMsg } = require("./receive-price-functions");
 const { calculate } = require("./strategy-best-save-functions");
@@ -189,11 +190,6 @@ function makePlan(node, values, startTimes, onOffBefore, firstValueNextDay) {
   };
 }
 
-function validationFailure(node, message) {
-  node.status({ fill: "red", shape: "ring", text: message });
-  node.warn(message);
-}
-
 function validateMsg(node, msg) {
   if (!msg.payload && !msg.data?.new_state?.attributes) {
     validationFailure(node, "Payload missing");

package/src/receive-price-functions.js

@@ -6,9 +6,6 @@ function getPriceData(node, msg) {
     return node.context().get("lastPriceData");
   }
 
-  if (!validateMsg(node, msg)) {
-    return null;
-  }
   const input = convertMsg(msg);
   if (!validateInput(node, input)) {
     return null;
@@ -20,19 +17,6 @@ function getPriceData(node, msg) {
   return { priceData, source };
 }
 
-function validateMsg(node, msg) {
-  if (!msg.payload && !msg.data?.new_state?.attributes) {
-    validationFailure(node, "Payload missing");
-    return false;
-  }
-  const payload = msg.data?.new_state?.attributes ?? msg.data?.attributes ?? msg.payload;
-  if (typeof payload !== "object") {
-    validationFailure(node, "Payload must be an object");
-    return false;
-  }
-  return true;
-}
-
 function validateInput(node, input) {
   ["today", "tomorrow"].forEach((arr) => {
     if (
@@ -80,7 +64,15 @@ function convertMsg(msg) {
           value: v.value,
           start: v.start,
         }));
-    } else if (msg.payload?.attributes && msg.payload?.attributes["raw_" + day]) {
+    } else if (msg.data?.attributes && msg.data?.attributes["raw_" + day]) {
+      result.source = "Nordpool";
+      result[day] = msg.data.attributes["raw_" + day]
+        .filter((v) => v.value)
+        .map((v) => ({
+          value: v.value,
+          start: v.start,
+        }));
+    } else if (msg.payload?.attributes && msg.payload.attributes["raw_" + day]) {
       result.source = "Nordpool";
       result[day] = msg.payload.attributes["raw_" + day]
         .filter((v) => v.value)

package/src/strategy-lowest-price.js

@@ -48,7 +48,7 @@ function doPlanning(node, _, priceData, _, dateDayBefore, _) {
     if (hour === to && to === from && currentStatus === "Inside") {
       endIndexes.push(i - 1);
     }
-    if (hour === to && to !== from && i > 0) {
+    if (hour === to && to !== from && i > 0 && currentStatus !== "StartMissing") {
       currentStatus = "Outside";
       endIndexes.push(i - 1);
     }
@@ -66,6 +66,7 @@ function doPlanning(node, _, priceData, _, dateDayBefore, _) {
       hour = DateTime.fromISO(priceData[i].start).hour;
       i--;
     } while (periodStatus[i] === "Inside" && hour !== from);
+    startIndexes.splice(startIndexes.length - 1, 1);
   }
   if (hour === (to === 0 ? 23 : to - 1)) {
     endIndexes.push(priceData.length - 1);

package/src/utils.js

@@ -175,6 +175,11 @@ function getStartAtIndex(effectiveConfig, priceData, time) {
   }
 }
 
+function validationFailure(node, message, status = null) {
+  node.status({ fill: "red", shape: "ring", text: status ?? message });
+  node.warn(message);
+}
+
 module.exports = {
   booleanConfig,
   countAtEnd,
@@ -191,4 +196,5 @@ module.exports = {
   makeSchedule,
   roundPrice,
   sortedIndex,
+  validationFailure,
 };

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

@@ -0,0 +1,197 @@
+{
+  "priceData": [
+    {
+      "value": 1.588,
+      "start": "2021-12-15T00:00:00+01:00"
+    },
+    {
+      "value": 1.521,
+      "start": "2021-12-15T01:00:00+01:00"
+    },
+    {
+      "value": 1.492,
+      "start": "2021-12-15T02:00:00+01:00"
+    },
+    {
+      "value": 1.487,
+      "start": "2021-12-15T03:00:00+01:00"
+    },
+    {
+      "value": 1.497,
+      "start": "2021-12-15T04:00:00+01:00"
+    },
+    {
+      "value": 1.514,
+      "start": "2021-12-15T05:00:00+01:00"
+    },
+    {
+      "value": 1.583,
+      "start": "2021-12-15T06:00:00+01:00"
+    },
+    {
+      "value": 1.667,
+      "start": "2021-12-15T07:00:00+01:00"
+    },
+    {
+      "value": 1.729,
+      "start": "2021-12-15T08:00:00+01:00"
+    },
+    {
+      "value": 1.724,
+      "start": "2021-12-15T09:00:00+01:00"
+    },
+    {
+      "value": 1.707,
+      "start": "2021-12-15T10:00:00+01:00"
+    },
+    {
+      "value": 1.703,
+      "start": "2021-12-15T11:00:00+01:00"
+    },
+    {
+      "value": 1.692,
+      "start": "2021-12-15T12:00:00+01:00"
+    },
+    {
+      "value": 1.692,
+      "start": "2021-12-15T13:00:00+01:00"
+    },
+    {
+      "value": 1.692,
+      "start": "2021-12-15T14:00:00+01:00"
+    },
+    {
+      "value": 1.717,
+      "start": "2021-12-15T15:00:00+01:00"
+    },
+    {
+      "value": 1.72,
+      "start": "2021-12-15T16:00:00+01:00"
+    },
+    {
+      "value": 1.718,
+      "start": "2021-12-15T17:00:00+01:00"
+    },
+    {
+      "value": 1.679,
+      "start": "2021-12-15T18:00:00+01:00"
+    },
+    {
+      "value": 1.661,
+      "start": "2021-12-15T19:00:00+01:00"
+    },
+    {
+      "value": 1.629,
+      "start": "2021-12-15T20:00:00+01:00"
+    },
+    {
+      "value": 1.652,
+      "start": "2021-12-15T21:00:00+01:00"
+    },
+    {
+      "value": 1.612,
+      "start": "2021-12-15T22:00:00+01:00"
+    },
+    {
+      "value": 1.587,
+      "start": "2021-12-15T23:00:00+01:00"
+    },
+    {
+      "value": 1.682,
+      "start": "2021-12-16T00:00:00+01:00"
+    },
+    {
+      "value": 1.676,
+      "start": "2021-12-16T01:00:00+01:00"
+    },
+    {
+      "value": 1.669,
+      "start": "2021-12-16T02:00:00+01:00"
+    },
+    {
+      "value": 1.673,
+      "start": "2021-12-16T03:00:00+01:00"
+    },
+    {
+      "value": 1.692,
+      "start": "2021-12-16T04:00:00+01:00"
+    },
+    {
+      "value": 1.768,
+      "start": "2021-12-16T05:00:00+01:00"
+    },
+    {
+      "value": 1.888,
+      "start": "2021-12-16T06:00:00+01:00"
+    },
+    {
+      "value": 1.971,
+      "start": "2021-12-16T07:00:00+01:00"
+    },
+    {
+      "value": 2.098,
+      "start": "2021-12-16T08:00:00+01:00"
+    },
+    {
+      "value": 2.076,
+      "start": "2021-12-16T09:00:00+01:00"
+    },
+    {
+      "value": 2.073,
+      "start": "2021-12-16T10:00:00+01:00"
+    },
+    {
+      "value": 2.039,
+      "start": "2021-12-16T11:00:00+01:00"
+    },
+    {
+      "value": 2.003,
+      "start": "2021-12-16T12:00:00+01:00"
+    },
+    {
+      "value": 1.968,
+      "start": "2021-12-16T13:00:00+01:00"
+    },
+    {
+      "value": 1.971,
+      "start": "2021-12-16T14:00:00+01:00"
+    },
+    {
+      "value": 2.029,
+      "start": "2021-12-16T15:00:00+01:00"
+    },
+    {
+      "value": 2.138,
+      "start": "2021-12-16T16:00:00+01:00"
+    },
+    {
+      "value": 2.258,
+      "start": "2021-12-16T17:00:00+01:00"
+    },
+    {
+      "value": 2.248,
+      "start": "2021-12-16T18:00:00+01:00"
+    },
+    {
+      "value": 2.076,
+      "start": "2021-12-16T19:00:00+01:00"
+    },
+    {
+      "value": 2.009,
+      "start": "2021-12-16T20:00:00+01:00"
+    },
+    {
+      "value": 2.051,
+      "start": "2021-12-16T21:00:00+01:00"
+    },
+    {
+      "value": 1.926,
+      "start": "2021-12-16T22:00:00+01:00"
+    },
+    {
+      "value": 1.863,
+      "start": "2021-12-16T23:00:00+01:00"
+    }
+  ],
+  "source": "Nordpool"
+}