node-red-contrib-energymeterplus 0.2.7 → 0.3.0

package/README.md

@@ -1,4 +1,4 @@
-#### **EnergyMeterPlus Node Version 0.2.5**
+#### **EnergyMeterPlus Node Version 0.3.0**
 
 
 
@@ -172,7 +172,7 @@ Costs scale automatically with your configured unit cost.
 
 
 
-###### **V2.3:**
+###### **v2.3:**
 
 
 
@@ -192,7 +192,7 @@ updated counters to continuous absorption, no transfer at rollover
 
 
 
-###### v2.4
+###### **v2.4**
 
 
 
@@ -208,9 +208,17 @@ Fixed Baselines bug: Baselines captured once, stored in context, and survive aft
 
 
 
-v2.5
+###### **v2.5**
 
 
 
 Fixed internal counter bug
 
+
+
+###### **v3.0**
+
+
+
+**Major overhaul of UI and internal logic programming to fix bugs in counters and baseline corrections**
+

package/energyMeterPlus.html

@@ -1,17 +1,18 @@
+
 <script type="text/javascript">
     RED.nodes.registerType('energyMeterPlus', {
         category: 'energy',
-        color: '#f3a108fe', <!-- Dutch Orange -->
+        color: '#f3a108fe', //-- Dutch Orange --
         defaults: {
             name: {value:""},
-            baselineDaily: {value:0},
-            baselineWeekly: {value:0},
-            baselineMonthly: {value:0},
-            baselineYearly: {value:0},
-            unitCost: {value:0.15},
-            currency: {value:"USD"},   // NEW field
-            filePath: {value:"/config/node_red/solargen_data.json"},
-            inputUnit: {value:"kW"}
+            baselineDaily: {value:0, required:false},
+            baselineWeekly: {value:0, required:false},
+            baselineMonthly: {value:0, required:false},
+            baselineYearly: {value:0, required:false},
+            unitCost: {value:0.15, required:true},
+            currency: {value:"USD", required:true},
+            filePath: {value:"/config/node_red/solargen_data.json", required:false},
+            inputUnit: {value:"W", required:true}
         },
         inputs:1,
         outputs:1,
@@ -19,8 +20,33 @@
         label: function() {
             return this.name || "energyMeterPlus";
         },
+        oneditprepare: function() {
+            // Nothing special here yet
+        },
         oneditsave: function() {
-            // Cosmetic blanking: clear baseline fields in the editor UI after deploy
+            // Collect baseline values
+            var daily   = Number($("#node-input-baselineDaily").val()) || 0;
+            var weekly  = Number($("#node-input-baselineWeekly").val()) || 0;
+            var monthly = Number($("#node-input-baselineMonthly").val()) || 0;
+            var yearly  = Number($("#node-input-baselineYearly").val()) || 0;
+
+            var baselineMsg = {
+                nodeId: this.id,
+                payload: { daily, weekly, monthly, yearly }
+            };
+
+            // Feedback logic
+            if (daily === 0 && weekly === 0 && monthly === 0 && yearly === 0) {
+                RED.notify("⚠️ Baseline values are all zero — nothing applied", {type:"warning", timeout:3000});
+            } else if (isNaN(daily) || isNaN(weekly) || isNaN(monthly) || isNaN(yearly)) {
+                RED.notify("❌ Baseline values invalid — please enter numbers", {type:"error", timeout:4000});
+            } else {
+                RED.comms.send("energyMeterPlus/applyBaseline", baselineMsg);
+                RED.notify("✅ Baseline offset applied successfully", {type:"success", timeout:2000});
+                console.log("Baseline offset applied:", baselineMsg.payload);
+            }
+
+            // Clear fields after save
             $("#node-input-baselineDaily").val("");
             $("#node-input-baselineWeekly").val("");
             $("#node-input-baselineMonthly").val("");
@@ -34,24 +60,28 @@
         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
         <input type="text" id="node-input-name">
     </div>
+
+    <!-- Baseline offsets -->
     <div class="form-row">
-        <label for="node-input-baselineDaily">Baseline Daily (kWh)</label>
-        <input type="number" id="node-input-baselineDaily">
+        <label for="node-input-baselineDaily"><i class="fa fa-calendar-day"></i> Baseline Daily Offset</label>
+        <input type="number" id="node-input-baselineDaily" placeholder="Daily offset">
     </div>
     <div class="form-row">
-        <label for="node-input-baselineWeekly">Baseline Weekly (kWh)</label>
-        <input type="number" id="node-input-baselineWeekly">
+        <label for="node-input-baselineWeekly"><i class="fa fa-calendar-week"></i> Baseline Weekly Offset</label>
+        <input type="number" id="node-input-baselineWeekly" placeholder="Weekly offset">
     </div>
     <div class="form-row">
-        <label for="node-input-baselineMonthly">Baseline Monthly (kWh)</label>
-        <input type="number" id="node-input-baselineMonthly">
+        <label for="node-input-baselineMonthly"><i class="fa fa-calendar-alt"></i> Baseline Monthly Offset</label>
+        <input type="number" id="node-input-baselineMonthly" placeholder="Monthly offset">
     </div>
     <div class="form-row">
-        <label for="node-input-baselineYearly">Baseline Yearly (kWh)</label>
-        <input type="number" id="node-input-baselineYearly">
+        <label for="node-input-baselineYearly"><i class="fa fa-calendar"></i> Baseline Yearly Offset</label>
+        <input type="number" id="node-input-baselineYearly" placeholder="Yearly offset">
     </div>
+
+    <!-- Other settings -->
     <div class="form-row">
-        <label for="node-input-unitCost">Cost per Unit</label>
+        <label for="node-input-unitCost"><i class="fa fa-money"></i> Cost per Unit</label>
         <input type="number" id="node-input-unitCost" step="0.01">
     </div>
     <div class="form-row">
@@ -63,14 +93,21 @@
         </select>
     </div>
     <div class="form-row">
-        <label for="node-input-filePath">Filepath</label>
+        <label for="node-input-filePath"><i class="fa fa-file"></i> Filepath</label>
         <input type="text" id="node-input-filePath">
     </div>
     <div class="form-row">
-        <label for="node-input-inputUnit">Input Unit</label>
+        <label for="node-input-inputUnit"><i class="fa fa-bolt"></i> Input Unit</label>
         <select id="node-input-inputUnit">
             <option value="kW">kW</option>
             <option value="W">W</option>
         </select>
     </div>
 </script>
+
+<script type="text/x-red" data-help-name="energyMeterPlus">
+    <p><b>Energy Meter Plus</b> tracks energy consumption and cost.</p>
+    <p>Outputs <code>energyDaily</code>, <code>energyWeekly</code>, <code>energyMonthly</code>, and <code>energyYearly</code> values, plus cost calculations.</p>
+    <p>You can set baseline offsets (daily, weekly, monthly, yearly) to adjust counters. These offsets are additive and applied on top of live increments.</p>
+    <p>Rollover logic resets counters at midnight (daily), Sunday midnight (weekly), first day of month (monthly), and Dec 31 midnight (yearly, with archive).</p>
+</script>

package/energyMeterPlus.js

@@ -2,6 +2,24 @@ const fs = require("fs");
 const path = require("path");
 
 module.exports = function(RED) {
+
+    // Listener for baseline messages from the editor
+    RED.comms.subscribe("energyMeterPlus/applyBaseline", function(baselineMsg) {
+        const nodeInstance = RED.nodes.getNode(baselineMsg.nodeId);
+        if (nodeInstance) {
+            let baseline = nodeInstance.context().get("baseline") || {
+                daily:0, weekly:0, monthly:0, yearly:0
+            };
+            // Additive offsets
+            baseline.daily   += baselineMsg.payload.daily;
+            baseline.weekly  += baselineMsg.payload.weekly;
+            baseline.monthly += baselineMsg.payload.monthly;
+            baseline.yearly  += baselineMsg.payload.yearly;
+
+            nodeInstance.context().set("baseline", baseline);
+        }
+    });
+
     function EnergyMeterPlus(config) {
         RED.nodes.createNode(this, config);
         var node = this;
@@ -11,36 +29,23 @@ module.exports = function(RED) {
         let inputUnit = config.inputUnit || "W";
         let currencyCode = config.currency || "USD";
 
-        // Counters start from context or zero
-        let baseline = node.context().get("baseline") || {
-            daily: 0,
-            weekly: 0,
-            monthly: 0,
-            yearly: 0
-        };
-
-        // Capture baselines once on deploy
-        let storedBaselines = {
-            daily: Number(config.baselineDaily) || 0,
-            weekly: Number(config.baselineWeekly) || 0,
-            monthly: Number(config.baselineMonthly) || 0,
-            yearly: Number(config.baselineYearly) || 0
-        };
-
-        // Apply baselines once
-        baseline.daily   += storedBaselines.daily;
-        baseline.weekly  += storedBaselines.weekly;
-        baseline.monthly += storedBaselines.monthly;
-        baseline.yearly  += storedBaselines.yearly;
-
-        // Discard baselines from UI after applying
+        // Baseline offsets
+        let baseline = node.context().get("baseline") || { daily:0, weekly:0, monthly:0, yearly:0 };
+
+        // Live increments
+        let accumulated = node.context().get("accumulated") || { daily:0, weekly:0, monthly:0, yearly:0 };
+
+        // Apply initial baselines from config
+        baseline.daily   += Number(config.baselineDaily) || 0;
+        baseline.weekly  += Number(config.baselineWeekly) || 0;
+        baseline.monthly += Number(config.baselineMonthly) || 0;
+        baseline.yearly  += Number(config.baselineYearly) || 0;
+
         node.context().set("baseline", baseline);
-        node.context().set("storedBaselines", { daily:0, weekly:0, monthly:0, yearly:0 });
+        node.context().set("accumulated", accumulated);
 
-        // Last timestamp
         let lastCheck = node.context().get("lastCheck") || new Date();
 
-        // Helpers
         function currencySymbol(code) {
             switch (code) {
                 case "USD": return "$";
@@ -61,39 +66,44 @@ module.exports = function(RED) {
                 if (fs.existsSync(archivePath)) {
                     archive = JSON.parse(fs.readFileSync(archivePath));
                 }
-                archive.push({ year, total_kWh: total, timestamp: new Date().toISOString() });
+                archive.push({ year, total: total, timestamp: new Date().toISOString() });
                 fs.writeFileSync(archivePath, JSON.stringify(archive, null, 2));
             } catch (err) {
                 node.error("Failed to archive yearly total: " + err);
             }
         }
 
-        // Rollover logic
+        // Rollover logic resets counters
         function checkRollover() {
             let now = new Date();
 
-            // Daily rollover
+            // Daily reset at midnight
             if (now.getDate() !== lastCheck.getDate()) {
+                accumulated.daily = 0;
                 baseline.daily = 0;
             }
 
-            // Weekly rollover (Sunday midnight → Monday start)
+            // Weekly reset (Sunday midnight → Monday start)
             if (now.getDay() === 1 && lastCheck.getDay() !== 1) {
+                accumulated.weekly = 0;
                 baseline.weekly = 0;
             }
 
-            // Monthly rollover
+            // Monthly reset
             if (now.getMonth() !== lastCheck.getMonth()) {
+                accumulated.monthly = 0;
                 baseline.monthly = 0;
             }
 
-            // Yearly rollover
+            // Yearly reset
             if (now.getFullYear() !== lastCheck.getFullYear()) {
-                archiveYearly(baseline.yearly, lastCheck.getFullYear());
+                archiveYearly(baseline.yearly + accumulated.yearly, lastCheck.getFullYear());
+                accumulated.yearly = 0;
                 baseline.yearly = 0;
             }
 
             lastCheck = now;
+            node.context().set("accumulated", accumulated);
             node.context().set("baseline", baseline);
             node.context().set("lastCheck", lastCheck);
         }
@@ -109,26 +119,26 @@ module.exports = function(RED) {
                 let power_kW = (inputUnit === "W") ? power / 1000 : power;
                 let energyIncrement = power_kW * durationHours;
 
-                // Apply increment separately to each counter
-                baseline.daily   += energyIncrement;
-                baseline.weekly  += energyIncrement;
-                baseline.monthly += energyIncrement;
-                baseline.yearly  += energyIncrement;
+                accumulated.daily   += energyIncrement;
+                accumulated.weekly  += energyIncrement;
+                accumulated.monthly += energyIncrement;
+                accumulated.yearly  += energyIncrement;
             }
 
             lastCheck = now;
             node.context().set("lastCheck", lastCheck);
-            node.context().set("baseline", baseline);
+            node.context().set("accumulated", accumulated);
 
+            // Output = baseline + accumulated
             msg.payload = {
-                daily_kWh: round2(baseline.daily),
-                weekly_kWh: round2(baseline.weekly),
-                monthly_kWh: round2(baseline.monthly),
-                yearly_kWh: round2(baseline.yearly),
-                daily_cost: round2(baseline.daily * unitCost),
-                weekly_cost: round2(baseline.weekly * unitCost),
-                monthly_cost: round2(baseline.monthly * unitCost),
-                yearly_cost: round2(baseline.yearly * unitCost),
+                energyDaily:   round2(baseline.daily   + accumulated.daily),
+                energyWeekly:  round2(baseline.weekly  + accumulated.weekly),
+                energyMonthly: round2(baseline.monthly + accumulated.monthly),
+                energyYearly:  round2(baseline.yearly  + accumulated.yearly),
+                daily_cost:   round2((baseline.daily   + accumulated.daily)   * unitCost),
+                weekly_cost:  round2((baseline.weekly  + accumulated.weekly)  * unitCost),
+                monthly_cost: round2((baseline.monthly + accumulated.monthly) * unitCost),
+                yearly_cost:  round2((baseline.yearly  + accumulated.yearly)  * unitCost),
                 currency: currencySymbol(currencyCode)
             };
 

package/package.json

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