homebridge-tydom 0.23.14 → 0.24.0

package/lib/accessories/garageDoorOpener.js

@@ -242,7 +242,7 @@ const setupGarageDoorOpener = (accessory, controller) => {
 };
 exports.setupGarageDoorOpener = setupGarageDoorOpener;
 const updateGarageDoorOpener = (accessory, _controller, updates, type) => {
-    const { context } = accessory;
+    const { context: _context } = accessory;
     // const {state} = context as TydomAccessoryContext<State>;
     // Process command updates
     if (type === 'cdata') {
@@ -254,7 +254,7 @@ const updateGarageDoorOpener = (accessory, _controller, updates, type) => {
         return;
     }
     updates.forEach((update) => {
-        const { name, value } = update;
+        const { name, value: _value } = update;
         switch (name) {
             default:
                 return;

package/lib/accessories/smokeDetector.d.ts

@@ -0,0 +1,5 @@
+import type { PlatformAccessory } from 'homebridge';
+import TydomController from '../controller';
+import type { TydomAccessoryContext } from '../typings/tydom';
+export declare const setupSmokeDetector: (accessory: PlatformAccessory<TydomAccessoryContext>, controller: TydomController) => void;
+export declare const updateSmokeDetector: (accessory: PlatformAccessory<TydomAccessoryContext>, _controller: TydomController, updates: Record<string, unknown>[]) => void;

package/lib/accessories/smokeDetector.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateSmokeDetector = exports.setupSmokeDetector = void 0;
+const hap_1 = require("../config/hap");
+const accessory_1 = require("../helpers/accessory");
+const tydom_1 = require("../helpers/tydom");
+const debug_1 = require("../utils/debug");
+const setupSmokeDetector = (accessory, controller) => {
+    const { context } = accessory;
+    const { client } = controller;
+    const { SmokeDetected, StatusLowBattery } = hap_1.Characteristic;
+    const { deviceId, endpointId } = context;
+    (0, accessory_1.setupAccessoryInformationService)(accessory, controller);
+    (0, accessory_1.setupAccessoryIdentifyHandler)(accessory, controller);
+    // Add the actual accessory Service
+    const service = (0, accessory_1.addAccessoryService)(accessory, hap_1.Service.SmokeSensor, `${accessory.displayName}`, true);
+    service
+        .getCharacteristic(SmokeDetected)
+        .setProps({
+        format: "bool" /* Formats.BOOL */
+    })
+        .on("get" /* CharacteristicEventTypes.GET */, async (callback) => {
+        (0, debug_1.debugGet)(SmokeDetected, service);
+        try {
+            const data = await (0, tydom_1.getTydomDeviceData)(client, { deviceId, endpointId });
+            const smokeDefect = (0, tydom_1.getTydomDataPropValue)(data, 'techSmokeDefect');
+            (0, debug_1.debugGetResult)(SmokeDetected, service, smokeDefect);
+            callback(null, smokeDefect);
+        }
+        catch (err) {
+            callback(err);
+        }
+    });
+    service
+        .getCharacteristic(StatusLowBattery)
+        .on("get" /* CharacteristicEventTypes.GET */, async (callback) => {
+        (0, debug_1.debugGet)(StatusLowBattery, service);
+        try {
+            const data = await (0, tydom_1.getTydomDeviceData)(client, { deviceId, endpointId });
+            const battDefect = (0, tydom_1.getTydomDataPropValue)(data, 'battDefect');
+            (0, debug_1.debugGetResult)(StatusLowBattery, service, battDefect);
+            callback(null, battDefect ? StatusLowBattery.BATTERY_LEVEL_LOW : StatusLowBattery.BATTERY_LEVEL_NORMAL);
+        }
+        catch (err) {
+            callback(err);
+        }
+    });
+};
+exports.setupSmokeDetector = setupSmokeDetector;
+const updateSmokeDetector = (accessory, _controller, updates) => {
+    updates.forEach((update) => {
+        const { name, value } = update;
+        const { SmokeDetected, StatusLowBattery } = hap_1.Characteristic;
+        switch (name) {
+            case 'techSmokeDefect': {
+                const service = (0, accessory_1.getAccessoryService)(accessory, hap_1.Service.SmokeSensor);
+                (0, debug_1.debugSetUpdate)(SmokeDetected, service, value);
+                service.updateCharacteristic(SmokeDetected, value);
+                return;
+            }
+            case 'battDefect': {
+                const service = (0, accessory_1.getAccessoryService)(accessory, hap_1.Service.SmokeSensor);
+                (0, debug_1.debugSetUpdate)(StatusLowBattery, service, value);
+                service.updateCharacteristic(StatusLowBattery, value);
+                return;
+            }
+            default:
+                return;
+        }
+    });
+};
+exports.updateSmokeDetector = updateSmokeDetector;

package/lib/accessories/triggerSwitch.d.ts

@@ -6,5 +6,5 @@ type TriggerSwitchSettings = {
 };
 type TriggerSwitchContext = TydomAccessoryContext<TriggerSwitchSettings>;
 export declare const setupTriggerSwitch: (accessory: PlatformAccessory<TriggerSwitchContext>, controller: TydomController) => void;
-export declare const updateTriggerSwitch: (accessory: PlatformAccessory<TriggerSwitchContext>, controller: TydomController, updates: Record<string, unknown>[]) => void;
+export declare const updateTriggerSwitch: (_accessory: PlatformAccessory<TriggerSwitchContext>, _controller: TydomController, _updates: Record<string, unknown>[]) => void;
 export {};

package/lib/accessories/triggerSwitch.js

@@ -42,7 +42,7 @@ const setupTriggerSwitch = (accessory, controller) => {
         .updateValue(false);
 };
 exports.setupTriggerSwitch = setupTriggerSwitch;
-const updateTriggerSwitch = (accessory, controller, updates) => {
+const updateTriggerSwitch = (_accessory, _controller, _updates) => {
     // no-op
 };
 exports.updateTriggerSwitch = updateTriggerSwitch;

package/lib/controller.js

@@ -10,6 +10,7 @@ const tydom_client_1 = require("tydom-client");
 const env_1 = require("./config/env");
 const tydom_1 = require("./helpers/tydom");
 const utils_1 = require("./utils");
+const error_1 = require("./utils/error");
 const DEFAULT_REFRESH_INTERVAL_SEC = 4 * 60 * 60; // 4 hours
 class TydomController extends events_1.EventEmitter {
     constructor(log, config) {
@@ -30,8 +31,7 @@ class TydomController extends events_1.EventEmitter {
                 this.handleMessage(message);
             }
             catch (err) {
-                this.log.error(`Encountered an uncaught error while processing message=${(0, utils_1.chalkJson)(message)}"`);
-                this.log.debug(`${err instanceof Error ? err.stack : err}`);
+                this.log.error(`Encountered an uncaught error=${(0, error_1.stringifyError)(err)} while processing message=${(0, utils_1.chalkJson)(message)}"`);
             }
         });
         this.client.on('connect', () => {

package/lib/helpers/accessory.d.ts

@@ -8,23 +8,11 @@ export declare const getAccessoryServiceWithSubtype: (accessory: PlatformAccesso
 export declare const addAccessoryService: (accessory: PlatformAccessory, service: ServiceClass, name: string, removeExisting?: boolean) => Service;
 export declare const addAccessoryServiceWithSubtype: (accessory: PlatformAccessory, service: ServiceClass, name: string, subtype: string, removeExisting?: boolean) => Service;
 type TydomAccessorySetup<T extends TydomAccessoryContext> = (accessory: PlatformAccessory<T>, controller: TydomController) => void | Promise<void>;
-export declare const getTydomAccessorySetup: <T extends TydomAccessoryContext<any, any> = TydomAccessoryContext<{
-    [x: string]: unknown;
-}, {
-    [x: string]: unknown;
-}>>(accessory: PlatformAccessory<T>, context: T) => TydomAccessorySetup<T>;
+export declare const getTydomAccessorySetup: <T extends TydomAccessoryContext<any, any> = TydomAccessoryContext>(accessory: PlatformAccessory<T>, context: T) => TydomAccessorySetup<T>;
 export type TydomAccessoryUpdateType = 'data' | 'cdata';
 type TydomAccessoryUpdate<T extends TydomAccessoryContext> = (accessory: PlatformAccessory<T>, controller: TydomController, updates: Record<string, unknown>[], type: TydomAccessoryUpdateType) => void | Promise<void>;
-export declare const getTydomAccessoryDataUpdate: <T extends TydomAccessoryContext<any, any> = TydomAccessoryContext<{
-    [x: string]: unknown;
-}, {
-    [x: string]: unknown;
-}>>(accessory: PlatformAccessory<T>, context: T) => TydomAccessoryUpdate<T>;
+export declare const getTydomAccessoryDataUpdate: <T extends TydomAccessoryContext<any, any> = TydomAccessoryContext>(accessory: PlatformAccessory<T>, context: T) => TydomAccessoryUpdate<T>;
 export declare const setupAccessoryInformationService: (accessory: PlatformAccessory, _controller: TydomController) => void;
 export declare const setupAccessoryIdentifyHandler: (accessory: PlatformAccessory, _controller: TydomController) => void;
-export declare const assignTydomContext: (prev: PlatformAccessory['context'], next: TydomAccessoryContext) => prev is TydomAccessoryContext<{
-    [x: string]: unknown;
-}, {
-    [x: string]: unknown;
-}>;
+export declare const assignTydomContext: (prev: PlatformAccessory['context'], next: TydomAccessoryContext) => prev is TydomAccessoryContext;
 export {};

package/lib/helpers/accessory.js

@@ -15,6 +15,7 @@ const thermostat_1 = require("../accessories/thermostat");
 const windowCovering_1 = require("../accessories/windowCovering");
 const hap_1 = require("../config/hap");
 const utils_1 = require("../utils");
+const smokeDetector_1 = require("../accessories/smokeDetector");
 exports.SECURITY_SYSTEM_SENSORS = parseInt(`${11 /* Categories.SECURITY_SYSTEM */}0`);
 const getAccessoryService = (accessory, ServiceClass) => {
     const service = accessory.getService(ServiceClass);
@@ -23,7 +24,7 @@ const getAccessoryService = (accessory, ServiceClass) => {
 };
 exports.getAccessoryService = getAccessoryService;
 const getAccessoryServiceWithSubtype = (accessory, ServiceClass, subtype) => {
-    const service = accessory.getServiceByUUIDAndSubType(ServiceClass, subtype);
+    const service = accessory.getServiceById(ServiceClass, subtype);
     (0, utils_1.assert)(service, `Unexpected missing service "${ServiceClass.name}" with subtype="${subtype}" in accessory`);
     return service;
 };
@@ -36,6 +37,7 @@ const addAccessoryService = (accessory, service, name, removeExisting = false) =
         }
         accessory.removeService(existingService);
     }
+    // @ts-expect-error legacy HAP API
     return accessory.addService(service, name);
 };
 exports.addAccessoryService = addAccessoryService;
@@ -50,8 +52,9 @@ const addAccessoryServiceWithSubtype = (accessory, service, name, subtype, remov
     return accessory.addService(service, name, subtype);
 };
 exports.addAccessoryServiceWithSubtype = addAccessoryServiceWithSubtype;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const getTydomAccessorySetup = (accessory, context) => {
-    var _a;
+    var _a, _b;
     const { category } = accessory;
     switch (category) {
         case 5 /* Categories.LIGHTBULB */:
@@ -71,7 +74,7 @@ const getTydomAccessorySetup = (accessory, context) => {
         case 11 /* Categories.SECURITY_SYSTEM */:
             return securitySystem_1.setupSecuritySystem;
         case 10 /* Categories.SENSOR */:
-            return temperatureSensor_1.setupTemperatureSensor;
+            return ((_b = context.settings) === null || _b === void 0 ? void 0 : _b.smokeDetector) ? smokeDetector_1.setupSmokeDetector : temperatureSensor_1.setupTemperatureSensor;
         case 13 /* Categories.WINDOW */:
         case 12 /* Categories.DOOR */:
             return contactSensor_1.setupContactSensor;
@@ -82,8 +85,9 @@ const getTydomAccessorySetup = (accessory, context) => {
     }
 };
 exports.getTydomAccessorySetup = getTydomAccessorySetup;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 const getTydomAccessoryDataUpdate = (accessory, context) => {
-    var _a;
+    var _a, _b;
     const { category } = accessory;
     switch (category) {
         case 5 /* Categories.LIGHTBULB */:
@@ -103,7 +107,7 @@ const getTydomAccessoryDataUpdate = (accessory, context) => {
         case 11 /* Categories.SECURITY_SYSTEM */:
             return securitySystem_1.updateSecuritySystem;
         case 10 /* Categories.SENSOR */:
-            return temperatureSensor_1.updateTemperatureSensor;
+            return ((_b = context.settings) === null || _b === void 0 ? void 0 : _b.smokeDetector) ? smokeDetector_1.updateSmokeDetector : temperatureSensor_1.updateTemperatureSensor;
         case 13 /* Categories.WINDOW */:
         case 12 /* Categories.DOOR */:
             return contactSensor_1.updateContactSensor;

package/lib/helpers/tydom.js

@@ -104,7 +104,8 @@ const ENDPOINTS_SIGNATURES_CATEGORIES = {
     'others:449e2a60377094cde10224cee91d378fb0ae373ae6ceea0ac2cbc1ed011bffa7': 5 /* Categories.LIGHTBULB */,
     'plug:2534c497ff8fb013a88da28d341adff5bc0ba77e1fc8ea8dcb8b8f1c9d62ce19': 7 /* Categories.OUTLET */,
     'shutter:c3fe8e2afa864e1a7a5c6676b4287a7b2f2a886a466baec3df8a1ec4f898ad6c': 14 /* Categories.WINDOW_COVERING */,
-    'window:fb935867933d89b3058f09384f76fd63f3defb18cfb3172f60fa9f4f237f748b': 13 /* Categories.WINDOW */ // @mgcrea (MDO)
+    'window:fb935867933d89b3058f09384f76fd63f3defb18cfb3172f60fa9f4f237f748b': 13 /* Categories.WINDOW */,
+    'sensor:556f8aaf51e3807397b7e326d0aad4b61cceb8279166b50204f8a2e95464c9ba': [10 /* Categories.SENSOR */, { smokeDetector: true }] // DFR TYXAL+
 };
 const resolveEndpointCategory = ({ firstUsage, metadata, settings }) => {
     // Compute device signature

package/lib/typings/tydom.d.ts

@@ -145,6 +145,10 @@ export type TydomDeviceSecuritySystemData = [
     TydomDataElement<'irv3State', 'AVAILABLE' | 'UNAVAILABLE' | 'LOCKED'>,
     TydomDataElement<'irv4State', 'AVAILABLE' | 'UNAVAILABLE' | 'LOCKED'>
 ];
+export type TydomDeviceSmokeDetectorData = [
+    TydomDataElement<'techSmokeDefect', boolean>,
+    TydomDataElement<'battDefect', boolean>
+];
 export type TydomDeviceDataUpdateBody = {
     id: number;
     endpoints: {

package/lib/utils/error.d.ts

@@ -0,0 +1 @@
+export declare const stringifyError: (err: Error | unknown) => string;

package/lib/utils/error.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringifyError = void 0;
+const errorReplacer = (key, value) => {
+    if (value instanceof Error) {
+        return {
+            name: value.name,
+            message: value.message,
+            stack: value.stack
+        };
+    }
+    return `${value}`;
+};
+const stringifyError = (err) => JSON.stringify(err, errorReplacer);
+exports.stringifyError = stringifyError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-tydom",
-  "version": "0.23.14",
+  "version": "0.24.0",
   "description": "Homebridge plugin to manage Tydom devices by Delta Dore",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -31,32 +31,32 @@
     "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "chalk": "^4.0.0",
+    "chalk": "^4",
     "debug": "^4.3.4",
-    "fakegato-history": "^0.6.3",
+    "fakegato-history": "^0.6.4",
     "lodash": "^4.17.21",
     "source-map-support": "^0.5.21",
     "tydom-client": "^0.13.4"
   },
   "devDependencies": {
     "@tsconfig/node10": "^1.0.9",
-    "@types/debug": "^4.1.7",
-    "@types/jest": "^29.2.3",
-    "@types/lodash": "^4.14.190",
-    "@types/node": "^18.11.9",
-    "@types/node-persist": "^3.1.3",
-    "@types/ws": "^8.5.3",
-    "@typescript-eslint/eslint-plugin": "^5.44.0",
-    "@typescript-eslint/parser": "^5.44.0",
-    "eslint": "^8.28.0",
-    "eslint-config-prettier": "^8.5.0",
-    "eslint-plugin-prettier": "^4.2.1",
-    "homebridge": "^1.5.1",
-    "jest": "^29.3.1",
-    "nock": "^13.2.9",
-    "prettier": "^2.8.0",
+    "@types/debug": "^4.1.8",
+    "@types/jest": "^29.5.4",
+    "@types/lodash": "^4.14.197",
+    "@types/node": "^18.17.8",
+    "@types/node-persist": "^3.1.4",
+    "@types/ws": "^8.5.5",
+    "@typescript-eslint/eslint-plugin": "^6.4.1",
+    "@typescript-eslint/parser": "^6.4.1",
+    "eslint": "^8.47.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "homebridge": "^1.6.1",
+    "jest": "^29.6.3",
+    "nock": "^13.3.3",
+    "prettier": "^3.0.2",
     "ts-node": "^10.9.1",
-    "tsc-alias": "^1.7.1",
-    "typescript": "^4.9.3"
+    "tsc-alias": "^1.8.7",
+    "typescript": "^5.1.6"
   }
 }