node-red-contrib-energymeterplus 0.3.6 → 1.0.1

package/README.md

@@ -1,6 +1,6 @@
 ##### **EnergyMeterPlus** Node Version 1.0.1
 @ arcfrankye 26-06-26
-
+{The first stable release is here at last!}
 
 
 ###### Overview
@@ -130,7 +130,94 @@ Note: field names are `energyDaily`, `energyWeekly`, `energyMonthly`, `energyYea
 * Initial release: integrates power to energy, cost calc, rollovers, persistence, and basic baseline support.
 
 
-
+###### Quick Start Demo Flow
+To help you get started with **EnergyMeterPlus**, here is a small demo flow you can import directly into Node RED. It shows how to use the new Apply and Reset features, as well as runtime messages.
+
+**Steps**
+Open Node RED.
+
+Click the menu (top right) → Import → Clipboard.
+
+Paste the JSON below into the box.
+
+Click Import.
+
+You should see two Inject nodes wired into **EnergyMeterPlus** and a "Energy Output" debug node.
+
+Click the Inject buttons to test Apply/Reset and watch the payloads in the Debug sidebar.
+
+**Demo Flow JSON**
+json
+[
+  {
+    "id": "inject-apply",
+    "type": "inject",
+    "z": "flow1",
+    "name": "Apply Baseline (2 kWh daily)",
+    "props": [
+      { "p": "payload" },
+      { "p": "topic", "vt": "str" }
+    ],
+    "payload": "{\"daily\":2,\"weekly\":0,\"monthly\":0,\"yearly\":0}",
+    "payloadType": "json",
+    "topic": "applyBaseline",
+    "x": 180,
+    "y": 120,
+    "wires": [["energyMeterPlus"]]
+  },
+  {
+    "id": "inject-reset",
+    "type": "inject",
+    "z": "flow1",
+    "name": "Reset Editor Applied",
+    "props": [
+      { "p": "topic", "vt": "str" }
+    ],
+    "topic": "resetEditorApplied",
+    "x": 170,
+    "y": 180,
+    "wires": [["energyMeterPlus"]]
+  },
+  {
+    "id": "energyMeterPlus",
+    "type": "energyMeterPlus",
+    "z": "flow1",
+    "name": "EnergyMeterPlus",
+    "unitCost": "0.15",
+    "currency": "USD",
+    "filePath": "/config/node_red/solargen_data.json",
+    "inputUnit": "W",
+    "baselineDaily": "0",
+    "baselineWeekly": "0",
+    "baselineMonthly": "0",
+    "baselineYearly": "0",
+    "applied": false,
+    "x": 420,
+    "y": 150,
+    "wires": [["debug-output"]]
+  },
+  {
+    "id": "debug-output",
+    "type": "debug",
+    "z": "flow1",
+    "name": "Energy Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "payload",
+    "targetType": "msg",
+    "x": 650,
+    "y": 150,
+    "wires": []
+  }
+]
+**What it does**
+Apply Baseline (2 kWh daily) → sends a runtime applyBaseline message that adds 2 kWh to the daily baseline immediately.
+
+Reset Editor Applied → clears the remembered editor baseline so the same values can be applied again on next Deploy.
+
+Debug Output → shows the updated payload with energy totals and costs.
 
 
 

package/energyMeterPlus.html

@@ -122,6 +122,15 @@ RED.nodes.registerType('energyMeterPlus', {
 });
 </script>
 
+<!-- Tool tip -->
+<script type="text/x-red" data-help-name="energyMeterPlus">
+  <p><b>EnergyMeterPlus</b>: Converts instantaneous power readings into accumulated energy totals and cost, with robust baseline handling with archiving.</p>
+  <p><b>EnergyMeterPlus</b>: node integrates instantaneous power readings into daily, weekly, monthly, and yearly energy totals, with rollover logic that can be aligned to your reporting cycle.</p>
+  <p> Baseline offsets are applied once using the editor’s Apply button, preventing accidental double‑application, while the Reset button allows intentional re‑application when needed.</p>
+  <p>Totals and costs are persisted in context and written to file, with optional archiving of yearly data for long‑term analysis. Outputs are rounded for clean dashboard display.</p>
+</script>
+
+
 <!-- Template -->
 <script type="text/x-red" data-template-name="energyMeterPlus">
     <div class="form-row">

package/energyMeterPlus.js

@@ -1,5 +1,5 @@
 /**
- * energyMeterPlus runtime
+ * energyMeterPlus runtime #arcfrankye - 27/06/2026
  * - Applies editor baseline offsets exactly once when editor sets `applied` and you Deploy.
  * - Uses lastAppliedEditor in node context to avoid double application.
  * - Supports runtime messages:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-energymeterplus",
-  "version": "0.3.6",
+  "version": "1.0.1",
   "description": "A custom Node-RED node that integrates power readings into energy totals with persistence and cost calculation.",
   "author": "Arcfrankye",
   "license": "MIT",