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

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

@@ -49,4 +49,4 @@ The input is the [common strategy input format](./strategy-input.md)
 
 ## Output
 
-The input is the [common strategy input format](./strategy-input.md)
+The output is the [common strategy input format](./strategy-input.md)

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

@@ -0,0 +1,51 @@
+# ps-general-add-tariff
+
+![ps-general-add-tariff](../images/node-ps-general-add-tariff.png)
+
+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.
+
+## Description
+
+This node is useful if there is an addition to the electricity price that varies over the day, as it might be for the grid tariff.
+
+If there is one price for example from 22:00 to 06:00 every day, and another price from 06:00 to 22:00, this is the right node to use. It can be used for more than two periods, as long as the time it changes is the same every day.
+
+Here is how this node is normally used:
+
+![general flow](../images/add-tariff-flow.png)
+
+::: tip Changes during the year
+If there is one price now, and another price from a specific date, you can use two nodes after each other. Set the `Valid to date` of the node with the current prices to the last date the current prices are valid. Set the `Valid from date` of the node with the upcoming prices to the first date those prices are valid.
+:::
+
+## Configuration
+
+### Add and delete periods
+
+You can have from 1 to 24 periods during the day, with different values to add for each hour. Click the `Add period` button to add more periods. Click the `X` button to delete a period.
+
+### From time and Value
+
+For each period, select the time of the day the value is valid from, and enter the value.
+
+### Valid from date
+
+Fill in the first date the config is valid.
+
+If this is empty, the config is valid from the dawn of time.
+
+### Valid to date
+
+Fill in the last date the config is valid.
+
+If this is empty, the config is valid until forever.
+
+## Input
+
+The input is the [common strategy input format](./strategy-input.md)
+
+## Output
+
+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.

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

@@ -52,7 +52,9 @@ All the variables in the config object are optional. You can send only those you
 
 The config sent like this will be valid until a new config is sent the same way, or until the flow is restarted. On a restart, the original config set up in the node will be used.
 
-When a config is sent like this, the schedule will be replanned based on the last previously received price data. If no price data has been received, no scheduling is done.
+When a config is sent like this, and without price data, the schedule will be replanned based on the last previously received price data. If no price data has been received, no scheduling is done.
+
+However, you can send config and price data in the same message. Then both will be used .
 
 ## Input
 
@@ -115,7 +117,9 @@ Example of output:
     "minSaving": 0.001,
     "sendCurrentValueWhenRescheduling": true,
     "outputIfNoSchedule": false
-  }
+  },
+  "time": "2021-09-30T23:45:12.123+02:00",
+  "version": "3.1.2"
 }
 ```
 

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

@@ -70,7 +70,9 @@ All the variables in the config object are optional. You can send only those you
 
 The config sent like this will be valid until a new config is sent the same way, or until the flow is restarted. On a restart, the original config set up in the node will be used.
 
-When a config is sent like this, the schedule will be replanned based on the last previously received price data. If no price data has been received, no scheduling is done.
+When a config is sent like this, and without price data, the schedule will be replanned based on the last previously received price data. If no price data has been received, no scheduling is done.
+
+However, you can send config and price data in the same message. Then both will be used .
 
 ## Input
 
@@ -144,7 +146,9 @@ Example of output:
     "sendCurrentValueWhenRescheduling": true,
     "outputIfNoSchedule": "true",
     "outputOutsidePeriod": "true"
-  }
+  },
+  "time": "2021-09-30T23:45:12.123+02:00",
+  "version": "3.1.2"
 }
 ```
 

package/package.json

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

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

@@ -39,7 +39,11 @@ module.exports = function (RED) {
             p.value = roundPrice(p.powerPrice + p.gridTariffVariable);
           });
         }
-        node.send([{ payload: { priceData: prices } }]);
+        const payload = { priceData: prices };
+        if (msg.payload.config) {
+          payload.config = msg.payload.config;
+        }
+        node.send([{ payload }]);
       });
     });
   }

package/src/general-add-tariff-functions.js

@@ -0,0 +1,46 @@
+const cloneDeep = require("lodash.clonedeep");
+const { DateTime } = require("luxon");
+const { nodes } = require("node-red");
+const { roundPrice } = require("./utils");
+
+function buildAllHours(node, periods) {
+  const sortedPeriods = cloneDeep(periods);
+  sortedPeriods.sort((a, b) => a.start - b.start);
+  let res = [];
+  let hour = 0;
+  let current = sortedPeriods[sortedPeriods.length - 1];
+  sortedPeriods.push({ start: 24, value: null });
+  sortedPeriods.forEach((period) => {
+    const nextHour = parseInt(period.start);
+    while (hour < nextHour) {
+      let value = 0;
+      try {
+        value = parseFloat(("" + current.value).replace(",", "."));
+      } catch (e) {
+        node.warn("Illegal number: " + current.value);
+      }
+      res[hour] = value;
+      hour++;
+    }
+    current = period;
+  });
+  return res;
+}
+
+function addTariffToPrices(node, config, prices) {
+  const allHours = buildAllHours(node, config.periods);
+  const validFrom = DateTime.fromISO(config.validFrom || prices[0].start.substr(0, 10));
+  const validTo = DateTime.fromISO(config.validTo || prices[prices.length - 1].start.substr(0, 10));
+  prices.forEach((p, i) => {
+    const date = DateTime.fromISO(p.start.substr(0, 10));
+    const hour = DateTime.fromISO(p.start).hour;
+    if (date >= validFrom && date <= validTo) {
+      prices[i].value = roundPrice(prices[i].value + allHours[hour]);
+    }
+  });
+}
+
+module.exports = {
+  addTariffToPrices,
+  buildAllHours,
+};

package/src/general-add-tariff.html

@@ -0,0 +1,186 @@
+<script type="text/javascript">
+  const dateRe = /^$|^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$/;
+  const priceRe = /^(\d+\.\d*)|(\d+)$/;
+  RED.nodes.registerType("ps-general-add-tariff", {
+    category: "Power Saver",
+    color: "#a6bbcf",
+    defaults: {
+      name: { value: "Add General Tariff" },
+      periods: {
+        value: [
+          { start: "22", value: 0.0 },
+          { start: "06", value: 0.0 },
+        ],
+        validate: function () {
+          return !this.periods.some((p) => !priceRe.test("" + p.value));
+        },
+      },
+      validFrom: { value: null, required: false, validate: RED.validators.regex(dateRe) },
+      validTo: { value: null, required: false, validate: RED.validators.regex(dateRe) },
+    },
+    hours: [
+      "00",
+      "01",
+      "02",
+      "03",
+      "04",
+      "05",
+      "06",
+      "07",
+      "08",
+      "09",
+      "10",
+      "11",
+      "12",
+      "13",
+      "14",
+      "15",
+      "16",
+      "17",
+      "18",
+      "19",
+      "20",
+      "21",
+      "22",
+      "23",
+    ],
+    inputs: 1,
+    outputs: 1,
+    periodCont: 2,
+    icon: "font-awesome/fa-plus",
+    color: "#FFCC66",
+    label: function () {
+      return this.name || "Add Tariff";
+    },
+
+    oneditprepare: function () {
+      const createElement = function (type, attrs = [], children = []) {
+        const el = document.createElement(type);
+        attrs.forEach((attr) => {
+          el.setAttribute(attr[0], attr[1]);
+        });
+        children.forEach((child) => {
+          el.append(child);
+        });
+        return el;
+      };
+
+      const createInputPart = function (name, i, text, inpStyle, value) {
+        const id = `node-input-${name}-${i}`;
+        const label = createElement(
+          "label",
+          [
+            ["for", id],
+            ["style", "margin-right: 10px;"],
+          ],
+          []
+        );
+        label.innerHTML = text;
+        const inp = createElement("input", [
+          ["type", "text"],
+          ["id", id],
+          ["style", `width: 80px; ${inpStyle};`],
+        ]);
+        inp.value = value;
+        return createElement("span", [["style", "text-align: right;"]], [label, inp]);
+      };
+
+      const addPeriod = function (periods) {
+        const prev = periods[periods.length - 1].start;
+        const next = prev === "23" ? "00" : "" + (parseInt(prev) + 1);
+        periods.push({ start: next, value: null });
+        drawPeriods(periods);
+      };
+
+      const removePeriod = function (periods, i) {
+        periods.splice(i, 1);
+        drawPeriods(periods);
+        RED.nodes.dirty(true);
+      };
+
+      const drawPeriods = function (periods) {
+        document.getElementById("node-input-period-container").replaceChildren();
+        for (let i = 0; i < periods.length; i++) {
+          let period = periods[i];
+
+          const timeEl = createInputPart("fromTime", i, "From time:", "margin-right: 20px;", period.start);
+          const valEl = createInputPart("value", i, "Value:", "margin-right: 20px;", period.value);
+
+          let li;
+          if (periods.length > 1) {
+            // Delete button
+            const delButton = document.createElement("button");
+            delButton.setAttribute("style", "width: 24px;");
+            delButton.innerText = "X";
+            delButton.addEventListener("click", () => {
+              removePeriod(periods, i);
+            });
+            li = createElement("div", [["style", "text-align: left;"]], [timeEl, valEl, delButton]);
+          } else {
+            li = createElement("div", [["style", "text-align: left;"]], [timeEl, valEl]);
+          }
+          $("#node-input-period-container").append(li);
+
+          $("#node-input-fromTime-" + i).typedInput({
+            types: [
+              {
+                value: "fromtime",
+                options: hours.map((h) => ({ value: h, label: h + ":00" })),
+              },
+            ],
+          });
+          $("#node-input-fromTime-" + i).change(function () {
+            periods[i].start = this.value;
+            RED.nodes.dirty(true);
+          });
+          $("#node-input-value-" + i).change(function () {
+            periods[i].value = this.value;
+            RED.nodes.dirty(true);
+          });
+        }
+      };
+
+      drawPeriods(this.periods);
+      $("#add-period-button").on("click", () => {
+        addPeriod(this.periods);
+      });
+    },
+  });
+</script>
+
+<script type="text/html" data-template-name="ps-general-add-tariff">
+  <div class="form-row">
+    <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+    <input type="text" id="node-input-name" placeholder="Name" />
+  </div>
+
+  <div class="form-row node-input-period-container-row">
+    <div id="node-input-period-container"></div>
+  </div>
+
+  <div class="form-row">
+    <button type="button" id="add-period-button" class="red-ui-button">Add period</button>
+  </div>
+
+  <h3>Optional:</h3>
+
+  <div class="form-row">
+    <label for="node-input-validFrom"><i class="fa fa-calendar"></i> Valid from date</label>
+    <input type="text" id="node-input-validFrom" placeholder="YYYY-MM-DD" />
+  </div>
+
+  <div class="form-row">
+    <label for="node-input-validTo"><i class="fa fa-calendar"></i> Valid to date</label>
+    <input type="text" id="node-input-validTo" placeholder="YYYY-MM-DD" />
+  </div>
+</script>
+
+<script type="text/markdown" data-help-name="ps-general-add-tariff">
+  # Add Tariff
+
+  A node to add a tariff that is fixed for periods of the day/year
+  to the price before it is sent to the strategy nodes.
+  Use this node between the receive-price node and any of the strategy nodes.
+
+  Please read more in the [node documentation](https://ottopaulsen.github.io/node-red-contrib-power-saver/nodes/ps-general-add-tariff)
+</script>

package/src/general-add-tariff.js

@@ -0,0 +1,35 @@
+const cloneDeep = require("lodash.clonedeep");
+const { DateTime } = require("luxon");
+const { addTariffToPrices, buildAllHours } = require("./general-add-tariff-functions");
+const { roundPrice } = require("./utils");
+const { extractPlanForDate, getEffectiveConfig, validationFailure } = require("./utils");
+
+module.exports = function (RED) {
+  function PsGeneralAddTariffNode(config) {
+    RED.nodes.createNode(this, config);
+    this.range = config.range;
+    const node = this;
+
+    const originalConfig = {
+      periods: config.periods,
+      validFrom: config.validFrom,
+      validTo: config.validTo,
+    };
+    node.context().set("config", originalConfig);
+
+    node.on("input", function (originalMessage) {
+      const msg = cloneDeep(originalMessage);
+      const effectiveConfig = getEffectiveConfig(node, msg);
+      const prices = msg.payload.priceData;
+      if (!prices || prices.length === 0) {
+        return;
+      }
+
+      addTariffToPrices(node, effectiveConfig, prices);
+
+      node.send(msg);
+    });
+  }
+
+  RED.nodes.registerType("ps-general-add-tariff", PsGeneralAddTariffNode);
+};

package/src/handle-input.js

@@ -1,14 +1,19 @@
 const { extractPlanForDate, getEffectiveConfig, validationFailure } = require("./utils");
 const { DateTime } = require("luxon");
+const { version } = require("../package.json");
 
 function handleStrategyInput(node, msg, doPlanning) {
   node.schedulingTimeout = null;
 
   const effectiveConfig = getEffectiveConfig(node, msg);
+
   if (!validateInput(node, msg)) {
     return;
   }
   const priceData = getPriceData(node, msg);
+  if (!priceData) {
+    return;
+  }
   const planFromTime = msg.payload.time ? DateTime.fromISO(msg.payload.time) : DateTime.now();
 
   // Store config variables in node
@@ -38,6 +43,8 @@ function handleStrategyInput(node, msg, doPlanning) {
       hours: plan.hours,
       source: msg.payload.source,
       config: effectiveConfig,
+      time: planFromTime.toISO(),
+      version,
     },
   };
 
@@ -45,11 +52,12 @@ function handleStrategyInput(node, msg, doPlanning) {
   const pastSchedule = plan.schedule.filter((entry) => DateTime.fromISO(entry.time) <= planFromTime);
 
   const sendNow = node.sendCurrentValueWhenRescheduling && pastSchedule.length > 0;
+  const currentValue = pastSchedule[pastSchedule.length - 1]?.value;
   if (sendNow) {
-    const currentValue = pastSchedule[pastSchedule.length - 1].value;
     output1 = currentValue ? { payload: true } : null;
     output2 = currentValue ? null : { payload: false };
   }
+  output3.payload.current = currentValue;
 
   // Delete old data
   deleteSavedScheduleBefore(node, dateDayBefore);
@@ -63,7 +71,8 @@ function handleStrategyInput(node, msg, doPlanning) {
 
 function getPriceData(node, msg) {
   const isConfigMsg = !!msg?.payload?.config;
-  if (isConfigMsg) {
+  const isPriceMsg = !!msg?.payload?.priceData;
+  if (isConfigMsg && !isPriceMsg) {
     return node.context().get("lastPriceData");
   }
   const priceData = msg.payload.priceData;
@@ -82,9 +91,9 @@ function runSchedule(node, schedule, time, currentSent = false) {
     const wait = nextTime - currentTime;
     const onOff = entry.value ? "on" : "off";
     node.log("Switching " + onOff + " in " + wait + " milliseconds");
-    const statusMessage = `Scheduled ${remainingSchedule.length} changes. Next: ${
+    const statusMessage = `${remainingSchedule.length} changes - ${
       remainingSchedule[0].value ? "on" : "off"
-    }`;
+    } at ${nextTime.toLocaleString(DateTime.TIME_SIMPLE)}`;
     node.status({ fill: "green", shape: "dot", text: statusMessage });
     return setTimeout(() => {
       sendSwitch(node, entry.value);
@@ -104,7 +113,7 @@ function deleteSavedScheduleBefore(node, day) {
   let date = day;
   do {
     date = date.plus({ days: -1 });
-    data = node.context().get(date.toISO());
+    data = node.context().set(date.toISO(), undefined);
   } while (data);
 }
 

package/src/power-saver.js

@@ -156,7 +156,7 @@ function deleteSavedScheduleBefore(node, day) {
   let date = day;
   do {
     date = date.plus({ days: -1 });
-    data = node.context().get(date.toISO());
+    data = node.context().set(date.toISO(), undefined);
   } while (data);
 }
 

package/src/receive-price.js

@@ -12,8 +12,13 @@ module.exports = function (RED) {
         return;
       }
 
+      const payload = { priceData, source };
+      if (msg.config) {
+        payload.config = msg.config;
+      }
+
       // Send output
-      node.send({ payload: { priceData, source } });
+      node.send({ payload });
     });
   }
 

package/src/strategy-lowest-price.js

@@ -43,8 +43,8 @@ function doPlanning(node, _, priceData, _, dateDayBefore, _) {
   const endIndexes = [];
   let currentStatus = from < (to === 0 && to !== from ? 24 : to) ? "Outside" : "StartMissing";
   let hour;
-  priceData.forEach((pd, i) => {
-    hour = DateTime.fromISO(pd.start).hour;
+  startTimes.forEach((st, i) => {
+    hour = DateTime.fromISO(st).hour;
     if (hour === to && to === from && currentStatus === "Inside") {
       endIndexes.push(i - 1);
     }
@@ -63,13 +63,13 @@ function doPlanning(node, _, priceData, _, dateDayBefore, _) {
     let i = periodStatus.length - 1;
     do {
       periodStatus[i] = "EndMissing";
-      hour = DateTime.fromISO(priceData[i].start).hour;
+      hour = DateTime.fromISO(startTimes[i]).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);
+    endIndexes.push(startTimes.length - 1);
   }
 
   const onOff = [];
@@ -78,9 +78,9 @@ function doPlanning(node, _, priceData, _, dateDayBefore, _) {
   const lastStartMissing = periodStatus.lastIndexOf((s) => s === "StartMissing");
   if (lastStartMissing >= 0 && dataDayBefore?.hours?.length > 0) {
     const lastBefore = DateTime.fromISO(dataDayBefore.hours[dataDayBefore.hours.length - 1].start);
-    if (lastBefore >= DateTime.fromISO(priceData[lastStartMissing].start)) {
+    if (lastBefore >= DateTime.fromISO(startTimes[lastStartMissing])) {
       for (let i = 0; i <= lastStartMissing; i++) {
-        onOff[i] = dataDayBefore.hours.find((h) => h.start === priceData[i].start);
+        onOff[i] = dataDayBefore.hours.find((h) => h.start === startTimes[i]);
         periodStatus[i] = "Backfilled";
       }
     }