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

package/src/power-saver.html

@@ -1,116 +0,0 @@
-<script type="text/javascript">
-  RED.nodes.registerType("power-saver", {
-    category: "Power Saver",
-    color: "#a6bbcf",
-    defaults: {
-      name: { value: "Power Saver" },
-      maxHoursToSaveInSequence: {
-        value: 3,
-        required: true,
-        validate: RED.validators.number(),
-      },
-      minHoursOnAfterMaxSequenceSaved: {
-        value: 2,
-        required: true,
-        validate: RED.validators.number(),
-      },
-      minSaving: {
-        value: 0.01,
-        required: true,
-        validate: RED.validators.number(),
-      },
-      sendCurrentValueWhenRescheduling: {
-        value: true,
-        required: true,
-        // validate: RED.validators.number(),
-        align: "left",
-      },
-      outputIfNoSchedule: { value: "true", required: true, align: "left" },
-      scheduleOnlyFromCurrentTime: {
-        value: "true",
-        required: true,
-        align: "left",
-      },
-    },
-    inputs: 1,
-    outputs: 3,
-    icon: "font-awesome/fa-eur",
-    color: "#FFCC66",
-    label: function () {
-      return this.name || "Power Saver";
-    },
-    outputLabels: ["on", "off", "schedule"],
-    oneditprepare: function () {
-      $("#node-input-outputIfNoSchedule").typedInput({
-        types: [
-          {
-            value: "onoff",
-            options: [
-              { value: "true", label: "On" },
-              { value: "false", label: "Off" },
-            ],
-          },
-        ],
-      });
-      $("#node-input-scheduleOnlyFromCurrentTime").typedInput({
-        types: [
-          {
-            value: "nowOrStart",
-            options: [
-              { value: "false", label: "Whole data set" },
-              { value: "true", label: "From current hour" },
-            ],
-          },
-        ],
-      });
-    },
-  });
-</script>
-
-<script type="text/html" data-template-name="power-saver">
-    <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>Rules</h3>
-    <div class="form-row">
-        <label for="node-input-maxHoursToSaveInSequence"><i class="fa fa-arrows-h"></i> Max per sequence</label>
-        <input type="text" id="node-input-maxHoursToSaveInSequence" style="width: 80px" placeholder="Max hours to save in sequence">
-    </div>
-    <div class="form-row">
-        <label for="node-input-minHoursOnAfterMaxSequenceSaved"><i class="fa fa-ellipsis-h"></i> Min recover</label>
-        <input type="text"
-               id="node-input-minHoursOnAfterMaxSequenceSaved"
-               style="width: 80px"
-               placeholder="Min hours on after a max sequence">
-    </div>
-    <div class="form-row">
-        <label for="node-input-minSaving"><i class="fa fa-eur"></i> Min saving</label>
-        <input type="text" id="node-input-minSaving" placeholder="Minimum to save for turning off" style="width: 80px">
-    </div>
-    <div class="form-row">
-      <label for="node-input-scheduleOnlyFromCurrentTime">Schedule for</label>
-      <input type="text" id="node-input-scheduleOnlyFromCurrentTime" style="width: 160px">
-      </label>
-  </div>
-  <h3>Output</h3>
-    <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>
-</script>
-
-<script type="text/markdown" data-help-name="power-saver">
-  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/power-saver)
-</script>

package/src/power-saver.js

@@ -1,260 +0,0 @@
-const { DateTime } = require("luxon");
-const {
-  countAtEnd,
-  extractPlanForDate,
-  getDiff,
-  getEffectiveConfig,
-  getSavings,
-  getStartAtIndex,
-  loadDayData,
-  makeSchedule,
-  validationFailure,
-} = require("./utils");
-const { convertMsg } = require("./receive-price-functions");
-const { calculate } = require("./strategy-best-save-functions");
-
-let schedulingTimeout = null;
-
-module.exports = function (RED) {
-  function PowerSaverNode(config) {
-    RED.nodes.createNode(this, config);
-    const node = this;
-
-    const originalConfig = {
-      maxHoursToSaveInSequence: config.maxHoursToSaveInSequence,
-      minHoursOnAfterMaxSequenceSaved: config.minHoursOnAfterMaxSequenceSaved,
-      minSaving: parseFloat(config.minSaving),
-      sendCurrentValueWhenRescheduling: config.sendCurrentValueWhenRescheduling,
-      outputIfNoSchedule: config.outputIfNoSchedule === "true",
-      scheduleOnlyFromCurrentTime: config.scheduleOnlyFromCurrentTime === "true",
-    };
-    node.context().set("config", originalConfig);
-
-    node.on("close", function () {
-      clearTimeout(schedulingTimeout);
-    });
-
-    node.on("input", function (msg) {
-      const effectiveConfig = getEffectiveConfig(node, msg);
-      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
-      Object.keys(effectiveConfig).forEach((key) => (node[key] = effectiveConfig[key]));
-
-      clearTimeout(schedulingTimeout);
-
-      const dates = [...new Set(priceData.map((v) => DateTime.fromISO(v.start).toISODate()))];
-
-      // Load data from day before
-      const dateToday = DateTime.fromISO(dates[0]);
-      const dateDayBefore = DateTime.fromISO(dates[0]).plus({ days: -1 });
-
-      // Make plan
-      const startAtIndex = getStartAtIndex(effectiveConfig, priceData, planFromTime);
-      const dataJustBefore = loadDataJustBefore(node, dateDayBefore, dateToday, startAtIndex);
-      const values = priceData.map((d) => d.value).slice(startAtIndex);
-      const startTimes = priceData.map((d) => d.start).slice(startAtIndex);
-      const onOffBefore = dataJustBefore.hours.map((h) => h.onOff);
-      const lastPlanHours = node.context().get("lastPlan")?.hours ?? [];
-      const plan = makePlan(node, values, startTimes, onOffBefore);
-      const includeFromLastPlanHours = lastPlanHours.filter(
-        (h) => h.start < plan.hours[0].start && h.start >= priceData[0].start
-      );
-      adjustSavingsPassedHours(plan, includeFromLastPlanHours);
-      plan.hours.splice(0, 0, ...includeFromLastPlanHours);
-
-      // Save schedule
-      node.context().set("lastPlan", plan);
-      dates.forEach((d) => saveDayData(node, d, extractPlanForDate(plan, d)));
-
-      // Prepare output
-      let output1 = null;
-      let output2 = null;
-      let output3 = {
-        payload: {
-          schedule: plan.schedule,
-          hours: plan.hours,
-          source: priceData.source,
-          config: effectiveConfig,
-        },
-      };
-
-      // 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 currentValue = pastSchedule[pastSchedule.length - 1].value;
-        output1 = currentValue ? { payload: true } : null;
-        output2 = currentValue ? null : { payload: false };
-      }
-
-      // Delete old data
-      deleteSavedScheduleBefore(node, dateDayBefore);
-
-      // Send output
-      node.send([output1, output2, output3]);
-
-      // Run schedule
-      schedulingTimeout = runSchedule(node, plan.schedule, planFromTime);
-    });
-  }
-
-  RED.nodes.registerType("power-saver", PowerSaverNode);
-};
-
-function adjustSavingsPassedHours(plan, includeFromLastPlanHours) {
-  const firstOnIndex = plan.hours.findIndex((h) => h.onOff);
-  if (firstOnIndex < 0) {
-    return;
-  }
-  const nextOnValue = plan.hours[firstOnIndex].price;
-  let adjustIndex = includeFromLastPlanHours.length - 1;
-  while (adjustIndex >= 0 && !includeFromLastPlanHours[adjustIndex].onOff) {
-    includeFromLastPlanHours[adjustIndex].saving = getDiff(includeFromLastPlanHours[adjustIndex].price, nextOnValue);
-    adjustIndex--;
-  }
-}
-
-function getPriceData(node, msg) {
-  const isConfigMsg = !!msg?.payload?.config;
-  if (isConfigMsg) {
-    return node.context().get("lastPriceData");
-  }
-
-  if (!validateMsg(node, msg)) {
-    return null;
-  }
-  const input = convertMsg(msg);
-  if (!validateInput(node, input)) {
-    return null;
-  }
-
-  priceData = [...input.today, ...input.tomorrow];
-  priceData.source = input.source;
-  node.context().set("lastPriceData", priceData);
-  return priceData;
-}
-
-function loadDataJustBefore(node, dateDayBefore, dateToday, startAtIndex) {
-  const dataDayBefore = loadDayData(node, dateDayBefore);
-  const dataToday = loadDayData(node, dateToday);
-  return {
-    schedule: [...dataDayBefore.schedule, ...dataToday.schedule.slice(0, startAtIndex)],
-    hours: [...dataDayBefore.hours, ...dataToday.hours.slice(0, startAtIndex)],
-  };
-}
-
-function saveDayData(node, date, plan) {
-  node.context().set(date, plan);
-}
-
-function deleteSavedScheduleBefore(node, day) {
-  let date = day;
-  do {
-    date = date.plus({ days: -1 });
-    data = node.context().set(date.toISO(), undefined);
-  } while (data);
-}
-
-function makePlan(node, values, startTimes, onOffBefore, firstValueNextDay) {
-  const strategy = "mostSaved"; // TODO: Get from node settings
-  const lastValueDayBefore = onOffBefore[onOffBefore.length - 1];
-  const lastCountDayBefore = countAtEnd(onOffBefore, lastValueDayBefore);
-  const onOff =
-    strategy === "mostSaved"
-      ? calculate(
-          values,
-          node.maxHoursToSaveInSequence,
-          node.minHoursOnAfterMaxSequenceSaved,
-          node.minSaving,
-          lastValueDayBefore,
-          lastCountDayBefore
-        )
-      : [];
-
-  const schedule = makeSchedule(onOff, startTimes, lastValueDayBefore);
-  const savings = getSavings(values, onOff, firstValueNextDay);
-  const hours = values.map((v, i) => ({
-    price: v,
-    onOff: onOff[i],
-    start: startTimes[i],
-    saving: savings[i],
-  }));
-  return {
-    hours,
-    schedule,
-  };
-}
-
-function validateMsg(node, msg) {
-  if (!msg.payload && !msg.data?.new_state?.attributes) {
-    validationFailure(node, "Payload missing");
-    return false;
-  }
-  const payload = msg.data?.new_state?.attributes ?? msg.data?.attributes ?? msg.payload;
-  if (typeof payload !== "object") {
-    validationFailure(node, "Payload must be an object");
-    return false;
-  }
-  return true;
-}
-
-function validateInput(node, input) {
-  ["today", "tomorrow"].forEach((arr) => {
-    if (
-      input[arr].some((day) => {
-        return day.start === undefined || day.value === undefined;
-      })
-    ) {
-      validationFailure(node, `Malformed entries in payload.${arr}. All entries must contain start and value.`);
-    }
-  });
-  if (!input.today.length && !input.tomorrow.length) {
-    validationFailure(node, "Payload has no data");
-    return false;
-  }
-
-  return true;
-}
-
-/**
- * Start a timer until the next time in the schedule.
- * When the time is out, send the relaed value and start timer for next time.
- * @param {*} node
- * @param {*} schedule
- * @param {*} time
- */
-function runSchedule(node, schedule, time) {
-  let currentTime = time;
-  let remainingSchedule = schedule.filter((entry) => DateTime.fromISO(entry.time) > time);
-  if (remainingSchedule.length > 0) {
-    const entry = remainingSchedule[0];
-    const nextTime = DateTime.fromISO(entry.time);
-    const wait = nextTime - currentTime;
-    const onOff = entry.value ? "on" : "off";
-    node.log("Switching " + onOff + " in " + wait + " milliseconds");
-    const statusMessage = `Scheduled ${remainingSchedule.length} changes. Next: ${
-      remainingSchedule[0].value ? "on" : "off"
-    }`;
-    node.status({ fill: "green", shape: "dot", text: statusMessage });
-    return setTimeout(() => {
-      sendSwitch(node, entry.value);
-      schedulingTimeout = runSchedule(node, remainingSchedule, nextTime);
-    }, wait);
-  } else {
-    const message = "No schedule";
-    node.warn(message);
-    node.status({ fill: "red", shape: "dot", text: message });
-    sendSwitch(node, node.outputIfNoSchedule);
-  }
-}
-
-function sendSwitch(node, onOff) {
-  const output1 = onOff ? { payload: true } : null;
-  const output2 = onOff ? null : { payload: false };
-  node.send([output1, output2, null]);
-}

package/test/commands-input.test.js

@@ -1,47 +0,0 @@
-const expect = require("expect");
-const helper = require("node-red-node-test-helper");
-const bestSave = require("../src/strategy-best-save.js");
-const prices = require("./data/converted-prices.json");
-const result = require("./data/best-save-result.json");
-const { testPlan, equalPlan } = require("./test-utils");
-const { makeFlow, makePayload } = require("./strategy-best-save-test-utils");
-
-helper.init(require.resolve("node-red"));
-
-describe("send command as input", () => {
-  beforeEach(function (done) {
-    helper.startServer(done);
-  });
-
-  afterEach(function (done) {
-    helper.unload().then(function () {
-      helper.stopServer(done);
-    });
-  });
-
-  it("should send output on command", function (done) {
-    const flow = makeFlow(3, 2, true);
-    let pass = 1;
-    helper.load(bestSave, flow, function () {
-      const n1 = helper.getNode("n1");
-      const n2 = helper.getNode("n2");
-      n1.sendCurrentValueWhenRescheduling = true;
-      n2.on("input", function (msg) {
-        switch (pass) {
-          case 1:
-            pass++;
-            expect(equalPlan(result, msg.payload)).toBeTruthy();
-            expect(msg.payload.sentOnCommand).toBeFalsy();
-            n1.receive({ payload: { commands: { sendSchedule: true } } });
-            break;
-          case 2:
-            expect(equalPlan(result, msg.payload)).toBeTruthy();
-            expect(msg.payload.sentOnCommand).toBeTruthy();
-            done();
-            break;
-        }
-      });
-      n1.receive({ payload: makePayload(prices, testPlan.time) });
-    });
-  });
-});

package/test/power-saver.test.js

@@ -1,189 +0,0 @@
-const cloneDeep = require("lodash.clonedeep");
-const expect = require("expect");
-const helper = require("node-red-node-test-helper");
-const powerSaver = require("../src/power-saver.js");
-
-const prices = require("./data/prices");
-const result = require("./data/result");
-const { testPlan: plan, makePayload } = require("./test-utils");
-
-helper.init(require.resolve("node-red"));
-
-describe("power-saver Node", function () {
-  beforeEach(function (done) {
-    helper.startServer(done);
-  });
-
-  afterEach(function (done) {
-    helper.unload().then(function () {
-      helper.stopServer(done);
-    });
-  });
-
-  it("should be loaded", function (done) {
-    const flow = [{ id: "n1", type: "power-saver", name: "test name" }];
-    helper.load(powerSaver, flow, function () {
-      const n1 = helper.getNode("n1");
-      expect(n1).toHaveProperty("name", "test name");
-      done();
-    });
-  });
-
-  it("should log error when illegal data is received", function (done) {
-    const flow = [{ id: "n1", type: "power-saver", name: "test name" }];
-    helper.load(powerSaver, flow, function () {
-      const n1 = helper.getNode("n1");
-      n1.receive({});
-      n1.warn.should.be.calledWithExactly("Payload missing");
-      n1.receive({ payload: "Error" });
-      n1.warn.should.be.calledWithExactly("Payload must be an object");
-      n1.receive({ payload: { today: [], tomorrow: [] } });
-      n1.warn.should.be.calledWithExactly("Payload has no data");
-
-      ["start", "value"].forEach((attr) => {
-        const testData1 = {
-          today: cloneDeep(prices.today),
-          tomorrow: cloneDeep(prices.tomorrow),
-        };
-        delete testData1.today[3][attr];
-        n1.receive({ payload: testData1 });
-        n1.warn.should.be.calledWithExactly(
-          "Malformed entries in payload.today. All entries must contain start and value."
-        );
-      });
-
-      n1.receive({ payload: cloneDeep(prices) });
-      n1.warn.should.not.be.called;
-      done();
-    });
-  });
-  it("should send new schedule on output 3", function (done) {
-    const flow = makeFlow(3, 2);
-    helper.load(powerSaver, 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).toHaveProperty("payload", result);
-        n1.warn.should.not.be.called;
-        done();
-      });
-      n3.on("input", function (msg) {
-        expect(msg).toHaveProperty("payload", true);
-      });
-      n4.on("input", function (msg) {
-        expect(msg).toHaveProperty("payload", false);
-      });
-      n1.receive({ payload: makePayload(prices, plan.time) });
-    });
-  });
-
-  it("can schedule one day", function (done) {
-    const values = [1, 1, 1, 1, 1, 1, 1, 5, 4, 3];
-    const schedule = [
-      {
-        time: "2021-06-20T01:50:00.000+02:00",
-        value: true,
-        countHours: 7,
-      },
-      {
-        time: "2021-06-20T01:50:00.070+02:00",
-        value: false,
-        countHours: 2,
-      },
-      {
-        time: "2021-06-20T01:50:00.090+02:00",
-        value: true,
-        countHours: 1,
-      },
-    ];
-    const flow = makeFlow(4, 2);
-    helper.load(powerSaver, flow, function () {
-      const n1 = helper.getNode("n1");
-      const n2 = helper.getNode("n2");
-      n2.on("input", function (msg) {
-        expect(msg.payload).toHaveProperty("schedule", schedule);
-        n1.warn.should.not.be.called;
-        done();
-      });
-      const mPrices = cloneDeep(prices);
-      delete mPrices.tomorrow;
-      for (i = 0; i < mPrices.today.length; i++) {
-        mPrices.today[i].value = values[i];
-      }
-      const payload = makePayload(mPrices, plan.time);
-      n1.receive({ payload });
-    });
-  });
-
-  it("should schedule over midnight", function (done) {
-    const values1 = [1, 1, 1, 1, 1, 1, 1, 5, 4, 3];
-    const values2 = [2, 1, 5, 5, 5, 5, 5, 5, 5, 5];
-    const schedule = [
-      {
-        time: "2021-06-20T01:50:00.000+02:00",
-        value: true,
-        countHours: 7,
-      },
-      {
-        time: "2021-06-20T01:50:00.070+02:00",
-        value: false,
-        countHours: 4,
-      },
-      {
-        time: "2021-06-20T01:50:00.110+02:00",
-        value: true,
-        countHours: 9,
-      },
-    ];
-    const flow = makeFlow(4, 2);
-    helper.load(powerSaver, flow, function () {
-      const n1 = helper.getNode("n1");
-      const n2 = helper.getNode("n2");
-      n2.on("input", function (msg) {
-        expect(msg.payload).toHaveProperty("schedule", schedule);
-        n1.warn.should.not.be.called;
-        done();
-      });
-      const mPrices = cloneDeep(prices);
-      for (i = 0; i < mPrices.today.length; i++) {
-        mPrices.today[i].value = values1[i];
-        mPrices.tomorrow[i].value = values2[i];
-      }
-      const payload = makePayload(mPrices, plan.time);
-      n1.receive({ payload });
-    });
-  });
-  it("works for Tibber data", function (done) {
-    const tibberData = require("./data/tibber-prices.json");
-    const tibberResult = require("./data/tibber-result.json");
-    const flow = makeFlow(4, 2);
-    helper.load(powerSaver, flow, function () {
-      const n1 = helper.getNode("n1");
-      const n2 = helper.getNode("n2");
-      n2.on("input", function (msg) {
-        expect(msg).toHaveProperty("payload", tibberResult);
-        done();
-      });
-      n1.receive({ ...tibberData });
-    });
-  });
-});
-
-function makeFlow(maxHoursToSaveInSequence, minHoursOnAfterMaxSequenceSaved) {
-  return [
-    {
-      id: "n1",
-      type: "power-saver",
-      name: "test name",
-      maxHoursToSaveInSequence,
-      minHoursOnAfterMaxSequenceSaved,
-      minSaving: 0.001,
-      wires: [["n3"], ["n4"], ["n2"]],
-    },
-    { id: "n2", type: "helper" },
-    { id: "n3", type: "helper" },
-    { id: "n4", type: "helper" },
-  ];
-}