New upstream version 1.8.0+dfsgupstream/1.8.0+dfsg

1 files changed, 192 insertions, 119 deletions

diff --git a/node.d/fronius.node.js b/node.d/fronius.node.js
index f771f6c3d..7aa2c13b7 100644
--- a/node.d/fronius.node.js
+++ b/node.d/fronius.node.js
@@ -1,15 +1,15 @@
-'use strict';
+"use strict";
 
 // This program will connect to one or more Fronius Symo Inverters.
 // to get the Solar Power Generated (current, today).
 
 // example configuration in netdata/conf.d/node.d/fronius.conf.md
 
-var url = require('url');
-var http = require('http');
-var netdata = require('netdata');
+var url = require("url");
+var http = require("http");
+var netdata = require("netdata");
 
-netdata.debug('loaded ' + __filename + ' plugin');
+netdata.debug("loaded " + __filename + " plugin");
 
 var fronius = {
     name: "Fronius",
@@ -39,24 +39,25 @@ var fronius = {
     },
 
     // Gets the site power chart. Will be created if not existing.
-    getSitePowerChart: function (service, id) {
+    getSitePowerChart: function (service, suffix) {
+        var id = this.getChartId(service, suffix);
         var chart = fronius.charts[id];
         if (fronius.isDefined(chart)) return chart;
 
         var dim = {};
-        dim[fronius.powerGridId] = this.createBasicDimension(fronius.powerGridId, "Grid", 1);
-        dim[fronius.powerPvId] = this.createBasicDimension(fronius.powerPvId, "Photovoltaics", 1);
-        dim[fronius.powerAccuId] = this.createBasicDimension(fronius.powerAccuId, "Accumulator", 1);
+        dim[fronius.powerGridId] = this.createBasicDimension(fronius.powerGridId, "grid", 1);
+        dim[fronius.powerPvId] = this.createBasicDimension(fronius.powerPvId, "photovoltaics", 1);
+        dim[fronius.powerAccuId] = this.createBasicDimension(fronius.powerAccuId, "accumulator", 1);
 
         chart = {
             id: id,                                         // the unique id of the chart
-            name: '',                                       // the unique name of the chart
-            title: service.name + ' Current Site Power',    // the title of the chart
-            units: 'W',                                   // the units of the chart dimensions
-            family: 'power',                                  // the family of the chart
-            context: 'fronius.power',                // the context of the chart
+            name: "",                                       // the unique name of the chart
+            title: service.name + " Current Site Power",    // the title of the chart
+            units: "W",                                     // the units of the chart dimensions
+            family: "power",                                // the family of the chart
+            context: "fronius.power",                       // the context of the chart
             type: netdata.chartTypes.area,                  // the type of the chart
-            priority: fronius.base_priority + 1,             // the priority relative to others in the same family
+            priority: fronius.base_priority + 1,            // the priority relative to others in the same family
             update_every: service.update_every,             // the expected update frequency of the chart
             dimensions: dim
         };
@@ -67,19 +68,20 @@ var fronius = {
     },
 
     // Gets the site consumption chart. Will be created if not existing.
-    getSiteConsumptionChart: function (service, id) {
+    getSiteConsumptionChart: function (service, suffix) {
+        var id = this.getChartId(service, suffix);
         var chart = fronius.charts[id];
         if (fronius.isDefined(chart)) return chart;
         var dim = {};
-        dim[fronius.consumptionLoadId] = this.createBasicDimension(fronius.consumptionLoadId, "Load", 1);
+        dim[fronius.consumptionLoadId] = this.createBasicDimension(fronius.consumptionLoadId, "load", 1);
 
         chart = {
             id: id,                                         // the unique id of the chart
-            name: '',                                       // the unique name of the chart
-            title: service.name + ' Current Load',          // the title of the chart
-            units: 'W',                                     // the units of the chart dimensions
-            family: 'consumption',                                  // the family of the chart
-            context: 'fronius.consumption',                 // the context of the chart
+            name: "",                                       // the unique name of the chart
+            title: service.name + " Current Load",          // the title of the chart
+            units: "W",                                     // the units of the chart dimensions
+            family: "consumption",                          // the family of the chart
+            context: "fronius.consumption",                 // the context of the chart
             type: netdata.chartTypes.area,                  // the type of the chart
             priority: fronius.base_priority + 2,            // the priority relative to others in the same family
             update_every: service.update_every,             // the expected update frequency of the chart
@@ -92,20 +94,21 @@ var fronius = {
     },
 
     // Gets the site consumption chart. Will be created if not existing.
-    getSiteAutonomyChart: function (service, id) {
+    getSiteAutonomyChart: function (service, suffix) {
+        var id = this.getChartId(service, suffix);
         var chart = fronius.charts[id];
         if (fronius.isDefined(chart)) return chart;
         var dim = {};
-        dim[fronius.autonomyId] = this.createBasicDimension(fronius.autonomyId, "Autonomy", 1);
-        dim[fronius.consumptionSelfId] = this.createBasicDimension(fronius.consumptionSelfId, "Self Consumption", 1);
+        dim[fronius.autonomyId] = this.createBasicDimension(fronius.autonomyId, "autonomy", 1);
+        dim[fronius.consumptionSelfId] = this.createBasicDimension(fronius.consumptionSelfId, "self_consumption", 1);
 
         chart = {
             id: id,                                         // the unique id of the chart
-            name: '',                                       // the unique name of the chart
-            title: service.name + ' Current Autonomy',      // the title of the chart
-            units: '%',                                     // the units of the chart dimensions
-            family: 'autonomy',                                  // the family of the chart
-            context: 'fronius.autonomy',                 // the context of the chart
+            name: "",                                       // the unique name of the chart
+            title: service.name + " Current Autonomy",      // the title of the chart
+            units: "%",                                     // the units of the chart dimensions
+            family: "autonomy",                             // the family of the chart
+            context: "fronius.autonomy",                    // the context of the chart
             type: netdata.chartTypes.area,                  // the type of the chart
             priority: fronius.base_priority + 3,            // the priority relative to others in the same family
             update_every: service.update_every,             // the expected update frequency of the chart
@@ -118,21 +121,22 @@ var fronius = {
     },
 
     // Gets the site energy chart for today. Will be created if not existing.
-    getSiteEnergyTodayChart: function (service, chartId) {
+    getSiteEnergyTodayChart: function (service, suffix) {
+        var chartId = this.getChartId(service, suffix);
         var chart = fronius.charts[chartId];
         if (fronius.isDefined(chart)) return chart;
         var dim = {};
-        dim[fronius.energyTodayId] = this.createBasicDimension(fronius.energyTodayId, "Today", 1000);
+        dim[fronius.energyTodayId] = this.createBasicDimension(fronius.energyTodayId, "today", 1000);
         chart = {
             id: chartId,                                         // the unique id of the chart
-            name: '',                                       // the unique name of the chart
-            title: service.name + ' Energy production for today',    // the title of the chart
-            units: 'kWh',                                   // the units of the chart dimensions
-            family: 'energy',                                  // the family of the chart
-            context: 'fronius.energy.today',                // the context of the chart
-            type: netdata.chartTypes.area,                  // the type of the chart
-            priority: fronius.base_priority + 4,             // the priority relative to others in the same family
-            update_every: service.update_every,             // the expected update frequency of the chart
+            name: "",                                            // the unique name of the chart
+            title: service.name + " Energy production for today",// the title of the chart
+            units: "kWh",                                        // the units of the chart dimensions
+            family: "energy",                                    // the family of the chart
+            context: "fronius.energy.today",                     // the context of the chart
+            type: netdata.chartTypes.area,                       // the type of the chart
+            priority: fronius.base_priority + 4,                 // the priority relative to others in the same family
+            update_every: service.update_every,                  // the expected update frequency of the chart
             dimensions: dim
         };
         chart = service.chart(chartId, chart);
@@ -142,21 +146,22 @@ var fronius = {
     },
 
     // Gets the site energy chart for today. Will be created if not existing.
-    getSiteEnergyYearChart: function (service, chartId) {
+    getSiteEnergyYearChart: function (service, suffix) {
+        var chartId = this.getChartId(service, suffix);
         var chart = fronius.charts[chartId];
         if (fronius.isDefined(chart)) return chart;
         var dim = {};
-        dim[fronius.energyYearId] = this.createBasicDimension(fronius.energyYearId, "Year", 1000);
+        dim[fronius.energyYearId] = this.createBasicDimension(fronius.energyYearId, "year", 1000);
         chart = {
-            id: chartId,                                         // the unique id of the chart
-            name: '',                                       // the unique name of the chart
-            title: service.name + ' Energy production for this year',    // the title of the chart
-            units: 'kWh',                                   // the units of the chart dimensions
-            family: 'energy',                                  // the family of the chart
-            context: 'fronius.energy.year',                // the context of the chart
-            type: netdata.chartTypes.area,                  // the type of the chart
-            priority: fronius.base_priority + 5,             // the priority relative to others in the same family
-            update_every: service.update_every,             // the expected update frequency of the chart
+            id: chartId,                                             // the unique id of the chart
+            name: "",                                                // the unique name of the chart
+            title: service.name + " Energy production for this year",// the title of the chart
+            units: "kWh",                                            // the units of the chart dimensions
+            family: "energy",                                        // the family of the chart
+            context: "fronius.energy.year",                          // the context of the chart
+            type: netdata.chartTypes.area,                           // the type of the chart
+            priority: fronius.base_priority + 5,                     // the priority relative to others in the same family
+            update_every: service.update_every,                      // the expected update frequency of the chart
             dimensions: dim
         };
         chart = service.chart(chartId, chart);
@@ -167,35 +172,30 @@ var fronius = {
 
     // Gets the inverter power chart. Will be created if not existing.
     // Needs the array of inverters in order to create a chart with all inverters as dimensions
-    getInverterPowerChart: function (service, chartId, inverters) {
-
+    getInverterPowerChart: function (service, suffix, inverters) {
+        var chartId = this.getChartId(service, suffix);
         var chart = fronius.charts[chartId];
         if (fronius.isDefined(chart)) return chart;
 
         var dim = {};
-
-        var inverterCount = Object.keys(inverters).length;
-        var inverter = inverters[inverterCount.toString()];
-        var i = 1;
-        for (i; i <= inverterCount; i++) {
-            if (fronius.isUndefined(inverter)) {
-                netdata.error("Expected an Inverter with a numerical name! " +
-                    "Have a look at your JSON output to verify.");
-                continue;
+        for (var key in inverters) {
+            if (inverters.hasOwnProperty(key)) {
+                var name = key;
+                if (!isNaN(key)) name = "inverter_" + key;
+                dim[key] = this.createBasicDimension("inverter_" + key, name, 1);
             }
-            dim[i.toString()] = this.createBasicDimension("inverter_" + i, "Inverter " + i, 1);
         }
 
         chart = {
-            id: chartId,                                         // the unique id of the chart
-            name: '',                                       // the unique name of the chart
-            title: service.name + ' Current Inverter Output',    // the title of the chart
-            units: 'W',                                   // the units of the chart dimensions
-            family: 'inverters',                                  // the family of the chart
-            context: 'fronius.inverter.output',                // the context of the chart
-            type: netdata.chartTypes.stacked,                  // the type of the chart
+            id: chartId,                                     // the unique id of the chart
+            name: "",                                        // the unique name of the chart
+            title: service.name + " Current Inverter Output",// the title of the chart
+            units: "W",                                      // the units of the chart dimensions
+            family: "inverters",                             // the family of the chart
+            context: "fronius.inverter.output",              // the context of the chart
+            type: netdata.chartTypes.stacked,                // the type of the chart
             priority: fronius.base_priority + 6,             // the priority relative to others in the same family
-            update_every: service.update_every,             // the expected update frequency of the chart
+            update_every: service.update_every,              // the expected update frequency of the chart
             dimensions: dim
         };
         chart = service.chart(chartId, chart);
@@ -205,62 +205,126 @@ var fronius = {
     },
 
     processResponse: function (service, content) {
-        if (content === null) return;
-        var json = JSON.parse(content);
-        if (!fronius.isResponseValid(json)) return;
+        var json = fronius.convertToJson(content);
+        if (json === null) return;
 
         // add the service
         service.commit();
 
+        var chartDefinitions = fronius.parseCharts(service, json);
+        var chartCount = chartDefinitions.length;
+        while (chartCount--) {
+            var chartObj = chartDefinitions[chartCount];
+            service.begin(chartObj.chart);
+            var dimCount = chartObj.dimensions.length;
+            while (dimCount--) {
+                var dim = chartObj.dimensions[dimCount];
+                service.set(dim.name, dim.value);
+            }
+            service.end();
+        }
+    },
+
+    parseCharts: function (service, json) {
         var site = json.Body.Data.Site;
+        return [
+            this.parsePowerChart(service, site),
+            this.parseConsumptionChart(service, site),
+            this.parseAutonomyChart(service, site),
+            this.parseEnergyTodayChart(service, site),
+            this.parseEnergyYearChart(service, site),
+            this.parseInverterChart(service, json.Body.Data.Inverters)
+        ];
+    },
 
-        // Site Current Power Chart
-        service.begin(fronius.getSitePowerChart(service, 'fronius_' + service.name + '.power'));
-        service.set(fronius.powerGridId, Math.round(site.P_Grid));
-        service.set(fronius.powerPvId, Math.round(site.P_PV));
-        service.set(fronius.powerAccuId, Math.round(site.P_Akku));
-        service.end();
-
-        // Site Consumption Chart
-        service.begin(fronius.getSiteConsumptionChart(service, 'fronius_' + service.name + '.consumption'));
-        service.set(fronius.consumptionLoadId, Math.round(Math.abs(site.P_Load)));
-        service.end();
-
-        // Site Autonomy Chart
-        service.begin(fronius.getSiteAutonomyChart(service, 'fronius_' + service.name + '.autonomy'));
-        service.set(fronius.autonomyId, Math.round(site.rel_Autonomy));
+    parsePowerChart: function (service, site) {
+        return this.getChart(this.getSitePowerChart(service, "power"),
+            [
+                this.getDimension(this.powerGridId, Math.round(site.P_Grid)),
+                this.getDimension(this.powerPvId, Math.round(Math.max(site.P_PV, 0))),
+                this.getDimension(this.powerAccuId, Math.round(site.P_Akku))
+            ]
+        );
+    },
+
+    parseConsumptionChart: function (service, site) {
+        return this.getChart(this.getSiteConsumptionChart(service, "consumption"),
+            [this.getDimension(this.consumptionLoadId, Math.round(Math.abs(site.P_Load)))]
+        );
+    },
+
+    parseAutonomyChart: function (service, site) {
         var selfConsumption = site.rel_SelfConsumption;
-        service.set(fronius.consumptionSelfId, Math.round(selfConsumption === null ? 100 : selfConsumption));
-        service.end();
-
-        // Site Energy Today Chart
-        service.begin(fronius.getSiteEnergyTodayChart(service, 'fronius_' + service.name + '.energy.today'));
-        service.set(fronius.energyTodayId, Math.round(site.E_Day));
-        service.end();
-
-        // Site Energy Year Chart
-        service.begin(fronius.getSiteEnergyYearChart(service, 'fronius_' + service.name + '.energy.year'));
-        service.set(fronius.energyYearId, Math.round(site.E_Year));
-        service.end();
-
-        // Inverters
-        var inverters = json.Body.Data.Inverters;
-        var inverterCount = Object.keys(inverters).length + 1;
-        while (inverterCount--) {
-            var inverter = inverters[inverterCount];
-            if (fronius.isUndefined(inverter)) continue;
-            service.begin(fronius.getInverterPowerChart(service, 'fronius_' + service.name + '.inverters.output', inverters));
-            service.set(inverterCount.toString(), Math.round(inverter.P));
-            service.end();
+        return this.getChart(this.getSiteAutonomyChart(service, "autonomy"),
+            [
+                this.getDimension(this.autonomyId, Math.round(site.rel_Autonomy)),
+                this.getDimension(this.consumptionSelfId, Math.round(selfConsumption === null ? 100 : selfConsumption))
+            ]
+        );
+    },
+
+    parseEnergyTodayChart: function (service, site) {
+        return this.getChart(this.getSiteEnergyTodayChart(service, "energy.today"),
+            [this.getDimension(this.energyTodayId, Math.round(Math.max(site.E_Day, 0)))]
+        );
+    },
+
+    parseEnergyYearChart: function (service, site) {
+        return this.getChart(this.getSiteEnergyYearChart(service, "energy.year"),
+            [this.getDimension(this.energyYearId, Math.round(Math.max(site.E_Year, 0)))]
+        );
+    },
+
+    parseInverterChart: function (service, inverters) {
+        var dimensions = [];
+        for (var key in inverters) {
+            if (inverters.hasOwnProperty(key)) {
+                dimensions.push(this.getDimension(key, Math.round(inverters[key].P)));
+            }
+        }
+        return this.getChart(this.getInverterPowerChart(service, "inverters.output", inverters), dimensions);
+    },
+
+    getDimension: function (name, value) {
+        return {
+            name: name,
+            value: value
+        };
+    },
+
+    getChart: function (chart, dimensions) {
+        return {
+            chart: chart,
+            dimensions: dimensions
+        };
+    },
+
+    getChartId: function (service, suffix) {
+        return "fronius_" + service.name + "." + suffix;
+    },
+
+    convertToJson: function (httpBody) {
+        if (httpBody === null) return null;
+        var json = httpBody;
+        // can't parse if it's already a json object,
+        // the check enables easier testing if the httpBody is already valid JSON.
+        if (typeof httpBody !== "object") {
+            try {
+                json = JSON.parse(httpBody);
+            } catch (error) {
+                netdata.error("fronius: Got a response, but it is not valid JSON. Ignoring. Error: " + error.message);
+                return null;
+            }
         }
+        return this.isResponseValid(json) ? json : null;
     },
 
     // some basic validation
     isResponseValid: function (json) {
-        if (fronius.isUndefined(json.Body)) return false;
-        if (fronius.isUndefined(json.Body.Data)) return false;
-        if (fronius.isUndefined(json.Body.Data.Site)) return false;
-        return fronius.isDefined(json.Body.Data.Inverters);
+        if (this.isUndefined(json.Body)) return false;
+        if (this.isUndefined(json.Body.Data)) return false;
+        if (this.isUndefined(json.Body.Data.Site)) return false;
+        return this.isDefined(json.Body.Data.Inverters);
     },
 
     // module.serviceExecute()
@@ -268,11 +332,11 @@ var fronius = {
     // its purpose is to prepare the request and call
     // netdata.serviceExecute()
     serviceExecute: function (name, uri, update_every) {
-        netdata.debug(this.name + ': ' + name + ': url: ' + uri + ', update_every: ' + update_every);
+        netdata.debug(this.name + ": " + name + ": url: " + uri + ", update_every: " + update_every);
 
         var service = netdata.service({
             name: name,
-            request: netdata.requestFromURL('http://' + uri),
+            request: netdata.requestFromURL("http://" + uri),
             update_every: update_every,
             module: this
         });
@@ -287,6 +351,7 @@ var fronius = {
         while (len--) {
             var server = config.servers[len];
             if (fronius.isUndefined(server.update_every)) server.update_every = this.update_every;
+            if (fronius.areUndefined([server.name, server.hostname, server.api_path])) continue;
 
             var url = server.hostname + server.api_path;
             this.serviceExecute(server.name, url, server.update_every);
@@ -306,11 +371,19 @@ var fronius = {
     },
 
     isUndefined: function (value) {
-        return typeof value === 'undefined';
+        return typeof value === "undefined";
+    },
+
+    areUndefined: function (valueArray) {
+        var i = 0;
+        for (i; i < valueArray.length; i++) {
+            if (this.isUndefined(valueArray[i])) return true;
+        }
+        return false;
     },
 
     isDefined: function (value) {
-        return typeof value !== 'undefined';
+        return typeof value !== "undefined";
     }
 };