node-red-contrib-power-saver 4.1.2 → 4.1.3

package/docs/.vuepress/components/AdsenseAdd.vue

@@ -38,3 +38,9 @@ onMounted(() => {
   (adsbygoogle = window.adsbygoogle || []).push({});
 });
 </script>
+
+<style scoped>
+ins {
+  margin-bottom: 30px;
+}
+</style>

package/docs/changelog/README.md

@@ -7,6 +7,10 @@ sidebarDepth: 1
 
 List the most significant changes.
 
+## 4.1.3
+
+- Fix bug that saved some data in wrong context storage.
+
 ## 4.1.2
 
 - Fix so configured values for output are sent, not only true/false.

package/docs/contribute/README.md

@@ -49,7 +49,7 @@ Main developer: [Otto Paulsen](https://github.com/ottopaulsen)
 
 Heat Capacitor developer: [Arne Klaveness](https://github.com/TomTorger)
 
-Example contributors: [Stefan](https://github.com/oakhill87/node-red-contrib-power-saver)
+Example contributors: [Stefan](https://github.com/oakhill87/node-red-contrib-power-saver), [Kim Storøy](https://www.facebook.com/kim.storoy)
 
 ###
 

package/docs/examples/example-grid-tariff-capacity-part.md

@@ -451,7 +451,10 @@ context.set("buffer", buffer);
 
 // Calculate buffer
 const periodMs = buffer[buffer.length - 1].timeMs - buffer[0].timeMs;
-const consumptionInPeriod = buffer[buffer.length - 1].accumulatedConsumption - buffer[0].accumulatedConsumption;
+let consumptionInPeriod = buffer[buffer.length - 1].accumulatedConsumption - buffer[0].accumulatedConsumption;
+if (consumptionInPeriod < 0) {
+  consumptionInPeriod = 0;
+}
 if (periodMs === 0) {
   return; // First item in buffer
 }
@@ -895,6 +898,8 @@ If you don't want the actions, or you want to control actions another way,
 you can omit the action-related nodes and only use the nodes creating the sensors.
 :::
 
+The `MIN_MINUTES_INTO_HOUR_TO_TAKE_ACTION` constant in the `On Message` code sets a period (of default 5 minutes) in the beginning of the hour when no reduction action is taken. This is to avoid that a high consumption at the end of the previous hour causes reduction actions to be taken as soon as the hour changes.
+
 ::: details Code
 
 <CodeGroup>
@@ -1008,6 +1013,7 @@ flow.set("actions", actions);
 
 ```js
 const MIN_CONSUMPTION_TO_CARE = 0.05; // Do not reduce unless at least 50W
+const MIN_MINUTES_INTO_HOUR_TO_TAKE_ACTION = 5;
 
 const actions = flow.get("actions");
 const ha = global.get("homeassistant").homeAssistant;
@@ -1015,10 +1021,21 @@ const ha = global.get("homeassistant").homeAssistant;
 let reductionRequired = msg.payload.reductionRequired;
 let reductionRecommended = msg.payload.reductionRecommended;
 
+node.status({});
+
 if (reductionRecommended <= 0) {
   return null;
 }
 
+if (3600 - msg.payload.timeLeftSec < MIN_MINUTES_INTO_HOUR_TO_TAKE_ACTION * 60) {
+  node.status({
+    fill: "yellow",
+    shape: "ring",
+    text: "No action during first " + MIN_MINUTES_INTO_HOUR_TO_TAKE_ACTION + " minutes",
+  });
+  return;
+}
+
 function takeAction(action, consumption) {
   const info = {
     time: new Date().toISOString(),
@@ -1105,7 +1122,7 @@ function resetAction(action) {
   const info = {
     time: new Date().toISOString(),
     name: "Reset action",
-    data: msg.paylaod,
+    data: msg.payload,
     action,
   };
   const output1 = action.payloadToResetAction ? { payload: action.payloadToResetAction } : null;

package/docs/guide/README.md

@@ -239,4 +239,8 @@ You may directly replace the `Power Saver` node by two of the new nodes (`ps-rec
 
 See more details in the [documentation for the `ps-strategy-best-save`](../nodes/ps-strategy-best-save.md) node.
 
-<VippsPlakat/>
+## Disclaimer
+
+This software is offered for free as open source. You use it totally on your own risk. The developers take no responsibility of any consequences caused by use or misuse of this software.
+
+It is not recommended to reduce the temperature of the water heater or similar over longer periods, due to the risk of legionella. Please read the recommendations of [FHI](https://www.fhi.no/sv/smittsomme-sykdommer/legionella/) about this. You do this at your own risk.

package/examples/example-grid-tariff-capacity-flow.json

@@ -82,7 +82,7 @@
     "type": "function",
     "z": "d938c47f.3398f8",
     "name": "Collect estimate for hour",
-    "func": "\n// Number of minutes used to calculate assumed consumption:\nconst ESTIMATION_TIME_MINUTES = 1\n\nconst buffer = context.get(\"buffer\") || []\n\n// Add new record to buffer\nconst time = new Date(msg.payload.timestamp)\nconst timeMs = time.getTime()\nconst accumulatedConsumption = msg.payload.accumulatedConsumption\nconst accumulatedConsumptionLastHour = msg.payload.accumulatedConsumptionLastHour\nbuffer.push({timeMs, accumulatedConsumption})\n\nconst currentHour = new Date(msg.payload.timestamp)\ncurrentHour.setMinutes(0)\ncurrentHour.setSeconds(0)\n\n// Remove too old records from buffer\nconst maxAgeMs = ESTIMATION_TIME_MINUTES * 60 * 1000\nlet oldest = buffer[0]\nwhile ((timeMs - oldest.timeMs) > maxAgeMs) {\n    buffer.splice(0, 1)\n    oldest = buffer[0]\n}\ncontext.set(\"buffer\", buffer)\n\n// Calculate buffer\nconst periodMs = buffer[buffer.length - 1].timeMs - buffer[0].timeMs\nconst consumptionInPeriod = buffer[buffer.length - 1].accumulatedConsumption - buffer[0].accumulatedConsumption\nif (periodMs === 0) {\n    return // First item in buffer\n}\n\n// Estimate remaining of current hour\nconst timeLeftMs = (60 * 60 * 1000) - (time.getMinutes() * 60000 + time.getSeconds() * 1000 + time.getMilliseconds())\nconst consumptionLeft = consumptionInPeriod / periodMs * timeLeftMs\nconst averageConsumptionNow = consumptionInPeriod / periodMs * 60 * 60 * 1000\n\n// Estimate total hour\nconst hourEstimate = accumulatedConsumptionLastHour + consumptionLeft + 0 // Change for testing\n\nmsg.payload = {\n  accumulatedConsumption,\n  accumulatedConsumptionLastHour,\n  periodMs,\n  consumptionInPeriod,\n  averageConsumptionNow,\n  timeLeftMs,\n  consumptionLeft,\n  hourEstimate,\n  currentHour\n}\n\nreturn msg;",
+    "func": "\n// Number of minutes used to calculate assumed consumption:\nconst ESTIMATION_TIME_MINUTES = 1\n\nconst buffer = context.get(\"buffer\") || []\n\n// Add new record to buffer\nconst time = new Date(msg.payload.timestamp)\nconst timeMs = time.getTime()\nconst accumulatedConsumption = msg.payload.accumulatedConsumption\nconst accumulatedConsumptionLastHour = msg.payload.accumulatedConsumptionLastHour\nbuffer.push({timeMs, accumulatedConsumption})\n\nconst currentHour = new Date(msg.payload.timestamp)\ncurrentHour.setMinutes(0)\ncurrentHour.setSeconds(0)\n\n// Remove too old records from buffer\nconst maxAgeMs = ESTIMATION_TIME_MINUTES * 60 * 1000\nlet oldest = buffer[0]\nwhile ((timeMs - oldest.timeMs) > maxAgeMs) {\n    buffer.splice(0, 1)\n    oldest = buffer[0]\n}\ncontext.set(\"buffer\", buffer)\n\n// Calculate buffer\nconst periodMs = buffer[buffer.length - 1].timeMs - buffer[0].timeMs\nlet consumptionInPeriod = buffer[buffer.length - 1].accumulatedConsumption - buffer[0].accumulatedConsumption\nif (consumptionInPeriod < 0) {\nconsumptionInPeriod = 0\n}\nif (periodMs === 0) {\n    return // First item in buffer\n}\n\n// Estimate remaining of current hour\nconst timeLeftMs = (60 * 60 * 1000) - (time.getMinutes() * 60000 + time.getSeconds() * 1000 + time.getMilliseconds())\nconst consumptionLeft = consumptionInPeriod / periodMs * timeLeftMs\nconst averageConsumptionNow = consumptionInPeriod / periodMs * 60 * 60 * 1000\n\n// Estimate total hour\nconst hourEstimate = accumulatedConsumptionLastHour + consumptionLeft + 0 // Change for testing\n\nmsg.payload = {\n  accumulatedConsumption,\n  accumulatedConsumptionLastHour,\n  periodMs,\n  consumptionInPeriod,\n  averageConsumptionNow,\n  timeLeftMs,\n  consumptionLeft,\n  hourEstimate,\n  currentHour\n}\n\nreturn msg;",
     "outputs": 1,
     "noerr": 0,
     "initialize": "// Code added here will be run once\n// whenever the node is started.\ncontext.set(\"buffer\", [])",
@@ -112,7 +112,7 @@
     "type": "function",
     "z": "d938c47f.3398f8",
     "name": "Reduction Actions",
-    "func": "const MIN_CONSUMPTION_TO_CARE = 0.05 // Do not reduce unless at least 50W\n\nconst actions = flow.get(\"actions\")\nconst ha = global.get(\"homeassistant\").homeAssistant\n\nlet reductionRequired = msg.payload.reductionRequired\nlet reductionRecommended = msg.payload.reductionRecommended\n\nif(reductionRecommended <= 0) {\n  return null\n}\n\nfunction takeAction(action, consumption ) {\n  const info = {\n    time: new Date().toISOString(),\n    name: \"Reduction action\",\n    data: msg.payload,\n    action\n  }\n\n  // output1 is for actions\n  const output1 = action.payloadToTakeAction ? { payload: action.payloadToTakeAction } : null\n  // output 2 is for overriding PS strategies\n  const output2 = action.nameOfStrategyToOverride ? { payload: { config: { override: \"off\" }, name: action.nameOfStrategyToOverride} } : null\n  // output 3 is for logging\n  const output3 = { payload: info }\n\n  node.send([output1, output2, output3])\n  reductionRequired = Math.max(0, reductionRequired - consumption)\n  reductionRecommended = Math.max(0, reductionRecommended - consumption)\n  action.actionTaken = true\n  action.actionTime = Date.now()\n  action.savedConsumption = consumption\n  flow.set(\"actions\", actions)\n}\n\nfunction getConsumption(consumption) {\n  if(typeof consumption === \"string\") {\n    const sensor = ha.states[consumption]\n    return sensor.state / 1000\n  } else if (typeof consumption === \"number\") {\n    return consumption\n  } else if(typeof consumption === \"function\") {\n    return consumption()\n  } else {\n    node.warn(\"Config error: consumption has illegal type: \" + typeof consumption)\n    return 0\n  }\n}\n\nactions\n.filter(a => msg.payload.alarmLevel >= a.minAlarmLevel && !a.actionTaken)\n.forEach(a => {\n  const consumption = getConsumption(a.consumption)\n  if (consumption < MIN_CONSUMPTION_TO_CARE) {\n    return\n  }\n  if (reductionRequired > 0 || (reductionRecommended > 0 && a.reduceWhenRecommended)) {\n    takeAction(a, consumption)\n  }\n})\n    \n",
+    "func": "const MIN_CONSUMPTION_TO_CARE = 0.05 // Do not reduce unless at least 50W\nconst MIN_MINUTES_INTO_HOUR_TO_TAKE_ACTION = 5\n\nconst actions = flow.get(\"actions\")\nconst ha = global.get(\"homeassistant\").homeAssistant\n\nlet reductionRequired = msg.payload.reductionRequired\nlet reductionRecommended = msg.payload.reductionRecommended\n\nnode.status({})\n\nif(reductionRecommended <= 0 ) {\n  return null\n}\n\nif (3600 - msg.payload.timeLeftSec < MIN_MINUTES_INTO_HOUR_TO_TAKE_ACTION * 60) {\n  node.status({ fill: \"yellow\", shape: \"ring\", text: \"No action during first \" + MIN_MINUTES_INTO_HOUR_TO_TAKE_ACTION + \" minutes\"});\n  return\n}\n\nfunction takeAction(action, consumption ) {\n  const info = {\n    time: new Date().toISOString(),\n    name: \"Reduction action\",\n    data: msg.payload,\n    action\n  }\n\n  // output1 is for actions\n  const output1 = action.payloadToTakeAction ? { payload: action.payloadToTakeAction } : null\n  // output 2 is for overriding PS strategies\n  const output2 = action.nameOfStrategyToOverride ? { payload: { config: { override: \"off\" }, name: action.nameOfStrategyToOverride} } : null\n  // output 3 is for logging\n  const output3 = { payload: info }\n\n  node.send([output1, output2, output3])\n  reductionRequired = Math.max(0, reductionRequired - consumption)\n  reductionRecommended = Math.max(0, reductionRecommended - consumption)\n  action.actionTaken = true\n  action.actionTime = Date.now()\n  action.savedConsumption = consumption\n  flow.set(\"actions\", actions)\n}\n\nfunction getConsumption(consumption) {\n  if(typeof consumption === \"string\") {\n    const sensor = ha.states[consumption]\n    return sensor.state / 1000\n  } else if (typeof consumption === \"number\") {\n    return consumption\n  } else if(typeof consumption === \"function\") {\n    return consumption()\n  } else {\n    node.warn(\"Config error: consumption has illegal type: \" + typeof consumption)\n    return 0\n  }\n}\n\nactions\n.filter(a => msg.payload.alarmLevel >= a.minAlarmLevel && !a.actionTaken)\n.forEach(a => {\n  const consumption = getConsumption(a.consumption)\n  if (consumption < MIN_CONSUMPTION_TO_CARE) {\n    return\n  }\n  if (reductionRequired > 0 || (reductionRecommended > 0 && a.reduceWhenRecommended)) {\n    takeAction(a, consumption)\n  }\n})\n    \n",
     "outputs": 3,
     "noerr": 0,
     "initialize": "// You MUST edit the actions array with your own actions.\n\nconst actions = [\n    { \n        consumption: \"sensor.varmtvannsbereder_electric_consumption_w\",\n        name: \"Varmtvannsbereder\",\n        id: \"vvb\",\n        minAlarmLevel: 3,\n        reduceWhenRecommended: true,\n        minTimeOffSec: 300,\n        nameOfStrategyToOverride: \"Best Save\",\n    },\n    { \n        consumption: \"sensor.varme_gulv_bad_electric_consumption_w_2\",\n        name: \"Varme gulv bad 1. etg.\",\n        id: \"gulvbad\",\n        minAlarmLevel: 3,\n        reduceWhenRecommended: true,\n        minTimeOffSec: 300,\n        payloadToTakeAction: {\n            domain: \"climate\",\n            service: \"turn_off\",\n            target: {\n                entity_id: [\"climate.varme_gulv_bad_2\"]\n            }\n        },\n        payloadToResetAction: {\n            domain: \"climate\",\n            service: \"turn_on\",\n            target: {\n                entity_id: [\"climate.varme_gulv_bad_2\"]\n            }\n        }\n    },\n    { \n        consumption: \"sensor.varme_gulv_gang_electric_consumption_w\",\n        name: \"Varme gulv gang 1. etg.\",\n        id: \"gulvgang\",\n        minAlarmLevel: 3,\n        reduceWhenRecommended: true,\n        minTimeOffSec: 300,\n        payloadToTakeAction: {\n            domain: \"climate\",\n            service: \"turn_off\",\n            target: {\n                entity_id: [\"climate.varme_gulv_gang\"]\n            }\n        },\n        payloadToResetAction: {\n            domain: \"climate\",\n            service: \"turn_on\",\n            target: {\n                entity_id: [\"climate.varme_gulv_gang\"]\n            }\n        }\n    },\n    {\n        consumption: \"sensor.varme_gulv_kjellerstue_electric_consumption_w\",\n        name: \"Varme gulv kjellerstue\",\n        id: \"gulvkjeller\",\n        minAlarmLevel: 3,\n        reduceWhenRecommended: true,\n        minTimeOffSec: 300,\n        payloadToTakeAction: {\n            domain: \"climate\",\n            service: \"turn_off\",\n            target: {\n                entity_id: [\"climate.varme_gulv_kjellerstue\"]\n            }\n        },\n        payloadToResetAction: {\n            domain: \"climate\",\n            service: \"turn_on\",\n            target: {\n                entity_id: [\"climate.varme_gulv_kjellerstue\"]\n            }\n        }\n    }\n]\n// End of actions array\n\n// DO NOT DELETE THE CODE BELOW\n\n// Set default values for all actions\nactions.forEach(a => {\n    a.actionTaken = false\n    a.savedConsumption = 0\n})\n\nflow.set(\"actions\", actions)\n",
@@ -127,7 +127,7 @@
     "type": "function",
     "z": "d938c47f.3398f8",
     "name": "Reset Actions",
-    "func": "\nconst actions = flow.get(\"actions\")\nconst ha = global.get(\"homeassistant\").homeAssistant\n\nconst BUFFER_TO_RESET = 1 // Must have 1kW extra to perform reset\n\nlet increasePossible = msg.payload.increasePossible\n\nif (increasePossible <= 0) {\n  return null\n}\n\nfunction resetAction(action) {\n  const info = {\n    time: new Date().toISOString(),\n    name: \"Reset action\",\n    data: msg.paylaod,\n    action\n  }\n  const output1 = action.payloadToResetAction ? { payload: action.payloadToResetAction } : null\n  const output2 = action.nameOfStrategyToOverride ? { payload: { config: { override: \"auto\" }, name: action.nameOfStrategyToOverride } } : null\n  const output3 = { payload: info }\n\n  node.send([output1, output2, output3])\n  increasePossible -= action.savedConsumption\n  action.actionTaken = false\n  action.savedConsumption = 0\n  flow.set(\"actions\", actions)\n}\n\nactions\n  .filter(a => a.actionTaken\n    && (a.savedConsumption + BUFFER_TO_RESET) <= increasePossible\n    && (Date.now() - a.actionTime > a.minTimeOffSec * 1000)\n  ).forEach(a => resetAction(a))\n",
+    "func": "\nconst actions = flow.get(\"actions\")\nconst ha = global.get(\"homeassistant\").homeAssistant\n\nconst BUFFER_TO_RESET = 1 // Must have 1kW extra to perform reset\n\nlet increasePossible = msg.payload.increasePossible\n\nif (increasePossible <= 0) {\n  return null\n}\n\nfunction resetAction(action) {\n  const info = {\n    time: new Date().toISOString(),\n    name: \"Reset action\",\n    data: msg.payload,\n    action\n  }\n  const output1 = action.payloadToResetAction ? { payload: action.payloadToResetAction } : null\n  const output2 = action.nameOfStrategyToOverride ? { payload: { config: { override: \"auto\" }, name: action.nameOfStrategyToOverride } } : null\n  const output3 = { payload: info }\n\n  node.send([output1, output2, output3])\n  increasePossible -= action.savedConsumption\n  action.actionTaken = false\n  action.savedConsumption = 0\n  flow.set(\"actions\", actions)\n}\n\nactions\n  .filter(a => a.actionTaken\n    && (a.savedConsumption + BUFFER_TO_RESET) <= increasePossible\n    && (Date.now() - a.actionTime > a.minTimeOffSec * 1000)\n  ).forEach(a => resetAction(a))\n",
     "outputs": 3,
     "noerr": 0,
     "initialize": "",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-power-saver",
-  "version": "4.1.2",
+  "version": "4.1.3",
   "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": {

package/src/handle-output.js

@@ -62,7 +62,7 @@ function sendSwitch(node, onOff) {
   const output1 = onOff ? { payload: node.outputValueForOn } : null;
   const output2 = onOff ? null : { payload: node.outputValueForOff };
   node.send([output1, output2, null]);
-  node.context().set("currentOutput", onOff);
+  node.context().set("currentOutput", onOff, node.contextStorage);
 }
 
 function runSchedule(node, schedule, time, currentSent = false) {

package/src/schedule-merger-functions.js

@@ -11,7 +11,7 @@ function validateSchedule(msg) {
 }
 
 function saveSchedule(node, msg) {
-  let savedSchedules = node.context().get("savedSchedules") || {};
+  let savedSchedules = node.context().get("savedSchedules", node.contextStorage) || {};
 
   // If the saved schedule has a different start period, delete them
   const ids = Object.keys(savedSchedules);
@@ -35,7 +35,7 @@ function saveSchedule(node, msg) {
 function mergeSchedules(node, logicFunction) {
   // Transpose all schedules
   const transposed = {};
-  const savedSchedules = node.context().get("savedSchedules");
+  const savedSchedules = node.context().get("savedSchedules", node.contextStorage);
   if (!savedSchedules) {
     const msg = "No schedules";
     node.warn(msg);

package/src/schedule-merger.js

@@ -87,7 +87,7 @@ module.exports = function (RED) {
           };
 
           const planFromTime = msg.payload.time ? DateTime.fromISO(msg.payload.time) : DateTime.now();
-          const currentOutput = node.context().get("currentOutput");
+          const currentOutput = node.context().get("currentOutput", node.contextStorage);
           const plannedOutputNow = getOutputForTime(plan.schedule, planFromTime, node.outputIfNoSchedule);
 
           const outputCommands = {

package/src/strategy-functions.js

@@ -12,7 +12,7 @@ function strategyOnInput(node, msg, doPlanning, calcSavings) {
   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 currentOutput = node.context().get("currentOutput", node.contextStorage);
     const plannedOutputNow =
       node.override === "auto"
         ? getOutputForTime(plan.schedule, planFromTime, node.outputIfNoSchedule)

package/test/strategy-lowest-price-3days.test.js

@@ -54,6 +54,37 @@ describe("ps-strategy-lowest-price with data day before", function () {
       }, 100);
     });
   });
+
+  it("should handle new price data after midnight", function (done) {
+    const flow = makeFlow(1);
+    const pricesDay1 = cloneDeep(prices);
+    const pricesDay2 = cloneDeep(prices);
+    const res = cloneDeep(result);
+    res.schedule.splice(3, 2);
+    res.hours.splice(48, 24);
+    res.schedule[2].countHours = 19;
+    pricesDay1.priceData.splice(48, 24);
+    pricesDay2.priceData.splice(48, 24);
+    pricesDay2.priceData.splice(0, 24);
+    helper.load(lowestPrice, flow, function () {
+      const n1 = helper.getNode("n1");
+      const n2 = helper.getNode("n2");
+      let count = 0;
+      n2.on("input", function (msg) {
+        if (count === 1) {
+          expect(msg.payload).toHaveProperty("schedule", res.schedule);
+          done();
+        }
+        count++;
+      });
+      let time = DateTime.fromISO(pricesDay1.priceData[10].start);
+      n1.receive({ payload: makePayload(pricesDay1, time) });
+      setTimeout(() => {
+        time = DateTime.fromISO(pricesDay2.priceData[1].start);
+        n1.receive({ payload: makePayload(pricesDay2, time) });
+      }, 100);
+    });
+  });
 });
 
 function makeFlow(hoursOn) {