zigbee-herdsman 5.0.4 → 6.0.1

package/src/controller/model/device.ts

@@ -1,5 +1,4 @@
 import assert from "node:assert";
-
 import type {Events as AdapterEvents} from "../../adapter";
 import type {LQINeighbor, RoutingTableEntry} from "../../adapter/tstype";
 import {wait} from "../../utils";
@@ -8,6 +7,7 @@ import * as ZSpec from "../../zspec";
 import {BroadcastAddress} from "../../zspec/enums";
 import type {Eui64} from "../../zspec/tstypes";
 import * as Zcl from "../../zspec/zcl";
+import type {TPartialClusterAttributes} from "../../zspec/zcl/definition/clusters-types";
 import type {ClusterDefinition, CustomClusters} from "../../zspec/zcl/definition/tstype";
 import * as Zdo from "../../zspec/zdo";
 import type {ControllerEventMap} from "../controller";
@@ -23,6 +23,18 @@ const OneJanuary2000 = new Date("January 01, 2000 00:00:00 UTC+00:00").getTime()
 
 const NS = "zh:controller:device";
 
+const INTERVIEW_GENBASIC_ATTRIBUTES = [
+    "modelId",
+    "manufacturerName",
+    "powerSource",
+    "zclVersion",
+    "appVersion",
+    "stackVersion",
+    "hwVersion",
+    "dateCode",
+    "swBuildId",
+] as const;
+
 interface Lqi {
     neighbors: {
         ieeeAddr: string;
@@ -49,22 +61,14 @@ export enum InterviewState {
 export class Device extends Entity<ControllerEventMap> {
     // biome-ignore lint/style/useNamingConvention: cross-repo impact
     private readonly ID: number;
-    private _applicationVersion?: number;
-    private _dateCode?: string;
+    #genBasic: TPartialClusterAttributes<"genBasic"> = {};
     private _endpoints: Endpoint[];
-    private _hardwareVersion?: number;
     private _ieeeAddr: string;
     private _interviewState: InterviewState;
     private _lastSeen?: number;
     private _manufacturerID?: number;
-    private _manufacturerName?: string;
-    private _modelID?: string;
     private _networkAddress: number;
-    private _powerSource?: string;
-    private _softwareBuildID?: string;
-    private _stackVersion?: number;
     private _type: DeviceType;
-    private _zclVersion?: number;
     private _linkquality?: number;
     private _skipDefaultResponse: boolean;
     private _customReadResponse?: CustomReadResponse;
@@ -82,10 +86,10 @@ export class Device extends Entity<ControllerEventMap> {
         this._ieeeAddr = ieeeAddr;
     }
     get applicationVersion(): number | undefined {
-        return this._applicationVersion;
+        return this.#genBasic.appVersion;
     }
-    set applicationVersion(applicationVersion: number) {
-        this._applicationVersion = applicationVersion;
+    set applicationVersion(version: number) {
+        this.#genBasic.appVersion = version;
     }
     get endpoints(): Endpoint[] {
         return this._endpoints;
@@ -109,28 +113,28 @@ export class Device extends Entity<ControllerEventMap> {
         return this._type;
     }
     get dateCode(): string | undefined {
-        return this._dateCode;
+        return this.#genBasic.dateCode;
     }
-    set dateCode(dateCode: string) {
-        this._dateCode = dateCode;
+    set dateCode(code: string) {
+        this.#genBasic.dateCode = code;
     }
-    set hardwareVersion(hardwareVersion: number) {
-        this._hardwareVersion = hardwareVersion;
+    set hardwareVersion(version: number) {
+        this.#genBasic.hwVersion = version;
     }
     get hardwareVersion(): number | undefined {
-        return this._hardwareVersion;
+        return this.#genBasic.hwVersion;
     }
     get manufacturerName(): string | undefined {
-        return this._manufacturerName;
+        return this.#genBasic.manufacturerName;
     }
-    set manufacturerName(manufacturerName: string | undefined) {
-        this._manufacturerName = manufacturerName;
+    set manufacturerName(name: string | undefined) {
+        this.#genBasic.manufacturerName = name;
     }
-    set modelID(modelID: string) {
-        this._modelID = modelID;
+    set modelID(id: string) {
+        this.#genBasic.modelId = id;
     }
     get modelID(): string | undefined {
-        return this._modelID;
+        return this.#genBasic.modelId;
     }
     get networkAddress(): number {
         return this._networkAddress;
@@ -147,28 +151,39 @@ export class Device extends Entity<ControllerEventMap> {
         }
     }
     get powerSource(): string | undefined {
-        return this._powerSource;
+        return this.#genBasic.powerSource ? Zcl.POWER_SOURCES[this.#genBasic.powerSource] : undefined;
     }
-    set powerSource(powerSource: string) {
-        this._powerSource = typeof powerSource === "number" ? Zcl.POWER_SOURCES[powerSource & ~(1 << 7)] : powerSource;
+    set powerSource(source: string | number) {
+        if (typeof source === "number") {
+            this.#genBasic.powerSource = source & ~(1 << 7);
+        } else {
+            for (const key in Zcl.POWER_SOURCES) {
+                const val = Zcl.POWER_SOURCES[key];
+
+                if (val === source) {
+                    this.#genBasic.powerSource = Number(key);
+                    break;
+                }
+            }
+        }
     }
     get softwareBuildID(): string | undefined {
-        return this._softwareBuildID;
+        return this.#genBasic.swBuildId;
     }
-    set softwareBuildID(softwareBuildID: string) {
-        this._softwareBuildID = softwareBuildID;
+    set softwareBuildID(id: string) {
+        this.#genBasic.swBuildId = id;
     }
     get stackVersion(): number | undefined {
-        return this._stackVersion;
+        return this.#genBasic.stackVersion;
     }
-    set stackVersion(stackVersion: number) {
-        this._stackVersion = stackVersion;
+    set stackVersion(version: number) {
+        this.#genBasic.stackVersion = version;
     }
     get zclVersion(): number | undefined {
-        return this._zclVersion;
+        return this.#genBasic.zclVersion;
     }
-    set zclVersion(zclVersion: number) {
-        this._zclVersion = zclVersion;
+    set zclVersion(version: number) {
+        this.#genBasic.zclVersion = version;
     }
     get linkquality(): number | undefined {
         return this._linkquality;
@@ -208,6 +223,9 @@ export class Device extends Entity<ControllerEventMap> {
     get gpSecurityKey(): number[] | undefined {
         return this._gpSecurityKey;
     }
+    get genBasic(): TPartialClusterAttributes<"genBasic"> {
+        return this.#genBasic;
+    }
 
     public meta: KeyValue;
 
@@ -218,77 +236,6 @@ export class Device extends Entity<ControllerEventMap> {
     private static readonly deletedDevices: Map<string /* IEEE */, Device> = new Map();
     private static readonly nwkToIeeeCache: Map<number /* nwk addr */, string /* IEEE */> = new Map();
 
-    public static readonly REPORTABLE_PROPERTIES_MAPPING: {
-        [s: string]: {
-            set: (value: string | number, device: Device) => void;
-            key:
-                | "modelID"
-                | "manufacturerName"
-                | "applicationVersion"
-                | "zclVersion"
-                | "powerSource"
-                | "stackVersion"
-                | "dateCode"
-                | "softwareBuildID"
-                | "hardwareVersion";
-        };
-    } = {
-        modelId: {
-            key: "modelID",
-            set: (v: string | number, d: Device): void => {
-                d.modelID = v as string;
-            },
-        },
-        manufacturerName: {
-            key: "manufacturerName",
-            set: (v: string | number, d: Device): void => {
-                d.manufacturerName = v as string;
-            },
-        },
-        powerSource: {
-            key: "powerSource",
-            set: (v: string | number, d: Device): void => {
-                d.powerSource = v as string;
-            },
-        },
-        zclVersion: {
-            key: "zclVersion",
-            set: (v: string | number, d: Device): void => {
-                d.zclVersion = v as number;
-            },
-        },
-        appVersion: {
-            key: "applicationVersion",
-            set: (v: string | number, d: Device): void => {
-                d.applicationVersion = v as number;
-            },
-        },
-        stackVersion: {
-            key: "stackVersion",
-            set: (v: string | number, d: Device): void => {
-                d.stackVersion = v as number;
-            },
-        },
-        hwVersion: {
-            key: "hardwareVersion",
-            set: (v: string | number, d: Device): void => {
-                d.hardwareVersion = v as number;
-            },
-        },
-        dateCode: {
-            key: "dateCode",
-            set: (v: string | number, d: Device): void => {
-                d.dateCode = v as string;
-            },
-        },
-        swBuildId: {
-            key: "softwareBuildID",
-            set: (v: string | number, d: Device): void => {
-                d.softwareBuildID = v as string;
-            },
-        },
-    };
-
     private constructor(
         id: number,
         type: DeviceType,
@@ -319,15 +266,15 @@ export class Device extends Entity<ControllerEventMap> {
         this._networkAddress = networkAddress;
         this._manufacturerID = manufacturerID;
         this._endpoints = endpoints;
-        this._manufacturerName = manufacturerName;
-        this._powerSource = powerSource;
-        this._modelID = modelID;
-        this._applicationVersion = applicationVersion;
-        this._stackVersion = stackVersion;
-        this._zclVersion = zclVersion;
-        this._hardwareVersion = hardwareVersion;
-        this._dateCode = dateCode;
-        this._softwareBuildID = softwareBuildID;
+        this.#genBasic.manufacturerName = manufacturerName;
+        this.powerSource = powerSource ?? Zcl.PowerSource.Unknown;
+        this.#genBasic.modelId = modelID;
+        this.#genBasic.appVersion = applicationVersion;
+        this.#genBasic.stackVersion = stackVersion;
+        this.#genBasic.zclVersion = zclVersion;
+        this.#genBasic.hwVersion = hardwareVersion;
+        this.#genBasic.dateCode = dateCode;
+        this.#genBasic.swBuildId = softwareBuildID;
         this._interviewState = interviewState;
         this._skipDefaultResponse = false;
         this.meta = meta;
@@ -370,6 +317,10 @@ export class Device extends Entity<ControllerEventMap> {
         return this.endpoints.find((d): boolean => d.deviceID === deviceID);
     }
 
+    public updateGenBasic(data: TPartialClusterAttributes<"genBasic">): void {
+        Object.assign(this.#genBasic, data);
+    }
+
     public implicitCheckin(): void {
         // No need to do anythign in `catch` as `endpoint.sendRequest` already logs failures.
         Promise.allSettled(this.endpoints.map((e) => e.sendPendingRequests(false))).catch(() => {});
@@ -439,12 +390,16 @@ export class Device extends Entity<ControllerEventMap> {
         if (frame.header.isSpecific && frame.isCluster("genPollCtrl") && frame.isCommand("checkin")) {
             try {
                 if (this.hasPendingRequests() || this._checkinInterval === undefined) {
-                    const payload = {
-                        startFastPolling: true,
-                        fastPollTimeout: 0,
-                    };
                     logger.debug(`check-in from ${this.ieeeAddr}: accepting fast-poll`, NS);
-                    await endpoint.command(frame.cluster.ID, "checkinRsp", payload, {sendPolicy: "immediate"});
+                    await endpoint.command(
+                        frame.cluster.name as "genPollCtrl",
+                        "checkinRsp",
+                        {
+                            startFastPolling: 1,
+                            fastPollTimeout: 0,
+                        },
+                        {sendPolicy: "immediate"},
+                    );
 
                     // This is a good time to read the checkin interval if we haven't stored it previously
                     if (this._checkinInterval === undefined) {
@@ -458,14 +413,18 @@ export class Device extends Entity<ControllerEventMap> {
                     // We *must* end fast-poll when we're done sending things. Otherwise
                     // we cause undue power-drain.
                     logger.debug(`check-in from ${this.ieeeAddr}: stopping fast-poll`, NS);
-                    await endpoint.command(frame.cluster.ID, "fastPollStop", {}, {sendPolicy: "immediate"});
+                    await endpoint.command(frame.cluster.name as "genPollCtrl", "fastPollStop", {}, {sendPolicy: "immediate"});
                 } else {
-                    const payload = {
-                        startFastPolling: false,
-                        fastPollTimeout: 0,
-                    };
                     logger.debug(`check-in from ${this.ieeeAddr}: declining fast-poll`, NS);
-                    await endpoint.command(frame.cluster.ID, "checkinRsp", payload, {sendPolicy: "immediate"});
+                    await endpoint.command(
+                        frame.cluster.name as "genPollCtrl",
+                        "checkinRsp",
+                        {
+                            startFastPolling: 0,
+                            fastPollTimeout: 0,
+                        },
+                        {sendPolicy: "immediate"},
+                    );
                 }
             } catch (error) {
                 logger.error(`Handling of poll check-in from ${this.ieeeAddr} failed (${(error as Error).message})`, NS);
@@ -794,7 +753,7 @@ export class Device extends Entity<ControllerEventMap> {
             this.manufacturerName === "HOBEIAN" ||
             (this.modelID?.match("^TS\\d*$") && (this.manufacturerName?.match("^_TZ.*_.*$") || this.manufacturerName?.match("^_TYZB01_.*$")))
         ) {
-            this._powerSource = this._powerSource ?? "Battery";
+            this.#genBasic.powerSource = this.#genBasic.powerSource || Zcl.PowerSource.Battery;
             logger.debug("Interview - quirks matched for Tuya end device", NS);
             return true;
         }
@@ -807,24 +766,24 @@ export class Device extends Entity<ControllerEventMap> {
                 type?: DeviceType;
                 manufacturerID?: number;
                 manufacturerName?: string;
-                powerSource?: string;
+                powerSource?: Zcl.PowerSource;
             };
         } = {
             "^3R.*?Z": {
                 type: "EndDevice",
-                powerSource: "Battery",
+                powerSource: Zcl.PowerSource.Battery,
             },
             "lumi..*": {
                 type: "EndDevice",
                 manufacturerID: 4151,
                 manufacturerName: "LUMI",
-                powerSource: "Battery",
+                powerSource: Zcl.PowerSource.Battery,
             },
             "TERNCY-PP01": {
                 type: "EndDevice",
                 manufacturerID: 4648,
                 manufacturerName: "TERNCY",
-                powerSource: "Battery",
+                powerSource: Zcl.PowerSource.Battery,
             },
             "3RWS18BZ": {}, // https://github.com/Koenkk/zigbee-herdsman-converters/pull/2710
             "MULTI-MECI--EA01": {},
@@ -847,8 +806,8 @@ export class Device extends Entity<ControllerEventMap> {
             logger.debug(`Interview procedure failed but got modelID matching '${match}', assuming interview succeeded`, NS);
             this._type = this._type === "Unknown" && info.type ? info.type : this._type;
             this._manufacturerID = this._manufacturerID || info.manufacturerID;
-            this._manufacturerName = this._manufacturerName || info.manufacturerName;
-            this._powerSource = this._powerSource || info.powerSource;
+            this.#genBasic.manufacturerName = this.#genBasic.manufacturerName || info.manufacturerName;
+            this.#genBasic.powerSource = (this.#genBasic.powerSource || info.powerSource) /* v8 ignore next */ ?? Zcl.PowerSource.Unknown;
             logger.debug(`Interview - quirks matched on '${match}'`, NS);
             return true;
         }
@@ -898,9 +857,7 @@ export class Device extends Entity<ControllerEventMap> {
                 const endpoint = Endpoint.create(1, undefined, undefined, [], [], this.networkAddress, this.ieeeAddr);
                 const result = await endpoint.read("genBasic", ["modelId", "manufacturerName"], {sendPolicy: "immediate"});
 
-                for (const key in result) {
-                    Device.REPORTABLE_PROPERTIES_MAPPING[key].set(result[key], this);
-                }
+                this.updateGenBasic(result);
             } catch (error) {
                 logger.debug(`Interview - Tuya read modelID and manufacturerName failed (${error})`, NS);
             }
@@ -935,12 +892,10 @@ export class Device extends Entity<ControllerEventMap> {
             // Read attributes
             // nice to have but not required for successful pairing as most of the attributes are not mandatory in ZCL specification
             if (endpoint.supportsInputCluster("genBasic")) {
-                for (const key in Device.REPORTABLE_PROPERTIES_MAPPING) {
-                    const item = Device.REPORTABLE_PROPERTIES_MAPPING[key];
-
-                    if (ignoreCache || !this[item.key]) {
+                for (const key of INTERVIEW_GENBASIC_ATTRIBUTES) {
+                    if (ignoreCache || !this.#genBasic[key]) {
                         try {
-                            let result: KeyValue;
+                            let result: TPartialClusterAttributes<"genBasic">;
 
                             try {
                                 result = await endpoint.read("genBasic", [key], {sendPolicy: "immediate"});
@@ -949,8 +904,8 @@ export class Device extends Entity<ControllerEventMap> {
                                 // while joining like in:
                                 // https://github.com/Koenkk/zigbee-herdsman-converters/issues/2485.
                                 // The modelID and manufacturerName are crucial for device identification, so retry.
-                                if (item.key === "modelID" || item.key === "manufacturerName") {
-                                    logger.debug(`Interview - first ${item.key} retrieval attempt failed, retrying after 10 seconds...`, NS);
+                                if (key === "modelId" || key === "manufacturerName") {
+                                    logger.debug(`Interview - first ${key} retrieval attempt failed, retrying after 10 seconds...`, NS);
                                     await wait(10000);
                                     result = await endpoint.read("genBasic", [key], {sendPolicy: "immediate"});
                                 } else {
@@ -958,10 +913,10 @@ export class Device extends Entity<ControllerEventMap> {
                                 }
                             }
 
-                            item.set(result[key], this);
-                            logger.debug(`Interview - got '${item.key}' for device '${this.ieeeAddr}'`, NS);
+                            this.updateGenBasic(result);
+                            logger.debug(`Interview - got '${key}' for device '${this.ieeeAddr}'`, NS);
                         } catch (error) {
-                            logger.debug(`Interview - failed to read attribute '${item.key}' from endpoint '${endpoint.ID}' (${error})`, NS);
+                            logger.debug(`Interview - failed to read attribute '${key}' from endpoint '${endpoint.ID}' (${error})`, NS);
                         }
                     }
                 }