1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
'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');
netdata.debug('loaded ' + __filename + ' plugin');
var fronius = {
name: "Fronius",
enable_autodetect: false,
update_every: 5,
base_priority: 60000,
charts: {},
powerGridId: "p_grid",
powerPvId: "p_pv",
powerAccuId: "p_akku", // not my typo! Using the ID from the AP
consumptionLoadId: "p_load",
autonomyId: "rel_autonomy",
consumptionSelfId: "rel_selfconsumption",
energyTodayId: "e_day",
energyYearId: "e_year",
createBasicDimension: function (id, name, divisor) {
return {
id: id, // the unique id of the dimension
name: name, // the name of the dimension
algorithm: netdata.chartAlgorithms.absolute,// the id of the netdata algorithm
multiplier: 1, // the multiplier
divisor: divisor, // the divisor
hidden: false // is hidden (boolean)
};
},
// Gets the site power chart. Will be created if not existing.
getSitePowerChart: function (service, id) {
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);
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
type: netdata.chartTypes.area, // the type of the chart
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
};
chart = service.chart(id, chart);
fronius.charts[id] = chart;
return chart;
},
// Gets the site consumption chart. Will be created if not existing.
getSiteConsumptionChart: function (service, id) {
var chart = fronius.charts[id];
if (fronius.isDefined(chart)) return chart;
var dim = {};
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
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
dimensions: dim
};
chart = service.chart(id, chart);
fronius.charts[id] = chart;
return chart;
},
// Gets the site consumption chart. Will be created if not existing.
getSiteAutonomyChart: function (service, id) {
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);
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
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
dimensions: dim
};
chart = service.chart(id, chart);
fronius.charts[id] = chart;
return chart;
},
// Gets the site energy chart for today. Will be created if not existing.
getSiteEnergyTodayChart: function (service, chartId) {
var chart = fronius.charts[chartId];
if (fronius.isDefined(chart)) return chart;
var dim = {};
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
dimensions: dim
};
chart = service.chart(chartId, chart);
fronius.charts[chartId] = chart;
return chart;
},
// Gets the site energy chart for today. Will be created if not existing.
getSiteEnergyYearChart: function (service, chartId) {
var chart = fronius.charts[chartId];
if (fronius.isDefined(chart)) return chart;
var dim = {};
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
dimensions: dim
};
chart = service.chart(chartId, chart);
fronius.charts[chartId] = chart;
return chart;
},
// 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) {
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;
}
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
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
dimensions: dim
};
chart = service.chart(chartId, chart);
fronius.charts[chartId] = chart;
return chart;
},
processResponse: function (service, content) {
if (content === null) return;
var json = JSON.parse(content);
if (!fronius.isResponseValid(json)) return;
// add the service
service.commit();
var site = json.Body.Data.Site;
// 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));
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();
}
},
// 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);
},
// module.serviceExecute()
// this function is called only from this module
// 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);
var service = netdata.service({
name: name,
request: netdata.requestFromURL('http://' + uri),
update_every: update_every,
module: this
});
service.execute(this.processResponse);
},
configure: function (config) {
if (fronius.isUndefined(config.servers)) return 0;
var added = 0;
var len = config.servers.length;
while (len--) {
var server = config.servers[len];
if (fronius.isUndefined(server.update_every)) server.update_every = this.update_every;
var url = server.hostname + server.api_path;
this.serviceExecute(server.name, url, server.update_every);
added++;
}
return added;
},
// module.update()
// this is called repeatedly to collect data, by calling
// netdata.serviceExecute()
update: function (service, callback) {
service.execute(function (serv, data) {
service.module.processResponse(serv, data);
callback();
});
},
isUndefined: function (value) {
return typeof value === 'undefined';
},
isDefined: function (value) {
return typeof value !== 'undefined';
}
};
module.exports = fronius;
|
