node-red-contrib-power-saver 3.0.5 → 3.0.9

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

@@ -10,157 +10,177 @@ In this example, data is read from the Nord Pool sensor in HA via the `current s
 
 ```json:no-line-numbers
 [
-  {
-    "id": "e2578f6a.210a8",
-    "type": "debug",
-    "z": "d938c47f.3398f8",
-    "name": "Nord Pool result",
-    "active": true,
-    "tosidebar": true,
-    "console": false,
-    "tostatus": false,
-    "complete": "true",
-    "targetType": "full",
-    "statusVal": "",
-    "statusType": "auto",
-    "x": 820,
-    "y": 440,
-    "wires": []
-  },
-  {
-    "id": "48bcdcca.fe42a4",
-    "type": "api-current-state",
-    "z": "d938c47f.3398f8",
-    "name": "Read Nord Pool",
-    "server": "ec4a12a1.b2be9",
-    "version": 2,
-    "outputs": 1,
-    "halt_if": "",
-    "halt_if_type": "str",
-    "halt_if_compare": "is",
-    "entity_id": "sensor.nordpool_kwh_trheim_nok_3_095_025",
-    "state_type": "str",
-    "blockInputOverrides": false,
-    "outputProperties": [
-      {
-        "property": "payload",
-        "propertyType": "msg",
-        "value": "",
-        "valueType": "entityState"
-      },
-      {
-        "property": "payload",
-        "propertyType": "msg",
-        "value": "",
-        "valueType": "entity"
-      }
-    ],
-    "x": 280,
-    "y": 380,
-    "wires": [["428d7c7ca88db95f"]]
-  },
-  {
-    "id": "97cc8e58.4247a",
-    "type": "inject",
-    "z": "d938c47f.3398f8",
-    "name": "",
-    "props": [
-      {
-        "p": "payload"
-      },
-      {
-        "p": "topic",
-        "vt": "str"
-      }
-    ],
-    "repeat": "3600",
-    "crontab": "",
-    "once": true,
-    "onceDelay": 0.1,
-    "topic": "",
-    "payloadType": "date",
-    "x": 110,
-    "y": 380,
-    "wires": [["48bcdcca.fe42a4"]]
-  },
-  {
-    "id": "a6f2769b.1a62a8",
-    "type": "api-call-service",
-    "z": "d938c47f.3398f8",
-    "name": "Turn on VVB",
-    "server": "ec4a12a1.b2be9",
-    "version": 3,
-    "debugenabled": false,
-    "service_domain": "switch",
-    "service": "turn_on",
-    "entityId": "switch.varmtvannsbereder_switch",
-    "data": "",
-    "dataType": "jsonata",
-    "mergecontext": "",
-    "mustacheAltTags": false,
-    "outputProperties": [],
-    "queue": "none",
-    "x": 810,
-    "y": 320,
-    "wires": [[]]
-  },
-  {
-    "id": "9fc75126.65dd3",
-    "type": "api-call-service",
-    "z": "d938c47f.3398f8",
-    "name": "Turn off VVB",
-    "server": "ec4a12a1.b2be9",
-    "version": 3,
-    "debugenabled": true,
-    "service_domain": "switch",
-    "service": "turn_off",
-    "entityId": "switch.varmtvannsbereder_switch",
-    "data": "",
-    "dataType": "json",
-    "mergecontext": "",
-    "mustacheAltTags": false,
-    "outputProperties": [],
-    "queue": "none",
-    "x": 810,
-    "y": 360,
-    "wires": [[]]
-  },
-  {
-    "id": "428d7c7ca88db95f",
-    "type": "ps-receive-price",
-    "z": "d938c47f.3398f8",
-    "name": "Price Receiver",
-    "x": 460,
-    "y": 380,
-    "wires": [["4147bf0b99fe626f"]]
-  },
-  {
-    "id": "4147bf0b99fe626f",
-    "type": "ps-strategy-best-save",
-    "z": "d938c47f.3398f8",
-    "name": "Best Save",
-    "maxHoursToSaveInSequence": "4",
-    "minHoursOnAfterMaxSequenceSaved": "1",
-    "minSaving": "0.03",
-    "sendCurrentValueWhenRescheduling": true,
-    "outputIfNoSchedule": "true",
-    "scheduleOnlyFromCurrentTime": "false",
-    "x": 630,
-    "y": 380,
-    "wires": [["a6f2769b.1a62a8"], ["9fc75126.65dd3"], ["e2578f6a.210a8"]]
-  },
-  {
-    "id": "ec4a12a1.b2be9",
-    "type": "server",
-    "name": "Home Assistant",
-    "version": 2,
-    "addon": true,
-    "rejectUnauthorizedCerts": true,
-    "ha_boolean": "y|yes|true|on|home|open",
-    "connectionDelay": true,
-    "cacheJson": true,
-    "heartbeat": false,
-    "heartbeatInterval": 30
-  }
+    {
+        "id": "e2578f6a.210a8",
+        "type": "debug",
+        "z": "d938c47f.3398f8",
+        "name": "Nord Pool result",
+        "active": false,
+        "tosidebar": true,
+        "console": false,
+        "tostatus": false,
+        "complete": "true",
+        "targetType": "full",
+        "statusVal": "",
+        "statusType": "auto",
+        "x": 820,
+        "y": 440,
+        "wires": []
+    },
+    {
+        "id": "48bcdcca.fe42a4",
+        "type": "api-current-state",
+        "z": "d938c47f.3398f8",
+        "name": "Read Nord Pool",
+        "server": "ec4a12a1.b2be9",
+        "version": 2,
+        "outputs": 1,
+        "halt_if": "",
+        "halt_if_type": "str",
+        "halt_if_compare": "is",
+        "entity_id": "sensor.nordpool_kwh_trheim_nok_3_095_025",
+        "state_type": "str",
+        "blockInputOverrides": false,
+        "outputProperties": [
+            {
+                "property": "payload",
+                "propertyType": "msg",
+                "value": "",
+                "valueType": "entity"
+            }
+        ],
+        "x": 280,
+        "y": 380,
+        "wires": [
+            [
+                "428d7c7ca88db95f"
+            ]
+        ]
+    },
+    {
+        "id": "97cc8e58.4247a",
+        "type": "inject",
+        "z": "d938c47f.3398f8",
+        "name": "",
+        "props": [
+            {
+                "p": "payload"
+            },
+            {
+                "p": "topic",
+                "vt": "str"
+            }
+        ],
+        "repeat": "3600",
+        "crontab": "",
+        "once": true,
+        "onceDelay": 0.1,
+        "topic": "",
+        "payloadType": "date",
+        "x": 110,
+        "y": 380,
+        "wires": [
+            [
+                "48bcdcca.fe42a4"
+            ]
+        ]
+    },
+    {
+        "id": "a6f2769b.1a62a8",
+        "type": "api-call-service",
+        "z": "d938c47f.3398f8",
+        "name": "Turn on VVB",
+        "server": "ec4a12a1.b2be9",
+        "version": 3,
+        "debugenabled": false,
+        "service_domain": "switch",
+        "service": "turn_on",
+        "entityId": "switch.varmtvannsbereder_switch",
+        "data": "",
+        "dataType": "jsonata",
+        "mergecontext": "",
+        "mustacheAltTags": false,
+        "outputProperties": [],
+        "queue": "none",
+        "x": 810,
+        "y": 340,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "9fc75126.65dd3",
+        "type": "api-call-service",
+        "z": "d938c47f.3398f8",
+        "name": "Turn off VVB",
+        "server": "ec4a12a1.b2be9",
+        "version": 3,
+        "debugenabled": true,
+        "service_domain": "switch",
+        "service": "turn_off",
+        "entityId": "switch.varmtvannsbereder_switch",
+        "data": "",
+        "dataType": "json",
+        "mergecontext": "",
+        "mustacheAltTags": false,
+        "outputProperties": [],
+        "queue": "none",
+        "x": 810,
+        "y": 380,
+        "wires": [
+            []
+        ]
+    },
+    {
+        "id": "428d7c7ca88db95f",
+        "type": "ps-receive-price",
+        "z": "d938c47f.3398f8",
+        "name": "Price Receiver",
+        "x": 460,
+        "y": 380,
+        "wires": [
+            [
+                "4147bf0b99fe626f"
+            ]
+        ]
+    },
+    {
+        "id": "4147bf0b99fe626f",
+        "type": "ps-strategy-best-save",
+        "z": "d938c47f.3398f8",
+        "name": "Best Save",
+        "maxHoursToSaveInSequence": "4",
+        "minHoursOnAfterMaxSequenceSaved": "1",
+        "minSaving": "0.03",
+        "sendCurrentValueWhenRescheduling": true,
+        "outputIfNoSchedule": "true",
+        "scheduleOnlyFromCurrentTime": "false",
+        "x": 630,
+        "y": 380,
+        "wires": [
+            [
+                "a6f2769b.1a62a8"
+            ],
+            [
+                "9fc75126.65dd3"
+            ],
+            [
+                "e2578f6a.210a8"
+            ]
+        ]
+    },
+    {
+        "id": "ec4a12a1.b2be9",
+        "type": "server",
+        "name": "Home Assistant",
+        "version": 2,
+        "addon": true,
+        "rejectUnauthorizedCerts": true,
+        "ha_boolean": "y|yes|true|on|home|open",
+        "connectionDelay": true,
+        "cacheJson": true,
+        "heartbeat": false,
+        "heartbeatInterval": 30
+    }
 ]
 ```

package/docs/nodes/ps-receive-price.md

@@ -125,6 +125,10 @@ This is especially designed to work for Home Assistant (HA), and the [Nord Pool
 
 Data can be sent from both the `current state` node or the `events: state` node.
 
+::: tip Output properties
+When using the `current state` node, configure the output properties to set `msg.payload` to `entity`.
+:::
+
 [See example with Nord Pool and `current state` node](doc/example-nordpool-current-state.md)
 
 [See example with Nord Pool and `events: state` node](doc/example-nordpool-events-state.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-power-saver",
-  "version": "3.0.5",
+  "version": "3.0.9",
   "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": {
@@ -28,8 +28,7 @@
       "ps-elvia-config": "src/elvia/elvia-config.js",
       "ps-elvia-tariff-types": "src/elvia/elvia-tariff-types.js",
       "ps-elvia-tariff": "src/elvia/elvia-tariff.js",
-      "ps-elvia-add-tariff": "src/elvia/elvia-add-tariff.js",
-      "ps-general-add-tariff": "src/general-add-tariff.js"
+      "ps-elvia-add-tariff": "src/elvia/elvia-add-tariff.js"
     }
   },
   "prettier": {

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,
 };