@mp-consulting/homebridge-lg-thinq 1.0.0

package/dist/lib/Device.d.ts

@@ -0,0 +1,88 @@
+import { DeviceModel } from './DeviceModel.js';
+export interface DeviceData {
+    deviceId: string;
+    alias: string;
+    modelJsonUri: string;
+    deviceType: number;
+    modelName?: string;
+    manufacture?: {
+        macAddress?: string;
+        salesModel?: string;
+        serialNo?: string;
+        manufactureModel?: string;
+    };
+    modemInfo?: {
+        appVersion?: string;
+        modelName?: string;
+    };
+    snapshot: {
+        online?: boolean;
+    } & Record<string, any>;
+    platformType?: string;
+    online?: boolean;
+}
+/**
+ * Represents a device connected to the LG ThinQ platform.
+ * This class provides methods to interact with and retrieve information about the device.
+ */
+export declare class Device {
+    data: DeviceData;
+    deviceModel: DeviceModel;
+    constructor(data: DeviceData);
+    /**
+     * Gets the unique identifier for the device.
+     */
+    get id(): string;
+    /**
+     * Gets the name of the device.
+     */
+    get name(): string;
+    /**
+     * Gets the type of the device.
+     */
+    get type(): string;
+    /**
+     * Gets the model information for the device.
+     */
+    get model(): string;
+    /**
+     * Gets the MAC address of the device.
+     */
+    get macAddress(): string | undefined;
+    /**
+     * Gets the sales model of the device.
+     */
+    get salesModel(): string | undefined;
+    /**
+     * Gets the serial number of the device.
+     */
+    get serialNumber(): string | undefined;
+    /**
+     * Gets the firmware version of the device.
+     */
+    get firmwareVersion(): string | undefined;
+    /**
+     * Gets the current state snapshot of the device.
+     */
+    get snapshot(): {
+        online?: boolean;
+    } & Record<string, any>;
+    /**
+     * Sets the current state snapshot of the device.
+     */
+    set snapshot(value: {
+        online?: boolean;
+    } & Record<string, any>);
+    /**
+     * Gets the platform type of the device.
+     */
+    get platform(): string | undefined;
+    /**
+     * Gets the online status of the device.
+     */
+    get online(): boolean | undefined;
+    /**
+     * Returns a string representation of the device.
+     */
+    toString(): string;
+}

package/dist/lib/Device.js

@@ -0,0 +1,95 @@
+import { DeviceType } from './constants.js';
+/**
+ * Represents a device connected to the LG ThinQ platform.
+ * This class provides methods to interact with and retrieve information about the device.
+ */
+export class Device {
+    data;
+    deviceModel;
+    constructor(data) {
+        this.data = data;
+    }
+    /**
+     * Gets the unique identifier for the device.
+     */
+    get id() {
+        return this.data.deviceId;
+    }
+    /**
+     * Gets the name of the device.
+     */
+    get name() {
+        return this.data.alias;
+    }
+    /**
+     * Gets the type of the device.
+     */
+    get type() {
+        return DeviceType[this.data.deviceType];
+    }
+    /**
+     * Gets the model information for the device.
+     */
+    get model() {
+        const modelName = this.data.modelName || this.data.modemInfo?.modelName || this.data.manufacture?.manufactureModel || '';
+        if (/^([A-Z]+)_(\d+)_([A-Z]{2})$/.test(modelName)) {
+            return modelName.slice(0, -3);
+        }
+        return modelName;
+    }
+    /**
+     * Gets the MAC address of the device.
+     */
+    get macAddress() {
+        return this.data.manufacture?.macAddress;
+    }
+    /**
+     * Gets the sales model of the device.
+     */
+    get salesModel() {
+        return this.data.manufacture?.salesModel;
+    }
+    /**
+     * Gets the serial number of the device.
+     */
+    get serialNumber() {
+        return this.data.manufacture?.serialNo;
+    }
+    /**
+     * Gets the firmware version of the device.
+     */
+    get firmwareVersion() {
+        return this.data.modemInfo?.appVersion;
+    }
+    /**
+     * Gets the current state snapshot of the device.
+     */
+    get snapshot() {
+        return this.data.snapshot || null;
+    }
+    /**
+     * Sets the current state snapshot of the device.
+     */
+    set snapshot(value) {
+        this.data.snapshot = value;
+    }
+    /**
+     * Gets the platform type of the device.
+     */
+    get platform() {
+        return this.data.platformType;
+    }
+    /**
+     * Gets the online status of the device.
+     */
+    get online() {
+        return this.data.online !== undefined ? this.data.online : this.data.snapshot.online;
+    }
+    /**
+     * Returns a string representation of the device.
+     */
+    toString() {
+        return `${this.id}: ${this.name} (${this.type} ${this.model})`;
+    }
+}
+//# sourceMappingURL=Device.js.map

package/dist/lib/Device.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Device.js","sourceRoot":"","sources":["../../src/lib/Device.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AA0B5C;;;GAGG;AACH,MAAM,OAAO,MAAM;IAGE;IAFZ,WAAW,CAAe;IAEjC,YAAmB,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEvC;;OAEG;IACH,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAW,KAAK;QACd,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,gBAAgB,IAAI,EAAE,CAAC;QACzH,IAAI,6BAA6B,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;YAClD,OAAO,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;QAChC,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC;IAC3C,CAAC;IAED;;OAEG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC;IAC3C,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,UAAU,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC;IACpC,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ,CAAC,KAAK;QACvB,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IAC7B,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;IAChC,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IACvF,CAAC;IAED;;OAEG;IACI,QAAQ;QACb,OAAO,GAAG,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,KAAK,GAAG,CAAC;IACjE,CAAC;CACF"}

package/dist/lib/Device.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/lib/Device.spec.js

@@ -0,0 +1,53 @@
+import { Device } from './Device.js';
+import { describe, test, beforeEach, expect } from '@jest/globals';
+import Fs from 'fs';
+import Path from 'path';
+const mockDeviceData = JSON.parse(Fs.readFileSync(Path.resolve(process.cwd(), 'sample/airconditioner.json'), 'utf8'));
+describe('Device', () => {
+    let device;
+    beforeEach(() => {
+        device = new Device(mockDeviceData);
+    });
+    test('should retrieve device ID', () => {
+        expect(device.id).toBe(mockDeviceData.deviceId);
+    });
+    test('should retrieve device name', () => {
+        expect(device.name).toBe(mockDeviceData.alias);
+    });
+    test('should retrieve device type', () => {
+        expect(device.type).toBe('AC');
+    });
+    test('should retrieve device model from modelName', () => {
+        expect(device.model).toBe(mockDeviceData.modelName.slice(0, -3));
+    });
+    test('should retrieve MAC address', () => {
+        expect(device.macAddress).toBe(mockDeviceData.manufacture.macAddress);
+    });
+    test('should retrieve sales model', () => {
+        expect(device.salesModel).toBe(mockDeviceData.manufacture.salesModel);
+    });
+    test('should retrieve serial number', () => {
+        expect(device.serialNumber).toBe(mockDeviceData.manufacture.serialNo);
+    });
+    test('should retrieve firmware version', () => {
+        expect(device.firmwareVersion).toBe(mockDeviceData.modemInfo.appVersion);
+    });
+    test('should retrieve snapshot when available', () => {
+        expect(device.snapshot).toEqual(mockDeviceData.snapshot);
+    });
+    test('should set snapshot', () => {
+        const newSnapshot = { online: false };
+        device.snapshot = newSnapshot;
+        expect(device.snapshot).toEqual(newSnapshot);
+    });
+    test('should retrieve platform type', () => {
+        expect(device.platform).toBe(mockDeviceData.platformType);
+    });
+    test('should retrieve online status from data.online', () => {
+        expect(device.online).toBe(mockDeviceData.online);
+    });
+    test('should return string representation of the device', () => {
+        expect(device.toString()).toBe(`${mockDeviceData.deviceId}: ${mockDeviceData.alias} (AC ${mockDeviceData.modelName.slice(0, -3)})`);
+    });
+});
+//# sourceMappingURL=Device.spec.js.map

package/dist/lib/Device.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Device.spec.js","sourceRoot":"","sources":["../../src/lib/Device.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAc,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACnE,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,4BAA4B,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC;AAEtH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,IAAI,MAAc,CAAC;IAEnB,UAAU,CAAC,GAAG,EAAE;QACd,MAAM,GAAG,IAAI,MAAM,CAAC,cAAuC,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACrC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAClD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACvC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACvC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACvD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACnE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACvC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACvC,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACzC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IACxE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kCAAkC,EAAE,GAAG,EAAE;QAC5C,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACnD,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAC/B,MAAM,WAAW,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;QACtC,MAAM,CAAC,QAAQ,GAAG,WAAW,CAAC;QAC9B,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+BAA+B,EAAE,GAAG,EAAE;QACzC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,YAAY,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,gDAAgD,EAAE,GAAG,EAAE;QAC1D,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mDAAmD,EAAE,GAAG,EAAE;QAC7D,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,QAAQ,KAAK,cAAc,CAAC,KAAK,QAAQ,cAAc,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACtI,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/lib/DeviceModel.d.ts

@@ -0,0 +1,164 @@
+export declare enum ValueType {
+    Bit = "Bit",
+    Enum = "Enum",
+    Range = "Range",
+    Reference = "Reference",
+    StringComment = "StringComment"
+}
+export interface ModelDataValue {
+    type: string;
+    [key: string]: any;
+}
+export interface MonitoringValue {
+    dataType: string;
+    valueMapping: {
+        [key: string]: {
+            index: string;
+            label: string;
+        };
+    };
+}
+export interface ModelData {
+    Info: {
+        productType: string;
+        productCode: string;
+        country: string;
+        modelType: string;
+        model: string;
+        modelName: string;
+        networkType: string;
+        version: string;
+    };
+    Value: {
+        [key: string]: ModelDataValue;
+    };
+    MonitoringValue?: {
+        [key: string]: MonitoringValue;
+    };
+    [key: string]: any;
+}
+export interface BitValue {
+    type: ValueType.Bit;
+    options: any;
+}
+export interface EnumValue {
+    type: ValueType.Enum;
+    options: Record<string, string | number>;
+}
+export interface RangeValue {
+    type: ValueType.Range;
+    min: number;
+    max: number;
+    step: number;
+}
+export interface ReferenceValue {
+    type: ValueType.Reference;
+    reference: any;
+}
+export interface StringCommentValue {
+    type: ValueType.StringComment;
+    comment: string;
+}
+/**
+ * Represents the model of a device, including its metadata, values, and monitoring data.
+ * This class provides methods to retrieve and decode device-specific information.
+ */
+export declare class DeviceModel {
+    data: ModelData;
+    /**
+     * Creates a new `DeviceModel` instance.
+     *
+     * @param data - The raw model data for the device.
+     */
+    constructor(data: ModelData);
+    /**
+     * Retrieves the monitoring values defined in the device model.
+     */
+    get monitoringValue(): {
+        [key: string]: MonitoringValue;
+    } | undefined;
+    /**
+     * Retrieves the value definition for a given key in the device model.
+     * Supports ThinQ2 protocol mappings for monitoring values.
+     *
+     * @param name - The key to retrieve the value definition for.
+     * @returns The value definition or `null` if not found.
+     */
+    value(name: string): BitValue | EnumValue | RangeValue | ReferenceValue | StringCommentValue | null;
+    /**
+     * Retrieves the default value for a given key in the device model.
+     *
+     * @param name - The key to retrieve the default value for.
+     * @returns The default value or `undefined` if not found.
+     */
+    default(name: string): any;
+    /**
+     * Retrieves the enum value for a given key and name.
+     *
+     * @param key - The key to retrieve the enum value for.
+     * @param name - The name of the enum **value**.
+     * @returns The enum value or `undefined` if not found.
+     */
+    enumValue(key: string, name: string): string | null;
+    /**
+     * Retrieves the enum name for a given key and value.
+     *
+     * @param key - The key to retrieve the enum name for.
+     * @param value - The value of the enum.
+     * @returns The enum name or `null` if not found.
+     */
+    enumName(key: string, value: string): string | number | null;
+    /**
+     * Retrieves the monitoring value mapping for a given key.
+     *
+     * @param key - The key to retrieve the monitoring value mapping for.
+     * @returns The monitoring value mapping or `null` if not found.
+     */
+    monitoringValueMapping(key: string): {
+        [key: string]: {
+            index: string;
+            label: string;
+        };
+    } | null;
+    /**
+     * Looks up a monitor value based on a given key and name, with an optional default value.
+     *
+     * @param key - The key used to identify the monitoring value mapping.
+     * @param name - The name of the specific value to look up within the mapping.
+     * @param default_value - An optional default value to return if the lookup fails. Defaults to `null`.
+     * @returns The label of the monitoring value if found, or the `default_value` if not found.
+     */
+    lookupMonitorValue(key: string, name: string): string | number | null;
+    /**
+     * Looks up a monitor value based on a given key and name, with an optional default value.
+     *
+     * @param key - The key used to identify the monitoring value mapping.
+     * @param name - The name of the specific value to look up within the mapping.
+     * @param default_value - An optional default value to return if the lookup fails. Defaults to `null`.
+     * @returns The label of the monitoring value if found, or the `default_value` if not found.
+     */
+    lookupMonitorValue2(key: string, name: string, default_value: string): string | number;
+    /**
+     * Looks up a monitor name based on a given key and label.
+     *
+     * @param key - The key used to identify the monitoring value mapping.
+     * @param label - The label of the specific value to look up within the mapping.
+     * @returns The name of the monitoring value if found, or `null` if not found.
+     */
+    lookupMonitorName(key: string, label: string): string | null;
+    /**
+     * Decodes the monitoring data for the device.
+     *
+     * @param data - The raw monitoring data to decode.
+     * @returns The decoded monitoring data.
+     */
+    decodeMonitor(data: any): any;
+    /**
+     * Decodes binary monitoring data for the device.
+     *
+     * @param data - The raw binary monitoring data to decode.
+     * @param length - The length of each binary segment (default: 8).
+     * @returns The decoded monitoring data.
+     */
+    private decodeMonitorBinary;
+}