plugins.d/sma_webbox.plugin

   1 #!/usr/bin/env node
   2
   3 // This program will connect to one or more SMA Sunny Webboxes
   4 // to get the Solar Power Generated (current, today, total).
   5
   6 // It needs a configuration file named sma_webbox.conf
   7 // The configuration is a JSON array, like this:
   8
   9 /* --- BEGIN EXAMPLE CONFIGURATION ---
  10
  11 [
  12         {
  13                 "name": "label_of_solar_installation1",
  14                 "hostname": "10.11.13.2"
  15         },
  16         {
  17                 "name": "label_of_solar_installation2",
  18                 "hostname": "10.11.13.3"
  19         }
  20 ]
  21
  22    --- END EXAMPLE CONFIGURATION --- */
  23
  24 // you can add an unlimited number of webboxes
  25
  26 var http = require('http');
  27 var fs = require('fs');
  28
  29 // --------------------------------------------------------------------------------------------------------------------
  30 // get NETDATA environment variables
  31
  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;
  36
  37 var filename = NETDATA_CONFIG_DIR + '/sma_webbox.conf';
  38
  39 // --------------------------------------------------------------------------------------------------------------------
  40 // get command line arguments
  41
  42 var DEBUG = false;
  43 var UPDATE_EVERY = NETDATA_UPDATE_EVERY;
  44 var EXIT_AFTER_MS = 3600 * 1000;
  45
  46 function debug(msg) {
  47         if(DEBUG)
  48                 console.error(__filename + ': DEBUG: ' + ((typeof(msg) === 'object')?JSON.stringify(msg):msg).toString());
  49 }
  50
  51 function error(msg) {
  52         console.error(__filename + ': ERROR: ' + ((typeof(msg) === 'object')?JSON.stringify(msg):msg).toString());
  53 }
  54
  55 function netdata(msg) {
  56         console.log(msg.toString());
  57 }
  58
  59 var found_myself = false;
  60 process.argv.forEach(function (val, index, array) {
  61         debug('PARAM: ' + val);
  62
  63         if(!found_myself) {
  64                 if(val === __filename)
  65                         found_myself = true;
  66         }
  67         else {
  68                 switch(val) {
  69                         case 'debug':
  70                                 DEBUG = true;
  71                                 debug('DEBUG enabled');
  72                                 break;
  73
  74                         default:
  75                                 try {
  76                                         var x = parseInt(val);
  77                                         if(x > 0) {
  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');
  82                                                 }
  83
  84                                                 debug('Update frequency set to ' + UPDATE_EVERY + ' ms');
  85                                         }
  86                                         else error('Ignoring parameter: ' + val);
  87                                 }
  88                                 catch(e) {
  89                                         error('Cannot get value of parameter: ' + val);
  90                                 }
  91                 }
  92         }
  93 });
  94
  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');
  99         UPDATE_EVERY = 5000;
 100 }
 101
 102 // --------------------------------------------------------------------------------------------------------------------
 103 // parse configuration
 104
 105 var Servers = new Array();
 106 try {
 107         Servers = JSON.parse(fs.readFileSync(filename, 'utf8'));
 108 }
 109 catch(e) {
 110         error('Cannot read configuration file ' + filename + ': ' + e.message);
 111         process.exit(1);
 112 }
 113
 114
 115 // --------------------------------------------------------------------------------------------------------------------
 116 // library functions
 117
 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');
 123                 return false;
 124         }
 125         server.running = true;
 126
 127         var now = new Date().getTime();
 128
 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;
 132
 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;
 137                 return false;
 138         }
 139
 140         // find the next refresh for this server
 141         while(server.next_run < now)
 142                 server.next_run += UPDATE_EVERY;
 143
 144         if(typeof(server.last_updated) === 'undefined')
 145                 server.last_updated = 0;
 146
 147         // create an agent for keep-alive
 148         if(typeof(server.agent) === 'undefined') {
 149                 server.agent = new http.Agent({
 150                         keepAlive: true,
 151                         keepAliveMsecs: UPDATE_EVERY * 5,
 152                         maxSockets: 2, // it needs 2, otherwise it ignores keepAlive
 153                         maxFreeSockets: 1
 154                 });
 155         }
 156
 157         // create the charts, if we haven't already
 158         if(typeof(server.created) === 'undefined') {
 159                 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));
 160                 netdata('DIMENSION GriPwr power absolute 1 1');
 161
 162                 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));
 163                 netdata('DIMENSION GriEgyTdy today absolute 1 1000');
 164
 165                 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));
 166                 netdata('DIMENSION GriEgyTot total absolute 1 1000');
 167
 168                 server.created = true;
 169         }
 170
 171         // initialize our metrics to null
 172         // so that we will know if we read them or not
 173         server.data = {
 174                 'GriPwr': {
 175                         unit: null,
 176                         value: null
 177                 },
 178                 'GriEgyTdy': {
 179                         unit: null,
 180                         value: null
 181                 },
 182                 'GriEgyTot': {
 183                         unit: null,
 184                         value: null
 185                 }
 186         };
 187
 188         var postData = 'RPC={"proc":"GetPlantOverview","format":"JSON","version":"1.0","id":"1"}'
 189
 190         var options = {
 191                 protocol: server.protocol || 'http:',
 192                 hostname: server.hostname,
 193                 path: server.path || '/rpc',
 194                 family: server.family || 4,
 195                 port: server.port || 80,
 196                 method: 'POST',
 197                 headers: {
 198                         'Content-Type': 'application/x-www-form-urlencoded',
 199                         'Connection': 'keep-alive',
 200                         'Content-Length': postData.length
 201                 },
 202                 agent: server.agent
 203         };
 204
 205         server.error = 0;
 206         server.success = false;
 207         server.response = '';
 208         server.request = http.request(options, function(res) {
 209                 res.setEncoding('utf8');
 210                 server.response_code = res.statusCode;
 211
 212                 // check if we got HTTP/200
 213                 if(server.response_code !== 200) {
 214                         // if this request is in error and we have
 215                         // handled it, don't do anything more
 216                         if(server.error === 0) {
 217                                 debug('Server responded with ' + server.response_code + ', failed to get data.');
 218                                 server.error = 503;
 219                                 server.success = false;
 220                                 server.running = false;
 221                                 if(typeof(callback) === 'function')
 222                                         callback(server);
 223                         }
 224                 }
 225
 226                 res.on('data', function(chunk) {
 227                         // read more data, only if there is no error
 228                         if(server.error === 0)
 229                                 server.response += chunk;
 230                 });
 231
 232                 res.on('error', function() {
 233                         // do we have already handled this error?
 234                         if(server.error !== 0)
 235                                 return;
 236
 237                         debug('Received HTTP read error, failed to get data.');
 238                         server.error = 504;
 239                         server.success = false;
 240                         server.running = false;
 241                         if(typeof(callback) === 'function')
 242                                 callback(server);
 243                 });
 244
 245                 res.on('end', function() {
 246                         // if there is an error we have handled
 247                         // don't do anything
 248                         if(server.error !== 0)
 249                                 return;
 250
 251                         var t = new Date().getTime();
 252
 253                         server.dt = 0;
 254                         if(server.last_updated !== 0)
 255                                 server.dt = t - server.last_updated;
 256
 257                         debug('RESPONSE: ' + server.response);
 258                         try {
 259                                 server.response = JSON.parse(server.response);
 260
 261                                 var len = server.response.result.overview.length;
 262                                 while(len--) {
 263                                         var e = server.response.result.overview[len];
 264                                         debug(e);
 265                                         if(typeof(server.data[e.meta]) !== 'undefined') {
 266                                                 server.data[e.meta].value = e.value;
 267                                                 server.data[e.meta].unit = e.unit;
 268                                         }
 269                                 }
 270
 271                                 if(server.data['GriPwr'].value !== null) {
 272                                         netdata('BEGIN sma_webbox_' + server.name + '.current ' + ((server.dt)?server.dt*1000:'').toString());
 273                                         netdata('SET GriPwr = ' + server.data['GriPwr'].value);
 274                                         netdata('END');
 275                                 }
 276
 277                                 if(server.data['GriEgyTdy'].value !== null) {
 278                                         netdata('BEGIN sma_webbox_' + server.name + '.today ' + ((server.dt)?server.dt*1000:'').toString());
 279                                         netdata('SET GriEgyTdy = ' + Math.round(server.data['GriEgyTdy'].value * 1000));
 280                                         netdata('END');
 281                                 }
 282
 283                                 if(server.data['GriEgyTot'].value !== null) {
 284                                         netdata('BEGIN sma_webbox_' + server.name + '.total ' + ((server.dt)?server.dt*1000:'').toString());
 285                                         netdata('SET GriEgyTot = ' + Math.round(server.data['GriEgyTot'].value * 1000));
 286                                         netdata('END');
 287                                 }
 288
 289                                 server.error = 0;
 290                                 server.success = true;
 291                                 server.last_updated = t;
 292                         }
 293                         catch(e) {
 294                                 server.error = 501;
 295                                 server.success = false;
 296                                 server.failure_message = e.message;
 297                                 error('FAILED TO PARSE DATA: ' + e.message);
 298                         }
 299
 300                         server.running = false;
 301                         if(typeof(callback) === 'function')
 302                                 callback(server);
 303                 });
 304         });
 305
 306         server.request.on('error', function(e) {
 307                 // do we have already handled this error?
 308                 if(server.error !== 0)
 309                         return;
 310
 311                 server.error = 502;
 312                 server.success = false;
 313                 server.running = false;
 314                 server.failure_message = e.message;
 315                 error('problem with request to ' + server.hostname + ': ' + e.message);
 316
 317                 if(typeof(callback) === 'function')
 318                         callback(server);
 319         });
 320
 321         // write data to request body
 322         server.request.write(postData);
 323         server.request.end();
 324
 325         return true;
 326 }
 327
 328 // get a message for the current error
 329 function getSMAError(server) {
 330         if(server.success) return 'OK';
 331
 332         if(typeof(server.error) === 'undefined')
 333                 return 'Not initialized';
 334
 335         switch(server.error) {
 336                 case 500: return 'Pre-fetch Error';
 337                 case 501: return 'Failed to parse server response';
 338                 case 502: return 'HTTP error while making request';
 339                 case 504: return 'Failed to read response data';
 340                 default: return 'Undefined Error';
 341         }
 342 }
 343
 344 // --------------------------------------------------------------------------------------------------------------------
 345
 346 // if we don't have any servers to run
 347 // inform netdata we don't need to run on this machine
 348 if(!Servers.length) {
 349         error('No SMA webbox servers defined.');
 350         process.exit(1);
 351 }
 352
 353 var started = new Date().getTime();
 354 function runServers() {
 355         var now = new Date().getTime();
 356         if(now - started > EXIT_AFTER_MS) {
 357                 debug('We have to exit now. Netdata will restart us.');
 358                 // FIXME
 359                 // We should wait for any currently running requests to complete
 360                 process.exit(0);
 361         }
 362
 363         var len = Servers.length;
 364         while(len--) {
 365                 getSMAData(Servers[len], function(server) {
 366                         if(server.success)
 367                                 debug(' OK ' + server.name + ' time since last run: ' + server.dt + ' ms');
 368                         else
 369                                 error(getSMAError(server) + server.name);
 370                 });
 371         }
 372
 373         setTimeout(runServers, 100);
 374 }
 375
 376 runServers();