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

package/src/strategy-fixed-schedule.html

@@ -0,0 +1,339 @@
+<script type="text/javascript">
+  const defaultDaysSfs = { Mon: true, Tue: true, Wed: true, Thu: true, Fri: true, Sat: true, Sun: true };
+  RED.nodes.registerType("ps-strategy-fixed-schedule", {
+    category: "Power Saver",
+    color: "#a6bbcf",
+    defaults: {
+      name: { value: "Fixed Schedule" },
+      periods: {
+        value: [{ start: "00", value: true }],
+        validate: function () {
+          return !this.periods.some((p) => !/^(true)|(false)$/.test("" + p.value));
+        },
+      },
+      validFrom: {
+        value: null,
+        required: false,
+        validate: RED.validators.regex(/^$|^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$/),
+      },
+      validTo: {
+        value: null,
+        required: false,
+        validate: RED.validators.regex(/^$|^\d{4}\-(0[1-9]|1[012])\-(0[1-9]|[12][0-9]|3[01])$/),
+      },
+      days: { value: { ...defaultDaysSfs } },
+      sendCurrentValueWhenRescheduling: {
+        value: true,
+        required: true,
+        align: "left",
+      },
+      outputValueForOn: {
+        value: true,
+        required: true,
+        validate: RED.validators.typedInput("outputValueForOntype", false),
+      },
+      outputValueForOff: {
+        value: false,
+        required: true,
+        validate: RED.validators.typedInput("outputValueForOfftype", false),
+      },
+      outputValueForOntype: {
+        value: "bool",
+        required: true,
+      },
+      outputValueForOfftype: {
+        value: "bool",
+        required: true,
+      },
+      outputIfNoSchedule: { value: "false", required: true, align: "left" },
+      contextStorage: { value: "default", required: false, align: "left" },
+    },
+    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: 3,
+    icon: "font-awesome/fa-bar-chart",
+    color: "#FFCC66",
+    label: function () {
+      return this.name || "Fixed Schedule";
+    },
+    outputLabels: ["on", "off", "schedule"],
+    oneditprepare: function () {
+      $("#node-input-outputIfNoSchedule").typedInput({
+        types: [
+          {
+            value: "onoff",
+            options: [
+              { value: "true", label: "On" },
+              { value: "false", label: "Off" },
+            ],
+          },
+        ],
+      });
+      $("#node-input-contextStorage").typedInput({
+        types: [
+          {
+            value: "storages",
+            options: RED.settings.context.stores.map((s) => ({ value: s, label: s })),
+          },
+        ],
+      });
+      $("#node-input-outputValueForOn").typedInput({
+        default: "bool",
+        typeField: $("#node-input-outputValueForOntype"),
+        types: ["bool", "num", "str"],
+      });
+      $("#node-input-outputValueForOff").typedInput({
+        default: "bool",
+        typeField: $("#node-input-outputValueForOfftype"),
+        types: ["bool", "num", "str"],
+      });
+      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);
+              setTypedInputOnValues(periods.length);
+            });
+            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);
+          });
+        }
+      };
+
+      const drawDays = function (days) {
+        const dayNames = Object.keys(days);
+        document.getElementById("node-input-days-container").replaceChildren();
+        for (let i = 0; i < dayNames.length; i++) {
+          let day = dayNames[i];
+
+          const id = `node-input-day-${i}`;
+          const label = createElement(
+            "label",
+            [
+              ["for", id],
+              ["style", " margin: 4px 10px 0px 2px;width: 30px; text-align: left;"],
+            ],
+            []
+          );
+          label.innerHTML = day;
+          const attrs = [
+            ["name", "node-input-day"],
+            ["type", "checkbox"],
+            ["id", id],
+            ["style", `width: 15px; margin: 2px 0px 5px 5px;`],
+          ];
+          if (days[day]) {
+            attrs.push(["checked", ""]);
+          }
+          const inp = createElement("input", attrs);
+          inp.value = dayNames[i];
+
+          const el = createElement("span", [["style", "text-align: right;"]], [inp, label]);
+
+          $("#node-input-days-container").append(el);
+
+          $("#node-input-day-" + i).change(function (e) {
+            days[day] = $(this).is(":checked");
+            RED.nodes.dirty(true);
+          });
+        }
+      };
+
+      const setTypedInputOnValues = function (length) {
+        for (let i = 0; i < length; i++) {
+          $("#node-input-value-" + i).typedInput({
+            types: [
+              {
+                value: "onoff",
+                options: [
+                  { value: "true", label: "On" },
+                  { value: "false", label: "Off" },
+                ],
+              },
+            ],
+          });
+        }
+      };
+
+      drawPeriods(this.periods);
+      $("#add-period-button").on("click", () => {
+        addPeriod(this.periods);
+        setTypedInputOnValues(this.periods.length);
+      });
+
+      // Set typed input for value on all periods
+      setTypedInputOnValues(this.periods.length);
+
+      if (!this.days) {
+        // To support nodes created before this was developed
+        this.days = { ...defaultDaysSfs };
+      }
+      drawDays(this.days);
+    },
+  });
+</script>
+
+<script type="text/html" data-template-name="ps-strategy-fixed-schedule">
+    <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" style="width: 240px">
+    </div>
+  <h3>Schedule</h3>
+  <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>
+
+  <div class="form-row">
+    <label for="node-input-days-container"><i class="fa fa-calendar-o"></i> Days</label>
+    <span id="node-input-days-container"></span>
+  </div>
+
+  <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>
+  <h3>Output</h3>
+    <div class="form-row">
+      <div class="form-row">
+        <label for="node-input-outputValueForOn">Output value for on</label>
+        <input type="text" id="node-input-outputValueForOn" style="text-align: left; width: 120px">
+        <input type="hidden" id="node-input-outputValueForOntype">
+    </div>
+    <div class="form-row">
+        <label for="node-input-outputValueForOff">Output value for off</label>
+        <input type="text" id="node-input-outputValueForOff" style="text-align: left; width: 120px">
+        <input type="hidden" id="node-input-outputValueForOfftype">
+    </div>
+        <label for="node-input-sendCurrentValueWhenRescheduling" style="width:240px">
+        <input type="checkbox"
+               id="node-input-sendCurrentValueWhenRescheduling"
+               style="display:inline-block; width:22px; vertical-align:top;"
+               autocomplete="off"><span>Send when rescheduling</span>
+        </label>
+    </div>
+    <div class="form-row">
+        <label for="node-input-outputIfNoSchedule">If no schedule, send</label>
+        <input type="text" id="node-input-outputIfNoSchedule" style="width: 80px">
+        </label>
+    </div>
+    <h3>Context storage</h3>
+    <div class="form-row">
+      <label for="node-input-contextStorage"><i class="fa fa-archive"></i> Context storage</label>
+      <input type="text" id="node-input-contextStorage" style="width: 160px">
+  </div>
+</script>
+
+<script type="text/markdown" data-help-name="ps-strategy-fixed-schedule">
+  A node you can use to save money by turning off and on a switch based on power prices.
+
+  Please read more in the [node documentation](https://powersaver.no/nodes/ps-strategy-fixed-schedule)
+</script>

package/src/strategy-fixed-schedule.js

@@ -0,0 +1,84 @@
+const {
+  booleanConfig,
+  calcNullSavings,
+  fixOutputValues,
+  fixPeriods,
+  getSavings,
+  saveOriginalConfig,
+} = require("./utils");
+const { strategyOnInput } = require("./strategy-functions");
+const { DateTime } = require("luxon");
+const cloneDeep = require("lodash.clonedeep");
+
+module.exports = function (RED) {
+  function StrategyFixedScheduleNode(config) {
+    RED.nodes.createNode(this, config);
+    const node = this;
+    node.status({});
+
+    const validConfig = {
+      periods: config.periods || [],
+      validFrom: config.validFrom,
+      validTo: config.validTo,
+      days: config.days || { Mon: true, Tue: true, Wed: true, Thu: true, Fri: true, Sat: true, Sun: true },
+      contextStorage: config.contextStorage || "default",
+      outputIfNoSchedule: booleanConfig(config.outputIfNoSchedule),
+      outputValueForOn: config.outputValueForOn || true,
+      outputValueForOff: config.outputValueForOff || false,
+      outputValueForOntype: config.outputValueForOntype || "bool",
+      outputValueForOfftype: config.outputValueForOfftype || "bool",
+      override: "auto",
+      sendCurrentValueWhenRescheduling: config.sendCurrentValueWhenRescheduling,
+    };
+
+    fixOutputValues(validConfig);
+    fixPeriods(validConfig);
+    saveOriginalConfig(node, validConfig);
+
+    node.on("close", function () {
+      clearTimeout(node.schedulingTimeout);
+    });
+
+    node.on("input", function (msg) {
+      strategyOnInput(node, msg, doPlanning, calcNullSavings);
+    });
+  }
+  RED.nodes.registerType("ps-strategy-fixed-schedule", StrategyFixedScheduleNode);
+};
+
+function doPlanning(node, priceData) {
+  const startTimes = priceData.map((pd) => pd.start);
+  const onOff = startTimes.map(() => node.outputIfNoSchedule);
+  const allHours = buildAllHours(node, node.periods);
+  const validFrom = DateTime.fromISO(node.validFrom || startTimes[0].substr(0, 10));
+  const validTo = DateTime.fromISO(node.validTo || startTimes[startTimes.length - 1].substr(0, 10));
+  startTimes.forEach((st, i) => {
+    const date = DateTime.fromISO(st.substr(0, 10));
+    const hour = DateTime.fromISO(st).hour;
+    const day = DateTime.fromISO(st).weekday;
+    const dayName = Object.keys(node.days)[day - 1];
+    if (date >= validFrom && date <= validTo && node.days[dayName]) {
+      onOff[i] = allHours[hour];
+    }
+  });
+
+  return onOff;
+}
+
+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) {
+      res[hour] = current.value;
+      hour++;
+    }
+    current = period;
+  });
+  return res;
+}

package/src/strategy-functions.js

@@ -0,0 +1,35 @@
+const { DateTime } = require("luxon");
+const { getEffectiveConfig, getOutputForTime } = require("./utils");
+const { handleStrategyInput } = require("./handle-input");
+const { handleOutput, shallSendOutput, strategyShallSendSchedule } = require("./handle-output");
+
+function strategyOnInput(node, msg, doPlanning, calcSavings) {
+  if (msg.payload?.name && msg.payload.name !== node.name) {
+    // If payload.name is set, and does not match this nodes name, discard message
+    return;
+  }
+  const config = getEffectiveConfig(node, msg);
+  const { plan, commands } = handleStrategyInput(node, msg, config, doPlanning, calcSavings);
+  if (plan) {
+    const planFromTime = msg.payload.time ? DateTime.fromISO(msg.payload.time) : DateTime.now();
+    const currentOutput = node.context().get("currentOutput");
+    const plannedOutputNow =
+      node.override === "auto"
+        ? getOutputForTime(plan.schedule, planFromTime, node.outputIfNoSchedule)
+        : node.override === "on";
+    const outputCommands = {
+      sendOutput: shallSendOutput(
+        msg,
+        commands,
+        currentOutput,
+        plannedOutputNow,
+        node.sendCurrentValueWhenRescheduling
+      ),
+      sendSchedule: strategyShallSendSchedule(msg, commands),
+      runSchedule: commands.replan !== false && config.override === "auto",
+    };
+    handleOutput(node, config, plan, outputCommands, planFromTime);
+  }
+}
+
+module.exports = { strategyOnInput };

package/src/strategy-lowest-price.html

@@ -61,6 +61,24 @@
         required: true,
         align: "left",
       },
+      outputValueForOn: {
+        value: true,
+        required: true,
+        validate: RED.validators.typedInput("outputValueForOntype", false),
+      },
+      outputValueForOff: {
+        value: false,
+        required: true,
+        validate: RED.validators.typedInput("outputValueForOfftype", false),
+      },
+      outputValueForOntype: {
+        value: "bool",
+        required: true,
+      },
+      outputValueForOfftype: {
+        value: "bool",
+        required: true,
+      },
       outputIfNoSchedule: { value: "true", required: true, align: "left" },
       outputOutsidePeriod: { value: "false", required: true, align: "left" },
       contextStorage: { value: "default", required: false, align: "left" },
@@ -132,58 +150,78 @@
           },
         ],
       });
+      $("#node-input-outputValueForOn").typedInput({
+        default: "bool",
+        typeField: $("#node-input-outputValueForOntype"),
+        types: ["bool", "num", "str"],
+      });
+      $("#node-input-outputValueForOff").typedInput({
+        default: "bool",
+        typeField: $("#node-input-outputValueForOfftype"),
+        types: ["bool", "num", "str"],
+      });
     },
   });
 </script>
 
 <script type="text/html" data-template-name="ps-strategy-lowest-price">
-  <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" style="width: 240px">
-  </div>
-  <div class="form-row">
-      <label for="node-input-fromTime"><i class="fa fa-clock-o"></i> From time</label>
-      <input type="text" id="node-input-fromTime" style="width: 80px">
+    <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" style="width: 240px">
     </div>
-  <div class="form-row">
-      <label for="node-input-toTime"><i class="fa fa-clock-o"></i> To time</label>
-      <input type="text" id="node-input-toTime" style="width: 80px">
-  </div>
-  <div class="form-row">
-      <label for="node-input-hoursOn"><i class="fa fa-arrows-h"></i> Hours on</label>
-      <input type="text" id="node-input-hoursOn" style="width: 80px">
-  </div>
-  <div class="form-row">
-    <label for="node-input-maxPrice"><i class="fa fa-minus"></i> Max price</label>
-    <input type="text" id="node-input-maxPrice" placeholder="Max price" style="width: 80px">
-  </div>
-  <div class="form-row">
-      <label for="node-input-doNotSplit">Consecutive on-period</label>
-      <input type="checkbox" id="node-input-doNotSplit" style="display:inline-block; width:22px; vertical-align:top;">
-      </label>
-  </div>
     <div class="form-row">
-        <label for="node-input-sendCurrentValueWhenRescheduling" style="width:240px">
-        <input type="checkbox"
-               id="node-input-sendCurrentValueWhenRescheduling"
-               style="display:inline-block; width:22px; vertical-align:top;"
-               autocomplete="off"><span>Send when rescheduling</span>
-        </label>
+        <label for="node-input-fromTime"><i class="fa fa-clock-o"></i> From time</label>
+        <input type="text" id="node-input-fromTime" style="width: 80px">
+      </div>
+    <div class="form-row">
+        <label for="node-input-toTime"><i class="fa fa-clock-o"></i> To time</label>
+        <input type="text" id="node-input-toTime" style="width: 80px">
     </div>
     <div class="form-row">
-        <label for="node-input-outputIfNoSchedule">If no schedule, send</label>
-        <input type="text" id="node-input-outputIfNoSchedule" style="width: 80px">
-        </label>
+        <label for="node-input-hoursOn"><i class="fa fa-arrows-h"></i> Hours on</label>
+        <input type="text" id="node-input-hoursOn" style="width: 80px">
     </div>
     <div class="form-row">
-        <label for="node-input-outputIfNoSchedule">Outside period, send</label>
-        <input type="text" id="node-input-outputOutsidePeriod" style="width: 80px">
-        </label>
+      <label for="node-input-maxPrice"><i class="fa fa-minus"></i> Max price</label>
+      <input type="text" id="node-input-maxPrice" placeholder="Max price" style="width: 80px">
     </div>
     <div class="form-row">
-      <label for="node-input-contextStorage"><i class="fa fa-archive"></i> Context storage</label>
-      <input type="text" id="node-input-contextStorage" style="width: 160px">
+        <label for="node-input-doNotSplit">Consecutive on-period</label>
+        <input type="checkbox" id="node-input-doNotSplit" style="display:inline-block; width:22px; vertical-align:top;">
+        </label>
     </div>
+    <div class="form-row">
+      <label for="node-input-outputValueForOn">Output value for on</label>
+      <input type="text" id="node-input-outputValueForOn" style="text-align: left; width: 120px">
+      <input type="hidden" id="node-input-outputValueForOntype">
+  </div>
+  <div class="form-row">
+      <label for="node-input-outputValueForOff">Output value for off</label>
+      <input type="text" id="node-input-outputValueForOff" style="text-align: left; width: 120px">
+      <input type="hidden" id="node-input-outputValueForOfftype">
+  </div>
+    <div class="form-row">
+          <label for="node-input-sendCurrentValueWhenRescheduling" style="width:240px">
+          <input type="checkbox"
+                 id="node-input-sendCurrentValueWhenRescheduling"
+                 style="display:inline-block; width:22px; vertical-align:top;"
+                 autocomplete="off"><span>Send when rescheduling</span>
+          </label>
+      </div>
+      <div class="form-row">
+          <label for="node-input-outputIfNoSchedule">If no schedule, send</label>
+          <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="text" id="node-input-outputOutsidePeriod" style="width: 80px">
+          </label>
+      </div>
+      <div class="form-row">
+        <label for="node-input-contextStorage"><i class="fa fa-archive"></i> Context storage</label>
+        <input type="text" id="node-input-contextStorage" style="width: 160px">
+      </div>
 </script>
 
 <script type="text/markdown" data-help-name="ps-strategy-lowest-price">