isy-nodejs 0.5.0-beta.54 → 0.5.0-beta.56

package/src/ISYConstants.ts

@@ -1,182 +0,0 @@
-
-const ISYConstants = {
-
-	States: {
-		Off: 0,
-		On: 100,
-		Lock: {
-			Locked: 100,
-			Unlocked: 0
-		},
-		SecureLock: {
-			Secured: 1,
-			NotSecured: 0
-		},
-		DoorWindow: {
-			Closed: 0,
-			Open: 100// 255
-		},
-		Siren:
-		{
-
-		},
-		Sensor:
-		{
-			Triggered: 100,
-			NotTriggered: 0
-		},
-		Level: {
-			Min: 0,
-			Max: 100
-		},
-		LeakSensor: {
-			Dry: 0,
-			Wet: 100,
-			Heartbeat: 'hb'
-		},
-		Fan: {
-			Low: 25, // 63,
-			Medium: 75, // 191,
-			High: 100// 255
-		},
-		Climate: {
-			FanMode: {
-				On: 7,
-				Auto: 8
-			},
-			Mode: {
-				Off: 0,
-				Heat: 1,
-				Cool: 2,
-				Auto: 3,
-				Fan: 4,
-				ProgramAuto: 5,
-				ProgramHeat: 6,
-				ProgramCool: 7
-			},
-			ScheduleMode: {
-				Hold: 0,
-				Run: 1,
-				Away: 2
-			},
-			OperatingMode: {
-				Idle: 0,
-				Heating: 1,
-				Cooling: 2
-			},
-			UnitOfMeasure: {
-				Celcius: 1,
-				Fahrenheit: 2
-			}
-
-		}
-	},
-	Cmds: {
-		On: 'DON',
-		Off: 'DOF',
-		Dimmable: {
-			FastOn: 'DFON',
-			FastOff: 'DFOF',
-			Brighten: 'BRT',
-			Dim: 'DIM',
-			FadeUp: 'FDUP',
-			FadeDown: 'FDDOWN',
-			FadeStop: 'FDSTOP'
-		},
-		Lock: {
-			Lock: 'DON',
-			Unlock: 'DOF'
-		},
-		Thermostat:
-		{
-			SetpointUp: 'BRT',
-			SetpointDown: 'DIM'
-		},
-		Query: 'ST'
-	},
-	Props: {
-		Status: 'ST',
-		RampRate: 'RR',
-		OnLevel: 'OL',
-		BatteryLevel: 'BATLVL',
-		SecureLock: {
-			Mode: 'SECMD'
-		},
-
-		ZWave: {
-			LockAlarm: 'ALARM',
-			LockAccess: 'USRNUM',
-			LockStatus: 'ST',
-			EnergyPowerFactor: 'PF',
-			EnergyPowerPolarizedPower: 'PPW',
-			EnergyPowerCurrent: 'CC',
-			EnergyPowerTotalPower: 'TPW',
-			EnergyPowerVoltage: 'CV'
-		},
-		Climate: {
-			Temperature: 'CLITEMP',
-			Humidity: 'CLIHUM',
-			OperatingMode: 'CLIHCS',
-			Mode: 'CLIMD',
-			FanMode: 'CLIFS',
-			FanState: 'CLIFRS',
-			CoolSetPoint: 'CLISPC',
-			HeatSetPoint: 'CLISPH',
-			ScheduleMode: 'CLISMD',
-			EnergyMode: 'CLIEMD',
-
-		},
-		Error: 'ERR',
-		UnitOfMeasure: 'UOM'
-	},
-	deviceTypes: {
-		lock: 'Lock',
-		secureLock: 'SecureLock',
-		light: 'Light',
-		dimmableLight: 'DimmableLight',
-		outlet: 'Outlet',
-		fan: 'Fan',
-		unknown: 'Unknown',
-		doorWindowSensor: 'DoorWindowSensor',
-		alarmDoorWindowSensor: 'AlarmDoorWindowSensor',
-		coSensor: 'CoSensor',
-		alarmPanel: 'AlarmPanel',
-		motionSensor: 'MotionSensor',
-		leakSensor: 'LeakSensor',
-		remote: 'Remote',
-		scene: 'Scene',
-		thermostat: 'Thermostat',
-		polyNode: 'PolyNode'
-	},
-
-
-
-
-};
-
-export const Properties =
-{
-
-}
-
-export enum VariableType {
-	Integer = 1,
-	State = 2
-}
-export enum NodeType {
-	Device = 1,
-	Scene = 2,
-	Folder = 3,
-	X10A10 = 4
-}
-export enum LinkType
-{
-	Controller = 16,
-	Responder = 0
-}
-
-
-export default ISYConstants;
-export const Props = ISYConstants.Props;
-export const States = ISYConstants.States;
-export const Commands = ISYConstants.Cmds;

package/src/ISYNode.ts

@@ -1,195 +0,0 @@
-import { EventEmitter } from 'events';
-import { isNullOrUndefined } from 'util';
-
-import { Family } from './Families';
-import { Categories, Controls, ISY, NodeType } from './ISY';
-import { PropertyChangedEventEmitter } from './Utils';
-
-
-export class ISYNode extends EventEmitter implements PropertyChangedEventEmitter {
-
-	public readonly isy: ISY;
-	public readonly flag: any;
-	public readonly nodeDefId: string;
-	public readonly address: string;
-	[x: string]: any;
-	public name: string;
-	public displayName: string;
-	public spokenName: string;
-	public location: string;
-	public isLoad: boolean;
-
-	public folder: string = '';
-	public parent: any;
-	public parentType: NodeType;
-	public readonly elkId: string;
-	public nodeType: number;
-	public readonly baseDisplayName: string;
-	public propsInitialized: boolean;
-	public logger: (msg: any) => void;
-	public lastChanged: Date;
-	public enabled: boolean;
-	constructor (isy: ISY, node: { flag?: any; nodeDefId?: string; address?: string; name?: string; family?: Family; parent?: any; enabled: boolean; ELK_ID?: string; }) {
-		super();
-		this.isy = isy;
-		this.nodeType = 0;
-		this.flag = node.flag;
-		this.nodeDefId = node.nodeDefId;
-		this.address = String(node.address);
-		this.name = node.name;
-		this.family = node.family ?? Family.Insteon;
-
-		this.parent = node.parent;
-
-		this.parentType = Number(this.parent?.type);
-
-		this.enabled = node.enabled;
-		this.elkId = node.ELK_ID;
-
-		this.propsInitialized = false;
-		const s = this.name.split('.');
-		//if (s.length > 1)
-			//s.shift();
-		this.baseDisplayName = s.join(' ').replace(/([A-Z])/g, ' $1').replace('  ', ' ').replace('  ',' ').trim();
-		if (this.parentType === NodeType.Folder) {
-
-			this.folder = isy.folderMap.get(this.parent._);
-			isy.logger(`${this.name} this node is in folder ${this.folder}`);
-			this.logger = (msg) => {
-				return isy.logger(`${this.folder} ${this.name} (${this.address}): ${msg}`);
-			};
-
-			this.displayName = `${this.folder} ${this.baseName}`;
-		}
-		else {
-			this.displayName = this.baseDisplayName;
-			this.logger = (msg) => {
-				return isy.logger(`${this.name} (${this.address}): ${msg}`);
-			};
-		}
-
-		this.logger(this.nodeDefId);
-		this.lastChanged = new Date();
-	}
-
-	public handlePropertyChange(propertyName: string, value: any, formattedValue: string): boolean {
-		this.lastChanged = new Date();
-
-		return true;
-	}
-
-	public handleControlTrigger(controlName: string): boolean {
-		//this.lastChanged = new Date();
-
-		return true;
-	}
-
-	public on(event: 'PropertyChanged'|'ControlTriggered', listener: ((propertyName: string, newValue: any, oldValue: any, formattedValue: string) => any)|((controlName: string) => any)): this {
-		super.on(event, listener);
-		return this;
-	}
-
-	public emit(event: 'PropertyChanged'|'ControlTriggered', propertyName?: string, newValue?: any, oldValue?: any, formattedValue?: string, controlName?: string) {
-		if('PropertyChanged')
-			return super.emit(event, propertyName, newValue, oldValue, formattedValue);
-		else if('ControlTriggered')
-			return super.emit(event,controlName);
-	}
-
-
-	public handleEvent(event: any): boolean {
-		let actionValue = null;
-		if (event.action instanceof Object) {
-			actionValue = event.action._;
-		} else if (event.action instanceof Number || event.action instanceof String) {
-			actionValue = Number(event.action);
-		}
-
-		if (event.control in this) {
-			// property not command
-			const formatted = 'fmtAct' in event ? event.fmtAct : actionValue;
-			return this.handlePropertyChange(event.control, actionValue, formatted);
-		}
-		else if(event.control === '_3')
-		{
-			this.logger(`Received Node Change Event: ${JSON.stringify(event)}. These are currently unsupported.`);
-		}
-		else {
-			// this.logger(event.control);
-			const e = event.control;
-			const dispName = Controls[e];
-			if (dispName !== undefined && dispName !== null) {
-				this.logger(`Command ${dispName.label} (${e}) triggered.`);
-			} else {
-				this.logger(`Command ${e} triggered.`);
-
-			}
-			let controlName : string = e;
-			this.handleControlTrigger(controlName);
-			return true;
-		}
-	}
-
-	static _displayNameFunction: Function;
-
-	public setDisplayName(template: string): string {
-		// tslint:disable-next-line: only-arrow-functions
-		if (!ISYNode._displayNameFunction) {
-			// template = template.replace("{", "{this."};
-			const regex = /(?<op1>\w+) \?\? (?<op2>\w+)/g;
-			this.logger(`Display name format: ${template}`);
-			let newttemp = template.replace(regex, 'this.$<op1> === null || this.$<op1> === undefined || this.$<op1> === \'\' ? this.$<op2> : this.$<op1>');
-			this.logger(`Template format updated to: ${newttemp}`);
-			const s = { location: this.location ?? '', folder: this.folder ?? '', spokenName: this.spokenName ?? this.name, name: this.name ?? '' };
-			newttemp = newttemp.replace('this.name', 'this.baseDisplayName');
-			ISYNode._displayNameFunction = new Function(`return \`${newttemp}\`.trim();`);
-		}
-
-		return ISYNode._displayNameFunction.call(this);
-
-	}
-
-
-	public async refreshNotes() {
-		const that = this;
-		try {
-
-			const result = await this.getNotes();
-			if (result !== null && result !== undefined) {
-				that.location = result.location ?? this.folder ?? '';
-				that.spokenName = result.spoken ?? this.folder ?? '';
-				// if(result.spoken)
-
-			} else {
-				that.logger('No notes found.');
-			}
-			that.displayName = that.setDisplayName.bind(that)(that.isy.displayNameFormat);
-			that.displayName = that.displayName ?? this.baseDisplayName;
-			that.logger(`The friendly name updated to: ${that.displayName}`);
-		} catch (e) {
-
-			that.logger(e);
-		}
-
-	}
-
-	public async getNotes(): Promise<any> {
-
-		try {
-			const result = await this.isy.callISY(`nodes/${this.address}/notes`);
-			if (result !== null && result !== undefined) {
-				return result.NodeProperties;
-			} else {
-				return null;
-			}
-
-		} catch (e) {
-			return null;
-		}
-	}
-
-
-
-
-
-}

package/src/ISYScene.ts

@@ -1,120 +0,0 @@
-import { InsteonDimmableDevice } from './Devices/Insteon/InsteonDimmableDevice';
-import { Family } from './Families';
-import { InsteonRelayDevice, ISY, ISYDevice } from './ISY';
-import { Commands, LinkType } from './ISYConstants';
-import { ISYNode } from './ISYNode';
-
-export class ISYScene extends ISYNode {
-	public type: string;
-	public connectionType: string;
-	public batteryOperated: boolean;
-	public deviceType: any;
-	public deviceFriendlyName: string;
-	public members: Array<ISYDevice<any>>;
-	public isDimmable: boolean;
-	public typeCode: string;
-	constructor(isy: ISY, scene: { members?: { link: any; }; flag?: any; nodeDefId?: string; address?: string; name?: string; family?: Family; parent?: any; enabled: boolean; ELK_ID?: string; }) {
-		super(isy, scene);
-		// this.logger(JSON.stringify(scene));
-		this.typeCode = '';
-		this.connectionType = 'Insteon Wired';
-		this.batteryOperated = false;
-
-		this.deviceFriendlyName = 'ISY Scene';
-		this.members = [];
-		this.isDimmable = false;
-		if (Array.isArray(scene.members?.link)) {
-			for (const node of scene.members.link) {
-				if ('_' in node) {
-					// childDevices.push(node._);
-					// childDevices.push(object)
-					const s = node._;
-					const d = isy.getDevice(s);
-
-					if (d !== null && d !== undefined) { d.addLink(this); }
-
-					if (d instanceof InsteonDimmableDevice && node.type !== LinkType.Controller) { this.isDimmable = true; }
-					this.members[s] = d;
-				}
-			}
-		} else if (scene.members?.link) {
-			if ('_' in scene.members.link) {
-				const node = scene.members.link._;
-				this.logger(JSON.stringify(node));
-				// childDevices.push(node._);
-				// childDevices.push(object)
-				const s = scene.members.link._;
-				const d = isy.getDevice(s);
-				if (d) { d.addLink(this);
-				// tslint:disable-next-line: triple-equals
-				if ((d.isDimmable && node.type != LinkType.Controller) || this.isDimmable) { this.isDimmable = true; }
-				this.members[s] = d;
-				}
-			}
-		}
-		// check dimmability this.dimmable = Array.apply(p => p.dimmable);
-		this.recalculateState();
-	}
-	// Get the current light state
-	get isOn() {
-		for (const device of this.members) {
-			if (device instanceof InsteonRelayDevice) {
-				if (device.isOn) {
-					return true;
-				}
-			}
-		}
-		return false;
-	}
-
-	get brightnessLevel() {
-		let lightDeviceCount = 0;
-		let blevel = 0;
-		for (const device of this.members) {
-			if (device instanceof InsteonDimmableDevice) {
-				lightDeviceCount++;
-				blevel += device.brightnessLevel;
-			} else if (device instanceof InsteonRelayDevice) {
-				lightDeviceCount++;
-				blevel += device.isOn ? 100 : 0;
-			}
-		}
-		if (lightDeviceCount > 0) {
-			return Math.floor(blevel / lightDeviceCount);
-		} else {
-			return 0;
-		}
-	}
-	// Current light dim state is always calculated
-	public recalculateState() {
-		this.markAsChanged();
-		return true;
-	}
-	public markAsChanged() {
-		this.lastChanged = new Date();
-		this.emit('PropertyChanged', 'isOn', this.isOn, this.isOn, this.isOn ? 'on' : 'off');
-
-		if (this.isDimmable) {
-			this.emit('PropertyChanged', 'brightnesslevel', this.brightnessLevel, this.brightnessLevel, this.brightnessLevel + '%');
-
-		}
-	}
-	public async updateIsOn(lightState: boolean) {
-		return this.isy.sendNodeCommand(this, lightState ? Commands.On : Commands.Off);
-	}
-	public async updateBrightnessLevel(level) {
-		return this.isy.sendNodeCommand(this, level > 0 ? Commands.On : Commands.Off, level);
-	}
-	public getAreAllLightsInSpecifiedState(state) {
-		for (const device of this.members) {
-			if (device instanceof InsteonRelayDevice) {
-				if (device.isOn !== state) {
-					return false;
-				}
-			}
-		}
-		return true;
-	}
-
-
-}

package/src/ISYVariable.ts

@@ -1,49 +0,0 @@
-import { EventEmitter } from 'events';
-import { ISY } from './ISY';
-import { VariableType } from './ISYConstants';
-
-export class ISYVariable extends EventEmitter {
-	public isy: ISY;
-	public id: number;
-	public name: string;
-	public value: any;
-	public init: any;
-	public type: VariableType;
-	public lastChanged: Date;
-	constructor(isy: ISY, id: number, name: string, type: any) {
-		super();
-		this.isy = isy;
-		this.id = id;
-		this.name = name;
-		this.value = undefined;
-		this.init = undefined;
-		this.type = type;
-		this.lastChanged = new Date();
-	}
-
-	public handleEvent(event: { eventInfo: { var: any }; })
-	{
-		const varNode = event.eventInfo.var;
-		if (varNode !== null) {
-			const id = varNode.id;
-			const type = varNode.type;
-			const priorVal = this.value;
-			this.value = parseInt(varNode.val);
-			const year = parseInt(varNode.ts.substr(0, 4));
-			const month = parseInt(varNode.ts.substr(4, 2));
-			const day = parseInt(varNode.ts.substr(6, 2));
-			const hour = parseInt(varNode.ts.substr(9, 2));
-			const min = parseInt(varNode.ts.substr(12, 2));
-			const sec = parseInt(varNode.ts.substr(15, 2));
-			 this.lastChanged = new Date(year, month, day, hour, min, sec);
-			this.emit('ValueChanged',this.value, priorVal);
-		}
-	}
-
-	public async updateValue(value: any): Promise<void> {
-		const p = await this.isy.callISY(`vars\\${this.type}\\${this.id}\\${value}`);
-		this.value = value;
-		return p;
-	}
-
-}