node-red-contrib-energymeterplus 0.1.0 → 0.2.0

package/README.md

@@ -0,0 +1,166 @@
+#### **EnergyMeterPlus Node Version 0.1.2**
+
+
+
+##### **Overview:**
+
+
+
+EnergyMeterPlus is a custom Node‑RED function node designed to convert instantaneous power readings (Watts) into accumulated energy values (kWh) over time. It integrates power based on elapsed time between samples, applies baseline corrections, calculates costs, and persists totals across restarts.
+
+
+
+
+
+##### **Features:**
+
+
+
+* Converts power (W) into energy (kWh) using time integration.
+
+
+
+* Tracks daily, weekly, monthly, and yearly energy totals.
+
+
+
+* Calculates costs based on a configurable unit cost.
+
+
+
+* Unit cost configurable in 3 different currencies
+
+
+
+* Supports baseline corrections to start counters from existing values.
+
+
+
+* Handles rollover at day, week, month, and year boundaries.
+
+
+
+* Persists counters and timestamps in Node‑RED context and writes snapshots to file.
+
+
+
+* Outputs clean values rounded to two decimal places for dashboards.
+
+
+
+
+
+###### **Configuration:**
+
+
+
+Unit Cost: Cost per kWh (e.g., 0.15 for $0.15/kWh).
+
+
+
+Currency: Choose USD, EUR, or NGN (fixed values, not convertible)
+
+
+
+File Path: Path to store snapshots (default: /config/node\_red/solargen\_data.json).
+
+
+
+Input Unit: "W" for Watts (default) or "kW" if your source already provides kilowatts.
+
+
+
+Baselines: Initial values for daily, weekly, monthly, and yearly counters. Can also be used to correct baseline values or left blank if not needed.
+
+
+
+
+
+###### **Output:**
+
+
+
+The node outputs a payload object:
+
+
+
+json
+
+{
+
+  "daily\_kWh": 4.53,
+
+  "weekly\_kWh": 32.18,
+
+  "monthly\_kWh": 128.74,
+
+  "yearly\_kWh": 1024.56,
+
+  "daily\_cost": 0.68,
+
+  "weekly\_cost": 4.83,
+
+  "monthly\_cost": 19.31,
+
+  "yearly\_cost": 153.68
+
+}
+
+All values are rounded to two decimal places.
+
+
+
+
+
+###### **Rollover Logic:**
+
+
+
+* Daily resets at midnight.
+* 
+* Weekly resets on Sunday.
+* 
+* Monthly resets on the first of the month.
+* 
+* Yearly resets on January 1st and archives the previous year’s totals.
+
+
+
+
+
+###### **Persistence:**
+
+
+
+Counters and timestamps are stored in Node‑RED context.
+
+
+
+Snapshots are written to the configured JSON file.
+
+
+
+Directories are auto‑created if missing, ensuring no ENOENT errors.
+
+
+
+
+
+##### **Example:**
+
+
+
+If your solar system outputs \~4526 W continuously:
+
+
+
+After 1 hour → \~4.53 kWh added to daily total.
+
+
+
+After 24 hours → \~108.6 kWh added to daily total.
+
+
+
+Costs scale automatically with your configured unit cost.
+

package/energyMeterPlus.html

@@ -1,7 +1,7 @@
 <script type="text/javascript">
     RED.nodes.registerType('energyMeterPlus', {
         category: 'energy',
-        color: '#d9910cfe', <!-- Dutch Orange -->
+        color: '#f3a108fe', <!-- Dutch Orange -->
         defaults: {
             name: {value:""},
             baselineDaily: {value:0},
@@ -9,7 +9,8 @@
             baselineMonthly: {value:0},
             baselineYearly: {value:0},
             unitCost: {value:0.15},
-            filePath: {value:"/addon_configs/a0d7b954_nodered/node_red/solarGen_data.json"},
+            currency: {value:"USD"},   // NEW field
+            filePath: {value:"/config/node_red/solargen_data.json"},
             inputUnit: {value:"kW"}
         },
         inputs:1,
@@ -46,6 +47,14 @@
         <label for="node-input-unitCost">Cost per Unit</label>
         <input type="number" id="node-input-unitCost" step="0.01">
     </div>
+    <div class="form-row">
+        <label for="node-input-currency"><i class="fa fa-money"></i> Currency</label>
+        <select id="node-input-currency">
+            <option value="USD">USD ($)</option>
+            <option value="EUR">Euro (€)</option>
+            <option value="NGN">Naira (₦)</option>
+        </select>
+    </div>
     <div class="form-row">
         <label for="node-input-filePath">Filepath</label>
         <input type="text" id="node-input-filePath">

package/energyMeterPlus.js

@@ -1,4 +1,5 @@
 const fs = require("fs");
+const path = require("path");
 
 module.exports = function(RED) {
     function EnergyMeterPlus(config) {
@@ -6,59 +7,115 @@ module.exports = function(RED) {
         var node = this;
 
         let unitCost = Number(config.unitCost) || 0;
-        let filePath = config.filePath || "/addon_configs/a0d7b954_nodered/node_red/solarGen_data.json";
-        let inputUnit = config.inputUnit || "W"; // default to Watts
+        let filePath = config.filePath || "/config/node_red/solargen_data.json";
+        let inputUnit = config.inputUnit || "W";
+        let currencyCode = config.currency || "USD";
 
-        // Numeric baseline corrections
+        // Baseline corrections
         let baselineDaily   = Number(config.baselineDaily)   || 0;
         let baselineWeekly  = Number(config.baselineWeekly)  || 0;
         let baselineMonthly = Number(config.baselineMonthly) || 0;
         let baselineYearly  = Number(config.baselineYearly)  || 0;
 
-        // Baseline counters
-        let baseline = { daily: baselineDaily, weekly: baselineWeekly, monthly: baselineMonthly, yearly: baselineYearly };
-        let lastCheck = new Date();
+        // Load persisted baseline or initialize
+        let baseline = node.context().get("baseline") || {
+            daily: 0,
+            weekly: 0,
+            monthly: 0,
+            yearly: 0
+        };
+
+        // Apply baselines if new values entered
+        let baselineApplied = node.context().get("baselineApplied") || false;
+        if (!baselineApplied || baselineDaily || baselineWeekly || baselineMonthly || baselineYearly) {
+            baseline.daily   += baselineDaily;
+            baseline.weekly  += baselineWeekly;
+            baseline.monthly += baselineMonthly;
+            baseline.yearly  += baselineYearly;
+
+            node.context().set("baselineApplied", true);
+
+            // Cosmetic blanking: clear config fields so they show empty in UI
+            config.baselineDaily   = "";
+            config.baselineWeekly  = "";
+            config.baselineMonthly = "";
+            config.baselineYearly  = "";
+        }
+
+        // Load last timestamp or initialize
+        let lastCheck = node.context().get("lastCheck") || new Date();
+
+        // Currency symbol helper
+        function currencySymbol(code) {
+            switch (code) {
+                case "USD": return "$";
+                case "EUR": return "€";
+                case "NGN": return "₦";
+                default: return code;
+            }
+        }
 
         // Rollover logic
         function checkRollover() {
             let now = new Date();
-            if (now.getDate() !== lastCheck.getDate()) baseline.daily = baselineDaily;
-            if (now.getDay() === 0 && lastCheck.getDay() !== 0) baseline.weekly = baselineWeekly;
-            if (now.getMonth() !== lastCheck.getMonth()) baseline.monthly = baselineMonthly;
+
+            // Daily rollover (midnight)
+            if (now.getDate() !== lastCheck.getDate()) {
+                baseline.weekly += baseline.daily; // absorb yesterday
+                baseline.daily = 0;
+            }
+
+            // Weekly rollover (Sunday → Monday)
+            if (now.getDay() === 1 && lastCheck.getDay() !== 1) {
+                baseline.monthly += baseline.weekly; // absorb last week
+                baseline.weekly = 0;
+            }
+
+            // Monthly rollover (1st of month)
+            if (now.getMonth() !== lastCheck.getMonth()) {
+                baseline.yearly += baseline.monthly; // absorb last month
+                baseline.monthly = 0;
+            }
+
+            // Yearly rollover (Jan 1)
             if (now.getFullYear() !== lastCheck.getFullYear()) {
-                let archiveName = filePath.replace(".json", `_${lastCheck.getFullYear()}.json`);
-                try { fs.writeFileSync(archiveName, JSON.stringify(baseline, null, 2)); }
-                catch (err) { node.error("Failed to archive yearly file: " + err); }
-                baseline.yearly = baselineYearly;
+                try {
+                    const archivePath = path.join(path.dirname(filePath), "yearly_archive.json");
+                    let archive = [];
+                    if (fs.existsSync(archivePath)) {
+                        archive = JSON.parse(fs.readFileSync(archivePath));
+                    }
+                    archive.push({
+                        year: lastCheck.getFullYear(),
+                        total_kWh: baseline.yearly,
+                        timestamp: new Date().toISOString()
+                    });
+                    fs.writeFileSync(archivePath, JSON.stringify(archive, null, 2));
+                } catch (err) {
+                    node.error("Failed to archive yearly total: " + err);
+                }
+                baseline.yearly = 0;
             }
+
             lastCheck = now;
+            node.context().set("baseline", baseline);
+            node.context().set("lastCheck", lastCheck);
         }
         setInterval(checkRollover, 60000);
 
         node.on('input', function(msg) {
             let now = new Date();
-            let durationHours = (now - lastCheck) / (1000 * 3600); // elapsed time in hours
+            let durationHours = (now - lastCheck) / (1000 * 3600);
             lastCheck = now;
+            node.context().set("lastCheck", lastCheck);
 
             let power = Number(msg.payload) || 0;
             let power_kW = (inputUnit === "W") ? power / 1000 : power;
 
-            // Energy increment = Power × Time
             let energyIncrement = power_kW * durationHours;
 
-            // Add to counters
-            baseline.daily   += energyIncrement;
-            baseline.weekly  += energyIncrement;
-            baseline.monthly += energyIncrement;
-            baseline.yearly  += energyIncrement;
-
-            // Calculate costs
-            let daily_cost   = baseline.daily   * unitCost;
-            let weekly_cost  = baseline.weekly  * unitCost;
-            let monthly_cost = baseline.monthly * unitCost;
-            let yearly_cost  = baseline.yearly  * unitCost;
+            baseline.daily += energyIncrement;
 
-            // Round all outputs to 2 decimal places
             function round2(val) { return Number(val.toFixed(2)); }
 
             msg.payload = {
@@ -66,21 +123,31 @@ module.exports = function(RED) {
                 weekly_kWh: round2(baseline.weekly),
                 monthly_kWh: round2(baseline.monthly),
                 yearly_kWh: round2(baseline.yearly),
-                daily_cost: round2(daily_cost),
-                weekly_cost: round2(weekly_cost),
-                monthly_cost: round2(monthly_cost),
-                yearly_cost: round2(yearly_cost)
+                daily_cost: round2(baseline.daily * unitCost),
+                weekly_cost: round2(baseline.weekly * unitCost),
+                monthly_cost: round2(baseline.monthly * unitCost),
+                yearly_cost: round2(baseline.yearly * unitCost),
+                currency: currencySymbol(currencyCode)
             };
 
-            // Save snapshot
-            try { fs.writeFileSync(filePath, JSON.stringify(msg.payload, null, 2)); }
-            catch (err) { node.error("Failed to write to file: " + err); }
+            // Ensure directory exists
+            const dir = path.dirname(filePath);
+            if (!fs.existsSync(dir)) {
+                fs.mkdirSync(dir, { recursive: true });
+            }
+
+            // Write snapshot safely
+            try {
+                fs.writeFileSync(filePath, JSON.stringify(msg.payload, null, 2));
+            } catch (err) {
+                node.error("Failed to write to file: " + err);
+            }
 
             node.send(msg);
         });
     }
 
     RED.nodes.registerType("energyMeterPlus", EnergyMeterPlus, {
-        color: "#d9910cfe" // Dutch Orange
+        color: "#f3a108fe"
     });
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "node-red-contrib-energymeterplus",
-  "version": "0.1.0",
-  "description": "A node-red energy meter node with editable baseline data, milestone summary, and cost calculation",
+  "version": "0.2.0",
+  "description": "A custom Node-RED node that integrates power readings into energy totals with persistence and cost calculation.",
   "author": "Arcfrankye",
   "license": "MIT",
   "keywords": [
@@ -13,3 +13,4 @@
     }
   }
 }
+