isy-nodejs 1.0.9-alpha.1 → 1.3.24

package/src/Converters.ts

@@ -1,6 +1,10 @@
+import { DoorLock, FanControl } from '@matter/main/clusters';
 import { UnitOfMeasure } from './Definitions/Global/UOM.js';
-import {type PathsWithLimit, type StringKeys } from './Utils.js';
-import {Paths} from 'type-fest'
+import { FanLevel, RampRate } from './Definitions/Insteon/index.js';
+
+import { Paths } from 'type-fest';
+import { Insteon } from './ISY.js';
+import { type PathsWithLimit, type StringKeys } from './Utils.js';
 
 let BooleanPercentage: Converter<boolean, number>;
 let NullConverter: Converter<any, any>;
@@ -13,27 +17,43 @@ const StandardConverters = {
 	Boolean: {
 		LevelFrom0To255: {
 			to: (value: boolean) => (value ? 255 : 0),
-			from: (value: number) => value > 0
+			from: (value: number) => value > 0,
 		},
 		Percent: {
 			to: (value: boolean) => (value ? 100 : 0),
-			from: (value: number) => value > 0
-		}
+			from: (value: number) => value > 0,
+		},
+	},
+	Fahrenheit: {
+		Celsius: {
+			to: (value: number) => (value - 32) / 1.8,
+			from: (value: number) => value * 1.8 + 32,
+		},
+		LevelFrom0To255: {
+			to: (value: number) => Math.round(value / 2.55),
+			from: (value: number) => Math.round(value * 2.55),
+		},
+	},
+	Celsius: {
+		LevelFrom0To255: {
+			to: (value: number) => Math.round(value / 2.55),
+			from: (value: number) => Math.round(value * 2.55),
+		},
 	},
 	LevelFrom0To255: {
 		Percent: {
 			to: (value: number): number => {
-				if(value === 0) return 0;
-				if(value === 255) return 100;
+				if (value === 0) return 0;
+				if (value === 255) return 100;
 				return Math.round((value * 100) / 255);
 			},
 			from: (value: number): number => {
-				if(value === 0) return 0;
-				if(value === 100) return 255;
+				if (value === 0) return 0;
+				if (value === 100) return 255;
 				return Math.round((value * 255) / 100);
-			}
-		}
-	}
+			},
+		},
+	},
 };
 
 //StandardConverters.Percent.LevelFrom0To255 = invert(StandardConverters.LevelFrom0To255.Percent);
@@ -59,7 +79,12 @@ function registerConverters() {
 }
 
 function registerConverter(
-	from: keyof typeof StandardConverters | keyof typeof Converter.Matter | Paths<typeof StandardConverters> | Paths<typeof Converter.Matter> | string,
+	from:
+		| keyof typeof StandardConverters
+		| keyof typeof Converter.Matter
+		| Paths<typeof StandardConverters>
+		| Paths<typeof Converter.Matter>
+		| string,
 	to: keyof typeof StandardConverters | keyof typeof Converter.Matter | string,
 	converter: Converter<any, any>
 ) {
@@ -76,64 +101,126 @@ function registerConverter(
 
 export namespace Converter {
 	export const Standard: typeof StandardConverters = StandardConverters;
+	//TODO: Migrate to isy matter
+	//TODO: Simplify
 
 	export const Matter = {
 		LevelFrom0To255: {
 			LightingLevel: {
-				from: (value: number) =>
-					value === 1 ? 0
-					: value === 254 ? 255
-					: value,
-				to: (value: number) =>
-					value === 0 ? 1
-					: value === 255 ? 254
-					: value
-			}
-
+				from: (value: number) => (value === 1 ? 0 : value === 254 ? 255 : value),
+				to: (value: number) => (value === 0 ? 1 : value === 255 ? 254 : value),
+			},
 		},
 		Percent: {
 			LightingLevel: {
-				from: (value: number) =>
-					value === 1 ? 0
-					: value === 254 ? 100
-					: Math.round(value / 254 * 100),
-				to: (value: number) =>
-					value === 0 ? 1
-					: value === 100 ? 254
-					: Math.round(value / 100 * 254)
-			}
+				from: (value: number) => (value === 1 ? 0 : value === 254 ? 100 : Math.round((value / 254) * 100)),
+				to: (value: number) => (value === 0 ? 1 : value === 100 ? 254 : Math.round((value / 100) * 254)),
+			},
+			InverseBoolean: {
+				from: (value: boolean) => (value ? 0 : 100),
+				to: (value: number) => (value > 0 ? false : true),
+			},
+		},
+
+		ZWaveLock: {
+			LockState: {
+				from: (value: DoorLock.LockState) => (value == DoorLock.LockState.Locked ? 101 : 0),
+				to: (value: Insteon.Lock) => (value == 0 ? DoorLock.LockState.Unlocked : DoorLock.LockState.Locked),
+			},
+		},
+
+		InsteonLock: {
+			LockState: {
+				from: (value: DoorLock.LockState) =>
+					value == DoorLock.LockState.Locked ? Insteon.Lock.Locked : Insteon.Lock.Unlocked,
+				to: (value: Insteon.Lock) =>
+					value == Insteon.Lock.Locked ? DoorLock.LockState.Locked : DoorLock.LockState.Unlocked,
+			},
 		},
 		Boolean: {
 			LightingLevel: {
 				from: (value: number) => value > 0,
-				to: (value: any) => value ? 254 : 0
-			}
-		}
+				to: (value: boolean) => (value ? 254 : 0),
+			},
+		},
+		RampRate: {
+			Deciseconds: {
+				from: (value: number) => RampRate.from.seconds(value / 10),
+				to: (value: RampRate) => RampRate.to.seconds(value) * 10,
+			},
+			Seconds: {
+				from: (value: number) => RampRate.from.seconds(value),
+				to: (value: RampRate) => RampRate.to.seconds(value),
+			},
+		},
+
+		FanLevel: {
+			FanMode: {
+				from: (value: FanControl.FanMode) => {
+					switch (value) {
+						case FanControl.FanMode.Low:
+							return FanLevel.Low;
+						case FanControl.FanMode.Medium:
+							return FanLevel.Medium;
+						case FanControl.FanMode.High:
+							return FanLevel.High;
+						case FanControl.FanMode.Off:
+							return FanLevel.Off;
+						default:
+							throw new Error('Invalid Fan Mode: ' + FanControl.FanMode[value]);
+					}
+				},
+				to: (value: FanLevel) => {
+					switch (value) {
+						case FanLevel.Low:
+							return FanControl.FanMode.Low;
+						case FanLevel.Medium:
+							return FanControl.FanMode.Medium;
+						case FanLevel.High:
+							return FanControl.FanMode.High;
+						case FanLevel.Off:
+							return FanControl.FanMode.Off;
+					}
+				},
+			},
+		},
 	};
 
 	export type ConverterTypes = `${StringKeys<typeof StandardConverters>}`;
 
-	type StandardConverters = Paths<typeof StandardConverters, {maxRecursionDepth: 1, bracketNotation: false}>
+	type StandardConverters = Paths<
+		typeof StandardConverters,
+		{ maxRecursionDepth: 1; bracketNotation: false; depth: 1 }
+	>;
 
-	type Invert<K extends string> = K extends `${infer T}.${infer U}` ? `${U}.${T}` | K  : never;
+	type Invert<K extends string> = K extends `${infer T}.${infer U}` ? `${U}.${T}` | K : never;
 	//export type StandardConvertersList = PathsWithLimit<typeof StandardConverters, 1>;
 
-
 	export type MatterISYConvertibleTypes = `${StringKeys<(typeof Matter)[`${keyof typeof Matter}`]>}`;
 
 	export type ISYMatterConvertibleTypes = `${StringKeys<typeof Matter>}`;
 
-	export type MatterConverters = Paths<typeof Matter, {maxRecursionDepth: 1, bracketNotation: false}>
+	export type MatterConverters = Paths<
+		typeof Matter,
+		{ maxRecursionDepth: 1; bracketNotation: false; leavesOnly: true }
+	>;
 
-	export type KnownConverters = Invert<StandardConverters> | Invert<MatterConverters>;
+	export type KnownConverters =
+		| StandardConverters
+		| MatterConverters
+		| Invert<StandardConverters>
+		| Invert<MatterConverters>;
 	const cache: { [x: string]: Converter<any, any> } = {};
 	export function get(label: KnownConverters): Converter<any, any>;
-	export function get(from: UnitOfMeasure, to: UnitOfMeasure): Converter<any,any>
+	export function get(from: UnitOfMeasure, to: UnitOfMeasure): Converter<any, any>;
 	export function get(from: ConverterTypes, to: ConverterTypes);
 	export function get(from: UnitOfMeasure, to: UnitOfMeasure);
 	export function get(from: MatterISYConvertibleTypes, to: ISYMatterConvertibleTypes);
 	export function get(to: ISYMatterConvertibleTypes, from: MatterISYConvertibleTypes);
-	export function get(from: UnitOfMeasure | `${keyof typeof UnitOfMeasure}` | string, to?: UnitOfMeasure | `${keyof typeof UnitOfMeasure}` | string): Converter<any, any> {
+	export function get(
+		from: UnitOfMeasure | `${keyof typeof UnitOfMeasure}` | string,
+		to?: UnitOfMeasure | `${keyof typeof UnitOfMeasure}` | string
+	): Converter<any, any> {
 		if (to === undefined) {
 			return ConverterRegistry.get(from as string) ?? NullConverter;
 		}
@@ -165,11 +252,16 @@ export namespace Converter {
 		return null;
 	}
 
-
-	export function register<F,T>(from: UnitOfMeasure, to: UnitOfMeasure, converter: Converter<F, T>) {
+	export function register<F, T>(from: UnitOfMeasure, to: UnitOfMeasure, converter: Converter<F, T>) {
 		registerConverter(UnitOfMeasure[from], UnitOfMeasure[to], converter);
 	}
-
+	export function registerAll(converters: Record<string, Record<string, Converter<any, any>>>) {
+		for (const from in converters) {
+			for (const to in converters[from]) {
+				registerConverter(from, to, converters[from][to]);
+			}
+		}
+	}
 }
 
 registerConverters();
@@ -183,6 +275,6 @@ export interface Converter<F, T> {
 export function invert<F, T>(converter: Converter<F, T>): Converter<T, F> {
 	return {
 		from: converter.to,
-		to: converter.from
+		to: converter.from,
 	};
 }

package/src/Definitions/Brultech/index.ts

@@ -1 +1 @@
-export * from "./generated/index.js";
+export * from './generated/index.js';

package/src/Definitions/Generic/Error.ts

@@ -1,4 +1,18 @@
+import type { Converter } from '../../Converters.js';
+
 export enum Error {
-    True = 0,
-    False = 1
+	True = 0,
+	False = 1,
+}
+
+export namespace Error {
+	export const Boolean: Converter<boolean, Error> = {
+		from: (value: boolean): Error => (value ? Error.True : Error.False),
+		to: (value: Error): boolean => value === Error.True,
+	};
+
+	export const Index: Converter<Error, number> = {
+		from: (value: Error): number => value,
+		to: (value: number): Error => value,
+	};
 }

package/src/Definitions/Generic/index.ts

@@ -1 +1 @@
-export * from './Error.js';
+export * from './Error.js';

package/src/Definitions/Global/Categories.ts

@@ -1,19 +1,288 @@
-export enum Category {
-  Controller = 0,
-  DimmableControl = 1,
-  RelayControl = 2,
-  NetworkBridge = 3,
-  IrrigationControl = 4,
-  ClimateControl = 5,
-  PoolControl = 6,
-  SensorActuator = 7,
-  HomeEntertainment = 8,
-  EnergyManagement = 9,
-  ApplianceControl = 10,
-  WindowShadeControl = 14,
-  AccessControl = 15,
-  SecurityHealthSafety = 16,
-  A10X10 = 113,
-  Virtual = 127,
-  Unknown = 254,
+import type { Negative, StringKeyOf } from 'type-fest';
+import { isNumberObject } from 'util/types';
+import { type StringKeys, logStringify } from '../../Utils.js';
+
+/**
+ * Checks if a given string represents a valid number.
+ * @param value - The string to check.
+ * @returns True if the string is a valid number, false otherwise.
+ */
+function isNumberString(value: string): boolean {
+	return !isNaN(Number(value));
+}
+
+export namespace Category {
+	export enum Insteon {
+		Controller = 0,
+		DimmableControl = 1,
+		RelayControl = 2,
+		NetworkBridge = 3,
+		IrrigationControl = 4,
+		ClimateControl = 5,
+		PoolControl = 6,
+		SensorActuator = 7,
+		HomeEntertainment = 8,
+		EnergyManagement = 9,
+		ApplianceControl = 10,
+		WindowShadeControl = 14,
+		AccessControl = 15,
+		SecurityHealthSafety = 16,
+		A10X10 = 113,
+		Virtual = 127,
+		Unknown = 254,
+	}
+
+	export enum Domain {
+		Home = 1,
+		Outdoor = 2,
+		Industrial = 3,
+		Commercial = 4,
+	}
+
+	export namespace Home {
+		export enum Category {
+			DeviceID = 0,
+			Alarm = 1,
+			Controller = 2,
+			Sensor = 3,
+			Relay = 4,
+			Remote = 5,
+			AudioVisual = 6,
+			DoorLock = 7,
+			Doorbell = 8,
+			Camera = 9,
+			DateTime = 10,
+			Weather = 11,
+			HVAC = 12,
+			Display = 13,
+			Gateway = 14,
+			PowerManagement = 15,
+			Appliance = 16,
+			HomeHealth = 17,
+			Barrier = 18,
+			Automotive = 19,
+		}
+
+		export enum Alarm {
+			SecurityPanel = 1,
+			Zone = 2,
+			Partition = 3,
+			Siren = 4,
+		}
+
+		export enum Controller {
+			ClassAMotorControl = 1,
+			ClassBMotorControl = 2,
+			ClassCMotorControl = 3,
+			MotorMultiposition = 4,
+			EntryControl = 5,
+			PCController = 6,
+			SceneController = 7,
+			SubsystemController = 8,
+			DimmerSwitch = 9,
+			MultilevelSwitch = 10,
+			SceneSwitch = 11,
+			Toggle = 12,
+			NonDimmingLighting = 16,
+		}
+
+		export enum Sensor {
+			BinarySensor = 1,
+			MultilevelSensor = 2,
+			ClimateSensor = 3,
+			MotionSensor = 4,
+			EnergyMeter = 5,
+			PulseMeter = 6,
+			WaterMeter = 7,
+			GasMeter = 8,
+			SmokeDetector = 9,
+			TamperSensor = 10,
+			TiltSensor = 11,
+			WaterSensor = 12,
+			DoorWindowSensor = 13,
+			LowBatterySensor = 14,
+			COEndOfLifeSensor = 15,
+			OverheatSensor = 16,
+			RapidTempRiseSensor = 17,
+			UnderheatSensor = 18,
+			LeakDetectedSensor = 19,
+			LevelDropSensor = 20,
+			FilterCloggedSensor = 21,
+			IntrusionDetectSensor = 22,
+			CO2Sensor = 23,
+			COSensor = 24,
+			FreezeSensor = 25,
+			GlassBreakSensor = 26,
+			HeatSensor = 27,
+		}
+
+		export enum Relay {
+			OnOffPowerStrip = 1,
+			OnOffPowerSwitch = 2,
+			OnOffSceneSwitch = 3,
+			BinarySwitch = 4,
+			OpenCloseValve = 5,
+		}
+
+		export enum Remote {
+			AVRemoteControl = 1,
+			SimpleRemoteControl = 2,
+		}
+
+		export enum AudioVisual {
+			AVControlPoint = 1,
+			SatelliteReceiver = 2,
+			Television = 3,
+			SetTopBox = 4,
+		}
+
+		export enum DoorLock {
+			Unknown = '*',
+		}
+
+		export enum Doorbell {
+			DoorBell = 1,
+			Chime = 2,
+		}
+
+		export enum Camera {
+			Unknown = '*',
+		}
+
+		export enum DateTime {
+			Timer = 1,
+		}
+
+		export enum Weather {
+			WeatherStation = 0,
+			Temperature = 1,
+			Humidity = 2,
+			BarometricPressure = 3,
+			Wind = 4,
+			Precipitation = 5,
+			IlluminationLight = 6,
+			Lightning = 7,
+		}
+
+		export enum HVAC {
+			Thermostat = 1,
+			ResidentialHRV = 2,
+		}
+
+		export enum Display {
+			Unknown = '*',
+		}
+
+		export enum Gateway {
+			Unknown = '*',
+		}
+
+		export enum PowerManagement {
+			Unknown = '*',
+		}
+
+		export enum Appliance {
+			Unknown = '*',
+		}
+
+		export enum HomeHealth {
+			Unknown = '*',
+		}
+
+		export enum Barrier {
+			Unknown = '*',
+		}
+
+		export enum Automotive {
+			Tesla = 1,
+		}
+	}
+
+	export namespace Commercial {
+		export enum Category {
+			Unknown = '*',
+		}
+		export enum Unknown {
+			Unknown = '*',
+		}
+	}
+
+	export namespace Outdoor {
+		export enum Category {
+			Unknown = '*',
+		}
+		export enum Unknown {
+			Unknown = '*',
+		}
+	}
+
+	export namespace Industrial {
+		export enum Category {
+			Unknown = '*',
+		}
+		export enum Unknown {
+			Unknown = '*',
+		}
+	}
+}
+export type DeviceInfo<
+	D extends keyof typeof Category.Domain,
+	C extends keyof (typeof Category)[D],
+	S extends keyof (typeof Category)[D][C],
+> = {
+	domain: (typeof Category.Domain)[D];
+	category: (typeof Category)[D][C];
+	subcategory: (typeof Category)[D][C][S];
+	model: number;
+};
+
+export type DeviceHinto<
+	D extends 'Home' = 'Home',
+	C extends StringKeys<(typeof Category)[D]> = StringKeys<(typeof Category)[D]>,
+	S extends StringKeys<(typeof Category)[D][C]> = StringKeys<(typeof Category)[D][C]>,
+> = `${(typeof Category.Domain)[D]}.${StringKeys<(typeof Category)[D][C]>}.${S}.${number}`;
+
+function generateHints(): DeviceHint.Hints {
+	//@ts-ignore
+	const codes = {} as any;
+	for (var x in Category) {
+		if (x != 'Domain' && x != 'Insteon') {
+			codes[x] = {};
+			for (var y in Category[x]) {
+				if (y != 'Category' && typeof y == 'string' && isNaN(Number(y))) {
+					codes[x][y] = {};
+					for (var z in Category[x][y]) {
+						if (z != 'Category' && typeof z == 'string' && isNaN(Number(z))) {
+							try {
+								codes[x][y][z] = `${Category.Domain[x]}.${Category[x]['Category'][y]}.${Category[x][y][z]}`;
+							} catch {
+								console.log(`Error building: ${x}/${y}/${z}`);
+							}
+						}
+					}
+				}
+			}
+		}
+	}
+	console.log(logStringify(codes));
+	return codes;
+}
+
+type ValuesOf<X> = X[keyof X];
+
+export namespace DeviceHint {
+	export type Hints = {
+		[x in 'Home' | 'Industrial' | 'Outdoor' | 'Commercial']: {
+			[y in keyof Omit<(typeof Category)[x], 'Category'>]: {
+				[z in keyof Omit<(typeof Category)[x][y], ''>]: `${
+					(typeof Category.Domain)[x] //@ts-ignore
+				}.${(typeof Category)[x]['Category'][y]}.${(typeof Category)[x][y][z]}`;
+			};
+		};
+	};
+
+	type NegativeToNumber<T extends number> = T extends -1 ? number : T;
+	type NumberToString<T> = T extends number ? string : T;
+
+	export const Hints = generateHints();
 }