index.js

'use strict';

require('../assign'); // Object.assign polyfill
var net = require('net');
var util = require('util');
var events = require('events');
var Q = require('q');

var SerialPort;
/* istanbul ignore next */
try {
  SerialPort = require('serialport');
} catch (e) {
  SerialPort = 0;
}

var https = require('https');
var querystring = require('querystring');
var EventSource = require('eventsource');

var debug = require('debug')('home-controller:insteon');

var utils = require('./utils');
var toByte = utils.toByte;
var DEV_CAT_NAMES = utils.DEV_CAT_NAMES;


var DEDUP_TIMER = 5000; // 5 seconds

// responses
var MESSAGE_PROCESSED = 1; // signals the caller that a message was consumed.
var INSUFFICIENT_DATA = 2; // signals the caller that insufficient data is there to proceed.
var MESSAGE_SKIPPED = 3; // signals the caller that we skipped a message. Temporary.

var Light = require('./Light');
var Thermostat = require('./Thermostat');
var Motion = require('./Motion');
var Door = require('./Door');
var Leak = require('./Leak');
var Meter = require('./Meter');
var IO = require('./IO'); // EZIO
var IOLinc = require('./IOLinc');
var GarageDoor = require('./GarageDoor');
var X10 = require('./X10');

var Insteon = function () {

  this.queue = [];
  this.buffer = '';
  this.commandTimeout = 5000; // default 5 second timeout
  this.nakTimeout = 10;
  this.commandRetries = 1;

  this.defaultTempUnits = Insteon.defaultTempUnits;

  this.devices = {};

  this.emitDuplicates = false;
  this.emitSelfAck = false;
  // Clone the dispatchers to allow clients to override/customize if desired
  this.dispatchers = Object.assign({}, DISPATCHERS);

  // allow it to be overridden in tests
  this.SerialPort = SerialPort;
};


util.inherits(Insteon, events.EventEmitter);

Insteon.prototype.connect = function (host, port, connectListener) {

  var that = this;

  if (typeof port !== 'number') {
    connectListener = port;
    port = 9761;
  }

  this.host = host;
  this.port = port || 9761;
  debug('connecting', this.port, this.host);

  var socket = this.socket = new net.Socket();
  socket.setEncoding('hex');
  socket.setKeepAlive(true, 30000);


  socket.on('connect', function () {
    debug('connected');
    that.emit('connect');
  });

  socket.on('data', function (data) {
    debug('Rcvd:', data);
    that.buffer = that.buffer + data;
    that.checkStatus();
  });

  socket.on('error', function (err) {
    that.emit('error', err);
  });

  socket.on('close', function (had_error) {
    that.emit('close', had_error);
  });

  this.write = function (raw) {
    return this.socket.write(raw, 'hex');
  };
  this.close = this.socket.destroy.bind(this.socket);

  return new Promise((resolve) => {
    that.socket.connect(that.port, that.host, function () {
      resolve();
    });
  }).then(connectListener);
};

Insteon.prototype.serial = function (comName, options, connectListener) {

  /* istanbul ignore next */
  if (!this.SerialPort) {
    throw (new Error('serial is Unsupported on this platform'));
  }

  var that = this;

  if (typeof options === 'function') {
    connectListener = options;
    options = null;
  }
  if (!options) {
    options = {};
  }
  if (typeof options.baudRate === 'undefined') {
    options.baudRate = 19200;
  }
  if (typeof options.dataBits === 'undefined') {
    options.dataBits = 8;
  }
  if (typeof options.parity === 'undefined') {
    options.parity = 'none';
  }
  if (typeof options.stopBits === 'undefined') {
    options.stopBits = 1;
  }
  options.autoOpen = false;

  this.comName = comName;
  this.options = options;
  debug('connecting', this.comName);

  this.socket = new this.SerialPort(comName, this.options)
    .on('open', function () {
      debug('connected');
      that.emit('connect');
      if (!!connectListener) {
        connectListener(that.comName);
      }
    })
    .on('data', function (data) {
      data = data.toString('hex');
      debug('Rcvd:', data);
      that.buffer = that.buffer + data;
      that.checkStatus();
    })
    .on('error', function (err) {
      that.emit('error', err);
    })
    .on('close', function (had_error) {
      that.emit('close', had_error);
    });

  this.write = function (raw) {
    return that.socket.write(Buffer.from(raw, 'hex'));
  };
  this.close = this.socket.close.bind(this.socket);

  this.socket.open();
};

Insteon.prototype.spark = function (sparkId, token, reconnectInterval) {

  var that = this;

  var eventUrl = 'https://api.spark.io/v1/devices/' +
    sparkId +
    '/events/insteon?access_token=' +
    token;

  debug('Spark event url', eventUrl);
  var es = new EventSource(eventUrl);
  es.reconnectInterval = reconnectInterval || 5000;

  es.addEventListener('insteon', function (event) {
    debug('Spark Rcvd:', Date.now(), event);
    try {
      var eventData = JSON.parse(event.data);
      that.buffer = that.buffer + eventData.data;
      that.checkStatus();
    } catch (err) {
      debug('Spark Rcvd error - ignoring', err);
    }
  });

  es.onerror = function (err) {
    debug('Spark Error', err, es.readyState);
    setTimeout(function () {
      if (es.readyState === EventSource.CLOSED) {
        that.emit('error', err);
        that.close(true);
      }
    }, 100);
  };

  es.onopen = function () {
    debug('Spark connected');
    that.emit('connect');
  };

  this.write = function (raw) {

    var postData = querystring.stringify({
      'args': raw,
      'access_token': token
    });

    var options = {
      hostname: 'api.spark.io',
      port: 443,
      path: '/v1/devices/' + sparkId + '/insteon',
      method: 'POST',
      headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
        'Content-Length': postData.length
      }
    };

    var req = https.request(options, function (res) {
      debug('Spark resp', raw, res);
      res.setEncoding('utf8');
      res.on('data', function (data) {
        debug('Spark wrote', raw, data);
      });
    });

    req.on('error', function (err) {
      debug('Spark write error:', err);
      that.emit('error', err);
    });

    // write data to request body
    req.write(postData);
    req.end();
  };


  this.close = function (had_error) {
    try {
      es.close();
    } catch (err) {
      debug('Error closing spark', err);
    } finally {
      es = null;
      that.write = null;
    }
    that.emit('close', had_error);
  };
};

Insteon.prototype.httpClient = function (options, connectListener) {
  require('./httpClient')(this, options, connectListener);
};

/**************************************************************************
 * Command Functions
 **************************************************************************/



Insteon.prototype.sendCommand = function (cmd, timeout, next) {
  if (typeof timeout === 'function') {
    next = timeout;
    timeout = null;
  }
  if (typeof cmd === 'string') {
    cmd = {
      raw: '02' + cmd,
      type: cmd
    };
  }
  timeout = timeout || this.commandTimeout;

  var deferred = Q.defer();

  var status = {
    command: cmd,
    deferred: deferred,
    timeout: timeout,
    nakTimeout: this.nakTimeout
  };

  sendCommand(this, status);

  return deferred.promise.nodeify(next);
};

function sendCommand(gw, status) {
  if (!status) {
    return;
  }

  if (gw.status) {
    debug('Already running a command - queuing command: %j', status.command);
    return gw.queue.push(status);
  }

  var timeout = status.timeout;
  gw.status = status;

  debug('Send: %j', status);

  setTimeout(function () { // slowing down writes reduces errors
    try {
      gw.emit('sendCommand', status.command);
      if (gw.write) {
        gw.write(status.command.raw);
      }
    } catch (err) {
      debug('Error writing to socket', err);
      status.deferred.reject(err);
      delete gw.timeout;
      delete gw.status;
      return sendCommand(gw, gw.queue.shift());
    }
    gw.timeout = setTimeout(function () {
      sendCommandTimout(gw, timeout, gw.commandRetries);
    }, timeout);
  }, 10);

}

function sendCommandTimout(gw, timeout, retries) {
  var status = gw.status;
  debug('sendCommandTimout - status: %j', status);
  if (!status || !status.command) {
    debug('missing status');
    return sendCommand(gw, gw.queue.shift());
  }
  var resp = status.command.response;
  if (retries-- <= 0 || (resp && resp.standard && status.command.waitForExtended)) { // don't retry if we got a standard response
    delete gw.timeout;
    delete gw.status;
    status.deferred.resolve(status);
    sendCommand(gw, gw.queue.shift());
  } else {
    debug('Resend: %j', status);
    try {
      gw.emit('sendCommand', status.command);
      if (gw.write) {
        gw.write(status.command.raw);
      }
    } catch (err) {
      debug('Error writing to socket', err);
      status.deferred.reject(err);
      delete gw.timeout;
      delete gw.status;
      return sendCommand(gw, gw.queue.shift());
    }
    gw.timeout = setTimeout(function () {
      sendCommandTimout(gw, timeout, retries);
    }, timeout);
  }
}

Insteon.prototype.cancelInprogress = function () {
  if (this.status) {
    this.status.deferred.reject(new Error('Cancelled!'));
    if (this.timeout) {
      clearTimeout(this.timeout);
    }

    delete this.timeout;
    delete this.status;

    return sendCommand(this, this.queue.shift());
  }
  return false;
};

Insteon.prototype.cancelPending = function (cmdMatch) {
  if (cmdMatch === null || cmdMatch === undefined) {
    cmdMatch = /.*/;
  }

  if (typeof cmdMatch === 'string') {
    var id = cmdMatch.trim().replace(/\./g, '');

    if (!/^[0-9a-fA-F]{6}$/.test(id)) {
      throw new Error('Invalid Insteon ID');
    }
    cmdMatch = new RegExp('^....' + id + '.*');
  }

  if (!(cmdMatch instanceof RegExp)) {
    throw new Error('Invalid cmdMatch');
  }

  cmdMatch = new RegExp(cmdMatch.source, 'i');

  debug('canceling - match: %s', cmdMatch);

  this.queue = this.queue.filter(function (status) {
    if (cmdMatch.test(status.command.raw)) {
      debug('canceling - cmd: %s', status.command.raw);
      status.deferred.reject(new Error('Canceled'));
      return false;
    }
    return true;
  });
};


Insteon.prototype.directCommand = function (id, cmd, param, timeout, next) {
  if (typeof param === 'function') {
    next = param;
    param = '00';
  } else if (typeof timeout === 'function') {
    next = timeout;
    timeout = null;
  }
  if (typeof param === 'number') {
    timeout = param;
    param = '00';
  }
  if (!param) {
    param = '00';
  }
  if (typeof cmd === 'string') {
    cmd = {
      cmd1: cmd,
      cmd2: param
    };
  }

  id = id || '';
  id = id.trim().replace(/\./g, '');

  if (!/^[0-9a-fA-F]{6}$/.test(id)) {
    var msg = 'Invalid Insteon ID - ' + id;
    debug(msg);
    return Q.reject(new Error(msg)).nodeify(next);
  }

  var type = cmd.type = '62';
  var userData = '';
  var flags = '0F'; // standard command
  if (cmd.extended) {
    flags = '1F';
    var pad = '0000000000000000000000000000';
    userData = (cmd.userData ? cmd.userData.join('') : '');
    userData = userData.substring(0, pad.length);
    userData = userData + pad.substring(0, pad.length - userData.length);

    // create checksum for i2cs devices
    var fullCmd = cmd.cmd1 + cmd.cmd2 + userData;
    if (cmd.crc) {
      userData = userData.substring(0, pad.length - 4) + genCrc(fullCmd);
    } else {

      var checksum = 0;
      fullCmd.match(/.{1,2}/g).forEach(function (b) {
        checksum += parseInt(b, 16);
      });

      checksum = ((~checksum) + 1) & 255;
      cmd.checksum = checksum;
      userData = userData.substring(0, pad.length - 2) + toByte(checksum);
    }
  }

  cmd.raw = '02' + type + id + flags + cmd.cmd1 + cmd.cmd2 + userData;
  cmd.id = id;

  return this.sendCommand(cmd, timeout, next);

};

function genCrc(cmd) {
  var crc = 0;
  cmd.substring(0, 28).match(/.{1,2}/g).forEach(function (byte) {
    byte = parseInt(byte, 16);
    for (var bit = 0; bit < 8; bit++) {
      var fb = byte & 1;
      fb = (crc & 0x8000) ? fb ^ 1 : fb;
      fb = (crc & 0x4000) ? fb ^ 1 : fb;
      fb = (crc & 0x1000) ? fb ^ 1 : fb;
      fb = (crc & 0x0008) ? fb ^ 1 : fb;
      crc = (crc << 1) & 0xFFFF | fb;
      byte = byte >> 1;
    }
  });
  return toByte(crc, 2);
}

Insteon.prototype.handleCommand = function (device, cmd) {
  if (!cmd || !cmd.standard) {
    debug('Ignoring invalid command or not from this device (%s) : ', device.id, cmd);
    return;
  }

  var directCmd;

  if (cmd.standard.messageType === 0) {
    directCmd = {
      command1: cmd.standard.command1,
      command2: parseInt(cmd.standard.command2, 16)
    };
  }

  if (directCmd && device.handleDirect) {
    var lastDirectCmd = device.lastCmd;
    if (
      !this.emitDuplicates &&
      !!lastDirectCmd &&
      lastDirectCmd.command1 === directCmd.command1 &&
      lastDirectCmd.command2 === directCmd.command2 &&
      Date.now() - lastDirectCmd.timestamp < DEDUP_TIMER) {

      device.lastCmd.timestamp = Date.now();
      return;
    }

    device.lastCmd = directCmd;
    device.lastCmd.timestamp = Date.now();

    return device.handleDirect(directCmd.command1, directCmd.command2);
  }

  var broadcastCmd;

  // Standard ALL-link Broadcast
  if (cmd.standard.messageType === 6 && cmd.standard.command1 !== '06') {
    broadcastCmd = {
      group: parseInt(cmd.standard.gatewayId, 16),
      command1: cmd.standard.command1,
      command2: cmd.standard.command2
    };
  } else if (cmd.standard.messageType === 6) { // I2CS ALL-link Success Broadcast
    broadcastCmd = {
      group: parseInt(cmd.standard.gatewayId.substr(4), 16),
      command1: cmd.standard.gatewayId.substr(0, 2),
      command2: cmd.standard.gatewayId.substr(2, 2)
    };
  } else if (cmd.standard.messageType === 2 || cmd.standard.messageType === 3) { // ALL-link Clean Up and ACK of ALL-Link Cleanup Message
    broadcastCmd = {
      group: parseInt(cmd.standard.command2, 16),
      command1: cmd.standard.command1,
      command2: '00'
    };
  }


  if (broadcastCmd && device.handleAllLinkBroadcast) {
    var lastCmd = device.lastCmd;
    if (
      !this.emitDuplicates &&
      lastCmd &&
      lastCmd.group === broadcastCmd.group &&
      lastCmd.command1 === broadcastCmd.command1 &&
      Date.now() - lastCmd.timestamp < DEDUP_TIMER) {

      device.lastCmd.timestamp = Date.now();
      return;
    }

    device.lastCmd = broadcastCmd;
    device.lastCmd.timestamp = Date.now();

    return device.handleAllLinkBroadcast(broadcastCmd.group, broadcastCmd.command1, broadcastCmd.command2);
  }

  // if Ack
  if (cmd.standard.messageType === 1) {

    var status = this.status;
    var isSelfAck = status && status.command && status.command.id &&
      status.command.id.toUpperCase() === device.id;

    var handleAck = !!device.handleAck && (this.emitSelfAck || !isSelfAck);
    // Handle Ack
    if (handleAck) {
      return device.handleAck(cmd.standard.command1, cmd.standard.command2);
    }
    return;
  }

  debug('No event for command message type for device (%s) : ', device.id, cmd);
};

Insteon.prototype.checkStatus = function () {
  var that = this;
  var result = this._checkStatus();
  switch (result) {
    case INSUFFICIENT_DATA:
      debug('parsing - insufficient data to continue - %d', this.buffer.length);
      break;
    case MESSAGE_PROCESSED:
    case MESSAGE_SKIPPED:
      // If a message was consumed or skipped
      debug('parsing - message %s', ((result === MESSAGE_PROCESSED) ? 'consumed' : 'skipped'));
      if (this.buffer) {
        // Run this again, but allow the message loop a chance to wake up.
        setTimeout(function () {
          that.checkStatus();
        }, 0);
      }
      break;
    default:
      debug('parsing - unknown result %s', result);
  }
};

Insteon.prototype._checkStatus = function () {
  var result; // Just trying to be careful and suss out every single path
  var raw = this.buffer;
  debug('checkStatus - buffer: %s', raw);
  var status = this.status;
  debug('checkStatus - status: %j', status);

  // check for gateway NAK
  if (raw.substr(0, 2) === '15' && this.status && this.timeout) {
    // Got a PLM NAK; retry our command, if applicable
    var gw = this;
    var nakTimeout = this.status.nakTimeout;
    this.status.nakTimeout *= 2; // Exponential backoff

    clearTimeout(this.timeout);
    this.timeout = setTimeout(function () {
      sendCommandTimout(gw, gw.status.timeout, gw.commandRetries);
    }, nakTimeout);

    this.buffer = raw.substr(2);
    return MESSAGE_PROCESSED;
  }

  // check for enough data
  if (raw.length <= 4) {
    return INSUFFICIENT_DATA; // buffering
  }

  var nextCmdAt = raw.search(/02(5[0-8]|6[0-9a-f]|7[0-3])/i);
  if (nextCmdAt > 0) {
    this.buffer = raw = raw.substr(nextCmdAt);
  }

  var type = raw.substr(0, 4);

  // Dispatcher-style handling
  var dispatcher = this.dispatchers[type.toUpperCase()];
  if (dispatcher) {
    var rawMsg = dispatcher.checkSize.call(this, raw);
    if (rawMsg === false) {
      return INSUFFICIENT_DATA;
    }
    debug('checkStatus - dispatcher - %s', dispatcher.name);
    result = dispatcher.handler.call(this, rawMsg, status);
    if (result !== MESSAGE_SKIPPED) {
      this.trailer();
    }
    return result;
  } else {
    if (this.buffer.length > 4) {
      this.buffer = this.buffer.substr(4);
    } else {
      this.buffer = '';
    }
    return MESSAGE_SKIPPED;
  }
};

var DISPATCHERS = {};

// A closure factory to build the checkSize function for most of our handlers
function _defaultCheckSize(size) {
  return function (raw) {
    if (raw.length < size) {
      return false;
    }
    this.buffer = raw.substr(size);
    return raw.substr(0, size);
  };
}

function setupDispatcher(dispatcher) {
  if (!dispatcher.checkSize) {
    if (!dispatcher.size) {
      throw new Error('Dispatcher missing checkSize and size');
    }
    dispatcher.checkSize = _defaultCheckSize(dispatcher.size);
  }
  DISPATCHERS[dispatcher.id] = dispatcher;
}

// 0251 is a Standard Message that came on the wire and was not a direct response to a command.
setupDispatcher({
  id: '0250',
  name: 'Standard Command',
  size: 22,
  handler: function (raw, status) {
    var cmd = {
      standard: parseMessageReceived(raw)
    };
    this.emit('recvCommand', cmd);
    debug('Parsed command: %j', cmd);
    debug('Status: %j', status);
    var id = cmd.standard.id.toUpperCase();
    debug('Devices: %j', Object.keys(this.devices));
    if (this.devices[id]) {
      debug('Handle Command for device: %s', id);
      this.handleCommand(this.devices[id], cmd);
    }
    if (!status || !status.command || !status.command.id ||
      (status.command.id.toUpperCase() !== id)) { // command isn't a response for a command we sent
      this.emit('command', cmd);
      return MESSAGE_SKIPPED;
    }
    if (!status.response) {
      status.response = {};
    }
    var responseCount = status.command.responseCount;
    if (responseCount) {
      status.response.standard = status.response.standard || [];
      status.response.standard.push(cmd.standard);
      status.success = status.response.standard.length === responseCount;
    } else {
      status.response.standard = cmd.standard;
      status.success = cmd.standard !== undefined && cmd.standard !== null &&
        (!status.command.extended || !!status.command.isStandardResponse) &&
        !status.command.waitForExtended && !status.command.waitForLinking;
    }
    return MESSAGE_PROCESSED;
  }
});

// 0251 is an Extended message that came on the wire and was not a direct response to a command.
setupDispatcher({
  id: '0251',
  name: 'Extended Command',
  size: 50,
  handler: function (raw, status) {
    var cmd = {
      extended: parseMessageReceived(raw)
    };

    // Calculate if CRC is valid (not use by most commands)
    var fullCmd = cmd.extended.command1 + cmd.extended.command2;
    fullCmd = fullCmd + cmd.extended.userData.slice(0, 12).join('');
    var rspCrc = cmd.extended.userData.slice(12).join('').toLowerCase();
    var crc = genCrc(fullCmd).toLowerCase();
    cmd.extended.crc = rspCrc === crc;

    this.emit('recvCommand', cmd);
    debug('Parsed command: %j', cmd);
    debug('Status: %j', status);
    var id = cmd.extended.id.toUpperCase();
    if (this.devices[id]) {
      this.handleCommand(this.devices[id], cmd);
    }
    if (!status || !status.command || !status.command.id ||
      status.command.id.toUpperCase() !== id) { // command isn't a response for a command we sent
      this.emit('command', cmd);
      return MESSAGE_PROCESSED;
    }
    if (!status.response) {
      status.response = {};
    }
    status.response.extended = cmd.extended;
    status.success = cmd.extended !== undefined && cmd.extended !== null;
    return MESSAGE_PROCESSED;
  }
});

setupDispatcher({
  id: '0253',
  name: 'Link Command',
  size: 20,
  handler: function (raw, status) {
    var cmd = {
      link: parseLinkingComplete(raw)
    };
    this.emit('recvCommand', cmd);
    if (!status) {
      this.emit('command', cmd);
      return MESSAGE_PROCESSED;
    }
    if (!status.response) {
      status.response = {};
    }
    status.response.link = cmd.link;
    status.success = cmd.link !== undefined && cmd.link !== null;
    return MESSAGE_PROCESSED;
  }
});

setupDispatcher({
  id: '0257',
  name: 'Link Record Command',
  size: 20,
  handler: function (raw, status) {
    if (!status) {
      return MESSAGE_SKIPPED;
    }
    status.response = {};
    status.response.raw = raw;
    status.response.type = raw.substr(2, 2);
    status.response.link = parseLinkRecord(raw.substr(4, 16));
    this.emit('recvCommand', status.response);
    status.success = true;
    return MESSAGE_PROCESSED;
  }
});

setupDispatcher({
  id: '0258',
  name: 'All-Link Cleanup Status Report',
  size: 6,
  handler: function (raw, status) {
    if (!status) {
      return MESSAGE_SKIPPED;
    }
    status.report = {
      completed: raw.substr(4, 2) === '06',
      aborted: raw.substr(4, 2) === '15'
    };
    this.emit('recvCommand', {
      type: '58',
      raw: raw.substr(0, 6),
      report: status.report
    });
    status.success = true;
    return MESSAGE_PROCESSED;
  }
});

setupDispatcher({
  id: '0260',
  name: 'Get IM Info Response',
  size: 18,
  handler: function (raw, status) {
    if (!status) {
      return MESSAGE_SKIPPED;
    }
    status.ack = raw.substr(16, 2) === '06';
    status.nack = raw.substr(16, 2) === '15';
    status.response = parseGetInfo(raw.substr(0, 16));
    this.emit('recvCommand', status.response);
    status.success = true;
    return MESSAGE_PROCESSED;
  }
});

setupDispatcher({
  id: '0261',
  name: 'All-Link Command Response',
  size: 12,
  handler: function (raw, status) {
    this.emit('recvCommand', {
      type: '61',
      raw: raw.substr(0, 12)
    });
    if (!status) {
      return MESSAGE_SKIPPED; // TODO: this.emit('command', parsedCmd);
    }
    status.ack = raw.substr(10, 2) === '06';
    status.nack = raw.substr(10, 2) === '15';
    return MESSAGE_PROCESSED;
  }
});

// Response to a standard or extended message, usually direct
setupDispatcher({
  id: '0262',
  name: 'Direct Command Response',
  checkSize: function (raw) {
    // Under 12 characters, we don't have the flags byte, so we need more.
    if (raw.length < 12) {
      return false;
    }
    // The interesting thing about an 0262 is it's a variable length response.
    // So unlike the other responses, we need to get to the message flags byte to know
    // whether it's a standard (18 hex chars) or extended (46 hex chars) response.
    var flags = parseInt(raw.substr(10, 2), 16);
    var isExtended = (flags & 0x10) !== 0;
    var expectedLength = isExtended ? 46 : 18;
    if (raw.length < expectedLength) {
      return false;
    }

    this.buffer = raw.substr(expectedLength);
    return raw.substr(0, expectedLength);
  },
  handler: function (raw, status) {
    if (!this.status) {
      return MESSAGE_SKIPPED;
    }

    this.emit('recvCommand', {
      type: '62',
      raw: raw.substr(0, status.command.raw.length + 2)
    });
    status.ack = raw.substr(status.command.raw.length, 2) === '06';
    status.nack = raw.substr(status.command.raw.length, 2) === '15';
    return MESSAGE_PROCESSED;
  }
});

setupDispatcher({
  id: '0263', // X10 response
  name: 'X10 Response',
  size: 10,
  handler: function (raw, status) {
    if (!status) {
      // If we get here, we got an X10 response without sending a request. Probably nowhere to route it.
      return MESSAGE_SKIPPED;
    }

    debug('checkStatus - X10 Command');
    this.emit('recvCommand', {
      type: '63',
      raw: raw.substr(0, status.command.raw.length + 2)
    });
    status.ack = raw.substr(status.command.raw.length, 2) === '06';
    status.nack = raw.substr(status.command.raw.length, 2) === '15';
    return MESSAGE_PROCESSED;
  }
});

setupDispatcher({
  id: '0264',
  name: 'All-Link Start Response',
  size: 10,
  handler: function (raw, status) {
    if (!status) {
      return MESSAGE_SKIPPED;
    }

    this.emit('recvCommand', {
      type: '64',
      raw: raw.substr(0, 10)
    });
    status.ack = raw.substr(8, 2) === '06';
    status.nack = raw.substr(8, 2) === '15';
    status.success = !status.command.waitForLinking;
    return MESSAGE_PROCESSED;
  }
});

setupDispatcher({
  id: '0265',
  name: 'ALL-Link Cancel Response',
  size: 6,
  handler: function (raw, status) {
    if (!status) {
      return MESSAGE_SKIPPED;
    }

    this.emit('recvCommand', {
      type: '65',
      raw: raw.substr(0, 6)
    });
    status.ack = raw.substr(4, 2) === '06';
    status.nack = raw.substr(4, 2) === '15';
    status.success = true;
    return MESSAGE_PROCESSED;
  }
});

setupDispatcher({
  id: '0269',
  name: 'Get First ALL-Link Record',
  size: 6,
  handler: function (raw, status) {
    if (!status) {
      return MESSAGE_SKIPPED;
    }
    this.emit('recvCommand', {
      type: raw.substr(2, 2),
      raw: raw.substr(0, 6)
    });
    status.ack = raw.substr(4, 2) === '06';
    status.nack = raw.substr(4, 2) === '15';
    return MESSAGE_PROCESSED;
  }
});

setupDispatcher({
  id: '026A',
  name: 'Get Next ALL-Link Record',
  size: 6,
  handler: DISPATCHERS['0269'].handler
});

setupDispatcher({
  id: '026F',
  name: 'Manage ALL-Link Record Response',
  size: 24,
  handler: function (raw, status) {
    if (!status) {
      return MESSAGE_SKIPPED;
    }
    this.emit('recvCommand', {
      type: '6F',
      raw: raw.substr(0, 24)
    });
    status.ack = raw.substr(22, 2) === '06';
    status.nack = raw.substr(22, 2) === '15';
    status.command.code = raw.substr(4, 2);
    if (status.command.code !== '00' && status.command.code !== '01') {
      status.success = status.ack;
    }
    return MESSAGE_PROCESSED;
  }
});

Insteon.prototype.trailer = function () {
  var status = this.status;
  debug('checkStatus - status (after parsing): %j', status);
  if (status) {
    if (status.command.exitOnAck) {
      status.success = status.ack;
    }
    if (status.nack || (status.success && status.ack)) {
      if (this.timeout) {
        clearTimeout(this.timeout);
        delete this.timeout;
      }
      delete this.status;
      status.deferred.resolve(status);
      sendCommand(this, this.queue.shift());
    }
  }
};


function parseMessageReceived(raw) {
  var cmd = {};
  cmd.type = raw.substr(2, 2);
  if (cmd.type !== '51' && cmd.type !== '50') {
    return null;
  }
  cmd.id = raw.substr(4, 6);
  cmd.gatewayId = raw.substr(10, 6);
  var typeFlag = parseInt(raw.substr(16, 1), 16);
  cmd.extended = cmd.type === '51'; // typeFlag & 1 !== 0; // bit mask 0001
  cmd.messageType = typeFlag >> 1;
  var hopFlag = parseInt(raw.substr(17, 1), 16);
  cmd.hopsLeft = hopFlag >> 2;
  cmd.maxHops = hopFlag & 3; // bit mask 0011
  cmd.command1 = raw.substr(18, 2);
  cmd.command2 = raw.substr(20, 2);

  if (cmd.extended) {
    cmd.userData = [];
    for (var i = 0; i < 14; i++) {
      cmd.userData.push(raw.substr(22 + (i * 2), 2));
    }
    cmd.raw = raw.substr(0, (25 * 2));
  } else {
    cmd.raw = raw.substr(0, (11 * 2));
  }
  return cmd;
}

function parseGetInfo(raw) {
  var resp = {};
  resp.raw = raw;
  resp.type = raw.substr(2, 2);
  resp.id = raw.substr(4, 6);
  resp.deviceCategory = {
    id: parseInt(raw.substr(10, 2), 16)
  };
  resp.deviceCategory.name = DEV_CAT_NAMES[resp.deviceCategory.id];
  resp.deviceSubcategory = {
    id: parseInt(raw.substr(12, 2), 16)
  };
  resp.firmwareVersion = raw.substr(14, 2);
  return resp;
}


function parseLinkRecord(raw) {
  var link = {};
  var flags = parseInt(raw.substr(0, 2), 16);
  link.flags = raw.substr(0, 2);
  link.controller = (flags & 64) !== 0; // bit mask 0100 0000
  link.isInUse = (flags & 128) !== 0; // bit mask 1000 0000
  link.hasBeenUsed = (flags & 2) !== 0; // bit mask 0000 0010
  link.isLast = flags === 0;
  link.group = parseInt(raw.substr(2, 2), 16);
  link.id = raw.substr(4, 6);
  link.data = [raw.substr(10, 2), raw.substr(12, 2), raw.substr(14, 2)];
  link.onLevel = utils.byteToLevel(link.data[0]);
  link.rampRate = utils.byteToRampRate(link.data[0]);
  return link;
}

function parseLinkingComplete(raw) {
  var r = /^02(53)(\w{2})(\w{2})(\w{6})(\w{2})(\w{2})(\w{2})/.exec(raw);
  if (!r) {
    return {};
  }
  var devCatId = parseInt(r[5], 16);
  return {
    raw: r[0],
    type: r[1],
    controller: r[2] === '01',
    wasDeleted: r[2].toUpperCase() === 'FF',
    isNew: true,
    group: parseInt(r[3], 16),
    id: r[4],
    deviceCategory: {
      id: devCatId,
      name: DEV_CAT_NAMES[devCatId]
    },
    deviceSubcategory: {
      id: parseInt(r[5], 16)
    },
    firmwareVersion: r[6]
  };
}




/**************************************************************************
 * Linking Functions
 **************************************************************************/

/**
 * link or unlink a device(s) to the gateway
 *
 * options object:
 * {
 *   controller: Boolean
 *   group: Number,
 *   timeout: Number,
 *   unlink: Boolean
 * }
 *
 * default values:
 * {
 *   controller: false,
 *   group: 1, // contoller group/button
 *   timeout: 30 // 30 secondes to press set button - hurry up
 *   unlink: false
 * }
 *
 *
 *
 * @param  {String|Array}   device
 * @param  {Object}         options
 * @param  {Function}       next
 */
Insteon.prototype.link = function () {
  var args = Array.prototype.slice.call(arguments);
  return link.apply(null, [this, false, null].concat(args));
};

/**
 * Unlink a device from the gateway.
 *
 * @param  {String}         controller
 * @param  {String|Array}   responder
 * @param  {Object}         options
 * @param  {Function}       next
 */
Insteon.prototype.unlink = function () {
  var args = Array.prototype.slice.call(arguments);
  return link.apply(null, [this, true, null].concat(args));
};

function link(gw, unlink, links, device, options, next) {

  if (typeof options === 'function') {
    next = options;
    options = null;
    if (!Array.isArray(device) && typeof device === 'object') {
      options = device;
      device = null;
    }
  } else if (typeof device === 'function') {
    next = device;
    device = null;
  }
  var defaults = {
    controller: false,
    group: 1,
    timeout: 30000, // only used for manual linking (i.e. waiting for set button)
    unlink: unlink
  };

  options = utils.assignDefaults(defaults, options);

  debug('link options: %j', options);

  var gwCmd = {
    type: '64',
    group: options.group,
    waitForLinking: !device,
    raw: (
      options.unlink ? '0264FF' : (
        options.controller ? '026400' : '026401')
    ) + toByte(options.group)
  };

  var allLinkCmd = {
    cmd1: options.unlink ? '0A' : '09',
    cmd2: '00',
    extended: !options.unlink,
    waitForLinking: true
  };


  var deferred = Q.defer();

  if (options.controller) {
    // Make sure all linkng is cancel before trying to create a link
    deferred.resolve(
      gw.cancelLinking()
      .then(function () {
        if (device) { // device is controller
          if (Array.isArray(device)) {
            device = device.pop(); // When device is controller only one device supported
          }
          allLinkCmd.cmd2 = toByte(options.group);
          allLinkCmd.isStandardResponse = true;

          return sendLinkCommand(gw, gwCmd)
            .then(function () {
              return gw.directCommand(device, allLinkCmd);
            })
            .then(function (status) {
              if (status.response) {
                return status.response.link;
              } else {
                return null;
              }
            });
        } else { // unknown device is controller - press set button prior to calling function
          return sendLinkCommand(gw, gwCmd);
        }
      })
    );
  } else { // gw is contoller
    if (device) {
      deferred.resolve(
        linkResponders(gw, links, device, gwCmd, allLinkCmd)
      );
    } else { // unknown device is responder -- press set button
      // Make sure all linkng is cancel before trying to create a link
      deferred.resolve(
        gw.cancelLinking()
        .then(function () {
          return sendLinkCommand(gw, gwCmd, options.timeout);
        })

      );
    }
  }
  return deferred.promise.nodeify(next);
}

function sendLinkCommand(gw, cmd, timeout) {
  debug('sendLinkCommand: %j', cmd);
  return gw.sendCommand(cmd, timeout)
    .then(function (status) {
      if (status.response) {
        return status.response.link;
      } else {
        return null;
      }
    });
}

function linkResponders(gw, links, devices, gwCmd, allLinkCmd) {
  debug(
    'linkResponders - links: %j, devices: %j, gwCmd: %j, allLinkCmd: %j',
    links, devices, gwCmd, allLinkCmd
  );
  var responder;
  if (!Array.isArray(devices)) {
    responder = devices;
    devices = [];
  } else {
    links = links || [];
    responder = devices.shift();
  }
  // Make sure all linkng is cancel before trying to create a link
  return gw.cancelLinking()
    .then(function () {
      gwCmd.exitOnAck = true;
      return gw.sendCommand(gwCmd);
    })
    .then(function (gwStatus) {
      if (!gwStatus.ack) {
        debug('linkResponders - gwStatus: %j', gwStatus);
        return null;
      }
      allLinkCmd.waitForLinking = true;

      return gw.directCommand(responder, allLinkCmd)
        .then(function (status) {
          if (!status) {
            return null;
          }
          if (devices.length === 0) {
            if (links) {
              if (status.response) {
                links.push(status.response.link);
              }
              return links;
            } else {
              if (status.response) {
                return status.response.link;
              } else {
                return null;
              }
            }
          } else {
            if (status.response) {
              links.push(status.response.link);
            }
            return linkResponders(gw, links, devices, gwCmd, allLinkCmd);
          }
        });
    });
}


/**
 * Cancel linking/unlinking
 *
 * @param  {Function} next
 */
Insteon.prototype.cancelLinking = function (next) {
  debug('insteon.cancelLinking');
  return this.sendCommand('65', next);
};

/**
 * Gets the links of a device or the gateway.  Links are returned in the
 * callback as an Array of link Objects.
 *
 * @param  {String}   id
 * @param  {Function} next
 */
Insteon.prototype.links = function (id, next) {
  if (typeof id === 'function') {
    next = id;
    id = null;
  }
  debug('insteon.links - id: %j', id);
  if (id && id.length === 6) {
    return this.linkAt(id, 4095, [], next); // start at 0xFFF (4095)
  } else {
    return this.firstLink([], next);
  }
};

/**
 * Gets the first link record on the gateway.
 *
 * If links Array is provided, the function will add all links recursivly to
 * the links Array.
 *
 * @param  {Array}   links
 * @param  {Function} next
 */
Insteon.prototype.firstLink = function (links, next) {
  if (typeof links === 'function') {
    next = links;
    links = null;
  }
  var insteon = this;

  return insteon.sendCommand('69')
    .then(function (status) {
      if (status.ack) {
        if (links && status.response) {
          return insteon.nextLink([status.response.link]);
        } else {
          if (status.response) {
            return status.response.link;
          } else {
            return null;
          }
        }
      } else {
        return links;
      }
    }).nodeify(next);
};

/**
 * Gets the next link record on the gateway.
 *
 * If links Array is provided, the function will add all links recursivly to
 * the links Array.
 *
 * @param  {Array}   links
 * @param  {Function} next
 */
Insteon.prototype.nextLink = function (links, next) {
  if (typeof links === 'function') {
    next = links;
    links = null;
  }
  var insteon = this;

  return insteon.sendCommand('6A')
    .then(function (status) {
      if (status.ack) {
        if (links && status.response) {
          links.push(status.response.link);
          return insteon.nextLink(links);
        } else {
          if (status.response) {
            return status.response.link;
          } else {
            return null;
          }
        }
      } else {
        return links;
      }
    }).nodeify(next);
};

/**
 * Gets the link at a memory address on a device.
 *
 * If links Array is provided, the function will add all links recursivly to
 * the links Array.
 *
 * @param  {String}   id
 * @param  {Number}   at
 * @param  {Array}   links (optional)
 * @param  {Function} next
 */
Insteon.prototype.linkAt = function (id, at, links, next) {
  if (typeof links === 'function') {
    next = links;
    links = null;
  }
  var insteon = this;

  var cmd = {
    cmd1: '2F',
    cmd2: '00',
    extended: true
  };

  cmd.userData = ['00', '00', toByte(at, 2), '01'];


  return this.directCommand(id, cmd)
    .then(function (status) {
      if (status.ack && status.response && status.response.extended) {
        var data = status.response.extended.userData;
        var rawLink = data[5] + data[6] + data[7] + data[8] + data[9] + data[10] + data[11] + data[12];
        var link = parseLinkRecord(rawLink);
        link.at = parseInt(data[2] + data[3], 16);

        if (link.isLast) {
          return links;
        }
        if (links) {
          links.push(link);
          return insteon.linkAt(id, at - 8, links);
        } else {
          return link;
        }
      } else {
        return links;
      }
    }).nodeify(next);
};

Insteon.prototype.writeLinkData = function (id, at, link, next) {
  if (typeof link === 'object' && at) {
    link.at = at;
  }
  if (typeof link === 'function' || !link) {
    next = link;
    link = at;
    if (typeof id === 'number') {
      link.at = id;
      id = 'gw';
    }
  }
  if (typeof at === 'function' || !at) {
    link = id;
    next = at;
    id = 'gw';
  }

  debug('writeLinkData - id: %s, link: %j', id, link);

  /*in use (bit 7), controller (6), and used (1) */
  var ctrlBits = 0x82; // in used and used;

  if (link.controller) {
    ctrlBits |= 0x40;
  }

  if (id === 'gw') {

    var flags = link.flags ? parseInt(link.flags, 16) : 0; // set Product dependent flags

    ctrlBits |= (flags & 0x3D); // set product flags

    // update (0x20), add controller (0x40), add responder (0x41), delete (0x80)
    var code = '41'; // add resonder
    if (link.remove) {
      ctrlBits = flags; // must match record exactly
      code = '80';
    } else if (link.isInUse) {
      code = '20'; // update
    } else if (link.controller) {
      code = '40'; // add controller
    }

    var manageLinkRecordCmd = {
      type: '6F',
      /*Manage ALL-Link Record*/
      code: code,
      raw: '026F' + code + toByte(ctrlBits) + toByte(link.group) + link.id + link.data.join('')
    };

    return this.sendCommand(manageLinkRecordCmd);
  } else {

    if (link.remove) {
      ctrlBits &= 0x7F; // Clear is used bit
    }

    var cmd = {
      cmd1: '2F',
      cmd2: '00',
      extended: true
    };

    cmd.userData = [
      '00',
      '02', /* write */
      toByte(link.at, 2),
      '08', /* length */
      toByte(ctrlBits), /* control bits*/
      toByte(link.group),
      link.id
    ];
    cmd.userData = cmd.userData.concat(link.data);
    cmd.isStandardResponse = true;

    return this.directCommand(id, cmd, next);
  }
};


Insteon.prototype.addLink = function (device, link, next) {
  return this.modLink('add', device, link, next);
};

Insteon.prototype.updateLink = function (device, link, next) {
  return this.modLink('update', device, link, next);
};

Insteon.prototype.removeLink = function (device, link, next) {
  return this.modLink('remove', device, link, next);
};

Insteon.prototype.removeLinkAt = function (device, at, next) {
  var link, _link;
  var self = this;

  return this.links(device)
    .then(function (links) {
      for (var i = links.length - 1; i >= 0; i--) {
        _link = links[i];
        if (_link.at === at) {
          link = _link;
          break;
        }
      }

      if (!link) {
        return null;
      }

      return self.modLink('remove', device, link);
    })
    .catch(console.log)
    .nodeify(next);
};


Insteon.prototype.modLink = function (mod, device, link, next) {

  if (!link || typeof link === 'function') {
    next = link;
    link = device;
    device = null;
  }

  link = link || {};

  if (link.group === null || link.group === undefined) {
    link.group = 1;
  }

  link.data = link.data || ['00', '00', '00'];

  link.remove = mod === 'remove';
  link.isInUse = mod === 'update' || mod === 'remove';

  device = device || {
    id: 'gw'
  };

  if (typeof device === 'string') {
    device = {
      id: device
    };
  }


  var gw = this;
  if (device.id === 'gw') {
    return this.writeLinkData(device.id, link, next);
  } else {
    if (!link.at) {
      if (!device.links) {
        return this.links(device.id)
          .then(function (links) {
            device.links = links;
            return findAtAndUpdate(gw, device, link);
          }).nodeify(next);
      } else {
        return findAtAndUpdate(gw, device, link)
          .nodeify(next);
      }
    } else {
      return this.writeLinkData(device.id, link, next);
    }
  }
};

function findAtAndUpdate(gw, device, link) {
  var at, i, _link;

  if (link.isInUse) {
    for (i = device.links.length - 1; i >= 0; i--) {
      _link = device.links[i];
      if (
        _link.controller === link.controller &&
        _link.group === link.group &&
        _link.id === link.id) {
        at = _link.at;
        break;
      }
    }
  } else {
    at = 0x0FFF;
    for (i = device.links.length - 1; i >= 0; i--) {
      _link = device.links[i];
      if (!_link.isInUse) {
        at = _link.at;
        break;
      }
      if (_link.at <= at) {
        at = _link.at - 8;
      }
    }
  }
  link.at = at;

  if (!link.at) {
    throw new Error('Cannot update link - link.at is invalid');
  }
  return gw.writeLinkData(device.id, link);
}

Insteon.prototype.scene = function (controller, responders, options, next) {
  if (typeof options === 'function') {
    next = options;
    options = {};
  }
  options = options || {};

  utils.assignDefaults({
    group: 1
  }, options);

  responders = responders || [];

  if (!Array.isArray(responders)) {
    responders = [responders];
  }
  if (typeof controller === 'string') {
    controller = {
      id: controller
    };
  }
  controller.controller = true;

  var devices = [controller];

  responders.forEach(function (responder, i, arr) {
    if (typeof responder === 'string') {
      responder = {
        id: responder
      };
    }

    if (!responder.data || !Array.isArray(responder.data)) {
      responder.data = ['00', '00', '00'];
    }
    while (responder.data.length < 3) {
      responder.data.push('00');
    }
    if (responder.level) {
      responder.data[0] = utils.levelToHexByte(responder.level);
    }
    if (responder.ramp) {
      responder.data[1] = utils.rampRateToHexByte(responder.ramp);
    }

    arr[i] = responder;
    devices.push(responder);
  });

  var gw = this;

  var updateList = [];
  var addList = [];
  var removeList = [];

  return gw.info()
    .then(function (info) {
      gw.id = info.id;
      return loadLinks(gw, devices);
    })
    .then(function () {

      var current = [];
      controller.links.forEach(function (link) {
        if (link.group === options.group && link.controller && link.isInUse) {
          current.push(link.id);
        }
      });

      var r;
      while (r = responders.pop()) {
        var id = r.id;
        if (id === 'gw') {
          id = gw.id;
        }
        var i = current.indexOf(id);
        if (i >= 0) {
          updateList.push(r);
          current = current.splice(i, 1);
        } else {
          addList.push(r);
        }
      }

      current.forEach(function (id) {
        if (id === gw.id) {
          id = 'gw';
        }
        removeList.push({
          id: id
        });
      });


      return modLinks(gw, 'update', controller, options.group, updateList);
    })
    .then(function () {
      return modLinks(gw, 'add', controller, options.group, addList);
    })
    .then(function () {
      if (options.remove) {
        return loadLinks(gw, removeList)
          .then(function () {
            return modLinks(gw, 'remove', controller, options.group, removeList);
          });
      } else {
        return null;
      }
    }).nodeify(next);
};

function loadLinks(gw, devices) {

  var _loadLinks = function (i) {
    if (devices.length === i) {
      return null;
    }
    var device = devices[i];
    return gw.links(device.id)
      .then(function (links) {
        device.links = links;
        return _loadLinks(i + 1);
      });
  };

  return _loadLinks(0);
}

function modLinks(gw, mod, controller, group, responders) {

  debug('modLinks - mod: %s, controller: %s, group: %s, responders: %s', mod, controller.id, group, responders.length);

  if (responders.length === 0) {
    return null;
  }

  var responder = responders.pop();

  var ctrlID = controller.id;
  if (controller.id === 'gw') {
    ctrlID = gw.id;
  }

  var link = {
    id: ctrlID,
    group: group,
    data: responder.data,
    controller: false
  };

  return gw.modLink(mod, responder, link).then(function () {
    if (mod === 'update') { // no need to update controller links
      return modLinks(gw, mod, controller, group, responders);
    } else {
      return modCtlLink(gw, mod, controller, group, responder, responders);
    }
  });

}

function modCtlLink(gw, mod, controller, group, responder, responders) {

  debug('modCtlLink - mod: %s, controller: %s, group: %s, responders: %s', mod, controller.id, group, responders.length);

  var rspdID = responder.id;
  if (responder.id === 'gw') {
    rspdID = gw.id;
  }

  var link = {
    group: group,
    id: rspdID,
    data: responder.data,
    controller: true
  };

  return gw.modLink(mod, controller, link).then(function () {
    return modLinks(gw, mod, controller, group, responders);
  });
}


/**************************************************************************
 * Group/Scene Functions
 **************************************************************************/
Insteon.prototype.sendAllLinkCmd = function (group, command, next) {
  var sendAllLinkCmd = {
    type: '61',
    group: group,
    command: command,
    raw: '0261' + toByte(group) + command + '00'
  };


  var deferred = Q.defer();
  deferred.resolve(
    this.sendCommand(sendAllLinkCmd)
    .then(function (status) {
      return status.report;
    })
  );
  return deferred.promise.nodeify(next);
};


Insteon.prototype.sceneOn = function (group, next) {
  debug('sceneOn - group: %d', group);
  return this.sendAllLinkCmd(group, '11', next);
};

Insteon.prototype.sceneOnFast = function (group, next) {
  debug('sceneOnFast - group: %d', group);
  return this.sendAllLinkCmd(group, '12', next);
};

Insteon.prototype.sceneOff = function (group, next) {
  debug('sceneOff - group: %d', group);
  return this.sendAllLinkCmd(group, '13', next);
};

Insteon.prototype.sceneOffFast = function (group, next) {
  debug('sceneOffFast - group: %d', group);
  return this.sendAllLinkCmd(group, '14', next);
};

Insteon.prototype.sceneDim = function (group, next) {
  debug('sceneDim - group: %d', group);
  return this.sendAllLinkCmd(group, '16', next);
};

Insteon.prototype.sceneBrighten = function (group, next) {
  debug('sceneBrighten - group: %d', group);
  return this.sendAllLinkCmd(group, '15', next);
};



/**************************************************************************
 * Basic Functions
 **************************************************************************/

Insteon.prototype.info = function (id, next) {
  if (typeof id === 'function') {
    next = id;
    id = null;
  }


  if (id) {
    return this.idRequest(id, next);
  } else {
    var deferred = Q.defer();
    deferred.resolve(
      this.sendCommand('60')
      .then(function (status) {
        return status.response;
      })
    );
    return deferred.promise.nodeify(next);
  }
};

Insteon.prototype.version = function (id, next) {
  var deferred = Q.defer();
  deferred.resolve(
    this.directCommand(id, '0D')
    .then(function recievedVersion(status) {
      if (!status || !status.response || !status.response.standard) {
        return null;
      }
      var resp = status.response.standard;
      var version = {
        code: parseInt(resp.command2, 16),
        name: utils.VERSIONS[resp.command2]
      };
      return version;
    })
  );
  return deferred.promise.nodeify(next);
};


Insteon.prototype.ping = function (id, next) {
  var deferred = Q.defer();
  deferred.resolve(
    this.directCommand(id, '0F')
    .then(function recievedVersion(status) {
      if (!status || !status.response || !status.response.standard) {
        return null;
      }
      return status.response.standard;
    })
  );
  return deferred.promise.nodeify(next);
};



Insteon.prototype.idRequest = function (id, next) {
  var deferred = Q.defer();

  var cmd = {
    cmd1: '10',
    cmd2: '00',
    responseCount: 2
  };

  deferred.resolve(
    this.directCommand(id, cmd)
    .then(function recievedIdRequest(status) {
      if (!status || !status.response || !util.isArray(status.response.standard)) {
        return null;
      }

      var broadcastResp;

      for (var i = 0; i < status.response.standard.length; i++) {
        var resp = status.response.standard[i];
        if (resp.messageType === 4) {
          broadcastResp = resp;
          break;
        }
      }

      if (!broadcastResp) {
        return null;
      }

      var rawDevCat = broadcastResp.gatewayId.substr(0, 2);
      var rawDevSubCat = broadcastResp.gatewayId.substr(2, 2);
      var firmware = broadcastResp.gatewayId.substr(4, 2);


      var info = {
        id: broadcastResp.id,
        firmware: firmware,
        deviceCategory: {
          id: parseInt(rawDevCat, 16)
        },
        deviceSubcategory: {
          id: parseInt(rawDevSubCat, 16)
        },
        isDimmable: false,
        isLighting: false,
        isThermostat: false
      };

      if (info.deviceCategory.id < DEV_CAT_NAMES.length) {
        info.deviceCategory.name = DEV_CAT_NAMES[info.deviceCategory.id];
      }

      switch (info.deviceCategory.id) {
        case 1:
          info.isDimmable = true;
          info.isLighting = true;
          break;
        case 2:
          info.isLighting = true;
          break;
        case 5:
          info.isThermostat = true;
      }
      return info;
    })
  );
  return deferred.promise.nodeify(next);
};

Insteon.prototype.beep = function (id, next) {
  return this.directCommand(id, '30', next)
    .then(function (status) {
      return status.response;
    });
};


/**************************************************************************
 * Lighting Functions (deprecated)
 **************************************************************************/

/* istanbul ignore next */
Insteon.prototype.turnOn = function (id, level, rate, next) {
  console.trace('Insteon.trunOn(id, ...) is deprecated and will be removed in v1.0. Use Insteon.light(id).turnOn(...).');
  return this.light(id).turnOn(level, rate, next);
};

/* istanbul ignore next */
Insteon.prototype.turnOnFast = function (id, next) {
  console.trace('Insteon.turnOnFast(id, ...) is deprecated and will be removed in v1.0. Use Insteon.light(id).turnOnFast(...).');
  return this.light(id).turnOnFast(next);
};

/* istanbul ignore next */
Insteon.prototype.turnOff = function (id, rate, next) {
  console.trace('Insteon.turnOff(id, ...) is deprecated and will be removed in v1.0. Use Insteon.light(id).turnOff(...).');
  return this.light(id).turnOff(rate, next);
};

/* istanbul ignore next */
Insteon.prototype.turnOffFast = function (id, next) {
  console.trace('Insteon.turnOffFast(id, ...) is deprecated and will be removed in v1.0. Use Insteon.light(id).turnOffFast(...).');
  return this.light(id).turnOffFast(next);
};

/* istanbul ignore next */
Insteon.prototype.brighten = function (id, next) {
  console.trace('Insteon.brighten(id, ...) is deprecated and will be removed in v1.0. Use Insteon.light(id).brighten(...).');
  return this.light(id).brighten(next);
};

/* istanbul ignore next */
Insteon.prototype.dim = function (id, next) {
  console.trace('Insteon.dim(id, ...) is deprecated and will be removed in v1.0. Use Insteon.light(id).dim(...).');
  return this.light(id).dim(next);
};

/* istanbul ignore next */
Insteon.prototype.level = function (id, level, next) {
  console.trace('Insteon.level(id, ...) is deprecated and will be removed in v1.0. Use Insteon.light(id).level(...).');
  return this.light(id).level(level, next);
};

/* istanbul ignore next */
Insteon.prototype.rampRate = function (id, btn, rate, next) {
  console.trace('Insteon.rampRate(id, ...) is deprecated and will be removed in v1.0. Use Insteon.light(id).rampRate(...).');
  return this.light(id).rampRate(btn, rate, next);
};

/* istanbul ignore next */
Insteon.prototype.onLevel = function (id, btn, level, next) {
  console.trace('Insteon.onLevel(id, ...) is deprecated and will be removed in v1.0. Use Insteon.light(id).onLevel(...).');
  return this.light(id).onLevel(btn, level, next);
};

var getDevice = function (insteon, DeviceClass, id) {
  id = id.toUpperCase();
  var device = insteon.devices[id];
  if (device && device instanceof DeviceClass) {
    return device;
  }
  debug('Creating new %s: %s', DeviceClass.name, id);
  device = new DeviceClass(id, insteon);
  insteon.devices[id] = device;
  return device;
};

Insteon.prototype.light = function (id) {
  return getDevice(this, Light, id);
};
Insteon.prototype.thermostat = function (id) {
  return getDevice(this, Thermostat, id);
};
Insteon.prototype.motion = function (id) {
  return getDevice(this, Motion, id);
};
Insteon.prototype.meter = function (id) {
  return getDevice(this, Meter, id);
};
Insteon.prototype.door = function (id) {
  return getDevice(this, Door, id);
};
Insteon.prototype.leak = function (id) {
  return getDevice(this, Leak, id);
};
Insteon.prototype.io = function (id) {
  return getDevice(this, IO, id);
};
Insteon.prototype.garage = function (id) {
  return getDevice(this, GarageDoor, id);
};
Insteon.prototype.ioLinc = function (id) {
  return getDevice(this, IOLinc, id);
};

Insteon.prototype.x10 = function (house, unit) {
  return getDevice(this, X10, house + unit);
};


Insteon.defaultTempUnits = 'F';

module.exports = Insteon;