index.js

'use strict';

/*
 * NEEO driver for myStrom WiFi Switch device
 * https://github.com/zehnm/neeo-mystrom-switch
 *
 * Control local myStrom WiFi switches with NEEO.
 * WiFi Switch v2 devices are auto-discovered on local subnet. 
 * Manual configuration is possible in config/mystrom.json.
 * 
 * Still needs some improvements:
 * - code clean up (module exports, naming conventions etc.)
 * - error & auto retry handling
 * - option to use myStrom cloud (either for initial discovery only or for full device access)
 * - setting device reachability flag with connectivity test
 * ... and I really don't like Java Script, so certain things are probably a bit messy :/
 * 
 * Tested with:
 * - Node.js v8.9.1
 * - NEEO SDK 0.48.13 https://github.com/NEEOInc/neeo-sdk
 * - myStrom WiFi Switch v2 (firmware 3.60) and v1 (firmware 2.31) https://www.mystrom.ch/
 */

const neeoapi = require('neeo-sdk');
const logger = require('winston');
const Constants = require('./lib/constants');
const NeeoDevice = require('./lib/neeoDevice');

logger.level = process.env.LOG_LEVEL ? process.env.LOG_LEVEL : 'info';

// default configuration with required parameters. Customize in driver.json
// Optional: neeo.brainIp, neeo.callbackIp, mystrom.polling.interval, mystrom.polling.duration
var config = {
  "neeo": {
    "callbackPort": 6336
  },
  "mystrom": {
    "discoveryModes": {
      "configFile": false,  // read devices from configration file
      "local": true         // local discovery mode (listen for UDP broadcast)
    },
    "localDiscovery": {
      "listenAddress": "0.0.0.0", // listen address for UDP broadcast. 0.0.0.0 = all interfaces
      "reachableTimeout": 30,     // timeout in seconds to consider a device offline if no discovery message received
      "deviceTypeFilter": ["WS2"] // only consider the specified myStrom device types. See ./lib/mystrom/myStrom.js
    }
  }
};

console.log('NEEO device "myStrom WiFi Switch" v0.1.0');
console.log('------------------------------------------');

// Config file is optional
try {
  config = require(__dirname + '/config/driver.json');
} catch (e) {
  logger.info('Cannot find or load config.json! Using default values.');
}

const neeoDevices = [];
const neeoSwitchDevice = new NeeoDevice(config);

neeoDevices.push(neeoSwitchDevice.buildDevice(Constants.DEVICE_NAME, Constants.MANUFACTURER));

var brainIp = process.env.BRAINIP;
var baseurl = undefined;

if (brainIp) {
  logger.info('[NEEO] Using NEEO Brain IP from env variable:', brainIp);
} else if (config.neeo.brainIp) {
  brainIp = config.neeo.brainIp;
  logger.info('[NEEO] Using NEEO Brain IP from configuration:', brainIp);
}

// baseurl must be set for certain network setup (i.e. Windows with Hyper-V) until SDK is fixed.
// See forum and related issue with auto-discovery: https://github.com/NEEOInc/neeo-sdk/issues/36
if (config.neeo.callbackIp) {
  baseurl = 'http://' + config.neeo.callbackIp + ':' + config.neeo.callbackPort;
}

if (brainIp) {
  startDeviceServer(brainIp, config.neeo.callbackPort, baseurl, neeoDevices);
} else {
  logger.info('[NEEO] discover one NEEO Brain...');
  neeoapi.discoverOneBrain()
    .then((brain) => {
      logger.info('[NEEO] Brain discovered:', brain.name);
      brainIp = brain; // save discovered IP for shutdown hook
      startDeviceServer(brain, config.neeo.callbackPort, baseurl, neeoDevices);
    });
}

function startDeviceServer(brain, port, callbackBaseurl, neeoDevices) {
  logger.info('[NEEO] Starting server on port %d ...', port);
  neeoapi.startServer({
    brain,
    port,
    baseurl: callbackBaseurl,
    name: Constants.ADAPTER_NAME,
    devices: neeoDevices
  })
    .then(() => {
      logger.info('[NEEO] API server ready! Use the NEEO app to search for "%s" or "%s".', Constants.MANUFACTURER, Constants.DEVICE_NAME);
    })
    .catch((error) => {
      logger.error('[NEEO] Error starting device server!', error.message);
      process.exit(9);
    });
}

// shutdown hook for graceful shutdown
var gracefulShutdown = function() {
  logger.verbose("Received kill signal, shutting down gracefully.");
  neeoapi.stopServer({brain: brainIp, name: Constants.ADAPTER_NAME})
    .then(() => {
      logger.info('[NEEO] Stopped and unregistered device server');
      process.exit();
    })
    .catch((error) => {
      logger.warn('[NEEO] Error while stopping and unregistering device server:', error);
      process.exit();
    });
  
   // force exit after 10s 
   setTimeout(function() {
       logger.error("Could not stopping NEEO device driver in time, forcefully shutting down");
       process.exit();
  }, 10000);
}

// listen for TERM signal .e.g. kill 
process.on ('SIGTERM', gracefulShutdown);
// listen for INT signal e.g. Ctrl-C
process.on ('SIGINT', gracefulShutdown);