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

package/docs/examples/example-nordpool-current-state.md

@@ -0,0 +1,166 @@
+# Nord Pool and current state node
+
+## Description
+
+In this example, data is read from the Nord Pool sensor in HA via the `current state` node. The `ps-best-save` node is used to control a water heater via a switch, controlled by `call service` nodes in Home Assistant. The schedule is printed to a debug node. An `inject` node is used to trigger the reading of the Nord Pool sensor every hour.
+
+![Example with Tibber and MQTT](../images/power-saver-nordpool-current-state.png)
+
+## Flow
+
+```json:no-line-numbers
+[
+  {
+    "id": "e2578f6a.210a8",
+    "type": "debug",
+    "z": "d938c47f.3398f8",
+    "name": "Nord Pool result",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "targetType": "full",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 820,
+    "y": 440,
+    "wires": []
+  },
+  {
+    "id": "48bcdcca.fe42a4",
+    "type": "api-current-state",
+    "z": "d938c47f.3398f8",
+    "name": "Read Nord Pool",
+    "server": "ec4a12a1.b2be9",
+    "version": 2,
+    "outputs": 1,
+    "halt_if": "",
+    "halt_if_type": "str",
+    "halt_if_compare": "is",
+    "entity_id": "sensor.nordpool_kwh_trheim_nok_3_095_025",
+    "state_type": "str",
+    "blockInputOverrides": false,
+    "outputProperties": [
+      {
+        "property": "payload",
+        "propertyType": "msg",
+        "value": "",
+        "valueType": "entityState"
+      },
+      {
+        "property": "payload",
+        "propertyType": "msg",
+        "value": "",
+        "valueType": "entity"
+      }
+    ],
+    "x": 280,
+    "y": 380,
+    "wires": [["428d7c7ca88db95f"]]
+  },
+  {
+    "id": "97cc8e58.4247a",
+    "type": "inject",
+    "z": "d938c47f.3398f8",
+    "name": "",
+    "props": [
+      {
+        "p": "payload"
+      },
+      {
+        "p": "topic",
+        "vt": "str"
+      }
+    ],
+    "repeat": "3600",
+    "crontab": "",
+    "once": true,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payloadType": "date",
+    "x": 110,
+    "y": 380,
+    "wires": [["48bcdcca.fe42a4"]]
+  },
+  {
+    "id": "a6f2769b.1a62a8",
+    "type": "api-call-service",
+    "z": "d938c47f.3398f8",
+    "name": "Turn on VVB",
+    "server": "ec4a12a1.b2be9",
+    "version": 3,
+    "debugenabled": false,
+    "service_domain": "switch",
+    "service": "turn_on",
+    "entityId": "switch.varmtvannsbereder_switch",
+    "data": "",
+    "dataType": "jsonata",
+    "mergecontext": "",
+    "mustacheAltTags": false,
+    "outputProperties": [],
+    "queue": "none",
+    "x": 810,
+    "y": 320,
+    "wires": [[]]
+  },
+  {
+    "id": "9fc75126.65dd3",
+    "type": "api-call-service",
+    "z": "d938c47f.3398f8",
+    "name": "Turn off VVB",
+    "server": "ec4a12a1.b2be9",
+    "version": 3,
+    "debugenabled": true,
+    "service_domain": "switch",
+    "service": "turn_off",
+    "entityId": "switch.varmtvannsbereder_switch",
+    "data": "",
+    "dataType": "json",
+    "mergecontext": "",
+    "mustacheAltTags": false,
+    "outputProperties": [],
+    "queue": "none",
+    "x": 810,
+    "y": 360,
+    "wires": [[]]
+  },
+  {
+    "id": "428d7c7ca88db95f",
+    "type": "ps-receive-price",
+    "z": "d938c47f.3398f8",
+    "name": "Price Receiver",
+    "x": 460,
+    "y": 380,
+    "wires": [["4147bf0b99fe626f"]]
+  },
+  {
+    "id": "4147bf0b99fe626f",
+    "type": "ps-strategy-best-save",
+    "z": "d938c47f.3398f8",
+    "name": "Best Save",
+    "maxHoursToSaveInSequence": "4",
+    "minHoursOnAfterMaxSequenceSaved": "1",
+    "minSaving": "0.03",
+    "sendCurrentValueWhenRescheduling": true,
+    "outputIfNoSchedule": "true",
+    "scheduleOnlyFromCurrentTime": "false",
+    "x": 630,
+    "y": 380,
+    "wires": [["a6f2769b.1a62a8"], ["9fc75126.65dd3"], ["e2578f6a.210a8"]]
+  },
+  {
+    "id": "ec4a12a1.b2be9",
+    "type": "server",
+    "name": "Home Assistant",
+    "version": 2,
+    "addon": true,
+    "rejectUnauthorizedCerts": true,
+    "ha_boolean": "y|yes|true|on|home|open",
+    "connectionDelay": true,
+    "cacheJson": true,
+    "heartbeat": false,
+    "heartbeatInterval": 30
+  }
+]
+```

package/docs/examples/example-nordpool-events-state.md

@@ -0,0 +1,170 @@
+# Nord Pool and events: state node
+
+## Description
+
+In this example, data is read from the Nord Pool sensor in HA via the `events: state` node. The `ps-lowest-price` node is used to control a switch, controlled by `call service` nodes in Home Assistant, to turn on the cheapest 4 hours between 18:00 and 08:00. The schedule is printed to a debug node. The flow is triggered every time the Nord Pool sensor receives new prices.
+
+![Example with Tibber and MQTT](../images/power-saver-nordpool-events-state.png)
+
+## Flow
+
+```json:no-line-numbers
+[
+  {
+    "id": "3662aca5.dfe974",
+    "type": "server-state-changed",
+    "z": "d938c47f.3398f8",
+    "name": "Nord Pool sensor",
+    "server": "ec4a12a1.b2be9",
+    "version": 3,
+    "exposeToHomeAssistant": false,
+    "haConfig": [
+      {
+        "property": "name",
+        "value": ""
+      },
+      {
+        "property": "icon",
+        "value": ""
+      }
+    ],
+    "entityidfilter": "sensor.nordpool_kwh_trheim_nok_3_095_025",
+    "entityidfiltertype": "exact",
+    "outputinitially": true,
+    "state_type": "str",
+    "haltifstate": "",
+    "halt_if_type": "str",
+    "halt_if_compare": "is",
+    "outputs": 1,
+    "output_only_on_state_change": true,
+    "for": 0,
+    "forType": "num",
+    "forUnits": "minutes",
+    "ignorePrevStateNull": false,
+    "ignorePrevStateUnknown": false,
+    "ignorePrevStateUnavailable": false,
+    "ignoreCurrentStateUnknown": false,
+    "ignoreCurrentStateUnavailable": false,
+    "outputProperties": [
+      {
+        "property": "payload",
+        "propertyType": "msg",
+        "value": "",
+        "valueType": "entityState"
+      },
+      {
+        "property": "data",
+        "propertyType": "msg",
+        "value": "",
+        "valueType": "eventData"
+      },
+      {
+        "property": "topic",
+        "propertyType": "msg",
+        "value": "",
+        "valueType": "triggerId"
+      }
+    ],
+    "x": 120,
+    "y": 620,
+    "wires": [["e21a4b49adea2350"]]
+  },
+  {
+    "id": "ed7202ff.b5725",
+    "type": "debug",
+    "z": "d938c47f.3398f8",
+    "name": "Nord Pool result",
+    "active": false,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "targetType": "full",
+    "statusVal": "",
+    "statusType": "auto",
+    "x": 720,
+    "y": 680,
+    "wires": []
+  },
+  {
+    "id": "32f17ab2.927cf6",
+    "type": "api-call-service",
+    "z": "d938c47f.3398f8",
+    "name": "Turn on",
+    "server": "ec4a12a1.b2be9",
+    "version": 3,
+    "debugenabled": false,
+    "service_domain": "switch",
+    "service": "turn_on",
+    "entityId": "switch.varmtvannsbereder_switch",
+    "data": "",
+    "dataType": "jsonata",
+    "mergecontext": "",
+    "mustacheAltTags": false,
+    "outputProperties": [],
+    "queue": "none",
+    "x": 700,
+    "y": 580,
+    "wires": [[]]
+  },
+  {
+    "id": "2a3cd7db.0891f8",
+    "type": "api-call-service",
+    "z": "d938c47f.3398f8",
+    "name": "Turn off",
+    "server": "ec4a12a1.b2be9",
+    "version": 3,
+    "debugenabled": true,
+    "service_domain": "switch",
+    "service": "turn_off",
+    "entityId": "switch.varmtvannsbereder_switch",
+    "data": "",
+    "dataType": "json",
+    "mergecontext": "",
+    "mustacheAltTags": false,
+    "outputProperties": [],
+    "queue": "none",
+    "x": 700,
+    "y": 620,
+    "wires": [[]]
+  },
+  {
+    "id": "e21a4b49adea2350",
+    "type": "ps-receive-price",
+    "z": "d938c47f.3398f8",
+    "name": "Price Receiver",
+    "x": 310,
+    "y": 620,
+    "wires": [["391ac08890e0dd40"]]
+  },
+  {
+    "id": "391ac08890e0dd40",
+    "type": "ps-strategy-lowest-price",
+    "z": "d938c47f.3398f8",
+    "name": "Lowest Price",
+    "fromTime": "18",
+    "toTime": "08",
+    "hoursOn": "04",
+    "doNotSplit": false,
+    "sendCurrentValueWhenRescheduling": true,
+    "outputIfNoSchedule": "false",
+    "outputOutsidePeriod": "false",
+    "x": 490,
+    "y": 620,
+    "wires": [["32f17ab2.927cf6"], ["2a3cd7db.0891f8"], ["ed7202ff.b5725"]]
+  },
+  {
+    "id": "ec4a12a1.b2be9",
+    "type": "server",
+    "name": "Home Assistant",
+    "version": 2,
+    "addon": true,
+    "rejectUnauthorizedCerts": true,
+    "ha_boolean": "y|yes|true|on|home|open",
+    "connectionDelay": true,
+    "cacheJson": true,
+    "heartbeat": false,
+    "heartbeatInterval": 30
+  }
+]
+```

package/docs/examples/example-tibber-mqtt.md

@@ -0,0 +1,179 @@
+# Tibber, a switch and MQTT
+
+## Description
+
+In this example, data is read from Tibber and used to turn on/off a switch, scheduled by the `ps-best-save` node to be off up to 5 hours in a row, but only if at least 5 cents/øre is saved per kWh. Data is also sent to MQTT, for example to be displayed on [Magic Mirror](https://magicmirror.builders/).
+
+![Example with Tibber and MQTT](../images/power-saver-tibber-mqtt.png)
+
+## Flow
+
+```json:no-line-numbers
+[
+  {
+    "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": "ab2d599a.077738",
+    "type": "tibber-query",
+    "z": "d938c47f.3398f8",
+    "name": "Get Tibber prices",
+    "active": true,
+    "apiEndpointRef": "b70ec5d0.6f8f08",
+    "x": 470,
+    "y": 100,
+    "wires": [["0ef929fde193cf4d"]]
+  },
+  {
+    "id": "4f11b5ae.4cc22c",
+    "type": "inject",
+    "z": "d938c47f.3398f8",
+    "name": "Refresh",
+    "props": [
+      {
+        "p": "payload"
+      }
+    ],
+    "repeat": "3600",
+    "crontab": "",
+    "once": true,
+    "onceDelay": "1",
+    "topic": "",
+    "payload": "{   viewer {     homes {       currentSubscription{         priceInfo{           today {             total             startsAt           }           tomorrow {             total             startsAt           }         }       }     }   } }",
+    "payloadType": "str",
+    "x": 280,
+    "y": 100,
+    "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": 240,
+    "wires": []
+  },
+  {
+    "id": "5e485ff7.db156",
+    "type": "api-call-service",
+    "z": "d938c47f.3398f8",
+    "name": "Turn on VVB",
+    "server": "ec4a12a1.b2be9",
+    "version": 3,
+    "debugenabled": false,
+    "service_domain": "switch",
+    "service": "turn_on",
+    "entityId": "switch.varmtvannsbereder_switch",
+    "data": "",
+    "dataType": "jsonata",
+    "mergecontext": "",
+    "mustacheAltTags": false,
+    "outputProperties": [],
+    "queue": "none",
+    "x": 710,
+    "y": 60,
+    "wires": [[]]
+  },
+  {
+    "id": "9c978d1c.ee76",
+    "type": "api-call-service",
+    "z": "d938c47f.3398f8",
+    "name": "Turn off VVB",
+    "server": "ec4a12a1.b2be9",
+    "version": 3,
+    "debugenabled": true,
+    "service_domain": "switch",
+    "service": "turn_off",
+    "entityId": "switch.varmtvannsbereder_switch",
+    "data": "",
+    "dataType": "json",
+    "mergecontext": "",
+    "mustacheAltTags": false,
+    "outputProperties": [],
+    "queue": "none",
+    "x": 710,
+    "y": 180,
+    "wires": [[]]
+  },
+  {
+    "id": "5b6be1568744c6cf",
+    "type": "ps-strategy-best-save",
+    "z": "d938c47f.3398f8",
+    "name": "Best Save",
+    "maxHoursToSaveInSequence": "5",
+    "minHoursOnAfterMaxSequenceSaved": "1",
+    "minSaving": "0.05",
+    "sendCurrentValueWhenRescheduling": true,
+    "outputIfNoSchedule": "true",
+    "scheduleOnlyFromCurrentTime": "false",
+    "x": 490,
+    "y": 160,
+    "wires": [["467a5fe.d0bbba", "5e485ff7.db156"], ["9c978d1c.ee76", "467a5fe.d0bbba"], ["42d8b632.402e38"]]
+  },
+  {
+    "id": "0ef929fde193cf4d",
+    "type": "ps-receive-price",
+    "z": "d938c47f.3398f8",
+    "name": "Price Receiver",
+    "x": 280,
+    "y": 160,
+    "wires": [["5b6be1568744c6cf"]]
+  },
+  {
+    "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",
+    "version": 2,
+    "addon": true,
+    "rejectUnauthorizedCerts": true,
+    "ha_boolean": "y|yes|true|on|home|open",
+    "connectionDelay": true,
+    "cacheJson": true,
+    "heartbeat": false,
+    "heartbeatInterval": 30
+  }
+]
+```