isy-nodejs 1.0.8-alpha.0 → 1.3.24

package/src/Devices/DynamicNode.ts

@@ -1,30 +1,55 @@
-import { Driver, type Family } from '../Definitions/index.js';
-import type { ISY } from '../ISY.js';
+import { type Family } from '../Definitions/index.js';
+import { writeDebugFile, type ISY } from '../ISY.js';
 import { ISYNode } from '../ISYNode.js';
-import type { DriverState } from '../Model/DriverState.js';
 import type { NodeDef } from '../Model/NodeDef.js';
 import type { NodeInfo } from '../Model/NodeInfo.js';
 import { ISYDeviceNode } from './ISYDeviceNode.js';
 
-export abstract class DynamicNode<T extends Family.ZWave | Family.ZigBee,D extends ISYNode.DriverSignatures,C,E extends ISYNode.EventSignatures> extends ISYDeviceNode<T,D,C,E> {
+export abstract class DynamicNode<
+	T extends Family.ZWave | Family.ZigBee | Family.ZMatter,
+	D extends ISYNode.DriverSignatures,
+	C,
+	E extends ISYNode.EventSignatures,
+> extends ISYDeviceNode<T, D, C, E> {
+	nodeTypeId: string;
 
-	abstract getNodeDef() : Promise<NodeDef>;
+	abstract getNodeDef(nodeDefId: string): Promise<NodeDef>;
 
-	constructor(isy: ISY, node: NodeInfo<T>) {
-		super(isy, node);
-		this.getNodeDef().then((def) => {
-			for(let st in this.drivers) {
-				if(!((def.sts.st) as Array<any>).find((s) => s.id === st)) {
-					delete this.drivers[st];
-				}
+	async applyNodeDef(nodeDef?: NodeDef) {
+		if (!nodeDef) {
+			nodeDef = await this.getNodeDef(this.address);
+			if (this.isy.isDebugEnabled)
+				await writeDebugFile(
+					JSON.stringify(nodeDef),
+					`${this.address}_NodeDef.json`,
+					this.isy.logger,
+					this.isy.storagePath
+				);
+		}
+
+		for (let st in this.drivers) {
+			if (!(nodeDef?.sts?.st as Array<any>)?.find(s => s.id === st)) {
+				this.logger(`Driver ${this.drivers[st].name} ${st} not found in nodeDef. Removing...`);
+				delete this.drivers[st];
 			}
-			for(let cmd in this.commands) {
-				if(!((def.cmds.accepts.cmd) as Array<any>).find((c) => c.id === cmd)) {
+		}
+
+		for (let cmd in this.commands) {
+			if (!(nodeDef?.cmds?.accepts?.cmd as Array<any>)?.find(c => c.id === cmd)) {
+				try {
+					//@ts-ignore
+					this.logger(`Command ${this.commands[cmd]?.name} (${cmd}) not found in nodeDef. Removing...`);
 					delete this.commands[cmd];
+				} catch {
+					this.logger(`Error removing command ${cmd}`);
 				}
 			}
-		});
+		}
+	}
 
+	constructor(isy: ISY, node: NodeInfo<T>, nodeDef?: NodeDef) {
+		super(isy, node);
+		this.nodeTypeId = node.nodeTypeId;
 	}
 
 	/*override handleEvent(event: { control?: any; data?: any; node?: any; action?: any; fmtAct?: any; }): boolean {
@@ -34,4 +59,4 @@ export abstract class DynamicNode<T extends Family.ZWave | Family.ZigBee,D exten
 		if()
 		return false;
 	}*/
-}
+}

package/src/Devices/Elk/ElkAlarmPanelDevice.ts

@@ -8,7 +8,7 @@ import { ElkAlarmSensorDevice } from './ElkAlarmSensorDevice.js';
 // ELKAlarmPanelDevice
 
 //
-export class ELKAlarmPanelDevice extends ISYDeviceNode<Family.Global,any,any> {
+export class ELKAlarmPanelDevice extends ISYDeviceNode<Family.Global, any, any> {
 	[x: string]: any;
 	setFromAreaUpdate(nodes: any) {
 		throw new Error('Method not implemented.');
@@ -26,15 +26,18 @@ export class ELKAlarmPanelDevice extends ISYDeviceNode<Family.Global,any,any> {
 	public voltage: number;
 
 	constructor(isy: ISY, area: number) {
-
 		super(isy, {
-			family: Family.Global, type: '0.0.0.0', enabled: true, address: `ElkAlarmPanel_${area}`, name: `Elk Alarm Panel ${area}`,
+			family: Family.Global,
+			type: '0.0.0.0',
+			enabled: true,
+			address: `ElkAlarmPanel_${area}`,
+			name: `Elk Alarm Panel ${area}`,
 			pnode: undefined,
 			startDelay: 0,
 			hint: '',
 			endDelay: 0,
 			wattage: 0,
-			dcPeriod: 0
+			dcPeriod: 0,
 		});
 
 		this.area = area;
@@ -47,14 +50,11 @@ export class ELKAlarmPanelDevice extends ISYDeviceNode<Family.Global,any,any> {
 		this.connectionType = 'Elk Network Module';
 		this.batteryOperated = false;
 		this.voltage = 71;
-		this
-			.lastChanged = new Date();
+		this.lastChanged = new Date();
 	}
 
 	public override async sendCommand(command: string): Promise<any> {
-
 		return this.isy.sendISYCommand(`elk/area/${this.area}/cmd/${command}`);
-
 	}
 
 	public async sendSetAlarmModeCommand(alarmMode: string) {
@@ -79,7 +79,7 @@ export class ELKAlarmPanelDevice extends ISYDeviceNode<Family.Global,any,any> {
 	public getAlarmMode() {
 		return this.alarmMode;
 	}
-	public override handleEvent(event: { control?: string; data?: any; node?: any; eventInfo?: any; }) {
+	public override handleEvent(event: { control?: string; data?: any; node?: any; eventInfo?: any }) {
 		const areaUpdate = event.eventInfo.ae;
 		const areaId = areaUpdate.attr.area;
 		const updateType = areaUpdate.attr.type;
@@ -90,7 +90,13 @@ export class ELKAlarmPanelDevice extends ISYDeviceNode<Family.Global,any,any> {
 				if (this.alarmTripState !== valueToSet) {
 					const oldVal = this.alarmTripState;
 					this.alarmTripState = valueToSet;
-					this.emit('propertyChanged', 'alarmTripState', this.alarmTripState, oldVal, AlarmTripState[this.alarmTripState]);
+					this.emit(
+						'propertyChanged',
+						'alarmTripState',
+						this.alarmTripState,
+						oldVal,
+						AlarmTripState[this.alarmTripState]
+					);
 					valueChanged = true;
 				}
 			} else if (updateType === AlarmPanelProperty.AlarmState) {
@@ -115,13 +121,12 @@ export class ELKAlarmPanelDevice extends ISYDeviceNode<Family.Global,any,any> {
 
 		return valueChanged;
 	}
-
 }
 
 export enum AlarmPanelProperty {
 	AlarmMode = 3,
 	AlarmState = 2,
-	AlarmTripState = 1
+	AlarmTripState = 1,
 }
 
 export enum AlarmMode {
@@ -131,14 +136,13 @@ export enum AlarmMode {
 	STAY_INSTANT = 3,
 	NIGHT = 4,
 	NIGHT_INSTANT = 5,
-	VACATION = 6
+	VACATION = 6,
 }
 
 export enum AlarmTripState {
 	DISARMED = 0,
 	EXIT_DELAY = 1,
-	TRIPPED = 2
-
+	TRIPPED = 2,
 }
 
 export enum AlarmState {
@@ -148,8 +152,7 @@ export enum AlarmState {
 	ARMED_WITH_TIMER = 3,
 	ARMED_FULLY = 4,
 	FORCE_ARMED_VIOLATION = 5,
-	ARMED_WITH_BYPASS = 6
-
+	ARMED_WITH_BYPASS = 6,
 }
 
 // Alarm mode constanrs
@@ -180,7 +183,7 @@ export enum AlarmSensorPhysicalState {
 	NOT_CONFIGURED = 0,
 	OPEN = 1,
 	EOL = 2,
-	SHORT = 3
+	SHORT = 3,
 }
 
 ElkAlarmSensorDevice.prototype.SENSOR_STATE_PHYSICAL_NOT_CONFIGURED = 0;
@@ -192,7 +195,7 @@ export enum AlarmSensorLogicalState {
 	NORMAL = 0,
 	TROUBLE = 1,
 	VIOLATED = 2,
-	BYPASSED = 3
+	BYPASSED = 3,
 }
 
 // Physical status for sensors

package/src/Devices/Elk/ElkAlarmSensorDevice.ts

@@ -27,7 +27,7 @@ export class ElkAlarmSensorDevice extends ISYDeviceNode<Family.Global, any, any>
 			hint: '',
 			endDelay: 0,
 			wattage: 0,
-			dcPeriod: 0
+			dcPeriod: 0,
 		});
 		this.area = area;
 		this.zone = zone;
@@ -57,7 +57,9 @@ export class ElkAlarmSensorDevice extends ISYDeviceNode<Family.Global, any, any>
 		return this.logicalState;
 	}
 	public getCurrentDoorWindowState() {
-		return this.physicalState === this.SENSOR_STATE_PHYSICAL_OPEN || this.logicalState === this.SENSOR_STATE_LOGICAL_VIOLATED;
+		return (
+			this.physicalState === this.SENSOR_STATE_PHYSICAL_OPEN || this.logicalState === this.SENSOR_STATE_LOGICAL_VIOLATED
+		);
 	}
 	public getSensorStatus() {
 		return 'PS [' + this.physicalState + '] LS [' + this.logicatState + ']';

package/src/Devices/GenericNode.ts

@@ -1,22 +1,28 @@
 import { Driver } from '../Definitions/index.js';
 import type { ISY } from '../ISY.js';
-import { ISYNode } from '../ISYNode.js';
 import type { DriverState } from '../Model/DriverState.js';
 import type { NodeInfo } from '../Model/NodeInfo.js';
 import { ISYDeviceNode } from './ISYDeviceNode.js';
 
-export class GenericNode extends ISYDeviceNode<any,any,any,any> {
+export class GenericNode extends ISYDeviceNode<any, any, any, any> {
 	constructor(isy: ISY, node: NodeInfo) {
 		super(isy, node);
-		for(const prop in node.state) {
-			this.drivers[prop] = Driver.create(prop as never, this,node.state[prop]);
+		for (const prop in node.state) {
+			this.drivers[prop] = Driver.create(prop as never, this as any, node.state[prop]);
 		}
+	}
 
+	async query() {
+		return this.sendCommand('QUERY');
 	}
 
 	override applyStatus(prop: DriverState): void {
-		if(!this.drivers[prop.id]) {
-			this.drivers[prop.id] = Driver.create(prop.id as never, this,prop,{uom: prop.uom, label: prop.name  as string ?? prop.id as string, name: prop.name as string ?? prop.id as string});
+		if (!this.drivers[prop.id]) {
+			this.drivers[prop.id] = Driver.create(prop.id as never, this as any, prop, {
+				uom: prop.uom,
+				label: (prop.name as string) ?? (prop.id as string),
+				name: (prop.name as string) ?? (prop.id as string),
+			});
 		}
 		super.applyStatus(prop);
 	}
@@ -28,4 +34,4 @@ export class GenericNode extends ISYDeviceNode<any,any,any,any> {
 		if()
 		return false;
 	}*/
-}
+}

package/src/Devices/ISYDeviceNode.ts

@@ -1,37 +1,30 @@
-import type EventEmitter from 'events';
+import type { JsonifyObject } from 'type-fest/source/jsonify.js';
 import type { Category } from '../Definitions/Global/Categories.js';
 import type { Command } from '../Definitions/Global/Commands.js';
 import type { Driver } from '../Definitions/Global/Drivers.js';
 import type { Event } from '../Definitions/Global/Events.js';
 import type { Family } from '../Definitions/index.js';
-import type { NodeEvent } from '../Events/NodeEvent.js';
 import { type ISY } from '../ISY.js';
 import type { ISYDevice, ISYDeviceInfo } from '../ISYDevice.js';
 import { ISYNode } from '../ISYNode.js';
-import type { ISYScene } from '../ISYScene.js';
-import type { DriverState } from '../Model/DriverState.js';
 import type { NodeInfo } from '../Model/NodeInfo.js';
-import type {StringKeys } from '../Utils.js';
 
-export class ISYDeviceNode<
+export abstract class ISYDeviceNode<
 		T extends Family,
 		D extends ISYNode.DriverSignatures,
 		C extends ISYNode.CommandSignatures,
-		E extends ISYNode.EventSignatures = { [x in keyof D]: Event.DriverToEvent<D[x]> & { driver: x } } & { [x in keyof C]: Event.CommandToEvent<C[x]> & { command: x } }
+		E extends ISYNode.EventSignatures = { [x in keyof D]: Event.DriverToEvent<D[x]> & { driver: x } } & {
+			[x in keyof C]: Event.CommandToEvent<C[x]> & { command: x };
+		},
 	>
 	extends ISYNode<T, D, C, E>
-	implements ISYDeviceInfo,
-	ISYDevice<T, Driver.ForAll<D>, Command.ForAll<C>, any>
+	implements ISYDeviceInfo, ISYDevice<T, Driver.ForAll<D>, Command.ForAll<C>, any>
 {
-	public declare family: T;
-
 	public readonly typeCode: string;
 	public readonly deviceClass: any;
-	public readonly category: Category;
+	public readonly category: T extends Family.Insteon ? Category.Insteon : Category.Home.Category;
 	public readonly subCategory: number;
 
-
-
 	//public readonly isDimmable: boolean;
 
 	//public _parentDevice: ISYDeviceNode<T, any, any, any>;
@@ -53,7 +46,7 @@ export class ISYDeviceNode<
 		this.deviceClass = node.deviceClass;
 		this.parentAddress = node.pnode;
 		const s = this.type.split('.');
-		this.category = Number(s[0]) as Category;
+		this.category = Number(s[0]) as T extends Family.Insteon ? Category.Insteon : Category.Home.Category;
 		this.subCategory = Number(s[1]);
 
 		// console.log(nodeDetail);
@@ -85,7 +78,7 @@ export class ISYDeviceNode<
 		//   );
 		// }
 	}
-	vendorName: string;
+
 	manufacturer: string;
 	productId: string | number;
 	modelName: string;
@@ -163,3 +156,7 @@ export class ISYDeviceNode<
 	//   }
 	// }
 }
+
+export namespace ISYDeviceNode {
+	export type Any = ISYDeviceNode<any, any, any, any>;
+}

package/src/Devices/Insteon/COSensor.ts

@@ -0,0 +1,19 @@
+import { Category, CompositeDevice } from '../../ISY.js';
+
+import 'winston';
+import { BinaryAlarm } from './Generated/BinaryAlarm.js';
+
+export namespace COSensor {
+	export const Nodes = { sensor: BinaryAlarm, lowBattery: BinaryAlarm };
+
+	class COSensorDevice extends CompositeDevice.of(COSensor.Nodes, { sensor: 1, lowBattery: 3 }) {}
+
+	export const Class = COSensorDevice;
+	//export class Class extends CompositeDevice.of(Nodes, { sensor: 1, lowBattery: 3 }) {}
+
+	export const Sensor = BinaryAlarm;
+
+	export const LowBattery = BinaryAlarm;
+
+	export const typeCodes = [Category.Insteon.IrrigationControl];
+}