Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added more features #9

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Added more features #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
518db82
Formatted code in VS Code
pkozul Aug 22, 2016
4193652
Added support for zone changes, control outputs, and lighting devices
pkozul Aug 22, 2016
33673f6
Formatted code in VS Code
pkozul Aug 22, 2016
2163eb9
Added request valid user code areas
Sep 13, 2016
d5fb707
Added systemn log data request
Sep 28, 2016
96c8dbf
Added more info to log message
Sep 29, 2016
674c223
Added valid/invalid user number message
pkozul Aug 8, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
246 changes: 179 additions & 67 deletions index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
var net = require('net');
var tls = require('tls');
var protocol = require('./lib/protocol');
var parser = require('./lib/parser');
var messaging = require('./lib/messaging');
var safereturn = require('safereturn');
var net = require('net');
var tls = require('tls');
var protocol = require('./lib/protocol');
var parser = require('./lib/parser');
var messaging = require('./lib/messaging');
var safereturn = require('safereturn');
var EventEmitter = require('events').EventEmitter;

// safereturn overrides
safereturn.defaultTimeout = 3000;

safereturn.onTimeout = function(wrappedCallback, oldError) {
safereturn.onTimeout = function (wrappedCallback, oldError) {
var err = new Error('The Elk M1XEP failed to respond');
wrappedCallback(err);
}
Expand All @@ -18,181 +18,293 @@ safereturn.onTimeout = function(wrappedCallback, oldError) {
/* ElkConnection definition */
/*********************************/

var ElkConnection = function(opts) {
if(!opts) opts = {};
this.port = opts.port || 2101;
this.host = opts.host || '192.168.1.2';
var ElkConnection = function (opts) {

if (!opts) opts = {};

this.port = opts.port || 2101;
this.host = opts.host || '192.168.1.2';
this.responseTimeout = opts.responseTimeout || 3000;
this.useSecure = (opts.useSecure === true) ? true : false;
this.username = opts.username || null;
this.password = opts.password || null;
this.useSecure = (opts.useSecure === true) ? true : false;
this.username = opts.username || null;
this.password = opts.password || null;

this._authorized = false;
this._authorized = false;

this.defaultArmMode = (opts.defaultArmMode)
? opts.defaultArmMode.toLowerCase()
: 'away';

this.defaultArmMode = (opts.defaultArmMode)
? opts.defaultArmMode.toLowerCase()
: 'away';

var that = this;

function afterConnect() {

that._connection.setEncoding('ascii');

// data event handler
that._connection.on('data', function(data) {
that._connection.on('data', function (data) {

data = data.trim().replace('\r', '').replace('\n', '');

// check for elk auth requests
if(data == 'Username:') {
if (data == 'Username:') {
return that._connection.write(that.username + '\r\n');
} else if(data.indexOf('Password:') != -1) {
} else if (data.indexOf('Password:') != -1) {
return that._connection.write(that.password + '\r\n');
} else if(data.indexOf('Elk-M1XEP: Login successful.') !== -1) {
} else if (data.indexOf('Elk-M1XEP: Login successful.') !== -1) {
that._authorized = true;
that.emit('connect');
}

// we are getting a weird message during auth process
if(that.useSecure && (!that._authorized || data.substring(0,2) === '**')) {
if (that.useSecure && (!that._authorized || data.substring(0, 2) === '**')) {
return;
}

// if we are not using un/pw, we are connected and ready
if(!that.useSecure) that.emit('connect');
if (!that.useSecure) that.emit('connect');

// assuming the above passes, we parse the elk message and emit
var msg = parser.parseMessage(data);
msg.time = new Date();
msg.host = that._connection.address().address;
msg.port = that.port;
var msg = parser.parseMessage(data);
msg.time = new Date();
msg.host = that._connection.address().address;
msg.port = that.port;
msg.remotePort = that._connection.address().port;
that.emit('any', msg);
that.emit(msg.commandCode, msg);
});

// error event handler
that._connection.on('error', function(err){
if(err.code == 'ECONNREFUSED') {
that._connection.on('error', function (err) {
if (err.code == 'ECONNREFUSED') {
that.emit('error', 'Connection to M1XEP failed!');
} else {
that.emit('error', err.code);
}
});

// close event handler
that._connection.on('close', function(){
that._connection.on('close', function () {
that.emit('end', 'The connection to the Elk M1 has been lost');
});

}

if(this.useSecure) {
this._connection = new tls.connect(this.port, this.host, {}, afterConnect);

if (this.useSecure) {

var ciphers = ['TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384',
'TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256',
'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384',
'TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA',
'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256',
'TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA',
'TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384',
'TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256',
'TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384',
'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256',
'TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA'].join(':');

var options = {
secureProtocol: 'TLSv1_method',
rejectUnauthorized: false,
//requestCert: true,
//cipher: 'AES256-SHA'
};
this._connection = new tls.connect(this.port, this.host, options, afterConnect);
} else {
this._connection = new net.connect(this.port, this.host, afterConnect);
}

}

// inherit from EventEmitter
ElkConnection.prototype = Object.create(EventEmitter.prototype);

ElkConnection.prototype.disconnect = function() {
if(this._connection) this._connection.destroy();
ElkConnection.prototype.disconnect = function () {
if (this._connection) this._connection.destroy();
}

ElkConnection.prototype.disarm = function(opts) {
ElkConnection.prototype.disarm = function (opts) {
this._connection.write(messaging.writeArmingMessage('a0', opts));
}

ElkConnection.prototype.armAway = function(opts) {
ElkConnection.prototype.armAway = function (opts) {
this._connection.write(messaging.writeArmingMessage('a1', opts));
}

ElkConnection.prototype.armStay = function(opts) {
ElkConnection.prototype.armStay = function (opts) {
this._connection.write(messaging.writeArmingMessage('a2', opts));
}

ElkConnection.prototype.armStayInstant = function(opts) {
ElkConnection.prototype.armStayInstant = function (opts) {
this._connection.write(messaging.writeArmingMessage('a3', opts));
}

ElkConnection.prototype.armNight = function(opts) {
ElkConnection.prototype.armNight = function (opts) {
this._connection.write(messaging.writeArmingMessage('a4', opts));
}

ElkConnection.prototype.armNightInstant = function(opts) {
ElkConnection.prototype.armNightInstant = function (opts) {
this._connection.write(messaging.writeArmingMessage('a5', opts));
}

ElkConnection.prototype.armVacation = function(opts) {
ElkConnection.prototype.armVacation = function (opts) {
this._connection.write(messaging.writeArmingMessage('a6', opts));
}

ElkConnection.prototype.armStepAway = function(opts) {
ElkConnection.prototype.armStepAway = function (opts) {
this._connection.write(messaging.writeArmingMessage('a7', opts));
}

ElkConnection.prototype.armStepStay = function(opts) {
ElkConnection.prototype.armStepStay = function (opts) {
this._connection.write(messaging.writeArmingMessage('a8', opts));
}

ElkConnection.prototype.armingStatusRequest = function(callback) {
if(callback && typeof callback === 'function') {
ElkConnection.prototype.armingStatusRequest = function (callback) {
if (callback && typeof callback === 'function') {
callback = safereturn(callback, this.responseTimeout);
this.once('AS', function(data){
this.once('AS', function (data) {
callback(null, data);
});
}
this._connection.write(messaging.writeAscii('as'));
}

ElkConnection.prototype.alarmByZoneRequest = function(callback) {
if(callback && typeof callback === 'function') {
ElkConnection.prototype.alarmByZoneRequest = function (callback) {
if (callback && typeof callback === 'function') {
callback = safereturn(callback, this.responseTimeout);
this.once('AZ', function(data){
this.once('AZ', function (data) {
callback(null, data);
});
}
this._connection.write(messaging.writeAscii('az'));
}

ElkConnection.prototype.speak = function(message) {
ElkConnection.prototype.speak = function (message) {
var commands = messaging.getWordCommands(message);
for(var i=0; i<commands.length; i++) {
for (var i = 0; i < commands.length; i++) {
this._connection.write(commands[i]);
}
}

ElkConnection.prototype.zoneDefinitionRequest = function(callback) {
if(callback && typeof callback === 'function') {
ElkConnection.prototype.zoneDefinitionRequest = function (callback) {
if (callback && typeof callback === 'function') {
callback = safereturn(callback, this.responseTimeout);
this.once('ZD', function(data){
this.once('ZD', function (data) {
callback(null, data);
});
}
this._connection.write(messaging.writeAscii('zd'));
}

ElkConnection.prototype.textDescriptionRequest = function(type, address, callback) {
if(callback && typeof callback === 'function') {
ElkConnection.prototype.zoneStatusRequest = function (callback) {
if (callback && typeof callback === 'function') {
callback = safereturn(callback, this.responseTimeout);
this.once('ZS', function (data) {
callback(null, data);
});
}
this._connection.write(messaging.writeAscii('zs'));
}

ElkConnection.prototype.lightingDeviceStatusRequest = function (device, callback) {
if (callback && typeof callback === 'function') {
callback = safereturn(callback, this.responseTimeout);
this.once('DS', function (data) {
callback(null, data);
});
}
this._connection.write(messaging.writeAscii('ds' + ('000' + device).substr(-3)));
}

ElkConnection.prototype.insteonLightingDeviceStatusRequest = function (startDevice, numDevices, callback) {
if (callback && typeof callback === 'function') {
callback = safereturn(callback, this.responseTimeout);
this.once('IR', function (data) {
callback(null, data);
});
}

this._connection.write(messaging.writeAscii('ir' + ('000' + startDevice.toString()).substr(-3) + numDevices.toString()));
}

ElkConnection.prototype.powerLineCarrierStatusRequest = function (bank, callback) {
if (callback && typeof callback === 'function') {
callback = safereturn(callback, this.responseTimeout);
this.once('PS', function (data) {
callback(null, data);
});
}

this._connection.write(messaging.writeAscii('ps' + bank.toString()));
}

ElkConnection.prototype.powerLineCarrierChangeRequest = function (houseCode, unitCode, functionCode, level, duration) {
this._connection.write(messaging.writePowerLineCarrierChangeMessage('pc', houseCode, unitCode, functionCode, level, duration));
}

ElkConnection.prototype.controlOutputOnRequest = function (controlOutput, duration) {
this._connection.write(messaging.writeControlOutputOnMessage('cn', controlOutput, duration));
}

ElkConnection.prototype.controlOutputOffRequest = function (controlOutput) {
this._connection.write(messaging.writeControlOutputOffMessage('cf', controlOutput));
}

ElkConnection.prototype.controlOutputToggleRequest = function (controlOutput) {
this._connection.write(messaging.writeControlOutputToggleMessage('ct', controlOutput));
}

ElkConnection.prototype.controlOutputStatusRequest = function (callback) {
if (callback && typeof callback === 'function') {
callback = safereturn(callback, this.responseTimeout);
this.once('SD', function(data){
this.once('CS', function (data) {
callback(null, data);
});
}
this._connection.write(messaging.writeAscii('cs'));
}

ElkConnection.prototype.taskActivationRequest = function (task) {
this._connection.write(messaging.writeTaskActivationMessage('tn', task));
//console.log(messaging.writeTaskActivationMessage('tn', task));
}

ElkConnection.prototype.validUserCodeRequest = function (userCode, callback) {
if (callback && typeof callback === 'function') {
callback = safereturn(callback, this.responseTimeout);
this.once('UA', function (data) {
callback(null, data);
});
}
this._connection.write(messaging.writeValidUserCodeMessage('ua', userCode));
}

ElkConnection.prototype.textDescriptionRequest = function (type, address, callback) {
if (callback && typeof callback === 'function') {
callback = safereturn(callback, this.responseTimeout);
this.once('SD', function (data) {
callback(null, data);
});
}
this._connection.write(messaging.writeTextDescriptionsMessage('sd', type, address));
}

ElkConnection.prototype.systemLogRequest = function (logEntry, callback) {
if (callback && typeof callback === 'function') {
callback = safereturn(callback, this.responseTimeout);
this.once('LD', function (data) {
callback(null, data);
});
}
this._connection.write(messaging.writeSystemLogMessage('ld', logEntry));
}

/*********************************/
/* exports */
/*********************************/

module.exports.createConnection = function(opts) {
module.exports.createConnection = function (opts) {
return new ElkConnection(opts);
}

Expand Down
Loading