homebridge-tydom 0.23.9 → 0.23.11

package/README.md

@@ -51,7 +51,7 @@
   "private": true,
   "description": "This file keeps track of which plugins should be installed.",
   "dependencies": {
-    "homebridge-tydom": "^0.15.1"
+    "homebridge-tydom": "^0.23.9"
   }
 }
 ```

package/lib/accessories/securitySystem.d.ts

@@ -7,6 +7,7 @@ type ZoneAliases = {
     night?: number[];
 };
 type SecuritySystemSettings = {
+    legacy?: boolean;
     aliases?: ZoneAliases;
     sensors?: boolean;
     pin?: string;

package/lib/accessories/securitySystem.js

@@ -12,13 +12,16 @@ const accessory_1 = require("../helpers/accessory");
 const tydom_1 = require("../helpers/tydom");
 const utils_1 = require("../utils");
 const debug_1 = require("../utils/debug");
-const getActiveZones = (alarmData) => alarmData.reduce((soFar, { name, value }) => {
-    const matches = name.match(/zone([1-8])State/i);
-    if (matches && value === 'ON') {
-        soFar.push((0, utils_1.asNumber)(matches[1]));
-    }
-    return soFar;
-}, []);
+const getActiveZones = (alarmData, settings) => {
+    const { legacy } = settings;
+    return alarmData.reduce((soFar, { name, value }) => {
+        const matches = name.match(!legacy ? /zone([1-8])State/i : /part([1-4])State/i);
+        if (matches && value === 'ON') {
+            soFar.push((0, utils_1.asNumber)(matches[1]));
+        }
+        return soFar;
+    }, []);
+};
 const getStateForActiveZones = (activeZones, zoneAliases) => {
     const { SecuritySystemCurrentState } = hap_1.Characteristic;
     if (zoneAliases.stay && (0, utils_1.sameArrays)(activeZones, zoneAliases.stay)) {
@@ -29,7 +32,7 @@ const getStateForActiveZones = (activeZones, zoneAliases) => {
     }
     return SecuritySystemCurrentState.DISARMED;
 };
-const getStateForAlarmData = (alarmData, zoneAliases) => {
+const getStateForAlarmData = (alarmData, zoneAliases, settings) => {
     const { SecuritySystemCurrentState } = hap_1.Characteristic;
     const alarmMode = (0, tydom_1.getTydomDataPropValue)(alarmData, 'alarmMode');
     const alarmState = (0, tydom_1.getTydomDataPropValue)(alarmData, 'alarmState');
@@ -39,20 +42,20 @@ const getStateForAlarmData = (alarmData, zoneAliases) => {
     if (alarmMode === 'ON') {
         return SecuritySystemCurrentState.AWAY_ARM;
     }
-    if (alarmMode === 'ZONE') {
-        const activeZones = getActiveZones(alarmData);
+    if (['ZONE', 'PART'].includes(alarmMode)) {
+        const activeZones = getActiveZones(alarmData, settings);
         return getStateForActiveZones(activeZones, zoneAliases);
     }
     return SecuritySystemCurrentState.DISARMED;
 };
 const setupSecuritySystem = async (accessory, controller) => {
     const { context } = accessory;
-    const { client } = controller;
+    const { client, log } = controller;
     const { SecuritySystemTargetState, SecuritySystemCurrentState, StatusTampered, ContactSensorState, On } = hap_1.Characteristic;
     const { deviceId, endpointId, settings } = context;
     (0, accessory_1.setupAccessoryInformationService)(accessory, controller);
     (0, accessory_1.setupAccessoryIdentifyHandler)(accessory, controller);
-    const { aliases = {}, pin: settingsPin } = settings;
+    const { aliases = {}, pin: settingsPin, legacy: isLegacy = false } = settings;
     // Create separate dedicated sensor extra accessory;
     if (settings.sensors !== false) {
         const { accessoryId } = context;
@@ -64,13 +67,32 @@ const setupSecuritySystem = async (accessory, controller) => {
         };
         controller.emit('device', extraDevice);
     }
+    let zones = [];
     const initialData = await (0, tydom_1.getTydomDeviceData)(client, { deviceId, endpointId });
-    const labelResults = await client.command(`/devices/${deviceId}/endpoints/${endpointId}/cdata?name=label`);
-    const { zones } = labelResults[0];
+    if (!isLegacy) {
+        try {
+            const labelResults = await client.command(`/devices/${deviceId}/endpoints/${endpointId}/cdata?name=label`);
+            zones = labelResults[0].zones;
+        }
+        catch (err) {
+            log.warn(`Failed to query labels for security system`);
+            zones = [];
+        }
+    }
+    else {
+        log.warn(`Setting up legacy zones`);
+        // @NOTE could filter "UNUSED" zones from initialData
+        zones = [
+            { id: 1, nameCustom: 'Zone 1' },
+            { id: 2, nameCustom: 'Zone 2' },
+            { id: 3, nameCustom: 'Zone 3' },
+            { id: 4, nameCustom: 'Zone 4' }
+        ];
+    }
     // Pin code check
     const pin = env_1.HOMEBRIDGE_TYDOM_PIN ? (0, utils_1.decode)(env_1.HOMEBRIDGE_TYDOM_PIN) : settingsPin;
     if (!pin) {
-        controller.log.warn(`Missing pin for device securitySystem, add either {"settings": {"${deviceId}": {"pin": "123456"}}} or HOMEBRIDGE_TYDOM_PIN env var (base64 encoded)`);
+        log.warn(`Missing pin for device securitySystem, add either {"settings": {"${deviceId}": {"pin": "123456"}}} or HOMEBRIDGE_TYDOM_PIN env var (base64 encoded)`);
     }
     // Add the actual accessory Service
     const service = (0, accessory_1.addAccessoryService)(accessory, hap_1.Service.SecuritySystem, `${accessory.displayName}`, true);
@@ -81,7 +103,7 @@ const setupSecuritySystem = async (accessory, controller) => {
         (0, debug_1.debugGet)(SecuritySystemCurrentState, service);
         try {
             const data = await (0, tydom_1.getTydomDeviceData)(client, { deviceId, endpointId });
-            const nextValue = getStateForAlarmData(data, aliases);
+            const nextValue = getStateForAlarmData(data, aliases, settings);
             (0, debug_1.debugGetResult)(SecuritySystemCurrentState, service, nextValue);
             callback(null, nextValue);
         }
@@ -111,7 +133,7 @@ const setupSecuritySystem = async (accessory, controller) => {
         (0, debug_1.debugGet)(SecuritySystemTargetState, service);
         try {
             const data = await (0, tydom_1.getTydomDeviceData)(client, { deviceId, endpointId });
-            const nextValue = getStateForAlarmData(data, aliases);
+            const nextValue = getStateForAlarmData(data, aliases, settings);
             (0, debug_1.debugGetResult)(SecuritySystemTargetState, service, nextValue);
             callback(null, nextValue);
         }
@@ -132,10 +154,20 @@ const setupSecuritySystem = async (accessory, controller) => {
         // Global ON/OFF
         if ([SecuritySystemTargetState.AWAY_ARM, SecuritySystemTargetState.DISARM].includes(value)) {
             const tydomValue = value === SecuritySystemTargetState.DISARM ? 'OFF' : 'ON';
-            await client.put(`/devices/${deviceId}/endpoints/${endpointId}/cdata?name=alarmCmd`, {
-                value: tydomValue,
-                pwd: pin
-            });
+            if (!isLegacy) {
+                await client.put(`/devices/${deviceId}/endpoints/${endpointId}/cdata?name=alarmCmd`, {
+                    value: tydomValue,
+                    pwd: pin
+                });
+            }
+            else {
+                for (const zone in [1, 2, 3, 4]) {
+                    await client.put(`/devices/${deviceId}/endpoints/${endpointId}/cdata?name=partCmd`, {
+                        value: tydomValue,
+                        part: zone
+                    });
+                }
+            }
             (0, debug_1.debugSetResult)(SecuritySystemTargetState, service, value, tydomValue);
             callback();
             return;
@@ -145,11 +177,21 @@ const setupSecuritySystem = async (accessory, controller) => {
             const tydomValue = value === SecuritySystemTargetState.DISARM ? 'OFF' : 'ON';
             const targetZones = value === SecuritySystemTargetState.STAY_ARM ? aliases.stay : aliases.night;
             if (Array.isArray(targetZones) && targetZones.length > 0) {
-                await client.put(`/devices/${deviceId}/endpoints/${endpointId}/cdata?name=zoneCmd`, {
-                    value: tydomValue,
-                    pwd: pin,
-                    zones: targetZones
-                });
+                if (!isLegacy) {
+                    await client.put(`/devices/${deviceId}/endpoints/${endpointId}/cdata?name=zoneCmd`, {
+                        value: tydomValue,
+                        pwd: pin,
+                        zones: targetZones
+                    });
+                }
+                else {
+                    for (const zone in targetZones) {
+                        await client.put(`/devices/${deviceId}/endpoints/${endpointId}/cdata?name=partCmd`, {
+                            value: tydomValue,
+                            part: zone
+                        });
+                    }
+                }
             }
             (0, debug_1.debugSetResult)(SecuritySystemTargetState, service, value, tydomValue);
             callback();
@@ -347,8 +389,9 @@ const updateSecuritySystem = (accessory, controller, updates, type) => {
                         service.updateCharacteristic(SecuritySystemCurrentState, nextValue);
                         return;
                     }
+                    case 'PART':
                     case 'ZONE': {
-                        const activeZones = getActiveZones(updates);
+                        const activeZones = getActiveZones(updates, settings);
                         const nextValue = getStateForActiveZones(activeZones, aliases);
                         (0, debug_1.debugSetUpdate)(SecuritySystemCurrentState, service, nextValue);
                         service.updateCharacteristic(SecuritySystemCurrentState, nextValue);

package/lib/bin/cli.js

@@ -4,25 +4,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const fs_1 = require("fs");
 const tydom_1 = require("../helpers/tydom");
 const utils_1 = require("../utils");
-const [action = 'help', ..._args] = process.argv.slice(2);
-console.dir({ action });
+const [action = 'help', ...args] = process.argv.slice(2);
+const [filename] = args;
+console.dir({ action, args });
 const main = async () => {
     switch (action) {
         case 'dump': {
-            const stdin = (0, fs_1.readFileSync)(process.stdin.fd);
+            const stdin = (0, fs_1.readFileSync)(filename || process.stdin.fd);
             const dump = JSON.parse(stdin.toString('utf8'));
             const allDevicesConfig = dump['/configs/file'];
             const allDevicesMeta = dump['/devices/meta'];
             for (const deviceMeta of allDevicesMeta) {
-                const signature = (0, tydom_1.getEndpointSignatureFromMetadata)(deviceMeta.endpoints[0].metadata);
-                const config = allDevicesConfig.endpoints.find((item) => item.id_device === deviceMeta.id);
-                const hash = `${config === null || config === void 0 ? void 0 : config.first_usage}:${await (0, utils_1.sha256)(signature)}`;
-                console.dir({ id: config === null || config === void 0 ? void 0 : config.id_device, name: config === null || config === void 0 ? void 0 : config.name, signature, hash });
+                for (const endpointMeta of deviceMeta.endpoints) {
+                    const signature = (0, tydom_1.getEndpointSignatureFromMetadata)(endpointMeta.metadata);
+                    const config = allDevicesConfig.endpoints.find((item) => item.id_device === deviceMeta.id && item.id_endpoint === endpointMeta.id);
+                    const hash = `${config === null || config === void 0 ? void 0 : config.first_usage}:${await (0, utils_1.sha256)(signature)}`;
+                    console.dir({ id: `${deviceMeta.id}.${endpointMeta.id}`, name: config === null || config === void 0 ? void 0 : config.name, signature, hash });
+                }
             }
             break;
         }
         case 'hash': {
-            const stdin = (0, fs_1.readFileSync)(process.stdin.fd);
+            const stdin = (0, fs_1.readFileSync)(filename || process.stdin.fd);
             const meta = JSON.parse(stdin.toString('utf8'));
             const metaSignature = (0, tydom_1.getEndpointSignatureFromMetadata)(meta);
             const hash = (0, utils_1.sha256Sync)(metaSignature);

package/lib/controller.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
-import type { Categories, Logging } from 'homebridge';
+import { Categories, Logging } from 'homebridge';
 import TydomClient from 'tydom-client';
 import { TydomHttpMessage, TydomResponse } from 'tydom-client/lib/utils/tydom';
 import { TydomPlatformConfig } from './platform';
@@ -25,7 +25,8 @@ export default class TydomController extends EventEmitter {
     private state;
     private refreshInterval?;
     constructor(log: Logging, config: TydomPlatformConfig);
-    getAccessoryId(deviceId: number): string;
+    getUniqueId(deviceId: number, endpointId: number): string;
+    getAccessoryId(deviceId: number, endpointId: number): string;
     connect(): Promise<void>;
     sync(): Promise<{
         config: TydomConfigResponse;

package/lib/controller.js

@@ -43,9 +43,12 @@ class TydomController extends events_1.EventEmitter {
             this.emit('disconnect');
         });
     }
-    getAccessoryId(deviceId) {
+    getUniqueId(deviceId, endpointId) {
+        return deviceId === endpointId ? `${deviceId}` : `${deviceId}:${endpointId}`;
+    }
+    getAccessoryId(deviceId, endpointId) {
         const { username } = this.config;
-        return `tydom:${username.slice(6)}:accessories:${deviceId}`;
+        return `tydom:${username.slice(6)}:accessories:${this.getUniqueId(deviceId, endpointId)}`;
     }
     async connect() {
         const { hostname, username } = this.config;
@@ -95,6 +98,7 @@ class TydomController extends events_1.EventEmitter {
         const { endpoints, groups: configGroups } = config;
         endpoints.forEach((endpoint) => {
             const { id_endpoint: endpointId, id_device: deviceId, name: deviceName, first_usage: firstUsage } = endpoint;
+            const uniqueId = this.getUniqueId(deviceId, endpointId);
             const { metadata } = (0, tydom_1.getEndpointDetailsFromMeta)(endpoint, meta);
             const groupId = (0, tydom_1.getEndpointGroupIdFromGroups)(endpoint, groups);
             const group = groupId ? configGroups.find(({ id }) => id === groupId) : undefined;
@@ -108,7 +112,7 @@ class TydomController extends events_1.EventEmitter {
             if (excludedDevices.length && (0, utils_1.stringIncludes)(excludedDevices, deviceId)) {
                 return;
             }
-            const category = categoryFromSettings || (0, tydom_1.resolveEndpointCategory)({ firstUsage, metadata });
+            const category = categoryFromSettings || (0, tydom_1.resolveEndpointCategory)({ firstUsage, metadata, settings: deviceSettings });
             if (!category) {
                 this.log.warn(`Unsupported firstUsage="${firstUsage}" for endpoint with deviceId="${deviceId}"`);
                 (0, utils_1.debug)({ endpoint });
@@ -120,12 +124,12 @@ class TydomController extends events_1.EventEmitter {
             if (excludedCategories.length && (0, utils_1.stringIncludes)(excludedCategories, category)) {
                 return;
             }
-            if (!this.devices.has(deviceId)) {
+            if (!this.devices.has(uniqueId)) {
                 this.log.info(`Adding new device with firstUsage=${(0, utils_1.chalkString)(firstUsage)}, deviceId=${(0, utils_1.chalkNumber)(deviceId)} and endpointId=${(0, utils_1.chalkNumber)(endpointId)}`);
-                const accessoryId = this.getAccessoryId(deviceId);
+                const accessoryId = this.getAccessoryId(deviceId, endpointId);
                 const nameFromSetting = (0, lodash_1.get)(settings, `${deviceId}.name`);
                 const name = nameFromSetting || deviceName;
-                this.devices.set(deviceId, category);
+                this.devices.set(uniqueId, category);
                 const context = {
                     name,
                     category,
@@ -168,27 +172,31 @@ class TydomController extends events_1.EventEmitter {
             return;
         }
         body.forEach((device) => {
+            var _a;
             const { id: deviceId, endpoints } = device;
-            if (!this.devices.has(deviceId)) {
-                (0, utils_1.debug)(`${chalk_1.default.bold.yellow('←PUT')}:${chalk_1.default.blue('ignored')} for device id=${(0, utils_1.chalkString)(deviceId)}, endpoints:\n${(0, utils_1.chalkJson)(endpoints)}`);
-                return;
+            for (const endpoint of endpoints) {
+                const { id: endpointId, data, cdata } = endpoint;
+                const updates = type === 'data' ? data : cdata;
+                const uniqueId = this.getUniqueId(deviceId, endpointId);
+                if (!this.devices.has(uniqueId)) {
+                    (0, utils_1.debug)(`${chalk_1.default.bold.yellow('←PUT')}:${chalk_1.default.blue('ignored')} for device id=${(0, utils_1.chalkString)(deviceId)} and endpointId=${(0, utils_1.chalkNumber)(endpointId)}`);
+                    return;
+                }
+                const category = (_a = this.devices.get(uniqueId)) !== null && _a !== void 0 ? _a : 1 /* Categories.OTHER */;
+                const accessoryId = this.getAccessoryId(deviceId, endpointId);
+                (0, utils_1.debug)(`${chalk_1.default.bold.green('←PUT')}:${chalk_1.default.blue('update')} for deviceId=${(0, utils_1.chalkNumber)(deviceId)} and endpointId=${(0, utils_1.chalkNumber)(endpointId)}, updates:\n${(0, utils_1.chalkJson)(updates)}`);
+                const context = {
+                    category,
+                    deviceId,
+                    endpointId,
+                    accessoryId
+                };
+                this.emit('update', {
+                    type,
+                    updates,
+                    context
+                });
             }
-            const category = this.devices.get(deviceId);
-            const { id: endpointId, data, cdata } = endpoints[0];
-            const updates = type === 'data' ? data : cdata;
-            const accessoryId = this.getAccessoryId(deviceId);
-            (0, utils_1.debug)(`${chalk_1.default.bold.green('←PUT')}:${chalk_1.default.blue('update')} for device id=${(0, utils_1.chalkString)(deviceId)}, updates:\n${(0, utils_1.chalkJson)(updates)}`);
-            const context = {
-                category,
-                deviceId,
-                endpointId,
-                accessoryId
-            };
-            this.emit('update', {
-                type,
-                updates,
-                context
-            });
         });
     }
 }

package/lib/helpers/tydom.d.ts

@@ -21,7 +21,8 @@ export declare const getEndpointSignatureFromMetadata: (metadata: TydomMetaEleme
 type ResolveEndpointCategoryOptions = {
     firstUsage: string;
     metadata: TydomMetaElement[];
+    settings: Record<string, unknown>;
 };
-export declare const resolveEndpointCategory: ({ firstUsage, metadata }: ResolveEndpointCategoryOptions) => Categories | null;
+export declare const resolveEndpointCategory: ({ firstUsage, metadata, settings }: ResolveEndpointCategoryOptions) => Categories | null;
 export declare const asyncWait: (ms: number) => Promise<void>;
 export {};

package/lib/helpers/tydom.js

@@ -86,7 +86,10 @@ const LEGACY_SUPPORTED_CATEGORIES_MAP = {
 };
 const ENDPOINTS_SIGNATURES_CATEGORIES = {
     'alarm:0c6e1d33808fa50a0a921502f80d36430dfaeda5abfed2467f9f2b07821e4842': 11 /* Categories.SECURITY_SYSTEM */,
-    'alarm:6e33f7ee5e62b58f4e888c91a13fd9b9d868f3751cead5ea1252578ba86523a5': 11 /* Categories.SECURITY_SYSTEM */,
+    'alarm:6e33f7ee5e62b58f4e888c91a13fd9b9d868f3751cead5ea1252578ba86523a5': [
+        11 /* Categories.SECURITY_SYSTEM */,
+        { legacy: true }
+    ],
     'alarm:aad768ee0367013a974276117fd5ed4834cc26e4d31acc88d35134731331b0e7': 11 /* Categories.SECURITY_SYSTEM */,
     'awning:48f43ebab20eba438fa9cc2b6ce44311d3cfb01c5be84bf17599d9c152c348d3': 14 /* Categories.WINDOW_COVERING */,
     'belmDoor:fb935867933d89b3058f09384f76fd63f3defb18cfb3172f60fa9f4f237f748b': 12 /* Categories.DOOR */,
@@ -96,7 +99,6 @@ const ENDPOINTS_SIGNATURES_CATEGORIES = {
     'hvac:16804a9994bce28275150db329a9c0b931ef7f20608c1a3d2ff248f58569f0d3': 10 /* Categories.SENSOR */,
     'hvac:17f933bec8ed29f9b2a2cd5280fb5b64806cf8a1c064c83950e350f491d7cb9f': 9 /* Categories.THERMOSTAT */,
     'hvac:1bab47d1dd7e898b5dc2e9867b14dfb8bc9272c4cb0b5d1221da962d43a6ffb4': 9 /* Categories.THERMOSTAT */,
-    'hvac:e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855': 10 /* Categories.SENSOR */,
     'light:449e2a60377094cde10224cee91d378fb0ae373ae6ceea0ac2cbc1ed011bffa7': 5 /* Categories.LIGHTBULB */,
     'light:fce45085835f4f2790ea3b17d208b5ace34935444d2535e75ba3f0a2ce86de5f': 5 /* Categories.LIGHTBULB */,
     'others:449e2a60377094cde10224cee91d378fb0ae373ae6ceea0ac2cbc1ed011bffa7': 5 /* Categories.LIGHTBULB */,
@@ -104,13 +106,20 @@ const ENDPOINTS_SIGNATURES_CATEGORIES = {
     'shutter:c3fe8e2afa864e1a7a5c6676b4287a7b2f2a886a466baec3df8a1ec4f898ad6c': 14 /* Categories.WINDOW_COVERING */,
     'window:fb935867933d89b3058f09384f76fd63f3defb18cfb3172f60fa9f4f237f748b': 13 /* Categories.WINDOW */ // @mgcrea (MDO)
 };
-const resolveEndpointCategory = ({ firstUsage, metadata }) => {
+const resolveEndpointCategory = ({ firstUsage, metadata, settings }) => {
     // Compute device signature
     const metaSignature = (0, exports.getEndpointSignatureFromMetadata)(metadata);
     const hash = `${firstUsage}:${(0, utils_1.sha256Sync)(metaSignature)}`;
     // dir({metaSignature, hash});
-    if (ENDPOINTS_SIGNATURES_CATEGORIES[hash]) {
-        return ENDPOINTS_SIGNATURES_CATEGORIES[hash];
+    const category = ENDPOINTS_SIGNATURES_CATEGORIES[hash];
+    if (category) {
+        // Support settings override
+        if (Array.isArray(category)) {
+            const [_category, overrides] = category;
+            Object.assign(settings, overrides);
+            return _category;
+        }
+        return category;
     }
     (0, utils_1.debug)(`Unknown hash=${hash} with firstUsage="${firstUsage}"`);
     // Fallback on legacy resolution

package/lib/typings/tydom.d.ts

@@ -162,12 +162,13 @@ export type SecuritySystemProduct = {
     nameCustom?: string;
     number?: number;
 };
+export type SecuritySystemLabelCommandResultZone = {
+    id: number;
+    nameStd?: string;
+    nameCustom?: string;
+};
 export type SecuritySystemLabelCommandResult = {
-    zones: {
-        id: number;
-        nameStd?: string;
-        nameCustom?: string;
-    }[];
+    zones: SecuritySystemLabelCommandResultZone[];
     products: SecuritySystemProduct[];
 };
 export type SecuritySystemHistoOpenIssuesCommandResult = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-tydom",
-  "version": "0.23.9",
+  "version": "0.23.11",
   "description": "Homebridge plugin to manage Tydom devices by Delta Dore",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",