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

package/.github/workflows/{firebase-hosting-merge.yml → publish-doc-on-merge.yml}

@@ -1,16 +1,16 @@
-# This file was auto-generated by the Firebase CLI
-# https://github.com/firebase/firebase-tools
-
-name: Deploy to Firebase Hosting on merge
-'on':
+name: "Publish docs to firebase on merge"
+on:
   push:
     branches:
-      - gh-pages
+      - "main"
+    paths:
+      - "docs/**"
 jobs:
   build_and_deploy:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+      - run: npm ci
       - run: 'npm run docs:build'
       - uses: FirebaseExtended/action-hosting-deploy@v0
         with:

package/.github/workflows/publish-to-npm.yml

@@ -0,0 +1,23 @@
+
+name: Publish to npmjs
+on:
+  release:
+    types: [created]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16.x'
+          registry-url: 'https://registry.npmjs.org'
+      - uses: szenius/set-timezone@v1.0
+        with:
+          timezoneLinux: "Europe/Oslo"
+      - run: npm ci
+      - run: 'npm run test'
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/test-on-pull-request.yaml

@@ -0,0 +1,13 @@
+name: Run tests on pull request
+on: pull_request
+jobs:
+  build_and_test:
+    if: '${{ github.event.pull_request.head.repo.full_name == github.repository }}'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: szenius/set-timezone@v1.0
+        with:
+          timezoneLinux: "Europe/Oslo"
+      - run: npm ci
+      - run: 'npm run test'

package/docs/.vuepress/components/BestSaveVerificator.vue

@@ -6,8 +6,15 @@
     <p>Max in sequence: {{ payload.config.maxHoursToSaveInSequence }}</p>
     <p>Min on after max: {{ payload.config.minHoursOnAfterMaxSequenceSaved }}</p>
     <p>Minimum saving: {{ payload.config.minSaving }}</p>
-    <p>Send when rescheduling: {{ payload.config.sendCurrentValueWhenRescheduling ? "Yes" : "No" }}</p>
-    <p>If no schedule, output: {{ payload.config.outputIfNoSchedule ? "On" : "Off" }}</p>
+    <p>
+      Send when rescheduling:
+      {{ payload.config.sendCurrentValueWhenRescheduling ? "Yes" : "No" }}
+    </p>
+    <p>
+      If no schedule, output:
+      {{ payload.config.outputIfNoSchedule ? "On" : "Off" }}
+    </p>
+    <p>Context is saved to: {{ payload.config.contextStorage }}</p>
     <h3>Meta data:</h3>
     <p>Node version: {{ payload.version }}</p>
     <p>Data timestamp: {{ payload.time }}</p>
@@ -78,7 +85,9 @@
       </tr>
       <tr v-for="(hour, i) in payload.hours" :key="hour.start">
         <td>{{ DateTime.fromISO(hour.start).day }}</td>
-        <td>{{ DateTime.fromISO(hour.start).toLocaleString(DateTime.TIME_SIMPLE) }}</td>
+        <td>
+          {{ DateTime.fromISO(hour.start).toLocaleString(DateTime.TIME_SIMPLE) }}
+        </td>
         <td :class="priceClasses(i)">{{ hour.price }}</td>
         <td>{{ hour.onOff ? "On" : "Off" }}</td>
         <td>{{ hour.saving ?? "" }}</td>
@@ -106,9 +115,7 @@
 
 <script setup>
 import { computed, reactive, ref, watch } from "vue";
-
-const { roundPrice } = import("../../../src/utils");
-const { DateTime } = import("luxon");
+import { DateTime } from "luxon";
 
 const message = ref("");
 const showNegative = ref(false);
@@ -116,7 +123,9 @@ const showNegative = ref(false);
 const show = ref("avg");
 const showSum = computed(() => show.value === "sum");
 
-console.log("This is the setup script");
+function roundPrice(value) {
+  return Math.round(value * 10000) / 10000;
+}
 
 const dataString = ref("");
 watch(dataString, (value) => {
@@ -147,6 +156,8 @@ const totalPerSequence = reactive([]);
 const averagePerSequence = reactive([]);
 
 function calculatePotentialSavings() {
+  console.log("calculatePotentialSavings");
+  console.log({ roundPrice });
   const hours = payload.hours;
 
   // Savings per hour

package/docs/.vuepress/components/DonateButtons.vue

@@ -14,7 +14,6 @@
           title="PayPal - The safer, easier way to pay online!"
           alt="Donate with PayPal button"
         />
-        <img alt="" border="0" src="https://www.paypal.com/en_NO/i/scr/pixel.gif" width="1" height="1" />
       </form>
     </div>
     <div class="right">

package/docs/.vuepress/config.js

@@ -1,5 +1,5 @@
 const { path } = require("@vuepress/utils");
-const vue = require("@vitejs/plugin-vue");
+const navbar = require("./navbar");
 
 module.exports = {
   lang: "en-US",
@@ -8,36 +8,8 @@ module.exports = {
   base: "/",
   themeConfig: {
     contributors: false,
-    navbar: [
-      {
-        text: "Guide",
-        link: "/guide/",
-      },
-      {
-        text: "Nodes",
-        link: "/nodes/",
-      },
-      {
-        text: "Examples",
-        link: "/examples/",
-      },
-      {
-        text: "FAQ",
-        link: "/faq/",
-      },
-      {
-        text: "Contribute",
-        link: "/contribute/",
-      },
-      {
-        text: "Changes",
-        link: "/changelog/",
-      },
-      {
-        text: "GitHub",
-        link: "https://github.com/ottopaulsen/node-red-contrib-power-saver",
-      },
-    ],
+    logo: "/Ukraine-heart-shape-flag.png",
+    navbar,
     sidebar: {
       "/guide/": [{ text: "Guide", children: ["/guide/README.md"] }],
       "/nodes/": [
@@ -50,7 +22,10 @@ module.exports = {
               children: [
                 "/nodes/ps-strategy-best-save.md",
                 "/nodes/ps-strategy-lowest-price.md",
-                { text: "ps-strategy-heat-capacitor", link: "/nodes/ps-strategy-heat-capacitor.md" },
+                {
+                  text: "ps-strategy-heat-capacitor",
+                  link: "/nodes/ps-strategy-heat-capacitor.md",
+                },
               ],
             },
             { text: "Utility nodes", children: ["/nodes/ps-receive-price.md"] },
@@ -82,32 +57,13 @@ module.exports = {
       "/changelog/": [{ text: "Changelog", children: ["/changelog/README.md"] }],
     },
   },
-  head: [
-    ["link", { rel: "shortcut icon", type: "image/x-icon", href: "euro.png" }],
-    [
-      "script",
-      {
-        async: true,
-        src: "https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-9857859182772006",
-        crossorigin: "anonymous",
-      },
-    ],
-  ],
+  head: [["link", { rel: "shortcut icon", type: "image/x-icon", href: "euro.png" }]],
   plugins: [
     [
       "@vuepress/register-components",
       {
-        components: {
-          BestSaveVerificator: path.resolve(__dirname, "./components/BestSaveVerificator.vue"),
-          DonateButtons: path.resolve(__dirname, "./components/DonateButtons.vue"),
-        },
+        componentsDir: path.resolve(__dirname, "./components"),
       },
     ],
   ],
-  bundler: "@vuepress/bundler-webpack",
-  bundlerConfig: {
-    viteOptions: {
-      plugins: [vue()],
-    },
-  },
 };

package/docs/.vuepress/navbar.js

@@ -0,0 +1,43 @@
+module.exports = [
+  {
+    text: "Guide",
+    link: "/guide/",
+  },
+  {
+    text: "Nodes",
+    link: "/nodes/",
+  },
+  {
+    text: "Examples",
+    link: "/examples/",
+  },
+  {
+    text: "FAQ",
+    link: "/faq/",
+  },
+  {
+    text: "Contribute",
+    link: "/contribute/",
+  },
+  {
+    text: "Changes",
+    link: "/changelog/",
+  },
+  {
+    text: "Links",
+    children: [
+      {
+        text: "GitHub",
+        link: "https://github.com/ottopaulsen/node-red-contrib-power-saver",
+      },
+      {
+        text: "npm registry",
+        link: "https://www.npmjs.com/package/node-red-contrib-power-saver",
+      },
+      {
+        text: "Node-RED Library",
+        link: "https://flows.nodered.org/node/node-red-contrib-power-saver",
+      },
+    ],
+  },
+];

package/docs/changelog/README.md

@@ -6,6 +6,20 @@ sidebar: "auto"
 
 List the most significant changes, starting in version 1.0.9.
 
+## 3.5.0
+
+- Select what context storage to store data in the node configuration.
+- New dynamic command: `replan`, that can be sent after a restart in order to create a schedule based on the last received prices, provided `file` is used as context storage (alternatively another permanent storage).
+- Some improvements to node status.
+
+## 3.4.4
+
+- Fix bug in Best Save Viewer in the documentation (under FAQ)
+
+## 3.4.3
+
+- Fix Elvia config so it can be used independently on any node.
+
 ## 3.4.2
 
 - Fix bug in reset command. It did not reset daily data properly.

package/docs/examples/example-cascade-temperature-control.md

@@ -326,19 +326,6 @@ A cascade temperature controller is a controller which utilizes the input/setpoi
     "x": 290,
     "y": 160,
     "wires": [["6f77dd60c21180e1"]]
-  },
-  {
-    "id": "e2dd69fb.8f70a8",
-    "type": "server",
-    "name": "Home Assistant",
-    "version": 2,
-    "addon": true,
-    "rejectUnauthorizedCerts": true,
-    "ha_boolean": "y|yes|true|on|home|open",
-    "connectionDelay": false,
-    "cacheJson": true,
-    "heartbeat": true,
-    "heartbeatInterval": "30"
   }
 ]
 ```

package/docs/examples/example-heat-capacitor.md

@@ -1,4 +1,4 @@
-# Simple heat capacitor strategy flow 
+# Simple heat capacitor strategy flow
 
 ## Description
 
@@ -27,13 +27,15 @@ It is a good application for cabins/heated storage spaces, as the entity never a
 > Import the flow into Node-RED
 
 > Configure the heat-capacitor node:
-  - Insert an approximate time it takes to increase the temperature by 1 Centigrade (could be 90 minutes)
-  - Insert an approximate time it takes to decrease 1 Centigrade
-  - Insert minimum savings for a heating/cooling cycle (should not be zero, as a cycle might have a cost)
+
+- Insert an approximate time it takes to increase the temperature by 1 Centigrade (could be 90 minutes)
+- Insert an approximate time it takes to decrease 1 Centigrade
+- Insert minimum savings for a heating/cooling cycle (should not be zero, as a cycle might have a cost)
 
 > Configure the climate service to target the correct climate entity (this has to be edited in two places)
-  - Change `Entity Id` in the properties menu
-  - Change the `entity_id` value in the `Data` property
+
+- Change `Entity Id` in the properties menu
+- Change the `entity_id` value in the `Data` property
 
 > (optional) If the `input_number` entity was named something else than `setpoint`, change the `entity_id` of the `Setpoint` node accordingly.
 
@@ -49,7 +51,6 @@ It is a good application for cabins/heated storage spaces, as the entity never a
 
 ---
 
-
 ::: details [Flow code]
 
 ```json:no-line-numbers
@@ -252,20 +253,8 @@ It is a good application for cabins/heated storage spaces, as the entity never a
         "feedUrl": "wss://api.tibber.com/v1-beta/gql/subscriptions",
         "queryUrl": "https://api.tibber.com/v1-beta/gql",
         "name": "Tibber"
-    },
-    {
-        "id": "e2dd69fb.8f70a8",
-        "type": "server",
-        "name": "Home Assistant",
-        "version": 2,
-        "addon": false,
-        "rejectUnauthorizedCerts": true,
-        "ha_boolean": "y|yes|true|on|home|open",
-        "connectionDelay": false,
-        "cacheJson": true,
-        "heartbeat": false,
-        "heartbeatInterval": 30
     }
 ]
 ```
+
 :::

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

@@ -167,19 +167,6 @@ In this example, data is read from the Nord Pool sensor in HA via the `current s
                 "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

@@ -152,19 +152,6 @@ In this example, data is read from the Nord Pool sensor in HA via the `events: s
     "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

@@ -160,19 +160,6 @@ In this example, data is read from Tibber and used to turn on/off a switch, sche
     "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
   }
 ]
 ```

package/docs/faq/best-save-viewer.md

@@ -58,4 +58,5 @@ If the number is black, it could be used, but only if all other criteria are sat
 The tool is not using the same code as the node, so in case there is a bg in the node (or in the tool) the numbers may not match.
 
 <hr/>
+
 <DonateButtons/>

package/docs/guide/README.md

@@ -61,14 +61,17 @@ If you are a Tibber customer, use the `tibber-query` node from the [Tibber API](
 {
   viewer {
     homes {
-      id
-      address {
-        address1
-        address2
-        address3
-        postalCode
-        city
-        country
+      currentSubscription {
+        priceInfo {
+          today {
+            total
+            startsAt
+          }
+          tomorrow {
+            total
+            startsAt
+          }
+        }
       }
     }
   }
@@ -147,10 +150,11 @@ If the grid tariff is the same the whole day, you can skip this step i the flow.
 
 This is the step where the value is produced. Based on the prices received, the optimal schedule for you is calculated automatically, based on your configuration. You can choose between the following strategies:
 
-| Strategy     | Node                        | Description                                                     |
-| ------------ | --------------------------- | --------------------------------------------------------------- |
-| Best save    | `ps-strategy-best-save`     | Postpone power consumption when there is most to save.          |
-| Lowest price | `ps--strategy-lowest-price` | Turn on power when the prices are the lowest in a given period. |
+| Strategy       | Node                         | Description                                                                  |
+| -------------- | ---------------------------- | ---------------------------------------------------------------------------- |
+| Best Save      | `ps-strategy-best-save`      | Postpone power consumption when there is most to save.                       |
+| Lowest Price   | `ps-strategy-lowest-price`   | Turn on power when the prices are the lowest in a given period.              |
+| Heat Capacitor | `ps-strategy-heat-capacitor` | Move consumption from expensive to cheap periods utilizing climate entities. |
 
 These nodes must be configured for your purpose. See configuration description and other details in the documentation for each node.
 
@@ -161,12 +165,16 @@ strategy node you choose.
 Choose the best save strategy if you can postpone power consumption, and expect the consumption to occur during the first hour after power is turned on again.
 
 Choose the lowest price strategy if you need the power to be on for x hours, but it is not important when that is. Note that you can select to have all hours on in one consecutive period, or spread around on the cheapest hours.
+
+Choose the heat capacitor strategy for controlling for example room heating, where you can turn the heat a little down when electricity is expensive, and a little up when it is cheap, using trading principles (only that you know up front when the prices will change).
 :::
 
 ### Use schedule signals
 
 Use the outputs to control switches, thermostats or other entities to control your power consumers.
 
+The following os valid for the Best Save and Lowest Price strategies:
+
 **Output 1** is used to turn on. A payload with value `true` is sent every time turning on is scheduled.
 
 **Output 2** is used to turn off. A payload with value `false` is sent every time turning off is scheduled.

package/docs/nodes/ps-strategy-best-save.md

@@ -21,6 +21,7 @@ The picture at the bottom of the page, under [Integration with MagicMirror](#int
 | Min saving             | Minimum amount to save per kWh in order to bother turning it off. It is recommended to have some amount here, e.g. 2 cents / 2 øre. No point in saving 0.001, is it? |
 | Send when rescheduling | Check this to make sure on or off output is sent immediately after rescheduling                                                                                      |
 | If no schedule, send   | What to do if there is no valid schedule any more (turn on or off).                                                                                                  |
+| Context storage        | Select context storage to save data to, if more than one is configured in the Node-RED `settings.js` file.                                                           |
 
 ::: warning Min recover
 NB! The `Min recover` only has effect if the previous save-period is of length `Max per sequence`. If the save-period is shorter, the following on-period may be as short as one hour.
@@ -33,6 +34,7 @@ It is possible to change config dynamically by sending a config message to the n
 ```json
 "payload": {
   "config": {
+    "contextStorage": "file",
     "maxHoursToSaveInSequence": 4,
     "minHoursOnAfterMaxSequenceSaved": 2,
     "minSaving": 0.02,
@@ -107,13 +109,41 @@ This operation cannot be undone.
 However, it is normally not a big loss, as you can just feed the node with new price data and start from scratch.
 :::
 
+#### replan
+
+By sending this command, you can have the node read the last received prices from the context storage,
+and make a plan based on those prices:
+
+```json
+"payload": {
+  "commands": {
+    "replan": true,
+  }
+}
+```
+
+If the context storage is `file` you can use this to create a new schedule after a restart,
+instead of fetching prices again.
+
+### Config saved in context
+
+The nodes config is saved in the nodes context.
+If dynamic config is sent as input, this replaces the saved config.
+It is the config that is saved in context that is used when calculating.
+When Node-RED starts or the flow is redeployed, the config defined in the node replaces the saved config and will be used when planning.
+
 ## Input
 
 The input is the [common strategy input format](./strategy-input.md).
 
 In addition to the prices sent as input,
 the node is using the schedule for the day before it receives data for,
-so that it can calculate the schedule in the beginning of the day according to the configured rules. This requires of course that the node was run the day before.
+so that it can calculate the schedule in the beginning of the day according to the configured rules.
+This requires of course that the node was run the day before.
+
+When a payload with `priceData` is received, this is saved to the nodes context as `lastPriceData`.
+The source is saved as `lastSource`. If config- or command-messages are received without price data,
+the data saved in context is used for replanning.
 
 ## Output
 
@@ -167,6 +197,7 @@ Example of output:
   ],
   "source": "Nord Pool",
   "config": {
+    "contextStorage": "default",
     "maxHoursToSaveInSequence": 3,
     "minHoursOnAfterMaxSequenceSaved": "1",
     "minSaving": 0.001,
@@ -180,9 +211,9 @@ Example of output:
 
 The `schedule` array shows every time the switch is turned on or off. The `hours` array shows values per hour containing the price (received as input), whether that hour is on or off, the start time of the hour and the amount per kWh that is saved on hours that are turned off, compared to the next hour that is on.
 
-### Data saved in context
+### Output saved in context
 
-The node saves some data in the nodes context, so that it can be used on restarts and also taken into consideration when calculating the schedule over midnight.
+The `schedule` and the `hours` arrays from Output 3 are both saved to the nodes context in an object with key `lastPlan`. This may be used in the plan for the next day, for example if an off-period at the end of one day continues into the next day. In that case, the `saving` values for the last hours in the day have to be recalculated, since the next hour on is changed when the new day is calculated.
 
 You can see the saved data if you select the node in Node-RED, and view "Context data", and refresh the Node context.
 
@@ -204,23 +235,48 @@ I say "in most cases", because there is a chance that a group of two or more seq
 
 Normally data is received for one or two whole days, and all this data is used to do the calculation. In addition, if the node has run before, so there is historical data, the last period on or off before the period data is received for, is considered in the calculation, so that the rules in the configuration are followed also between days.
 
-## Restarts
+## Restarts and saved context
 
-The node saves data in the nodes context, so if Node-RED is configured to save context between restarts, the node will replan with the last received data when it restarts.
+The config, last received prices and the last calculated schedule are saved to the nodes context.
+This may be saved to memory, to file or to another destination based on how your Node-RED is configured.
+If multiple context storages are defined, you can select which one to use in the nodes config.
+If there is only one context storage defined, this is normally `memory`. In that case, data is not saved over restarts.
+It is common to have two different context storages defined, `memory` and `file`, but there may be more.
+It is also common to have a `default` context storage defined, and often this points to either `memory` or `file`.
+However, the configuration can be different from this.
 
-::: warning
-In Home Assistant, Node-RED is by default configured to save context between restarts. However, if you run Node-RED another way, this may not be the case by default. If context is only stored in memory, it is lost between restarts, and even between re-deployments. This can be changed in the `settings.js` file for Node-RED like this:
+You can find this configuration in the `settings.js` file for Node-RED, usually in the node-red config folder.
+In Home Assistant, this is normally `/config/node-red/settings.js`.
+
+Here is an example of a configuration for the context storage:
 
 ```js
 contextStorage: {
-   default: {
-       module: "localfilesystem"
-   }
+  file: { module: "localfilesystem"},
+  default: { module: "memory" }
 }
 ```
 
+By default, this node saves context to the `default` context storage. In the example above, this is memory.
+Then it is not preserved over a restart.
 Please read the [Node-RED documentation](https://nodered.org/docs/user-guide/context) for more details about this.
-:::
+
+The data that is saved is the config, the last used prices and the last calculated schedule.
+
+When Node-RED restarts, the config is reset to what is defined in the node config, so by default,
+nothing is read from the context storage after a restart. However, if you send a `replan` command to the
+nodes input, a plan is recalculated, using the last received prices. One way to do this is to use an `inject` node,
+and set `msg.payload` to the following JSON value:
+
+```json
+{
+  "commands": {
+    "replan": true
+  }
+}
+```
+
+This is an alternative to fetching new prices and send as input.
 
 ## Integration with MagicMirror