isy-js/elkdevice.js

Javascript wrapper for ISY interface including websockets for change notifications. Designed to be used in a node.js application. Unsupported and no longer under active development.

var isy = require('./isy.js');
var xmldoc = require('xmldoc');

/////////////////////////////
// ELKAlarmPanelDevice
//

function ELKAlarmPanelDevice(isy,area) {
	this.isy = isy;
	this.area = area;
	this.alarmTripState = this.ALARM_TRIP_STATE_DISARMED;
	this.alarmState = this.ALARM_STATE_NOT_READY_TO_ARM;
	this.alarmMode = this.ALARM_MODE_DISARMED;
	this.name = "Elk Alarm Panel "+area;
	this.address = "ElkPanel"+area;
	this.deviceFriendlyName = "Elk Main Alarm Panel";
	this.deviceType = isy.DEVICE_TYPE_ALARM_PANEL;
	this.connectionType = "Elk Network Module";
	this.batteryOperated = false;	
	this.voltage = 71;
	this.lastChanged = new Date();
}

// Alarm mode constanrs
ELKAlarmPanelDevice.prototype.ALARM_MODE_DISARMED = 0;
ELKAlarmPanelDevice.prototype.ALARM_MODE_AWAY = 1;
ELKAlarmPanelDevice.prototype.ALARM_MODE_STAY = 2;
ELKAlarmPanelDevice.prototype.ALARM_MODE_STAY_INSTANT = 3;
ELKAlarmPanelDevice.prototype.ALARM_MODE_NIGHT = 4;
ELKAlarmPanelDevice.prototype.ALARM_MODE_NIGHT_INSTANT = 5;
ELKAlarmPanelDevice.prototype.ALARM_MODE_VACATION = 6;

// Alarm trip state
ELKAlarmPanelDevice.prototype.ALARM_TRIP_STATE_DISARMED = 0;
ELKAlarmPanelDevice.prototype.ALARM_TRIP_STATE_EXIT_DELAY = 1;
ELKAlarmPanelDevice.prototype.ALARM_TRIP_STATE_TRIPPED = 2;

// Alarm state
ELKAlarmPanelDevice.prototype.ALARM_STATE_NOT_READY_TO_ARM = 0;
ELKAlarmPanelDevice.prototype.ALARM_STATE_READY_TO_ARM = 1;
ELKAlarmPanelDevice.prototype.ALARM_STATE_READY_TO_ARM_VIOLATION = 2;
ELKAlarmPanelDevice.prototype.ALARM_STATE_ARMED_WITH_TIMER = 3;
ELKAlarmPanelDevice.prototype.ALARM_STATE_ARMED_FULLY = 4;
ELKAlarmPanelDevice.prototype.ALARM_STATE_FORCE_ARMED_VIOLATION = 5;
ELKAlarmPanelDevice.prototype.ALARM_STATE_ARMED_WITH_BYPASS = 6;

ELKAlarmPanelDevice.prototype.sendSetAlarmModeCommand = function(alarmState,handleResult) {
	if(alarmState == isy.ISY_COMMAND_ELK_ALARM_MODE_DISARMED) {
		this.isy.sendISYCommand('elk/area/'+this.area+'/cmd/disarm',handleResult);		
	} else {
		this.isy.sendISYCommand('elk/area/'+this.area+'/cmd/arm?armType='+alarmState,handleResult);
	}
}

ELKAlarmPanelDevice.prototype.clearAllBypasses = function(handleResult) {
	this.isy.sendISYCommand('elk/area/'+this.area+'/cmd/unbypass',handleResult);		
}

ELKAlarmPanelDevice.prototype.getAlarmStatusAsText = function() {
	return "AM ["+this.alarmMode+"] AS ["+this.alarmState+"] ATS ["+this.alarmTripState+"]";
}

ELKAlarmPanelDevice.prototype.getAlarmTripState = function() {
	return this.alarmTripState;
}

ELKAlarmPanelDevice.prototype.getAlarmState = function() {
	return this.alarmState;
}

ELKAlarmPanelDevice.prototype.getAlarmMode = function() {
	return this.alarmMode;
}

ELKAlarmPanelDevice.prototype.setFromAreaUpdate = function(areaUpdate) {
	var areaId = areaUpdate.attr.area;
	var updateType = areaUpdate.attr.type;
	var valueToSet = areaUpdate.attr.val;
	var valueChanged = false;
	
	if(areaId == this.area) {
		if(updateType == 1) {
			if(this.alarmTripState != valueToSet) {
				this.alarmTripState = valueToSet;
				valueChanged = true;
			}
		} else if(updateType == 2) {
			if(this.alarmState != valueToSet) {
				this.alarmState = valueToSet;
				valueChanged = true;
			}
		} else if(updateType == 3){
			if(this.alarmMode != valueToSet) {
				this.alarmMode = valueToSet;
				valueChanged = true;
			}
		}
	}
	if(valueChanged) {
		this.lastChanged = new Date();
	}
	return valueChanged;
}

/////////////////////////////
// ELKAlarmSensor
//
function ElkAlarmSensor(isy,name,area,zone,deviceType) {
	this.isy = isy;
	this.area = area;
	this.zone = zone;
	this.name = name;
	this.address = "ElkZone"+zone;
	this.deviceFriendlyName = "Elk Connected Sensor";
	this.deviceType = deviceType;
	this.connectionType = "Elk Network";
	this.batteryOperated = false;	
	this.physicalState = this.SENSOR_STATE_PHYSICAL_NOT_CONFIGURED;
	this.logicalState = this.SENSOR_STATE_LOGICAL_NORMAL;
	this.lastChanged = new Date();
}

// Logical Status for sensors
ElkAlarmSensor.prototype.SENSOR_STATE_PHYSICAL_NOT_CONFIGURED = 0;
ElkAlarmSensor.prototype.SENSOR_STATE_PHYSICAL_OPEN = 1;
ElkAlarmSensor.prototype.SENSOR_STATE_PHYSICAL_EOL = 2;
ElkAlarmSensor.prototype.SENSOR_STATE_PHYSICAL_SHORT = 3;

// Physical status for sensors
ElkAlarmSensor.prototype.SENSOR_STATE_LOGICAL_NORMAL = 0;
ElkAlarmSensor.prototype.SENSOR_STATE_LOGICAL_TROUBLE = 1;
ElkAlarmSensor.prototype.SENSOR_STATE_LOGICAL_VIOLATED = 2;
ElkAlarmSensor.prototype.SENSOR_STATE_LOGICAL_BYPASSED = 3;

ElkAlarmSensor.prototype.sendBypassToggleCommand = function(handleResult) {
	this.isy.sendISYCommand('elk/zone/'+this.zone+'/cmd/toggle/bypass',handleResult);		
}

ElkAlarmSensor.prototype.getPhysicalState = function() {
	return this.physicalState;
}

ElkAlarmSensor.prototype.isBypassed = function() {
	return (this.logicalState == ElkAlarmSensor.SENSOR_STATE_LOGICAL_BYPASSED);
}

ElkAlarmSensor.prototype.getLogicalState = function() {
	return this.logicalState;
}

ElkAlarmSensor.prototype.getCurrentDoorWindowState = function() {
	return (this.physicalState == this.SENSOR_STATE_PHYSICAL_OPEN || this.logicalState == this.SENSOR_STATE_LOGICAL_VIOLATED );
}

ElkAlarmSensor.prototype.getSensorStatus = function() {
	return "PS ["+this.physicalState+"] LS ["+this.logicatState+"]";
}

ElkAlarmSensor.prototype.isPresent = function() {
	if(this.voltage < 65 || this.voltage > 80) {
		return true;
	} else {
		return false;
	}
}

ElkAlarmSensor.prototype.setFromZoneUpdate = function(zoneUpdate) {
	var zone = zoneUpdate.attr.zone;
	var updateType = zoneUpdate.attr.type;
	var valueToSet = zoneUpdate.attr.val;
	var valueChanged = false;
	
	if(zone == this.zone) {
		if(updateType == 51) {
			if(this.logicalState != valueToSet) {
				this.logicalState = valueToSet;
				// Not triggering change update on logical state because physical always follows and don't want double notify.
				// valueChanged = true;
			}
		} else if(updateType == 52) {
			if(this.physicalState != valueToSet) {
				this.physicalState = valueToSet;
				valueChanged = true;
			}
		} else if(updateType == 53) {
			if(this.voltage != valueToSet) {
				this.voltage = valueToSet;
				valueChanged = true;
			}
		}
	}
	if(valueChanged) {
		this.lastChanged = new Date();
	}
	return valueChanged;
}

exports.ELKAlarmPanelDevice = ELKAlarmPanelDevice;
exports.ElkAlarmSensor = ElkAlarmSensor;