node-red-contrib-power-saver 3.5.0 → 3.5.4

package/docs/.vuepress/config.js

@@ -49,6 +49,7 @@ module.exports = {
             "/examples/example-tibber-mqtt.md",
             "/examples/example-heat-capacitor.md",
             "/examples/example-cascade-temperature-control.md",
+            "/examples/example-visualize-on-off/example-visualize-on-off.md",
           ],
         },
       ],
@@ -65,5 +66,6 @@ module.exports = {
         componentsDir: path.resolve(__dirname, "./components"),
       },
     ],
+    ["@vuepress/plugin-search"],
   ],
 };

package/docs/changelog/README.md

@@ -6,6 +6,23 @@ sidebar: "auto"
 
 List the most significant changes, starting in version 1.0.9.
 
+## 3.5.4
+
+- Fix bug in context selection
+- Add example for visualization in Lovelace
+
+## 3.5.3
+
+- Fix a couple of bugs in how context is used.
+
+## 3.5.2
+
+- Re-introduce the search bar, after Vuepress upgrade.
+
+## 3.5.1
+
+- Update github actions to deploy automatically to the npm library.
+
 ## 3.5.0
 
 - Select what context storage to store data in the node configuration.

package/docs/examples/README.md

@@ -10,6 +10,8 @@
 
 [Cascade temperature control](./example-cascade-temperature-control)
 
+[Visualize on/off, price and consumption in Lovelace](example-visualize-on-off/example-visualize-on-off)
+
 ## User provided examples
 
 [Output schedule to a sensor entity](./example-next-schedule-entity.md) (by Stefan)

package/docs/examples/example-visualize-on-off/example-visualize-on-off.md

@@ -0,0 +1,41 @@
+# Lovelace Visualization
+
+The source of this example is made by Kim Storøy, and Otto Paulsen has written the documentation and made some changes to the files.
+
+![Lovelace image](./lovelace.jpg)
+
+## Introduction
+
+With this example you can visualize the schedule together with the price and the consumption in Lovelace, as shown above.
+
+## Installation
+
+You need the following installed before you can use this example:
+
+- The [Node-RED Companion Integration](https://github.com/zachowj/hass-node-red).
+- The [apexcharts-card](https://github.com/RomRider/apexcharts-card)
+- The Tibber integration (Configuration -> Integrations)
+
+If you don't already have them, install them first.
+
+In Node-RED, select `Import` from the menu, and paste the code for nodes below. Connect them like this:
+
+![nodes](./nodes.png)
+
+In Lovelace, use the Lovelace code below for the new card.
+Replace the `sensor.accumulated_consumption_current_hour_your_address`
+with the correct name for your corresponding sensor in your Tibber integration.
+
+### Code
+
+::: details Nodes
+
+@[code](./nodes.json)
+
+:::
+
+::: details Lovelace
+
+@[code](./lovelace.yaml)
+
+:::

package/docs/examples/example-visualize-on-off/lovelace.yaml

@@ -0,0 +1,89 @@
+type: custom:apexcharts-card
+header:
+  show: true
+  title: Pris 48t + Forbruk + Powersaver
+now:
+  show: true
+  label: Nå
+graph_span: 2d
+span:
+  start: day
+apex_config:
+  stroke:
+    width: 2
+  dataLabels:
+    enabled: true
+  fill:
+    type: gradient
+    gradient:
+      shadeIntensity: 1
+      inverseColors: false
+      opacityFrom: 0.45
+      opacityTo: 0.05
+      stops:
+        - 10
+        - 50
+        - 75
+        - 1000
+  legend:
+    show: false
+  yaxis:
+    - id: price
+      show: true
+      decimalsInFloat: 1
+      floating: false
+      forceNiceScale: true
+      extend_to: end
+    - id: usage
+      show: true
+      opposite: true
+      decimalsInFloat: 1
+      floating: false
+      forceNiceScale: true
+      extend_to: end
+    - id: powersaver
+      show: false
+      decimalsInFloat: 0
+      floating: false
+      extend_to: now
+series:
+  - entity: sensor.powersaver
+    yaxis_id: price
+    extend_to: now
+    name: Pris
+    type: area
+    curve: smooth
+    color: tomato
+    show:
+      legend_value: false
+    data_generator: |
+      return entity.attributes.hours.map((entry) => {
+        return [new Date(entry.start), entry.price];
+      });
+  - entity: sensor.accumulated_consumption_current_hour_xxxx
+    yaxis_id: usage
+    type: column
+    name: Forbruk
+    group_by:
+      func: max
+    show:
+      legend_value: false
+  - entity: sensor.powersaver
+    data_generator: |
+      return entity.attributes.hours.map((entry) => {
+        return [new Date(entry.start), entry.onOff];
+      });
+    yaxis_id: powersaver
+    name: ' '
+    type: area
+    color: rgb(0, 255, 0)
+    opacity: 0.2
+    stroke_width: 0
+    curve: stepline
+    group_by:
+      func: min
+    show:
+      legend_value: false
+      in_header: false
+      name_in_header: false
+      datalabels: false

package/docs/examples/example-visualize-on-off/nodes.json

@@ -0,0 +1,88 @@
+[
+  {
+    "id": "eab799518168f5a3",
+    "type": "ha-entity",
+    "z": "d938c47f.3398f8",
+    "name": "Info fra PS til HA",
+    "server": "ec4a12a1.b2be9",
+    "version": 2,
+    "debugenabled": false,
+    "outputs": 1,
+    "entityType": "sensor",
+    "config": [
+      {
+        "property": "name",
+        "value": "Powersaver"
+      },
+      {
+        "property": "device_class",
+        "value": ""
+      },
+      {
+        "property": "icon",
+        "value": ""
+      },
+      {
+        "property": "unit_of_measurement",
+        "value": ""
+      },
+      {
+        "property": "state_class",
+        "value": ""
+      },
+      {
+        "property": "last_reset",
+        "value": ""
+      }
+    ],
+    "state": "payload",
+    "stateType": "str",
+    "attributes": [
+      {
+        "property": "Schedule",
+        "value": "payload.schedule",
+        "valueType": "msg"
+      },
+      {
+        "property": "Hours",
+        "value": "payload.hours",
+        "valueType": "msg"
+      },
+      {
+        "property": "Control",
+        "value": "payload.hours[0].onOff",
+        "valueType": "str"
+      },
+      {
+        "property": "Current",
+        "value": "payload.current",
+        "valueType": "str"
+      }
+    ],
+    "resend": true,
+    "outputLocation": "payload",
+    "outputLocationType": "none",
+    "inputOverride": "allow",
+    "outputOnStateChange": false,
+    "outputPayload": "",
+    "outputPayloadType": "str",
+    "x": 830,
+    "y": 630,
+    "wires": [[]]
+  },
+  {
+    "id": "cad33a63f66ef72e",
+    "type": "function",
+    "z": "d938c47f.3398f8",
+    "name": "Convert true/false to 1/0",
+    "func": "msg.payload.hours.forEach(h => h.onOff = h.onOff ? \"1\" : \"0\")\nreturn msg;",
+    "outputs": 1,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 550,
+    "y": 630,
+    "wires": [["eab799518168f5a3", "37a23d88cfc668f2"]]
+  }
+]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-power-saver",
-  "version": "3.5.0",
+  "version": "3.5.4",
   "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": {
@@ -47,13 +47,14 @@
   "devDependencies": {
     "@vuepress/bundler-vite": "^2.0.0-beta.36",
     "@vuepress/plugin-register-components": "^2.0.0-beta.36",
+    "@vuepress/plugin-search": "^2.0.0-beta.38",
     "@vuepress/utils": "^2.0.0-beta.35",
-    "sass-loader": "^12.6.0",
-    "vuepress": "^2.0.0-beta.36",
     "expect": "^27.5.1",
     "mocha": "^9.2.0",
     "node-red": "^2.2.2",
-    "node-red-node-test-helper": "^0.2.7"
+    "node-red-node-test-helper": "^0.2.7",
+    "sass-loader": "^12.6.0",
+    "vuepress": "^2.0.0-beta.36"
   },
   "dependencies": {
     "floating-vue": "^2.0.0-beta.6",

package/src/handle-input.js

@@ -4,6 +4,8 @@ const { version } = require("../package.json");
 
 function handleStrategyInput(node, msg, doPlanning) {
   const effectiveConfig = getEffectiveConfig(node, msg);
+  // Store config variables in node
+  Object.keys(effectiveConfig).forEach((key) => (node[key] = effectiveConfig[key]));
 
   if (!validateInput(node, msg)) {
     return;
@@ -22,11 +24,12 @@ function handleStrategyInput(node, msg, doPlanning) {
       .set(["lastPlan", "lastPriceData", "lastSource"], [undefined, undefined, undefined], node.contextStorage);
     deleteSavedScheduleBefore(node, DateTime.now().plus({ days: 2 }), 100);
   }
+
   let { priceData, source } = getPriceData(node, msg);
   if (!priceData) {
     // Use last saved price data
-    priceData = node.context().get("lastPriceData");
-    source = node.context().get("lastSource");
+    priceData = node.context().get("lastPriceData", node.contextStorage);
+    source = node.context().get("lastSource", node.contextStorage);
     const message = "Using saved prices";
     node.warn(message);
     node.status({ fill: "green", shape: "ring", text: message });
@@ -39,9 +42,6 @@ function handleStrategyInput(node, msg, doPlanning) {
   }
   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(node.schedulingTimeout);
 
   const dates = [...new Set(priceData.map((v) => DateTime.fromISO(v.start).toISODate()))];

package/src/strategy-lowest-price.js

@@ -19,7 +19,7 @@ module.exports = function (RED) {
       outputOutsidePeriod: booleanConfig(config.outputOutsidePeriod),
       contextStorage: config.contextStorage || "default",
     };
-    node.context().set("config", originalConfig, node.contextStorage);
+    node.context().set("config", originalConfig);
 
     node.on("close", function () {
       clearTimeout(node.schedulingTimeout);

package/src/utils.js

@@ -57,14 +57,18 @@ function getDiff(large, small) {
 }
 
 function getEffectiveConfig(node, msg) {
-  const res = node.context().get("config", node.contextStorage);
+  const res = node.context().get("config");
+  if (!res) {
+    node.error("Node has no config");
+    return {};
+  }
   const isConfigMsg = !!msg?.payload?.config;
   if (isConfigMsg) {
     const inputConfig = msg.payload.config;
     Object.keys(inputConfig).forEach((key) => {
       res[key] = inputConfig[key];
     });
-    node.context().set("config", res, node.contextStorage);
+    node.context().set("config", res);
   }
   return res;
 }