node-red-contrib-power-saver 5.0.0-beta.0 → 5.0.0-beta.2

package/.github/FUNDING.yml

@@ -1,7 +1,7 @@
 # These are supported funding model platforms
 
 github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: ottopaulsen
+patreon: # ottopaulsen
 open_collective: # Replace with a single Open Collective username
 ko_fi: # Replace with a single Ko-fi username
 tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel

package/README.md

@@ -5,3 +5,6 @@ A Node-RED node to save money when power prices are changing by the hour.
 ![Logo](docs/.vuepress/public/logo.png)
 
 ## Please read more in the [documentation](https://powersaver.no/).
+
+
+[![Donation](./donation.png)](https://powersaver.no/contribute/#donate)

package/docs/.vuepress/config.js

@@ -83,6 +83,7 @@ export default defineUserConfig({
             "/examples/example-visualize-on-off/example-visualize-on-off.md",
             "/examples/example-grid-tariff-capacity-part.md",
             "/examples/example-stromstotte.md",
+            "/examples/example-reduce-minutes-array.md",
           ],
         },
       ],

package/docs/changelog/README.md

@@ -7,7 +7,18 @@ sidebarDepth: 1
 
 List the most significant changes.
 
-## 5.0.0
+## 5.0.0.beta.2
+
+ - Fix bug in Min minutes off
+
+## 5.0.0 beta.1
+
+ - Fix bug `dataDayBefore.minutes is not iterable`
+ - Update example for Lovelace Visualization. That example also has a function node that reduces the number of entries in the minutes array, that can be useful other places too.
+
+Please note that if you have nodes using the hours array on output 3, you need to change those to use the minutes array.
+
+## 5.0.0 beta.0
 
 ::: danger BREAKING CHANGE
 This is a breaking change.

package/docs/examples/README.md

@@ -17,6 +17,8 @@
 
 [Strømstøtte (governmentall support)](./example-stromstotte)
 
+[Reduce minutes-array](./example-reduce-minutes-array)
+
 ## User provided examples
 
 [Output schedule to a sensor entity](./example-next-schedule-entity.md) (by Stefan)

package/docs/examples/example-reduce-minutes-array.md

@@ -0,0 +1,23 @@
+# Reduce minutes array
+
+If you want to reduce number of entries in the minutes array on output 3, you can send it through a function node with the following code:
+```
+const minutes = []
+let previousHour = ""
+let previousSaving = null
+let previousPrice = null
+msg.payload.minutes.forEach(m => {
+  const hour = m.start.substring(0, 13)
+  if (hour !== previousHour || m.saving !== previousSaving || m.price !== previousPrice) {
+    minutes.push(m)
+    previousHour = hour
+    previousSaving = m.saving
+    previousPrice = m.price
+  }
+})
+
+msg.payload.minutes = minutes
+
+return msg;
+```
+It will remove all entries that are equal to the one before, but still send at least one per hour.

package/docs/examples/example-visualize-on-off/example-visualize-on-off.md

@@ -2,7 +2,7 @@
 
 The source of this example is made by Kim Storøy, and Otto Paulsen has written the documentation and made some changes to the files.
 
-![Lovelace image](./lovelace.jpg)
+![Lovelace image](./lovelace.png)
 
 ## Introduction
 

package/docs/examples/example-visualize-on-off/lovelace.yaml

@@ -30,7 +30,7 @@ apex_config:
   yaxis:
     - id: price
       show: true
-      decimalsInFloat: 1
+      decimalsInFloat: 2
       floating: false
       forceNiceScale: true
       extend_to: end
@@ -52,15 +52,15 @@ series:
     extend_to: now
     name: Pris
     type: area
-    curve: smooth
+    curve: stepline
     color: tomato
     show:
       legend_value: false
     data_generator: |
-      return entity.attributes.hours.map((entry) => {
+      return entity.attributes.minutes.map((entry) => {
         return [new Date(entry.start), entry.price];
       });
-  - entity: sensor.accumulated_consumption_current_hour_xxxx
+  - entity: sensor.accumulated_consumption_current_hour_xxx
     yaxis_id: usage
     type: column
     name: Forbruk
@@ -68,13 +68,14 @@ series:
       func: max
     show:
       legend_value: false
+    curve: smooth
   - entity: sensor.powersaver
     data_generator: |
-      return entity.attributes.hours.map((entry) => {
+      return entity.attributes.minutes.map((entry) => {
         return [new Date(entry.start), entry.onOff];
       });
     yaxis_id: powersaver
-    name: ' '
+    name: " "
     type: area
     color: rgb(0, 255, 0)
     opacity: 0.2

package/docs/examples/example-visualize-on-off/nodes.json

@@ -1,88 +1,74 @@
 [
   {
-    "id": "eab799518168f5a3",
-    "type": "ha-entity",
+    "id": "a6c0472f7981fad2",
+    "type": "function",
     "z": "d938c47f.3398f8",
-    "name": "Info fra PS til HA",
-    "server": "ec4a12a1.b2be9",
-    "version": 2,
-    "debugenabled": false,
+    "name": "Reduce minutes count",
+    "func": "const minutes = []\nlet previousHour = \"\"\nlet previousSaving = null\nmsg.payload.minutes.forEach(m => {\n  const hour = m.start.substring(0, 13)\n  if (hour !== previousHour || m.saving !== previousSaving) {\n    minutes.push(m)\n    previousHour = hour\n    previousSaving = m.saving\n  }\n})\n\nmsg.payload.minutes = minutes\nmsg.payload.hours = minutes\n\nreturn msg;",
     "outputs": 1,
-    "entityType": "sensor",
-    "config": [
-      {
-        "property": "name",
-        "value": "Powersaver"
-      },
-      {
-        "property": "device_class",
-        "value": ""
-      },
-      {
-        "property": "icon",
-        "value": ""
-      },
-      {
-        "property": "unit_of_measurement",
-        "value": ""
-      },
-      {
-        "property": "state_class",
-        "value": ""
-      },
-      {
-        "property": "last_reset",
-        "value": ""
-      }
-    ],
-    "state": "payload",
-    "stateType": "str",
-    "attributes": [
-      {
-        "property": "Schedule",
-        "value": "payload.schedule",
-        "valueType": "msg"
-      },
-      {
-        "property": "Hours",
-        "value": "payload.hours",
-        "valueType": "msg"
-      },
-      {
-        "property": "Control",
-        "value": "payload.hours[0].onOff",
-        "valueType": "str"
-      },
-      {
-        "property": "Current",
-        "value": "payload.current",
-        "valueType": "str"
-      }
-    ],
-    "resend": true,
-    "outputLocation": "payload",
-    "outputLocationType": "none",
-    "inputOverride": "allow",
-    "outputOnStateChange": false,
-    "outputPayload": "",
-    "outputPayloadType": "str",
-    "x": 830,
-    "y": 630,
-    "wires": [[]]
+    "timeout": 0,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 640,
+    "y": 640,
+    "wires": [["cad33a63f66ef72e"]]
   },
   {
     "id": "cad33a63f66ef72e",
     "type": "function",
     "z": "d938c47f.3398f8",
     "name": "Convert true/false to 1/0",
-    "func": "msg.payload.hours.forEach(h => h.onOff = h.onOff ? \"1\" : \"0\")\nreturn msg;",
+    "func": "msg.payload.minutes.forEach(h => h.onOff = h.onOff ? \"1\" : \"0\")\nreturn msg;",
     "outputs": 1,
+    "timeout": "",
     "noerr": 0,
     "initialize": "",
     "finalize": "",
     "libs": [],
-    "x": 550,
-    "y": 630,
-    "wires": [["eab799518168f5a3", "37a23d88cfc668f2"]]
+    "x": 880,
+    "y": 640,
+    "wires": [["4e2452b33c54d90b"]]
+  },
+  {
+    "id": "4e2452b33c54d90b",
+    "type": "ha-sensor",
+    "z": "d938c47f.3398f8",
+    "name": "Info fra PS til HA",
+    "entityConfig": "eab799518168f5a3",
+    "version": 0,
+    "state": "payload",
+    "stateType": "str",
+    "attributes": [
+      { "property": "Schedule", "value": "payload.schedule", "valueType": "msg" },
+      { "property": "Hours", "value": "payload.hours", "valueType": "msg" },
+      { "property": "Control", "value": "payload.minutes[0].onOff", "valueType": "str" },
+      { "property": "Current", "value": "payload.current", "valueType": "str" },
+      { "property": "Minutes", "value": "payload.minutes", "valueType": "msg" }
+    ],
+    "inputOverride": "allow",
+    "outputProperties": [],
+    "x": 1100,
+    "y": 640,
+    "wires": [[]]
+  },
+  {
+    "id": "eab799518168f5a3",
+    "type": "ha-entity-config",
+    "server": "ec4a12a1.b2be9",
+    "deviceConfig": "",
+    "name": "sensor config for Info fra PS til HA",
+    "version": 6,
+    "entityType": "sensor",
+    "haConfig": [
+      { "property": "name", "value": "Powersaver" },
+      { "property": "device_class", "value": "" },
+      { "property": "icon", "value": "" },
+      { "property": "unit_of_measurement", "value": "" },
+      { "property": "state_class", "value": "" },
+      { "property": "last_reset", "value": "" }
+    ],
+    "resend": true
   }
 ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-power-saver",
-  "version": "5.0.0-beta.0",
+  "version": "5.0.0-beta.2",
   "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/strategy-best-save-functions.js

@@ -8,7 +8,9 @@ const { fillArray } = require("./utils");
  *
  * @param {*} onOff Array of on/off values
  * @param {*} maxMinutesOff Max number of minutes that can be off in a sequence
- * @param {*} minMinutesOff Min number of minutes that must be on after maxOff is reached
+ * @param {*} minMinutesOff Min number of minutes that must be off to bother
+ * @param {*} recoveryPercentage Percent of off-time that must be on after being off
+ * @param {*} recoveryMaxMinutes Maximum recovery time in minutes
  * @returns
  */
 function isOnOffSequencesOk(
@@ -16,37 +18,53 @@ function isOnOffSequencesOk(
   maxMinutesOff,
   minMinutesOff,
   recoveryPercentage,
-  recoveryMaxMinutes = null,
-  minSaving) {
+  recoveryMaxMinutes = null) {
   let offCount = 0;
   let onCount = 0;
   let reachedMaxOff = false;
-  let reachedMinOn = minMinutesOff === 0;
-  let minOnAfterOff = null;
+  let reachedMinOn = true;
+  let reachedMinOff = null;
+  let minOnAfterOff = 0;
   for (let i = 0; i < onOff.length; i++) {
     if (!onOff[i]) {
       if (maxMinutesOff === 0 || reachedMaxOff) {
         return false;
       }
+      if(!reachedMinOn) {
+        return false;
+      }
+      if(reachedMinOff === null) {
+        reachedMinOff = false;
+      }
       offCount++;
       onCount = 0;
       if (offCount >= maxMinutesOff) {
         reachedMaxOff = true;
       }
       if (offCount >= minMinutesOff) {
-        reachedMinOn = true;
+        reachedMinOff = true;
       }
       const minRounded = Math.max(Math.round(offCount * recoveryPercentage / 100), 1)
       minOnAfterOff = Math.min(minRounded, recoveryMaxMinutes ?? minRounded)
+      if(i === onOff.length - 1) {
+        // If last minute, consider min reached
+        reachedMinOn = true;
+        reachedMinOff = true;
+      }
     } else {
+      if(reachedMinOff === false) {
+        return false;
+      }
       onCount++;
       if (onCount >= minOnAfterOff) {
         reachedMaxOff = false;
+        reachedMinOn = true;
       }
       offCount = 0;
+      reachedMinOff = null;
     }
   }
-  return reachedMinOn;
+  return reachedMinOn && !(reachedMinOff === false);
 }
 
 /**

package/src/utils.js

@@ -105,6 +105,9 @@ function loadDayData(node, date) {
     schedule: [],
     minutes: [],
   };
+  if(!res.minutes) {
+    res.minutes = []
+  }
   return res;
 }
 

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

@@ -58,17 +58,7 @@
     {
       "time": "2021-06-20T02:33:00.000+02:00",
       "value": true,
-      "countMinutes": 3
-    },
-    {
-      "time": "2021-06-20T02:36:00.000+02:00",
-      "value": false,
-      "countMinutes": 1
-    },
-    {
-      "time": "2021-06-20T02:37:00.000+02:00",
-      "value": true,
-      "countMinutes": 1
+      "countMinutes": 5
     },
     {
       "time": "2021-06-20T02:38:00.000+02:00",

package/test/data/reconfigResult.js

@@ -58,17 +58,7 @@ module.exports = {
   {
     time: "2021-06-20T02:33:00.000+02:00",
     value: true,
-    countMinutes: 3,
-  },
-  {
-    time: "2021-06-20T02:36:00.000+02:00",
-    value: false,
-    countMinutes: 1,
-  },
-  {
-    time: "2021-06-20T02:37:00.000+02:00",
-    value: true,
-    countMinutes: 1,
+    countMinutes: 5,
   },
   {
     time: "2021-06-20T02:38:00.000+02:00",