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

package/doc/example-tibber-mqtt.md

@@ -1,189 +0,0 @@
-## Example with Tibber, a switch and MQTT
-
-In this example, data is read from Tibber and used to turn on/off a switch. Data is also sent to MQTT for being displayed on Magic Mirror. This is optional, of course.
-
-![Example with Tibber and MQTT](./power-saver-tibber-mqtt.png)
-
-Flow:
-
-```json
-[
-    {
-        "id": "467a5fe.d0bbba",
-        "type": "mqtt out",
-        "z": "d938c47f.3398f8",
-        "name": "Send switch to MM",
-        "topic": "powersaver/switch",
-        "qos": "0",
-        "retain": "false",
-        "broker": "24fbcfb5.569ea",
-        "x": 730,
-        "y": 120,
-        "wires": []
-    },
-    {
-        "id": "8c533305.eacaa",
-        "type": "power-saver",
-        "z": "d938c47f.3398f8",
-        "name": "Power Saver",
-        "maxHoursToSaveInSequence": "3",
-        "minHoursOnAfterMaxSequenceSaved": "1",
-        "minSaving": "0.001",
-        "sendCurrentValueWhenRescheduling": true,
-        "outputIfNoSchedule": "true",
-        "x": 490,
-        "y": 120,
-        "wires": [
-            [
-                "5e485ff7.db156",
-                "467a5fe.d0bbba"
-            ],
-            [
-                "9c978d1c.ee76",
-                "467a5fe.d0bbba"
-            ],
-            [
-                "42d8b632.402e38"
-            ]
-        ]
-    },
-    {
-        "id": "ab2d599a.077738",
-        "type": "tibber-query",
-        "z": "d938c47f.3398f8",
-        "name": "Get Tibber prices",
-        "active": true,
-        "apiEndpointRef": "b70ec5d0.6f8f08",
-        "x": 290,
-        "y": 120,
-        "wires": [
-            [
-                "8c533305.eacaa"
-            ]
-        ]
-    },
-    {
-        "id": "4f11b5ae.4cc22c",
-        "type": "inject",
-        "z": "d938c47f.3398f8",
-        "name": "Refresh",
-        "props": [
-            {
-                "p": "payload"
-            }
-        ],
-        "repeat": "3600",
-        "crontab": "",
-        "once": false,
-        "onceDelay": "1",
-        "topic": "",
-        "payload": "{   viewer {     homes {       currentSubscription{         priceInfo{           today {             total             startsAt           }           tomorrow {             total             startsAt           }         }       }     }   } }",
-        "payloadType": "str",
-        "x": 100,
-        "y": 120,
-        "wires": [
-            [
-                "ab2d599a.077738"
-            ]
-        ]
-    },
-    {
-        "id": "42d8b632.402e38",
-        "type": "mqtt out",
-        "z": "d938c47f.3398f8",
-        "name": "Send schedule to MM",
-        "topic": "powersaver/plan",
-        "qos": "0",
-        "retain": "true",
-        "broker": "24fbcfb5.569ea",
-        "x": 740,
-        "y": 220,
-        "wires": []
-    },
-    {
-        "id": "5e485ff7.db156",
-        "type": "api-call-service",
-        "z": "d938c47f.3398f8",
-        "name": "Turn on VVB",
-        "server": "ec4a12a1.b2be9",
-        "version": 1,
-        "debugenabled": false,
-        "service_domain": "switch",
-        "service": "turn_on",
-        "entityId": "switch.varmtvannsbereder_switch",
-        "data": "",
-        "dataType": "jsonata",
-        "mergecontext": "",
-        "output_location": "",
-        "output_location_type": "none",
-        "mustacheAltTags": false,
-        "x": 710,
-        "y": 60,
-        "wires": [
-            []
-        ]
-    },
-    {
-        "id": "9c978d1c.ee76",
-        "type": "api-call-service",
-        "z": "d938c47f.3398f8",
-        "name": "Turn off VVB",
-        "server": "ec4a12a1.b2be9",
-        "version": 1,
-        "debugenabled": true,
-        "service_domain": "switch",
-        "service": "turn_off",
-        "entityId": "switch.varmtvannsbereder_switch",
-        "data": "",
-        "dataType": "json",
-        "mergecontext": "",
-        "output_location": "",
-        "output_location_type": "none",
-        "mustacheAltTags": false,
-        "x": 710,
-        "y": 180,
-        "wires": [
-            []
-        ]
-    },
-    {
-        "id": "24fbcfb5.569ea",
-        "type": "mqtt-broker",
-        "name": "MQTT",
-        "broker": "10.0.0.15",
-        "port": "1883",
-        "clientid": "",
-        "usetls": false,
-        "compatmode": false,
-        "keepalive": "60",
-        "cleansession": true,
-        "birthTopic": "",
-        "birthQos": "0",
-        "birthPayload": "",
-        "closeTopic": "",
-        "closeQos": "0",
-        "closePayload": "",
-        "willTopic": "",
-        "willQos": "0",
-        "willPayload": ""
-    },
-    {
-        "id": "b70ec5d0.6f8f08",
-        "type": "tibber-api-endpoint",
-        "feedUrl": "wss://api.tibber.com/v1-beta/gql/subscriptions",
-        "queryUrl": "https://api.tibber.com/v1-beta/gql",
-        "name": "Tibber API"
-    },
-    {
-        "id": "ec4a12a1.b2be9",
-        "type": "server",
-        "name": "Home Assistant",
-        "legacy": false,
-        "addon": true,
-        "rejectUnauthorizedCerts": true,
-        "ha_boolean": "y|yes|true|on|home|open",
-        "connectionDelay": true,
-        "cacheJson": true
-    }
-]
-```

package/mostSavedStrategy.js

@@ -1,84 +0,0 @@
-"use strict";
-
-const { isOnOffSequencesOk, fillArray } = require("./utils");
-/**
- * Turn off the hours where you save most compared to the next hour on.
- *
- * @param {*} values Array of prices
- * @param {*} maxOffInARow Max number of hours that can be saved in a row
- * @param {*} minOnAfterMaxOffInARow Min number of hours that must be on after maxOffInARow is saved
- * @param {*} minSaving Minimum amount that must be saved in order to turn off
- * @param {*} lastValueDayBefore Value of the last hour the day before
- * @param {*} lastCountDayBefore Number of lastValueDayBefore in a row
- * @returns Array with same number of values as in values array, where true is on, false is off
- */
-module.exports = {
-  calculate: function (
-    values,
-    maxOffInARow,
-    minOnAfterMaxOffInARow,
-    minSaving,
-    lastValueDayBefore = undefined,
-    lastCountDayBefore = 0
-  ) {
-    const dayBefore = fillArray(lastValueDayBefore, lastCountDayBefore);
-    const last = values.length - 1;
-
-    // Create matrix with saving per hour
-    const savingPerHour = [];
-    for (let hour = 0; hour < last; hour++) {
-      const row = [];
-      for (let count = 1; count <= maxOffInARow; count++) {
-        const on = hour + count;
-        const saving = values[hour] - values[on >= last ? last : on];
-        row.push(saving);
-      }
-      savingPerHour.push(row);
-    }
-
-    // Create list with summary saving per sequence
-    let savingsList = [];
-    for (let hour = 0; hour < last; hour++) {
-      for (let count = 1; count <= maxOffInARow; count++) {
-        let saving = 0;
-        for (let offset = 0; offset < count && hour + offset < last; offset++) {
-          saving += savingPerHour[hour + offset][count - offset - 1];
-        }
-        if (
-          saving > minSaving * count &&
-          hour + count <= last &&
-          values[hour] > values[hour + count] + minSaving
-        ) {
-          savingsList.push({ hour, count, saving });
-        }
-      }
-    }
-
-    savingsList.sort((a, b) => b.saving - a.saving);
-    let onOff = values.map((v) => true); // Start with all on
-
-    // Find the best possible sequences
-    while (savingsList.length > 0) {
-      const { hour, count } = savingsList[0];
-      const onOffCopy = [...onOff];
-      for (let c = 0; c < count; c++) {
-        onOff[hour + c] = false;
-      }
-      if (
-        isOnOffSequencesOk(
-          [...dayBefore, ...onOff],
-          maxOffInARow,
-          minOnAfterMaxOffInARow
-        )
-      ) {
-        savingsList = savingsList.filter(
-          (s) => s.hour < hour || s.hour >= hour + count
-        );
-      } else {
-        onOff = [...onOffCopy];
-        savingsList.splice(0, 1);
-      }
-    }
-    return onOff;
-  },
-};

package/power-saver.html

@@ -1,308 +0,0 @@
-<script type="text/javascript">
-  RED.nodes.registerType("power-saver", {
-    category: "function",
-    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="boolean" 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="boolean" id="node-input-outputIfNoSchedule" style="width: 80px">
-        </label>
-    </div>
-</script>
-
-<script type="text/html" data-help-name="power-saver">
-          <p>A node you can use to save money by turning off and on a switch based on power prices.</p>
-          <p>You can use it to control for example a heater, a water heater or any other power consumer that is
-            acceptable to turn off now and then.</p>
-          <p>It is designed to be used with Home Assistant, but can also be used without.
-            Prices can be supplied by the
-            <a href="https://github.com/custom-components/nordpool">nordpool</a> custom component,
-            by a Tibber query or by any other means that can produce data in a valid format.</p>
-          <h3>Configuration</h3>
-            <p>
-                <strong>Max per sequence</strong> is the maximum number of hours that can be saved (turned off) in a sequence.
-            </p>
-            <p>
-                <strong>Min recover</strong> If power is saved the maximum number of hours that is allowed (Max per sequence),
-                it must be followed by a period of not saving power that is minimum <em>Min recover</em> hours.
-            </p>
-            <p>
-                <strong>Min saving</strong> The minimum price that must be saved per kWh per hour, in order to turn off an hour.
-                For a sequence of multiple hours, the average per hour is evaluated against this value.
-            </p>
-            <p>
-              You can select to <strong>Schedule for</strong> either the whole data set
-              or just from the current time when the schedule is calculated.
-            </p>
-            <p>
-                Check <strong>Send when rescheduling</strong> to make sure the correct value for the current
-                time is sent on output 1 or output 2,
-                when a new schedule is calculated. The new schedule is sent to output 3 anyway.
-            </p>
-            <p>
-                <strong>If no schedule, send</strong> Select if the output shall be set to on or off when there is no valid schedule.
-                If you control a water heater or control heat in a room, selecting "on" is recommended.
-            </p>
-          <h3>Input</h3>
-          <dl class="message-properties">
-              <dt>payload
-                  <span class="property-type">object</span>
-              </dt>
-              <dd>The payload should be an object with two arrays: <code>raw_today</code> and <code>raw_tomorrow</code>.
-                  Each array shall contain one object per hour, with attributes start, end and value.
-                  <br>
-                  The <code>raw_today</code> and <code>raw_tomorrow</code> may alternatively be in the
-                  <code>data.new_state.attributes</code> part of the message.
-                  This is exactly what is delivered by the sensor given by the nordpool custom component,
-                  so just put the output from that sensor to the input of this node.
-              </dd>
-          </dl>
-
-       <h3>Outputs</h3>
-           <ol class="node-ports">
-               <li>Output 1
-                   <dl class="message-properties">
-                       <dt>payload <span class="property-type">string</span></dt>
-                       <dd>A payload containing <code>true</code> is sent to this output when the power shall be turned on.</dd>
-                   </dl>
-               </li>
-               <li>Output 2
-                   <dl class="message-properties">
-                       <dt>payload <span class="property-type">string</span></dt>
-                       <dd>A payload containing <code>false</code> is sent to this output when the power shall be turned off.</dd>
-                   </dl>
-               </li>
-               <li>Output 3
-                   <dl class="message-properties">
-                       <dt>payload <span class="property-type">string</span></dt>
-                       <dd>When the schedule is created or changed, a payload containing information about the schedule is sent to this output.</dd>
-                   </dl>
-               </li>
-           </ol>
-
-      <h3>Details</h3>
-      <p>
-        Set up the Home Assistants <em>events: state</em> node to receive state changes on the nordpool sensor.
-        Example of entity id: <code>sensor.nordpool_kwh_trheim_nok_3_095_025</code>, but you must check what your sensor id is.
-      </p>
-      <p>
-        Connect the nordpool sensor output directly to the input on this node. Connect output 1 to a node that can turn the power switch on,
-        and output 2 to a node that can turn the power switch off. The values are true and false,
-        so they may be connected to the same node, and use the value to turn on or off.
-      </p>
-      <p>You may use output 3 to display the schedule.</p>
-          <p><strong>Input payload example</strong><br/>
-              <pre>
-      {
-        raw_today:[
-          {
-            start: "2021-06-20T00:00:00+02:00",
-            end: "2021-06-20T01:00:00+02:00",
-            value: 0.37,
-          },
-          {
-            start: "2021-06-20T01:00:00+02:00",
-            end: "2021-06-20T02:00:00+02:00",
-            value: 0.4,
-          },
-          {
-            start: "2021-06-20T02:00:00+02:00",
-            end: "2021-06-20T03:00:00+02:00",
-            value: 0.35,
-          },
-          {
-            start: "2021-06-20T03:00:00+02:00",
-            end: "2021-06-20T04:00:00+02:00",
-            value: 0.65,
-          },
-          // One entry per hour, 24 hours
-        ],
-        raw_tomorrow: [
-          {
-            start: "2021-06-20T00:00:00+02:00",
-            end: "2021-06-21T01:00:00+02:00",
-            value: 1.5,
-          },
-          {
-              start: "2021-06-21T01:00:00+02:00",
-              end: "2021-06-21T02:00:00+02:00",
-              value: 1.4,
-          },
-          {
-              start: "2021-06-21T02:00:00+02:00",
-              end: "2021-06-21T03:00:00+02:00",
-              value: 0.8,
-          },
-          // One entry per hour, 24 hours
-        ],
-      };
-              </pre>
-          </p>
-          <p><strong>Output 3 payload example</strong><br/>
-              <pre>
-  {
-    "schedule": [
-      {
-        "time": "2021-09-30T00:00:00.000+02:00",
-        "value": false
-      },
-      {
-        "time": "2021-09-30T01:00:00.000+02:00",
-        "value": true
-      },
-      {
-        "time": "2021-09-30T02:00:00.000+02:00",
-        "value": true
-      },
-      ...
-    ],
-    "hours": [
-      {
-        "price": 1.2584,
-        "onOff": false,
-        "start": "2021-09-30T00:00:00.000+02:00",
-        "saving": 0.2034
-      },
-      {
-        "price": 1.0550,
-        "onOff": true,
-        "start": "2021-09-30T01:00:00.000+02:00",
-        "saving": null
-      },
-      {
-        "price": 1.2054,
-        "onOff": true,
-        "start": "2021-09-30T02:00:00.000+02:00",
-        "saving": null
-      },
-      ...
-    ]
-  }
-
-              </pre>
-          </p>
-          <p>
-            The <code>value</code> in <code>schedule</code> is <code>true</code> to turn on and <code>false</code> to turn off.
-          </p>
-          <p>
-            The <code>savings</code> array shows the price per kWh saved that hour, only for hours that are turned off.
-            Hours that are turned on has <code>null</code> as saving.
-          </p>
-      <h3>Algorithm</h3>
-      <p>
-        Currently there is only one algorithm / strategy for saving power. It is the <strong>most saved</strong> strategy.
-        In this strategy it is assumed that when the power has been off for some time, the consumer will catch up by consuming
-        power as soon as the power is turned on again. Based on this assumption, the algorithm will turn off those hours
-        that has the highest difference between the hour that is off and the next hour that is on, and by this, turn off
-        the hours where it is most to save. This would be a good fit for turning off a heater controlled by a thermostat.
-      </p>
-      <p>
-        Other strategies are planned, but not yet implemented.
-      </p>
-      <h3>References</h3>
-          <ul>
-              <li><a href="https://github.com/ottopaulsen/node-red-contrib-power-saver">
-                  node-red-contrib-power-saver</a>  on GitHub</li>
-              <li>The <a href="https://github.com/custom-components/nordpool">
-                  nordpool</a>  custom component for Home Assistant</li>
-          </ul>
-</script>