node-red-contrib-power-saver 4.0.0 → 4.1.0

package/docs/.vuepress/components/AdsenseAdd.vue

@@ -0,0 +1,40 @@
+<template>
+  <div>
+    <ins
+      v-if="øverst"
+      class="adsbygoogle"
+      style="display: inline-block; width: 740px; height: 90px"
+      data-ad-client="ca-pub-9857859182772006"
+      data-ad-slot="7524453641"
+    ></ins>
+    <ins
+      v-if="type === 'nederst'"
+      class="adsbygoogle"
+      style="display: block"
+      data-ad-client="ca-pub-9857859182772006"
+      data-ad-slot="3584713798"
+      data-ad-format="auto"
+      data-full-width-responsive="true"
+    ></ins>
+    <ins
+      v-if="type === 'artikkel'"
+      class="adsbygoogle"
+      style="display: block; text-align: center"
+      data-ad-layout="in-article"
+      data-ad-format="fluid"
+      data-ad-client="ca-pub-9857859182772006"
+      data-ad-slot="3152349396"
+    ></ins>
+  </div>
+</template>
+
+<script setup>
+import { onMounted } from "vue";
+
+const props = defineProps({
+  type: { type: String, required: false, default: "artikkel" },
+});
+onMounted(() => {
+  (adsbygoogle = window.adsbygoogle || []).push({});
+});
+</script>

package/docs/README.md

@@ -32,6 +32,8 @@ footer: Created by Otto Paulsen and contributors
 footerHtml: true
 ---
 
+<AdsenseAdd type="artikkel"/>
+
 This is a collection of nodes for the popular [Node-RED](https://nodered.org/) that you can use to save money on variable electricity prices. Node-RED is a widely used low-code programming tool that can be used together with many smart home solutions to create automations.
 
 <DonateButtons/>

package/docs/changelog/README.md

@@ -7,6 +7,12 @@ sidebarDepth: 1
 
 List the most significant changes.
 
+## 4.1.0
+
+- Fix bug with override function. It did not override longer than until next scheduled change. Now it overrides until set to auto again.
+- Show override on node status.
+- Fix name filter on schedule merger node.
+
 ## 4.0.0
 
 This is a major rewrite of some of the central code, in order to lay ground for further development and maintenance.

package/docs/contribute/README.md

@@ -50,3 +50,7 @@ Main developer: [Otto Paulsen](https://github.com/ottopaulsen)
 Heat Capacitor developer: [Arne Klaveness](https://github.com/TomTorger)
 
 Example contributors: [Stefan](https://github.com/oakhill87/node-red-contrib-power-saver)
+
+###
+
+<AdsenseAdd type="nederst"/>

package/docs/examples/README.md

@@ -1,3 +1,5 @@
+<AdsenseAdd type="øverst"/>
+
 # Examples
 
 [Nord Pool and `current state` node in HA](./example-nordpool-current-state)
@@ -17,3 +19,7 @@
 ## User provided examples
 
 [Output schedule to a sensor entity](./example-next-schedule-entity.md) (by Stefan)
+
+###
+
+<AdsenseAdd type="nederst"/>

package/docs/faq/README.md

@@ -48,3 +48,7 @@ Another alternative is to reduce the minimum saving from 0.05 to 0.001. Then the
 ## Can we get Legionella bacteria when turning off the water heater?
 
 Be aware that the norwegian [FHI](https://www.fhi.no/nettpub/legionellaveilederen/) recommends that the temperature in the water heater is at least 70°C to avoid growth of legionella. At this temperature, legionalla bacteria die quickly.
+
+###
+
+<AdsenseAdd type="nederst"/>

package/docs/faq/best-save-viewer.md

@@ -15,6 +15,10 @@ Then paste it here and see the result below:
 
 <BestSaveVerificator/>
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ## Explanation
 
 ### Config
@@ -53,6 +57,10 @@ If the average per hour is less than what you have configured as `Minimum saving
 
 If the number is black, it could be used, but only if all other criteria are satisfied, and only if it saves more than any other combination.
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ## Something seems wrong
 
 The tool is not using the same code as the node, so in case there is a bug in the node (or in the tool) the numbers may not match.

package/docs/guide/README.md

@@ -31,6 +31,10 @@ Here prices are received from Tibber, converted in the `ps-receive-price` node,
 The node collection fits very well with Home Assistant (HA), as Node-RED is frequently used for automations, and there also is an integration with Nord Pool, but there is no direct dependency to HA, so all nodes can be used also without HA.
 :::
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ## Getting started
 
 ### Installation
@@ -129,6 +133,10 @@ Data can be sent from both the `current state` node or the `events: state` node.
 
 [See example with Nord Pool and `events: state` node](../examples/example-nordpool-events-state.md)
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ### Add grid tariff
 
 When also the grid tariff changes per hour, it must be added to the electricity price in order to get the calculations right.
@@ -192,6 +200,10 @@ There are many ways you can use the output:
 - Send a notification
   :::
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ### Display schedule
 
 **Output 3** can be used to print or display the calculated schedule. If you just want to see it, send it to a debug node. You can also use it to display the result as graphs in HA.
@@ -214,6 +226,10 @@ Se the [Schedule Merger](../nodes/ps-schedule-merger.md) node for more details.
 
 There are more details and more information in the documentation for each [node](/nodes/) and in the [examples](/examples/).
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ## Migration from v2
 
 The `Power Saver` node from v2 has been removed and must be replaced.

package/docs/nodes/README.md

@@ -1,7 +1,13 @@
+<AdsenseAdd type="øverst"/>
+
 # Nodes
 
 Here is an overview of the nodes, and links to detailed descriptions for eah of them.
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ## Strategy nodes
 
 These are the nodes used to calculate and control saving.
@@ -30,6 +36,10 @@ A strategy for moving consumption from expensive to cheap periods utilizing clim
 
 A strategy for setting a fixed daily or weekly schedule.
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ## Utility nodes
 
 ### [ps-receive-price](./ps-receive-price)
@@ -69,3 +79,7 @@ Use this to get a list of the tariff types available in the Elvia API.
 ### ps-elvia-tariff
 
 Use this to get the Elvia grid tariff for a selected tariff type.
+
+###
+
+<AdsenseAdd type="nederst"/>

package/docs/nodes/dynamic-commands.md

@@ -1,3 +1,7 @@
+###
+
+<AdsenseAdd type="øverst"/>
+
 # 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.
@@ -39,6 +43,10 @@ You can get the node to send the current output to output 1 or 2 any time by sen
 
 When you do this, the current schedule is actually recalculated based on the last received data. The current output is sent to output 1 or 2.
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ### reset
 
 You can reset data the node has saved in context by sending this message:
@@ -77,3 +85,7 @@ and make a plan based on those prices:
 
 If the context storage is `file` you can use this to create a new schedule after a restart,
 instead of fetching prices again.
+
+###
+
+<AdsenseAdd type="nederst"/>

package/docs/nodes/dynamic-config.md

@@ -31,6 +31,10 @@ to be able to override a specific strategy node.
 The `name` is the exact same value as you set as name in the nodes config.
 :::
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ## Output values
 
 Valid values for `outputValueForOntype` and `outputValueForOfftype` are `bool`, `num` and `str` and must correspond
@@ -74,3 +78,7 @@ The nodes config is saved in the nodes context.
 If dynamic config is sent as input, this replaces the saved config.
 It is the config that is saved in context that is used when calculating.
 When Node-RED starts or the flow is redeployed, the config defined in the node replaces the saved config and will be used when planning.
+
+###
+
+<AdsenseAdd type="nederst"/>

package/docs/nodes/old-power-saver-doc.md

@@ -229,3 +229,7 @@ See [CHANGELOG.md](CHANGELOG.md)
 ## Contribute
 
 Contributions are welcome. Please start by creating a Github Issue with suggested changes, and state what you would like to do.
+
+###
+
+<AdsenseAdd type="nederst"/>

package/docs/nodes/ps-elvia-add-tariff.md

@@ -12,6 +12,10 @@ Node to add grid tariff from Elvia.
 You need an Elvia API subscription key to use this node. See [configuration](#elvia-configuration).
 :::
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ## Description
 
 When grid tariff changes from hour to hour, this should normally also be considered when finding the most favorable hours to use power. This node retrieves prices from Elvia, so if you are an elvia customer, you can put this node between the `ps-receive-price` node and the strategy nodes. When configured, it will add Elvia tariff to the power prices before doing the calculation:
@@ -47,6 +51,10 @@ Now you should be able to select the right tariff:
 
 The next time you use this node, you can select the same config as you created the first time, and then you can also select tariff immediately.
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ## Input
 
 The input is the [common strategy input format](./strategy-input.md)
@@ -54,3 +62,7 @@ The input is the [common strategy input format](./strategy-input.md)
 ## Output
 
 The output is the [common strategy input format](./strategy-input.md)
+
+###
+
+<AdsenseAdd type="nederst"/>

package/docs/nodes/ps-general-add-tariff.md

@@ -9,6 +9,10 @@ next: ./ps-elvia-add-tariff.md
 
 Node to add a value, for example a variable grid tariff, to the price before it is used to calculate savings in the strategy nodes.
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ## Description
 
 This node is useful if there is an addition to the electricity price that varies over the day or the week, as it might be for the grid tariff.
@@ -64,6 +68,10 @@ Fill in the last date the config is valid.
 
 If this is empty, the config is valid until forever.
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ## Input
 
 The input is the [common strategy input format](./strategy-input.md)
@@ -73,3 +81,7 @@ The input is the [common strategy input format](./strategy-input.md)
 The output is the [common strategy input format](./strategy-input.md)
 
 If there is a config property in the input payload, it is passed on to the output payload.
+
+###
+
+<AdsenseAdd type="nederst"/>

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

@@ -27,6 +27,10 @@ That is why this is now a separate node.
 
 There is no configuration except from node name.
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ## Input
 
 ### Tibber input
@@ -120,6 +124,10 @@ Then use the id in the following query, replacing the id with the one you found
 
 This is the query you shall put in the `tibber-query` node.
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ### Nord Pool input
 
 This is especially designed to work for Home Assistant (HA), and the [Nord Pool custom component](https://github.com/custom-components/nordpool). The Nord Pool component provides a _sensor_ that gives price per hour for today and tomorrow (after 13:00). Send the output from this sensor directly to the `ps-receive-price` node. Make sure this is done whenever the node is updated, as well as when the system starts up.
@@ -156,3 +164,7 @@ If you cannot use any of the two above (Tibber or Nord Pool), create the input t
 ## Output
 
 The output is the [common strategy input format](./strategy-input.md), so it can be sent directly to the strategy nodes, or via any `ps-xxx-add-tariff` node.
+
+###
+
+<AdsenseAdd type="nederst"/>

package/docs/nodes/ps-schedule-merger.md

@@ -55,6 +55,10 @@ the schedule from for example the Lowest Price node, using the Schedule Merger n
 | Send when rescheduling | Check this to make sure on or off output is sent immediately after rescheduling. If unchecked, the output is sent only if it has not been sent before, or is different from the current value. |
 | If no schedule, send   | What to do if there is no valid schedule any more (turn on or off). This value will be sent also before there is any valid schedule, or after the last hour there is price data for.           |
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ### Dynamic config
 
 The following config values can be changed dynamically:

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

@@ -37,6 +37,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.
 :::
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ### Dynamic config
 
 The following config values can be changed dynamically:
@@ -91,6 +95,10 @@ A payload with the value set in config, default `false` is sent to output 2 when
 
 When a valid input is received, and the schedule is recalculated, the resulting schedule, as well as some other information, is sent to output 3. You can use this to see the plan and verify that it meets your expectations. You can also use it to display the schedule in any way you like.
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 Example of output:
 
 ```json
@@ -155,6 +163,10 @@ The `schedule` and the `hours` arrays from Output 3 are both saved to the nodes
 
 You can see the saved data if you select the node in Node-RED, and view "Context data", and refresh the Node context.
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ## Algorithm
 
 The calculation that decides what hours to turn off works as follows:
@@ -216,6 +228,10 @@ and set `msg.payload` to the following JSON value:
 
 This is an alternative to fetching new prices and send as input.
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ## 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.
@@ -229,3 +245,7 @@ Read more about this in the [MMM-Tibber documentation](https://github.com/ottopa
 ## Viewer
 
 If you like to analyze the data output by the node, take a look at the [Best Save Viewer](../faq/best-save-viewer.md).
+
+###
+
+<AdsenseAdd type="nederst"/>

package/docs/nodes/ps-strategy-fixed-schedule.md

@@ -39,6 +39,10 @@ Here is an example of how to combine it with the Lowest Price node:
 | If no schedule, send   | What to do if there is no valid schedule any more (turn on or off). This value will be sent also before there is any valid schedule, or after the last hour there is price data for.                                                                                                |
 | Context storage        | Select context storage to save data to, if more than one is configured in the Node-RED `settings.js` file.                                                                                                                                                                          |
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ### Dynamic config
 
 The following config values can be changed dynamically:
@@ -91,6 +95,10 @@ When a valid input is received, and the schedule is recalculated, the resulting
 
 The aoutput is similar to the output from the other strategy nodes.
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ## Usage ideas
 
 ### Turn on every morning
@@ -99,3 +107,7 @@ If you want to make sure that a switch is turned on at least 2 hours every morni
 even if you are using the Lowest Price node to turn it on only the 4 cheapest hours during
 the whole day, you can use this node to make sure it is on this period, and then merge it with the
 Lowest Price schedule using the Schedule Merger node with the `OR` function.
+
+###
+
+<AdsenseAdd type="nederst"/>

package/docs/nodes/ps-strategy-heat-capacitor.md

@@ -37,6 +37,10 @@ It is a good application for cabins/heated storage spaces, as the entity never a
 
 The node consumes price information and outputs $\Delta T$ on its first output and the planned schedule and benefit calculations on the second output. The $\Delta T$ is used to adjust the set-point of a climate entity.
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ### The impact of **Time +1C**
 
 This time is used to optimize the timing of when to turn up the heat. An increase in temperature from 22 to 23C will cause an increased electricity consumption for quite some time after the change has occurred. For heat-pumps, the air is heated first, then walls, furniture etc., creating a high electricity demand in the first hour or so before the demand slowly reduces down to normal levels. The algorithm uses this time to estimate a period of increased consumption and places this at an optimum point in time.
@@ -349,3 +353,7 @@ Full example:
   ]
 }
 ```
+
+###
+
+<AdsenseAdd type="nederst"/>

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

@@ -64,6 +64,10 @@ If `Consecutive on period` is on (checked), hours will be turned on only if the
 If you leave `Max price` blank, it has no effect.
 :::
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 ### Dynamic config
 
 The following config values can be changed dynamically:
@@ -113,6 +117,10 @@ A payload with the value set in config, default `false` is sent to output 2 when
 
 When a valid input is received, and the schedule is recalculated, the resulting schedule, as well as some other information, is sent to output 3. You can use this to see the plan and verify that it meets your expectations. You can also use it to display the schedule in any way you like.
 
+###
+
+<AdsenseAdd type="artikkel"/>
+
 Example of output:
 
 ```json
@@ -246,3 +254,7 @@ If you want to find the `x` hours with the highest prices, do as follows:
 1. Calculate `y` as the total number of hours in the period. For example, if the period is from `08:00` to `20:00`, then `y = 12`.
 2. Configure `Hours On = y - x`, so if `x = 4`, then `Hours On = 12 - 4 = 8`.
 3. Use **Output 2** to get a signal when you have the hours with the highest prices. Just remember that the value sent to output 2 is `false`, not `true` as it is on output 1.
+
+###
+
+<AdsenseAdd type="nederst"/>

package/docs/nodes/strategy-input.md

@@ -37,3 +37,7 @@ This format is used for:
 - Output of the `ps-receive-price` node
 - Input and output of the `ps-xxx-add-tariff` nodes
 - Input for the strategy nodes (`ps-strategy-xxx-xxx`)
+
+###
+
+<AdsenseAdd type="nederst"/>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-power-saver",
-  "version": "4.0.0",
+  "version": "4.1.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

@@ -86,6 +86,9 @@ function makePlanFromPriceData(node, msg, config, doPlanning, calcSavings) {
 function getCommands(msg) {
   const legalCommands = ["reset", "replan", "sendOutput", "sendSchedule"];
   const commands = { legal: true };
+  if (msg.payload?.config?.override === "auto") {
+    commands.runSchedule = true;
+  }
   if (!msg?.payload?.commands) {
     return commands;
   }

package/src/handle-output.js

@@ -13,6 +13,9 @@ function handleOutput(node, config, plan, outputCommands, planFromTime) {
 
   */
 
+  // Clear status
+  node.status({});
+
   // Prepare output
   let output3 = {
     payload: {
@@ -44,10 +47,15 @@ function handleOutput(node, config, plan, outputCommands, planFromTime) {
   }
 
   // Run schedule
+  clearTimeout(node.schedulingTimeout);
   if (outputCommands.runSchedule) {
-    clearTimeout(node.schedulingTimeout);
     node.schedulingTimeout = runSchedule(node, plan.schedule, planFromTime, true);
   }
+
+  // Set status if override
+  if (config.override !== "auto") {
+    node.status({ fill: "yellow", shape: "dot", text: "Override " + config.override });
+  }
 }
 
 function sendSwitch(node, onOff) {

package/src/schedule-merger.js

@@ -45,6 +45,10 @@ module.exports = function (RED) {
     });
 
     node.on("input", function (msg) {
+      if (msg.payload?.name && msg.payload.name !== node.name) {
+        // If payload.name is set, and does not match this nodes name, discard message
+        return;
+      }
       if (msg.payload.hours) {
         // Delete config from strategy nodes so it does not merge
         // with config for this node.
@@ -100,7 +104,7 @@ module.exports = function (RED) {
 
           handleOutput(node, config, plan, outputCommands, planFromTime);
         },
-        commands.replan ? 0 : node.schedulingDelay
+        commands.replan || msg.payload.config ? 0 : node.schedulingDelay
       );
     });
   }

package/src/strategy-functions.js

@@ -26,7 +26,7 @@ function strategyOnInput(node, msg, doPlanning, calcSavings) {
         node.sendCurrentValueWhenRescheduling
       ),
       sendSchedule: strategyShallSendSchedule(msg, commands),
-      runSchedule: commands.replan !== false,
+      runSchedule: commands.replan !== false && config.override === "auto",
     };
     handleOutput(node, config, plan, outputCommands, planFromTime);
   }

package/test/send-config-input.test.js

@@ -115,6 +115,7 @@ describe("send config as input", () => {
   });
   it("can override", function (done) {
     const flow = makeFlow(3, 2, false);
+    const time = prices.priceData[0].start;
     helper.load(bestSave, flow, function () {
       const n1 = helper.getNode("n1");
       const n2 = helper.getNode("n2");
@@ -131,6 +132,7 @@ describe("send config as input", () => {
             console.log("countOn = " + countOn + ", countOff = " + countOff);
             expect(countOn).toEqual(2);
             expect(countOff).toEqual(2);
+            n1.status.should.be.calledWithExactly({ fill: "yellow", shape: "dot", text: "Override on" });
             done();
           }, 900);
         }
@@ -139,20 +141,19 @@ describe("send config as input", () => {
         countOn++;
         expect(msg).toHaveProperty("payload", true);
         if (countOn === 2) {
-          n1.receive({ payload: { config: { override: "on" } } });
+          n1.receive({ payload: { config: { override: "on" }, time } });
         }
       });
       n4.on("input", function (msg) {
         countOff++;
         expect(msg).toHaveProperty("payload", false);
         if (countOff === 1) {
-          n1.receive({ payload: { config: { override: "on" }, name: "wrong name" } });
+          n1.receive({ payload: { config: { override: "on" }, name: "wrong name" }, time });
         }
         if (countOff === 2) {
-          n1.receive({ payload: { config: { override: "on" } } });
+          n1.receive({ payload: { config: { override: "on" }, time } });
         }
       });
-      const time = prices.priceData[0].start;
       n1.receive({ payload: makePayload(prices, time) });
     });
   });

package/test/strategy-best-save.test.js

@@ -96,6 +96,7 @@ describe("ps-strategy-best-save node", function () {
       n1.receive({ payload: makePayload(prices, plan.time) });
     });
   });
+
   it("should not send output when rescheduling", function (done) {
     const flow = makeFlow(3, 2, false);
     helper.load(bestSave, flow, function () {
@@ -140,6 +141,51 @@ describe("ps-strategy-best-save node", function () {
       n1.receive({ payload });
     });
   });
+
+  it("should handle override", function (done) {
+    const flow = makeFlow(3, 2);
+    const expected = cloneDeep(result);
+    expected.version = version;
+    expected.time = plan.time;
+    expected.source = "Tibber";
+    expected.current = false;
+    let timeoutSet = false;
+    helper.load(bestSave, flow, function () {
+      const n1 = helper.getNode("n1");
+      const n2 = helper.getNode("n2");
+      const n3 = helper.getNode("n3");
+      const n4 = helper.getNode("n4");
+      let countOn = 0;
+      let countOff = 0;
+      n2.on("input", function (msg) {
+        expect(equalPlan(expected, msg.payload)).toBeTruthy();
+        n1.warn.should.not.be.called;
+        if (!timeoutSet) {
+          timeoutSet = true;
+          setTimeout(() => {
+            console.log("countOn = " + countOn + ", countOff = " + countOff);
+            expect(countOn).toEqual(2);
+            expect(countOff).toEqual(2);
+            done();
+          }, 900);
+        }
+      });
+      n3.on("input", function (msg) {
+        console.log("on");
+        countOn++;
+        expect(msg).toHaveProperty("payload", true);
+      });
+      n4.on("input", function (msg) {
+        console.log("off");
+        countOff++;
+        expect(msg).toHaveProperty("payload", false);
+        if (countOff === 2) {
+          n1.receive({ payload: { config: { override: "on" }, time: plan.time } });
+        }
+      });
+      n1.receive({ payload: makePayload(prices, plan.time) });
+    });
+  });
 });
 
 function makePayload(prices, time) {