node-red-contrib-power-saver 3.0.0 → 3.0.1

package/docs/changelog/README.md

@@ -6,6 +6,12 @@ sidebar: "auto"
 
 List the most significant changes, starting in version 1.0.9.
 
+## 3.0.1
+
+- Fix so elvia subscripion key is stored as credential
+- Fix bug on config for strategy nodes. Config was not saved properly.
+- Remove double output bug, and better handling when hoursOn > period
+
 ## 3.0.0
 
 - Deprecating old Power Saver node, adding multiple new nodes.

package/docs/contribute/README.md

@@ -32,7 +32,7 @@ It would be very nice to get more examples into the documentation. If you have m
 
 ## Bug reports
 
-If you find a bug, please describe it thouroghly and make a [GitHub issue](https://github.com/ottopaulsen/node-red-contrib-power-saver/issues). If the bug is related to the scheduling, please provide the full output from output 3 on the strategy node.
+If you find a bug, please describe it thouroghly and make a [GitHub issue](https://github.com/ottopaulsen/node-red-contrib-power-saver/issues). If the bug is related to the scheduling, **please provide the full output from output 3** on the strategy node.
 
 ## Ideas
 

package/docs/guide/README.md

@@ -174,6 +174,15 @@ Example using Home Assistant:
 
 ![Example flow](../images/example-flow-2.png)
 
+::: tip Use output
+There are many ways you can use the output:
+
+- Turn on/off a switch
+- Set a termostat up, down or to specific values
+- Change setting of a dimmer
+- Send a notification
+  :::
+
 ### Display schedule
 
 **Output 3** can be used to print or dispay 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.
@@ -190,4 +199,4 @@ The `Power Saver` node from v2 is still here, and it is working exactly as befor
 
 ![Migrate Power Saver](../images/migrate-best-save.png)
 
-See more details in the [documentation for the `Power Saver`](../nodes/power-saver.md) node.
+See more details in the [documentation for the `ps-strategy-best-save`](../nodes/ps-strategy-best-save.md) node.

package/package.json

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

@@ -4,7 +4,9 @@
     color: "#a6bbcf",
     defaults: {
       name: { value: "Elvia Config" },
-      elviaSubscriptionKey: { value: "", required: true },
+    },
+    credentials: {
+      elviaSubscriptionKey: { type: "text" },
     },
     inputs: 1,
     outputs: 1,

package/src/elvia/elvia-config.js

@@ -4,22 +4,16 @@ module.exports = function (RED) {
   function ElviaConfigNode(config) {
     RED.nodes.createNode(this, config);
 
+    this.elviaConfig = RED.nodes.getNode(config.elviaConfig);
+
     // Store config in global configList
     const configList = this.context().global.get("elviaConfigList") || [];
     configList.push(config);
     this.context().global.set("elviaConfigList", configList);
-
-    const node = this;
-
-    RED.httpAdmin.get("/elvia-tariff-types", RED.auth.needsPermission("ps-elvia-config.read"), function (req, res) {
-      const configList = node.context().global.get("elviaConfigList") || [];
-      const configId = req.query.configId;
-      const key = configList.find((c) => c.id == configId)?.elviaSubscriptionKey;
-      console.log("Getting tariff types for key " + key);
-      getTariffTypes(null, key).then((json) => {
-        res.json(json);
-      });
-    });
   }
-  RED.nodes.registerType("ps-elvia-config", ElviaConfigNode);
+  RED.nodes.registerType("ps-elvia-config", ElviaConfigNode, {
+    credentials: {
+      elviaSubscriptionKey: { type: "text" },
+    },
+  });
 };

package/src/elvia/elvia-tariff-types.js

@@ -4,19 +4,21 @@ module.exports = function (RED) {
   function PsElviaTariffTypesNode(config) {
     RED.nodes.createNode(this, config);
     this.elviaConfig = RED.nodes.getNode(config.elviaConfig);
+    const key = this.elviaConfig.credentials.elviaSubscriptionKey;
     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 configList = node.context().global.get("elviaConfigList") || [];
-      const key = configList.find((c) => c.id == node.elviaConfig.id)?.elviaSubscriptionKey;
+    node.on("input", function () {
       getTariffTypes(node, key).then((json) => {
         node.send([{ payload: json }]);
       });
     });
+
+    RED.httpAdmin.get("/elvia-tariff-types", RED.auth.needsPermission("ps-elvia-config.read"), function (req, res) {
+      getTariffTypes(null, key).then((json) => {
+        res.json(json);
+      });
+    });
   }
 
   RED.nodes.registerType("ps-elvia-tariff-types", PsElviaTariffTypesNode);

package/src/elvia/elvia-tariff.js

@@ -5,17 +5,13 @@ module.exports = function (RED) {
   function PsElviaTariffNode(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 () {
-      const configList = node.context().global.get("elviaConfigList") || [];
-      const key = configList.find((c) => c.id == node.elviaConfig.id)?.elviaSubscriptionKey;
       getTariff(node, key, node.tariffKey, node.range).then((json) => {
         node.send([{ payload: json }]);
       });

package/src/handle-input.js

@@ -45,7 +45,8 @@ 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);
 
-  if (node.sendCurrentValueWhenRescheduling && pastSchedule.length > 0) {
+  const sendNow = node.sendCurrentValueWhenRescheduling && pastSchedule.length > 0;
+  if (sendNow) {
     const currentValue = pastSchedule[pastSchedule.length - 1].value;
     output1 = currentValue ? { payload: true } : null;
     output2 = currentValue ? null : { payload: false };
@@ -58,7 +59,7 @@ function handleStrategyInput(node, msg, doPlanning) {
   node.send([output1, output2, output3]);
 
   // Run schedule
-  node.schedulingTimeout = runSchedule(node, plan.schedule, planFromTime);
+  node.schedulingTimeout = runSchedule(node, plan.schedule, planFromTime, sendNow);
 }
 
 function getPriceData(node, msg) {
@@ -71,7 +72,7 @@ function getPriceData(node, msg) {
   return priceData;
 }
 
-function runSchedule(node, schedule, time) {
+function runSchedule(node, schedule, time, currentSent = false) {
   let currentTime = time;
   let remainingSchedule = schedule.filter((entry) => {
     return DateTime.fromISO(entry.time) > DateTime.fromISO(time);
@@ -94,7 +95,9 @@ function runSchedule(node, schedule, time) {
     const message = "No schedule";
     node.warn(message);
     node.status({ fill: "red", shape: "dot", text: message });
-    sendSwitch(node, node.outputIfNoSchedule);
+    if (!currentSent) {
+      sendSwitch(node, node.outputIfNoSchedule);
+    }
   }
 }
 

package/src/power-saver.html

@@ -25,9 +25,9 @@
         // validate: RED.validators.number(),
         align: "left",
       },
-      outputIfNoSchedule: { value: true, required: true, align: "left" },
+      outputIfNoSchedule: { value: "true", required: true, align: "left" },
       scheduleOnlyFromCurrentTime: {
-        value: true,
+        value: "true",
         required: true,
         align: "left",
       },
@@ -46,8 +46,8 @@
           {
             value: "onoff",
             options: [
-              { value: true, label: "On" },
-              { value: false, label: "Off" },
+              { value: "true", label: "On" },
+              { value: "false", label: "Off" },
             ],
           },
         ],
@@ -57,8 +57,8 @@
           {
             value: "nowOrStart",
             options: [
-              { value: false, label: "Whole data set" },
-              { value: true, label: "From current hour" },
+              { value: "false", label: "Whole data set" },
+              { value: "true", label: "From current hour" },
             ],
           },
         ],
@@ -90,7 +90,7 @@
     </div>
     <div class="form-row">
       <label for="node-input-scheduleOnlyFromCurrentTime">Schedule for</label>
-      <input type="boolean" id="node-input-scheduleOnlyFromCurrentTime" style="width: 160px">
+      <input type="text" id="node-input-scheduleOnlyFromCurrentTime" style="width: 160px">
       </label>
   </div>
   <h3>Output</h3>
@@ -104,7 +104,7 @@
     </div>
     <div class="form-row">
         <label for="node-input-outputIfNoSchedule">If no schedule, send</label>
-        <input type="boolean" id="node-input-outputIfNoSchedule" style="width: 80px">
+        <input type="text" id="node-input-outputIfNoSchedule" style="width: 80px">
         </label>
     </div>
 </script>

package/src/strategy-best-save.html

@@ -25,9 +25,9 @@
         // validate: RED.validators.number(),
         align: "left",
       },
-      outputIfNoSchedule: { value: true, required: true, align: "left" },
+      outputIfNoSchedule: { value: "true", required: true, align: "left" },
       scheduleOnlyFromCurrentTime: {
-        value: true,
+        value: "true",
         required: true,
         align: "left",
       },
@@ -46,8 +46,8 @@
           {
             value: "onoff",
             options: [
-              { value: true, label: "On" },
-              { value: false, label: "Off" },
+              { value: "true", label: "On" },
+              { value: "false", label: "Off" },
             ],
           },
         ],
@@ -57,8 +57,8 @@
           {
             value: "nowOrStart",
             options: [
-              { value: false, label: "Whole data set" },
-              { value: true, label: "From current hour" },
+              { value: "false", label: "Whole data set" },
+              { value: "true", label: "From current hour" },
             ],
           },
         ],
@@ -90,7 +90,7 @@
     </div>
     <div class="form-row">
       <label for="node-input-scheduleOnlyFromCurrentTime">Schedule for</label>
-      <input type="boolean" id="node-input-scheduleOnlyFromCurrentTime" style="width: 160px">
+      <input type="text" id="node-input-scheduleOnlyFromCurrentTime" style="width: 160px">
       </label>
   </div>
   <h3>Output</h3>
@@ -104,7 +104,7 @@
     </div>
     <div class="form-row">
         <label for="node-input-outputIfNoSchedule">If no schedule, send</label>
-        <input type="boolean" id="node-input-outputIfNoSchedule" style="width: 80px">
+        <input type="text" id="node-input-outputIfNoSchedule" style="width: 80px">
         </label>
     </div>
 </script>

package/src/strategy-lowest-price.html

@@ -44,17 +44,17 @@
         required: true,
       },
       doNotSplit: {
-        value: false,
+        value: "false",
         required: true,
         align: "left",
       },
       sendCurrentValueWhenRescheduling: {
-        value: true,
+        value: "true",
         required: true,
         align: "left",
       },
-      outputIfNoSchedule: { value: true, required: true, align: "left" },
-      outputOutsidePeriod: { value: false, required: true, align: "left" },
+      outputIfNoSchedule: { value: "true", required: true, align: "left" },
+      outputOutsidePeriod: { value: "false", required: true, align: "left" },
     },
     inputs: 1,
     outputs: 3,
@@ -70,8 +70,8 @@
           {
             value: "onoff",
             options: [
-              { value: true, label: "On" },
-              { value: false, label: "Off" },
+              { value: "true", label: "On" },
+              { value: "false", label: "Off" },
             ],
           },
         ],
@@ -81,8 +81,8 @@
           {
             value: "onoff",
             options: [
-              { value: true, label: "On" },
-              { value: false, label: "Off" },
+              { value: "true", label: "On" },
+              { value: "false", label: "Off" },
             ],
           },
         ],
@@ -151,12 +151,12 @@
     </div>
     <div class="form-row">
         <label for="node-input-outputIfNoSchedule">If no schedule, send</label>
-        <input type="boolean" id="node-input-outputIfNoSchedule" style="width: 80px">
+        <input type="text" id="node-input-outputIfNoSchedule" style="width: 80px">
         </label>
     </div>
     <div class="form-row">
         <label for="node-input-outputIfNoSchedule">Outside period, send</label>
-        <input type="boolean" id="node-input-outputOutsidePeriod" style="width: 80px">
+        <input type="text" id="node-input-outputOutsidePeriod" style="width: 80px">
         </label>
     </div>
 </script>

package/test/strategy-lowest-price.test.js

@@ -4,6 +4,7 @@ const expect = require("expect");
 const helper = require("node-red-node-test-helper");
 const lowestPrice = require("../src/strategy-lowest-price.js");
 const prices = require("./data/converted-prices.json");
+const { testPlan: plan } = require("./test-utils");
 
 helper.init(require.resolve("node-red"));
 
@@ -304,6 +305,139 @@ describe("ps-strategy-lowest-price node", function () {
       n1.receive({ payload: makePayload(prices, time) });
     });
   });
+
+  it("should work with data for only current day", function (done) {
+    const oneDayPrices = {};
+    oneDayPrices.priceData = prices.priceData.filter((d) => d.start.startsWith("2021-10-11"));
+    const result = [
+      { time: "2021-10-11T00:00:00.000+02:00", value: false },
+      { time: "2021-10-11T12:00:00.000+02:00", value: true },
+      { time: "2021-10-11T13:00:00.000+02:00", value: false },
+    ];
+    const flow = makeFlow(1);
+    helper.load(lowestPrice, flow, function () {
+      const n1 = helper.getNode("n1");
+      const n2 = helper.getNode("n2");
+      const n3 = helper.getNode("n3");
+      const n4 = helper.getNode("n4");
+      n2.on("input", function (msg) {
+        expect(msg.payload).toHaveProperty("schedule", result);
+        n1.warn.should.not.be.called;
+        done();
+      });
+      n3.on("input", function (msg) {
+        console.log("n3 inout: " + msg);
+        expect(msg.payload).toEqual(true);
+      });
+      n4.on("input", function (msg) {
+        console.log("n4 inout: " + msg);
+        expect(msg.payload).toEqual(false);
+      });
+      const time = DateTime.fromISO(prices.priceData[10].start);
+      n1.receive({ payload: makePayload(oneDayPrices, time) });
+    });
+  });
+
+  it("should handle hours on > period", function (done) {
+    const result = [{ time: "2021-10-11T00:00:00.000+02:00", value: true }];
+    const flow = [
+      {
+        id: "n1",
+        type: "ps-strategy-lowest-price",
+        name: "test name",
+        fromTime: "17",
+        toTime: "22",
+        hoursOn: 6,
+        doNotSplit: true,
+        sendCurrentValueWhenRescheduling: true,
+        outputIfNoSchedule: false,
+        outputOutsidePeriod: true,
+        wires: [["n3"], ["n4"], ["n2"]],
+      },
+      { id: "n2", type: "helper" },
+      { id: "n3", type: "helper" },
+      { id: "n4", type: "helper" },
+    ];
+    helper.load(lowestPrice, 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(msg.payload).toHaveProperty("schedule", result);
+        n1.warn.should.not.be.called;
+        setTimeout(() => {
+          expect(countOn).toEqual(1);
+          expect(countOff).toEqual(0);
+          done();
+        }, 100);
+      });
+      n3.on("input", function (msg) {
+        countOn++;
+      });
+      n4.on("input", function (msg) {
+        countOff++;
+      });
+
+      const time = DateTime.fromISO(prices.priceData[10].start);
+      n1.receive({ payload: makePayload(prices, time) });
+    });
+  });
+  it("should handle hours on > period, false outside", function (done) {
+    const result = [
+      { time: "2021-10-11T00:00:00.000+02:00", value: false },
+      { time: "2021-10-11T17:00:00.000+02:00", value: true },
+      { time: "2021-10-11T22:00:00.000+02:00", value: false },
+      { time: "2021-10-12T17:00:00.000+02:00", value: true },
+      { time: "2021-10-12T22:00:00.000+02:00", value: false },
+    ];
+    const flow = [
+      {
+        id: "n1",
+        type: "ps-strategy-lowest-price",
+        name: "test name",
+        fromTime: "17",
+        toTime: "22",
+        hoursOn: 6,
+        doNotSplit: true,
+        sendCurrentValueWhenRescheduling: true,
+        outputIfNoSchedule: true,
+        outputOutsidePeriod: false,
+        wires: [["n3"], ["n4"], ["n2"]],
+      },
+      { id: "n2", type: "helper" },
+      { id: "n3", type: "helper" },
+      { id: "n4", type: "helper" },
+    ];
+    helper.load(lowestPrice, 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(msg.payload).toHaveProperty("schedule", result);
+        n1.warn.should.not.be.called;
+        setTimeout(() => {
+          expect(countOn).toEqual(0);
+          expect(countOff).toEqual(1);
+          done();
+        }, 100);
+      });
+      n3.on("input", function (msg) {
+        countOn++;
+      });
+      n4.on("input", function (msg) {
+        countOff++;
+      });
+
+      const time = DateTime.fromISO(prices.priceData[10].start);
+      n1.receive({ payload: makePayload(prices, time) });
+    });
+  });
 });
 
 function makeFlow(hoursOn) {