3 // This program will connect to one or more SMA Sunny Webboxes
4 // to get the Solar Power Generated (current, today, total).
6 // It needs a configuration file named sma_webbox.conf
7 // The configuration is a JSON array, like this:
9 /* --- BEGIN EXAMPLE CONFIGURATION ---
13 "name": "label_of_solar_installation1",
14 "hostname": "10.11.13.2"
17 "name": "label_of_solar_installation2",
18 "hostname": "10.11.13.3"
22 --- END EXAMPLE CONFIGURATION --- */
24 // you can add an unlimited number of webboxes
26 var http = require('http');
27 var fs = require('fs');
29 // --------------------------------------------------------------------------------------------------------------------
30 // get NETDATA environment variables
32 var NETDATA_PLUGINS_DIR = process.env.NETDATA_PLUGINS_DIR || __dirname;
33 var NETDATA_CONFIG_DIR = process.env.NETDATA_CONFIG_DIR || '/etc/netdata';
34 var NETDATA_UPDATE_EVERY = process.env.NETDATA_UPDATE_EVERY || 1;
35 NETDATA_UPDATE_EVERY = NETDATA_UPDATE_EVERY * 1000;
37 var filename = NETDATA_CONFIG_DIR + '/sma_webbox.conf';
39 // --------------------------------------------------------------------------------------------------------------------
40 // get command line arguments
43 var UPDATE_EVERY = NETDATA_UPDATE_EVERY;
44 var EXIT_AFTER_MS = 3600 * 1000;
48 console.error(__filename + ': DEBUG: ' + ((typeof(msg) === 'object')?JSON.stringify(msg):msg).toString());
52 console.error(__filename + ': ERROR: ' + ((typeof(msg) === 'object')?JSON.stringify(msg):msg).toString());
55 function netdata(msg) {
56 console.log(msg.toString());
59 var found_myself = false;
60 process.argv.forEach(function (val, index, array) {
61 debug('PARAM: ' + val);
64 if(val === __filename)
71 debug('DEBUG enabled');
76 var x = parseInt(val);
78 UPDATE_EVERY = x * 1000;
79 if(UPDATE_EVERY < NETDATA_UPDATE_EVERY) {
80 UPDATE_EVERY = NETDATA_UPDATE_EVERY;
81 debug('Update frequency ' + x + 's is too low');
84 debug('Update frequency set to ' + UPDATE_EVERY + ' ms');
86 else error('Ignoring parameter: ' + val);
89 error('Cannot get value of parameter: ' + val);
95 // there is no meaning to update the values sooner than 5 seconds
96 // the SMA webbox collects data every 5 seconds
97 if(UPDATE_EVERY < 5000) {
98 debug('Adjusting update frequency to 5 seconds');
102 // --------------------------------------------------------------------------------------------------------------------
103 // parse configuration
105 var Servers = new Array();
107 Servers = JSON.parse(fs.readFileSync(filename, 'utf8'));
110 error('Cannot read configuration file ' + filename + ': ' + e.message);
115 // --------------------------------------------------------------------------------------------------------------------
118 // function to get data from server
119 function getSMAData(server, callback) {
120 // make sure there is not a request in progress for this webbox
121 if(typeof(server.running) === 'boolean' && server.running) {
122 debug(server.name + ' is already running');
125 server.running = true;
127 var now = new Date().getTime();
129 // align the time to collect the values
130 if(typeof(server.next_run) === 'undefined')
131 server.next_run = now - (now % UPDATE_EVERY) + UPDATE_EVERY;
133 // if it is too soon, we will collect data later
134 if(now < server.next_run) {
135 debug(server.name + ' not yet');
136 server.running = false;
140 // find the next refresh for this server
141 while(server.next_run < now)
142 server.next_run += UPDATE_EVERY;
144 if(typeof(server.last_updated) === 'undefined')
145 server.last_updated = 0;
147 if(typeof(server.agent) === 'undefined') {
148 server.agent = new http.Agent({
150 keepAliveMsecs: UPDATE_EVERY * 5,
151 maxSockets: 2, // it needs 2, otherwise it ignores keepAlive
156 if(typeof(server.created) === 'undefined') {
157 netdata('CHART sma_webbox_' + server.name + '.current "" "Solar Power Production of ' + server.name + '" "Watts" sma_webbox_' + server.name + ' "" area 15000 ' + Math.round(UPDATE_EVERY / 1000));
158 netdata('DIMENSION GriPwr power absolute 1 1');
159 netdata('CHART sma_webbox_' + server.name + '.today "" "Today\'s Solar Power Production of ' + server.name + '" "kWatts" sma_webbox_' + server.name + ' "" area 15001 ' + Math.round(UPDATE_EVERY / 1000));
160 netdata('DIMENSION GriEgyTdy today absolute 1 1000');
161 netdata('CHART sma_webbox_' + server.name + '.total "" "Total Solar Power Production of ' + server.name + '" "kWatts" sma_webbox_' + server.name + ' "" area 15001 ' + Math.round(UPDATE_EVERY / 1000));
162 netdata('DIMENSION GriEgyTot total absolute 1 1000');
163 server.created = true;
167 server.success = false;
183 var postData = 'RPC={"proc":"GetPlantOverview","format":"JSON","version":"1.0","id":"1"}'
186 protocol: server.protocol || 'http:',
187 hostname: server.hostname,
188 path: server.path || '/rpc',
189 family: server.family || 4,
190 port: server.port || 80,
193 'Content-Type': 'application/x-www-form-urlencoded',
194 'Connection': 'keep-alive',
195 'Content-Length': postData.length
200 server.response = '';
201 server.request = http.request(options, function(res) {
202 res.setEncoding('utf8');
205 server.response_code = res.statusCode;
207 // check if we got HTTP/200
208 if(server.response_code !== 200) {
209 debug('Server responded with ' + server.response_code + ', failed to get data.');
211 server.running = false;
212 server.success = false;
213 if(typeof(callback) === 'function')
217 res.on('error', function() {
218 debug('Received HTTP read error, failed to get data.');
220 server.success = false;
221 server.running = false;
222 if(typeof(callback) === 'function')
226 res.on('data', function(chunk) {
227 server.response += chunk;
230 res.on('end', function() {
231 if(server.error !== 0)
234 var t = new Date().getTime();
237 if(server.last_updated !== 0)
238 server.dt = t - server.last_updated;
240 debug('RESPONSE: ' + server.response);
242 server.response = JSON.parse(server.response);
244 var len = server.response.result.overview.length;
246 var e = server.response.result.overview[len];
248 if(typeof(server.data[e.meta]) !== 'undefined') {
249 server.data[e.meta].value = e.value;
250 server.data[e.meta].unit = e.unit;
254 server.last_updated = t;
256 if(server.data['GriPwr'].value !== null) {
257 netdata('BEGIN sma_webbox_' + server.name + '.current ' + ((server.dt)?server.dt*1000:'').toString());
258 netdata('SET GriPwr = ' + server.data['GriPwr'].value);
262 if(server.data['GriEgyTdy'].value !== null) {
263 netdata('BEGIN sma_webbox_' + server.name + '.today ' + ((server.dt)?server.dt*1000:'').toString());
264 netdata('SET GriEgyTdy = ' + Math.round(server.data['GriEgyTdy'].value * 1000));
268 if(server.data['GriEgyTot'].value !== null) {
269 netdata('BEGIN sma_webbox_' + server.name + '.total ' + ((server.dt)?server.dt*1000:'').toString());
270 netdata('SET GriEgyTot = ' + Math.round(server.data['GriEgyTot'].value * 1000));
276 server.failure_message = e.message;
277 error('FAILED TO PARSE DATA: ' + e.message);
280 server.running = false;
281 if(typeof(callback) === 'function') {
282 server.success = true;
288 server.request.on('error', function(e) {
289 server.running = false;
291 server.failure_message = e.message;
292 error('problem with request to ' + server.hostname + ': ' + e.message);
295 // write data to request body
296 server.request.write(postData);
297 server.request.end();
302 // get a message for the current error
303 function getSMAError(server) {
304 if(server.success) return 'OK';
306 if(typeof(server.error) === 'undefined')
307 return 'Not initialized';
309 switch(server.error) {
310 case 500: return 'Pre-fetch Error';
311 case 501: return 'Failed to parse server response';
312 case 502: return 'HTTP error while making request';
313 case 504: return 'Failed to read response data';
314 default: return 'Undefined Error';
318 // --------------------------------------------------------------------------------------------------------------------
320 // if we don't have any servers to run
321 // inform netdata we don't need to run on this machine
322 if(!Servers.length) {
323 error('No SMA webbox servers defined.');
327 var started = new Date().getTime();
328 function runServers() {
329 var now = new Date().getTime();
330 if(now - started > EXIT_AFTER_MS) {
331 debug('We have to exit now. Netdata will restart us.');
333 // We should wait for any currently running requests to complete
337 var len = Servers.length;
339 getSMAData(Servers[len], function(server) {
341 debug(' OK ' + server.name + ' time since last run: ' + server.dt + ' ms');
343 error(getSMAError(server) + server.name);
347 setTimeout(runServers, 100);