isy-nodejs 1.0.1-alpha.11 → 1.0.1-alpha.16

package/package.json

@@ -2,7 +2,7 @@
     "name": "isy-nodejs",
     "description": "Node.js wrapper for ISY interface including websockets for change notifications. Fork of isy-js by Rod Toll. Designed to be used in a node.js application.",
     "license": "MIT",
-    "version": "1.0.1-alpha.11",
+    "version": "1.0.1-alpha.16",
     "author": {
         "name": "Pradeep Mouli"
     },
@@ -69,5 +69,5 @@
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "7d11decc2649f39d8f68cd78ff6ab0fdb9d85a77"
+    "gitHead": "b4a88111ae80ba556773857491645f48f15f7f33"
 }

package/src/ISY.ts

@@ -3,7 +3,6 @@ import { writeFile } from 'fs';
 
 import { Parser, type ParserOptions } from 'xml2js';
 import { parseBooleans, parseNumbers } from 'xml2js/lib/processors.js';
-import { XmlDocument } from 'xmldoc';
 
 import axios from 'axios';
 import { EventEmitter } from 'events';
@@ -43,8 +42,9 @@ import * as Utils from './Utils.js';
 
 import { X2jOptions, XMLParser } from 'fast-xml-parser';
 import { NodeFactory } from './Devices/NodeFactory.js';
+import type { Config } from './Model/Config.js';
 import { findPackageJson } from './Utils.js';
-
+import path from 'path';
 
 export {
 	Category as Categories,
@@ -157,7 +157,7 @@ export class ISY extends EventEmitter implements Disposable {
 
 	public static instance: ISY;
 
-	public configInfo: any;
+	public configInfo: Config;
 	public elkAlarmPanel: ELKAlarmPanelDevice;
 	public guardianTimer: any;
 	public id: string;
@@ -167,14 +167,12 @@ export class ISY extends EventEmitter implements Disposable {
 	public nodesLoaded: boolean = false;
 	public productId = 5226;
 	public productName = 'eisy';
-	public serverVersion: any;
+	public firmwareVersion: any;
 	public vendorName = 'Universal Devices, Inc.';
 	public webSocket: WebSocket.Client;
 
 	public apiVersion: string;
 
-
-
 	// #endregion Properties (30)
 
 	// #region Constructors (1)
@@ -230,11 +228,7 @@ export class ISY extends EventEmitter implements Disposable {
 	// #region Public Methods (24)
 
 	[Symbol.dispose](): void {
-		try {
-			this.webSocket?.close();
-		} catch (e) {
-			this.logger.error(`Error closing websocket: ${e.message}`);
-		}
+		this.close();
 	}
 
 	public override emit(event: 'InitializeCompleted' | 'NodeAdded' | 'NodeRemoved' | 'NodeChanged', node?: ISYNode<any, any, any, any>): boolean {
@@ -292,7 +286,7 @@ export class ISY extends EventEmitter implements Disposable {
 	}
 
 	public async handleInitializeError(step: string, reason: any): Promise<any> {
-		this.logger.error(`Error initializing ISY (${step}): ${JSON.stringify(reason)}`);
+		this.logger.error(`Error initializing ISY (${step}): ${Utils.logStringify(reason)}`);
 		return Promise.reject(reason);
 	}
 
@@ -340,7 +334,7 @@ export class ISY extends EventEmitter implements Disposable {
 					}
 					break;
 				case EventType.Heartbeat:
-					this.logger.debug(`Received ${EventType[Number(stringControl)]} Signal from ISY: ${JSON.stringify(evt)}`);
+					this.logger.debug(`Received ${EventType[Number(stringControl)]} Signal from ISY: ${Utils.logStringify(evt)}`);
 					break;
 
 				default:
@@ -354,13 +348,13 @@ export class ISY extends EventEmitter implements Disposable {
 								this.logger.error(`Error handling event for ${impactedDevice.name}: ${e.message}`);
 							}
 						} else {
-							this.logger.warn(`${EventType[stringControl]} Event for Unidentified Device: ${JSON.stringify(evt)}`);
+							this.logger.debug(`${EventType[stringControl]} Event for Unidentified Device: ${JSON.stringify(evt)}`);
 						}
 					} else {
 						if (stringControl === EventType.NodeChanged) {
-							this.logger.info(`Received Node Change Event: ${JSON.stringify(evt)}. These are currently unsupported.`);
+							this.logger.debug(`Received Node Change Event: ${JSON.stringify(evt)}. These are currently unsupported.`);
 						}
-						this.logger.debug(`${EventType[Number(stringControl)]} Event: ${JSON.stringify(evt)}`);
+						this.logger.debug(`${EventType[Number(stringControl)]} Event: ${Utils.logStringify(evt)}`);
 					}
 
 					break;
@@ -371,7 +365,7 @@ export class ISY extends EventEmitter implements Disposable {
 	public async initialize(): Promise<any> {
 		const that = this;
 		try {
-			this.apiVersion = (await findPackageJson()).content.version;
+			this.apiVersion = (await findPackageJson()).version;
 			await this.loadConfig();
 			await this.loadNodes();
 			await this.loadVariables(VariableType.Integer);
@@ -435,19 +429,18 @@ export class ISY extends EventEmitter implements Disposable {
 	public async loadConfig(): Promise<any> {
 		try {
 			this.logger.info('Loading ISY Config');
-			const configuration = (await this.sendRequest('config')).configuration;
+			const configuration = (await this.sendRequest('config')).configuration as Config;
 			if (this.isDebugEnabled) {
-				writeFile(this.storagePath + '/ISYConfigDump.json', JSON.stringify(configuration), this.logger.error);
+				writeFile(path.resolve(this.storagePath, 'ISYConfigDump.json'), JSON.stringify(configuration), this.logger.error);
 			}
 
 			const controls = configuration.controls;
 			this.model = configuration.deviceSpecs.model;
-			this.serverVersion = configuration.app_version;
+			this.firmwareVersion = configuration.app_full_version;
 			this.vendorName = configuration.deviceSpecs.make;
 			this.productId = configuration.product.id;
 			this.productName = configuration.product.desc;
 			this.id = configuration.root.id;
-			// TODO: Check Installed Features
 			// this.logger.info(result.configuration);
 			if (controls !== undefined) {
 				// this.logger.info(controls.control);
@@ -496,7 +489,9 @@ export class ISY extends EventEmitter implements Disposable {
 		}
 	}
 
-	public override on(event: 'InitializeCompleted' | 'NodeAdded' | 'NodeRemoved' | 'NodeChanged', listener: (node?: ISYNode<any, any, any, any>) => void): this {
+	public override on(event: 'initializeCompleted', listener: () => void): this;
+	public override on(event: 'nodeAdded' | 'nodeRemoved' | 'nodeChanged', listener: (node?: ISYNode<any, any, any, any>) => void): this;
+	override on(event: 'initializeCompleted' | 'nodeAdded' | 'nodeRemoved' | 'nodeChanged', listener: (node?: ISYNode<any, any, any, any>) => void): this {
 		return super.on(event, listener);
 	}
 
@@ -635,7 +630,11 @@ export class ISY extends EventEmitter implements Disposable {
 	}
 
 	public close() {
-		if (this.webSocket) this.webSocket.close();
+		try {
+			this.webSocket?.close();
+		} catch (e) {
+			this.logger.error(`Error closing websocket: ${e.message}`);
+		}
 	}
 
 	// #endregion Public Methods (24)
@@ -712,17 +711,17 @@ export class ISY extends EventEmitter implements Disposable {
 		});
 	}
 
-	#loadElkNodes(result: any) {
+	/* #loadElkNodes(result: any) {
 		const document = new XmlDocument(result);
 		const nodes = document.childNamed('areas').childNamed('area').childrenNamed('zone');
 		for (let index = 0; index < nodes.length; index++) {
 			const id = nodes[index].attr.id;
 			const name = nodes[index].attr.name;
 			const alarmDef = nodes[index].attr.alarmDef;
-			const newDevice = new ElkAlarmSensorDevice(this, name, 1, id /*TODO: Handle CO Sensor vs. Door/Window Sensor */);
+			const newDevice = new ElkAlarmSensorDevice(this, name, 1, id TODO: Handle CO Sensor vs. Door/Window Sensor );
 			this.zoneMap[newDevice.zone] = newDevice;
 		}
-	}
+	} */
 
 	async #readDeviceNodes(obj: { nodes: { node: NodeInfo[] } }) {
 		this.logger.info('Loading Device Nodes');

package/src/Matter/Bridge/Server.ts

@@ -14,15 +14,16 @@ import { StorageService } from '@project-chip/matter.js/environment';
 import { Level, levelFromString, Logger as MatterLogger } from '@project-chip/matter.js/log';
 import { ServerNode } from '@project-chip/matter.js/node';
 import { QrCode } from '@project-chip/matter.js/schema';
-import { resolve } from 'path';
+import path, { resolve } from 'path';
+import type { ISYDeviceNode } from '../../Devices/ISYDeviceNode.js';
 import { InsteonDimmableDevice, InsteonKeypadButtonDevice, InsteonRelayDevice, ISY } from '../../ISY.js';
 import { ISYBridgedDeviceBehavior } from '../Behaviors/ISYBridgedDeviceBehavior.js';
 import { ISYDimmableBehavior, ISYOnOffBehavior } from '../Behaviors/ISYOnOffBehavior.js';
 import '../Mappings/Insteon.js';
-import type { ISYDeviceNode } from '../../Devices/ISYDeviceNode.js';
 
 // #region Interfaces (1)
 
+export let instance: ServerNode;
 export interface Config {
 	// #region Properties (8)
 
@@ -55,12 +56,21 @@ export async function createMatterServer(isy?: ISY, config?: Config): Promise<Se
 	try {
 		MatterLogger.addLogger(
 			'polyLogger',
-			(level, message) => logger.log(Level[level].toLowerCase().replace('notice', 'info'), message.slice(23).remove(Level[level]).trimStart()) /*Preserve existing formatting, but trim off date*/,
+			(lvl, message) => {
+				let msg = message.slice(23).remove(Level[lvl]).trimStart();
+				let level = Level[lvl].toLowerCase().replace('notice', 'info');
+				if (msg.startsWith('EndpointStructureLogger')) {
+					if (lvl === Level.INFO) level = 'debug';
+				}
+				logger.log(level, msg);
+			},
+			/*Preserve existing formatting, but trim off date*/
 			{
 				defaultLogLevel: levelFromString(logger.level),
 				logFormat: 'plain'
 			}
 		);
+
 	} finally {
 		MatterLogger.defaultLogLevel = levelFromString(logger.level);
 	}
@@ -68,8 +78,8 @@ export async function createMatterServer(isy?: ISY, config?: Config): Promise<Se
 	config = await initializeConfiguration(isy, config);
 
 	logger.info(`Matter config read: ${JSON.stringify(config)}`);
-
-	const server = await ServerNode.create({
+	MatterLogger.removeLogger('default');
+	let server = await ServerNode.create({
 		// Required: Give the Node a unique ID which is used to store the state of this node
 		id: config.uniqueId,
 
@@ -216,12 +226,12 @@ export async function createMatterServer(isy?: ISY, config?: Config): Promise<Se
 	// logEndpoint(EndpointServer.forEndpoint(server), {logAttributePrimitiveValues: true, logAttributeObjectValues: true});
 	//else if(logger.isDebugEnabled())
 	// {
-	logEndpoint(EndpointServer.forEndpoint(server), { logAttributePrimitiveValues: true, logAttributeObjectValues: false });
+	logEndpoint(EndpointServer.forEndpoint(server), { logAttributePrimitiveValues: true, logAttributeObjectValues: false, logClusterGlobalAttributes: false });
 	// }
 	if (server.lifecycle.isOnline) {
 		const { qrPairingCode, manualPairingCode } = server.state.commissioning.pairingCodes;
 
-		logger.info(QrCode.get(qrPairingCode));
+		logger.info('/n' + QrCode.get(qrPairingCode));
 		logger.info(`QR Code URL: https://project-chip.github.io/connectedhomeip/qrcode.html?data=${qrPairingCode}`);
 		logger.info(`Manual pairing code: ${manualPairingCode}`);
 	}
@@ -229,22 +239,36 @@ export async function createMatterServer(isy?: ISY, config?: Config): Promise<Se
 	{
 	  e[1].initialize(e[0] as any);
 	}*/
-
+	instance = server;
 	return server;
 }
 
+type PairingCodeData = {
+	qrPairingCode: string;
+	manualPairingCode: string;
+	renderedQrPairingCode: string;
+	url: string | URL;
+};
+
+export function getPairingCode(server: ServerNode = instance): PairingCodeData {
+	let codes = server.state.commissioning.pairingCodes as PairingCodeData;
+	codes.renderedQrPairingCode = QrCode.get(codes.qrPairingCode);
+	codes.url = `https://project-chip.github.io/connectedhomeip/qrcode.html?data=${codes.qrPairingCode}`;
+	return codes;
+}
+
 async function initializeConfiguration(isy: ISY, config?: Config): Promise<Config> {
 	var logger = isy.logger;
 
 	const environment = NodeJsEnvironment();
 
 	const storageService = environment.get(StorageService);
-	environment.vars.set('storage.path', `${ISY.instance.storagePath}matter`);
+	environment.vars.set('storage.path', path.resolve(isy.storagePath, 'matter'));
 	environment.vars.use(() => {
 		const location = environment.vars.get('storage.path', environment.vars.get('path.root', '.'));
 		storageService.location = location;
 	});
-		storageService.factory = (namespace) => new StorageBackendDisk(resolve(storageService.location ?? '.', namespace), environment.vars.get('storage.clear', false));
+	storageService.factory = (namespace) => new StorageBackendDisk(resolve(storageService.location ?? '.', namespace), environment.vars.get('storage.clear', false));
 	logger.info(`Matter storage location: ${storageService.location} (Directory)`);
 
 	const deviceStorage = (await storageService.open('device')).createContext('data');

package/src/Utils.ts

@@ -8,7 +8,7 @@ import { EventEmitter as BaseEventEmitter } from 'events';
 import { Category } from './Definitions/Global/Categories.js';
 
 //import { get } from 'http';
-import PackageJson from '@npmcli/package-json';
+import type { PackageJson } from '@npmcli/package-json';
 import type { Identity } from '@project-chip/matter.js/util';
 import { existsSync } from 'fs';
 import path from 'path';
@@ -277,12 +277,44 @@ function getImportMeta() {
 	}
 }
 export async function findPackageJson(currentPath: string = getImportMeta()?.dirname): Promise<PackageJson> {
-	while (currentPath !== '/') {
-		const packageJsonPath = path.join(currentPath, 'package.json');
-		if (existsSync(packageJsonPath)) {
-			return await PackageJson.load(currentPath);
+	try {
+		while (currentPath !== '/') {
+			const packageJsonPath = path.join(currentPath, 'package.json');
+			if (existsSync(packageJsonPath)) {
+				return await import(packageJsonPath);
+			}
+			currentPath = path.join(currentPath, '..');
 		}
-		currentPath = path.join(currentPath, '..');
-	}
+	} catch {}
 	return null;
 }
+
+export function logStringify(obj: any, indent = 2) {
+	let cache = [];
+	const retVal = JSON.stringify(
+		obj,
+		(key, value) => {
+			if (typeof value === 'object' && value !== null) {
+				if (cache.includes(value)) {
+					// Circular reference found, discard key
+					return;
+				}
+				// Store value in our collection
+				cache.push(value);
+			}
+			if (value instanceof Map) {
+				return [...value];
+			}
+			if (value instanceof Set) {
+				return [...value];
+			}
+			if (key.toLowerCase().includes('password')) {
+				return '********';
+			}
+			return value;
+		},
+		indent
+	);
+	cache = null;
+	return retVal;
+}