@willieee802/zigbee-herdsman 0.49.1 → 0.49.2

package/dist/adapter/adapter.d.ts

@@ -0,0 +1,66 @@
+import events from "node:events";
+import type * as Models from "../models";
+import type { BroadcastAddress } from "../zspec/enums";
+import * as Zcl from "../zspec/zcl";
+import type * as Zdo from "../zspec/zdo";
+import type * as ZdoTypes from "../zspec/zdo/definition/tstypes";
+import type * as AdapterEvents from "./events";
+import type * as TsType from "./tstype";
+import { KonnextConfig } from "../controller/model/konnextConfig";
+interface AdapterEventMap {
+    deviceJoined: [payload: AdapterEvents.DeviceJoinedPayload];
+    zclPayload: [payload: AdapterEvents.ZclPayload];
+    zdoResponse: [clusterId: Zdo.ClusterId, response: ZdoTypes.GenericZdoResponse];
+    disconnected: [];
+    deviceLeave: [payload: AdapterEvents.DeviceLeavePayload];
+}
+export declare abstract class Adapter extends events.EventEmitter<AdapterEventMap> {
+    hasZdoMessageOverhead: boolean;
+    manufacturerID: Zcl.ManufacturerCode;
+    protected networkOptions: TsType.NetworkOptions;
+    protected adapterOptions: TsType.AdapterOptions;
+    protected serialPortOptions: TsType.SerialPortOptions;
+    protected backupPath: string;
+    protected constructor(networkOptions: TsType.NetworkOptions, serialPortOptions: TsType.SerialPortOptions, backupPath: string, adapterOptions: TsType.AdapterOptions);
+    /**
+     * Utility
+     */
+    static create(networkOptions: TsType.NetworkOptions, serialPortOptions: TsType.SerialPortOptions, backupPath: string, adapterOptions: TsType.AdapterOptions, konnextConfig: KonnextConfig): Promise<Adapter>;
+    abstract start(): Promise<TsType.StartResult>;
+    abstract stop(): Promise<void>;
+    abstract getCoordinatorIEEE(): Promise<string>;
+    abstract getCoordinatorVersion(): Promise<TsType.CoordinatorVersion>;
+    abstract reset(type: "soft" | "hard"): Promise<void>;
+    abstract supportsBackup(): Promise<boolean>;
+    abstract backup(ieeeAddressesInDatabase: string[]): Promise<Models.Backup>;
+    abstract getNetworkParameters(): Promise<TsType.NetworkParameters>;
+    abstract addInstallCode(ieeeAddress: string, key: Buffer, hashed: boolean): Promise<void>;
+    abstract waitFor(networkAddress: number | undefined, endpoint: number, frameType: Zcl.FrameType, direction: Zcl.Direction, transactionSequenceNumber: number | undefined, clusterID: number, commandIdentifier: number, timeout: number): {
+        promise: Promise<AdapterEvents.ZclPayload>;
+        cancel: () => void;
+    };
+    /**
+     * ZDO
+     */
+    abstract sendZdo(ieeeAddress: string, networkAddress: number, clusterId: Zdo.ClusterId, payload: Buffer, disableResponse: true): Promise<void>;
+    abstract sendZdo<K extends keyof ZdoTypes.RequestToResponseMap>(ieeeAddress: string, networkAddress: number, clusterId: K, payload: Buffer, disableResponse: false): Promise<ZdoTypes.RequestToResponseMap[K]>;
+    abstract sendZdo<K extends keyof ZdoTypes.RequestToResponseMap>(ieeeAddress: string, networkAddress: number, clusterId: K, payload: Buffer, disableResponse: boolean): Promise<ZdoTypes.RequestToResponseMap[K] | undefined>;
+    abstract permitJoin(seconds: number, networkAddress?: number): Promise<void>;
+    /**
+     * ZCL
+     */
+    abstract sendZclFrameToEndpoint(ieeeAddr: string, networkAddress: number, endpoint: number, zclFrame: Zcl.Frame, timeout: number, disableResponse: boolean, disableRecovery: boolean, sourceEndpoint?: number, profileId?: number): Promise<AdapterEvents.ZclPayload | undefined>;
+    abstract sendZclFrameToGroup(groupID: number, zclFrame: Zcl.Frame, sourceEndpoint?: number, profileId?: number): Promise<void>;
+    abstract sendZclFrameToAll(endpoint: number, zclFrame: Zcl.Frame, sourceEndpoint: number, destination: BroadcastAddress, profileId?: number): Promise<void>;
+    /**
+     * InterPAN
+     */
+    abstract setChannelInterPAN(channel: number): Promise<void>;
+    abstract sendZclFrameInterPANToIeeeAddr(zclFrame: Zcl.Frame, ieeeAddress: string): Promise<void>;
+    abstract sendZclFrameInterPANBroadcast(zclFrame: Zcl.Frame, timeout: number, disableResponse: false): Promise<AdapterEvents.ZclPayload>;
+    abstract sendZclFrameInterPANBroadcast(zclFrame: Zcl.Frame, timeout: number, disableResponse: true): Promise<undefined>;
+    abstract sendZclFrameInterPANBroadcast(zclFrame: Zcl.Frame, timeout: number, disableResponse: boolean): Promise<AdapterEvents.ZclPayload | undefined>;
+    abstract restoreChannelInterPAN(): Promise<void>;
+}
+export default Adapter;
+//# sourceMappingURL=adapter.d.ts.map

package/dist/adapter/adapter.js

@@ -0,0 +1,110 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Adapter = void 0;
+const node_events_1 = __importDefault(require("node:events"));
+const Zcl = __importStar(require("../zspec/zcl"));
+const adapterDiscovery_1 = require("./adapterDiscovery");
+class Adapter extends node_events_1.default.EventEmitter {
+    hasZdoMessageOverhead;
+    manufacturerID;
+    networkOptions;
+    adapterOptions;
+    serialPortOptions;
+    backupPath;
+    constructor(networkOptions, serialPortOptions, backupPath, adapterOptions) {
+        super();
+        this.hasZdoMessageOverhead = true;
+        this.manufacturerID = Zcl.ManufacturerCode.RESERVED_10;
+        this.networkOptions = networkOptions;
+        this.adapterOptions = adapterOptions;
+        this.serialPortOptions = serialPortOptions;
+        this.backupPath = backupPath;
+    }
+    /**
+     * Utility
+     */
+    static async create(networkOptions, serialPortOptions, backupPath, adapterOptions, konnextConfig) {
+        const discovered = await (0, adapterDiscovery_1.discoverAdapter)(serialPortOptions.adapter, serialPortOptions.path);
+        serialPortOptions.adapter = discovered.adapter;
+        serialPortOptions.path = discovered.path;
+        if (serialPortOptions.baudRate === undefined && discovered.baudRate !== undefined) {
+            serialPortOptions.baudRate = discovered.baudRate;
+        }
+        if (serialPortOptions.rtscts === undefined && discovered.rtscts !== undefined) {
+            serialPortOptions.rtscts = discovered.rtscts;
+        }
+        switch (discovered.adapter) {
+            case "zstack": {
+                const { ZStackAdapter } = await import("./z-stack/adapter/zStackAdapter.js");
+                return new ZStackAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions, konnextConfig);
+            }
+            case "ember": {
+                const { EmberAdapter } = await import("./ember/adapter/emberAdapter.js");
+                return new EmberAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions);
+            }
+            case "deconz": {
+                const { DeconzAdapter } = await import("./deconz/adapter/deconzAdapter.js");
+                return new DeconzAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions);
+            }
+            case "zigate": {
+                const { ZiGateAdapter } = await import("./zigate/adapter/zigateAdapter.js");
+                return new ZiGateAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions);
+            }
+            case "zboss": {
+                const { ZBOSSAdapter } = await import("./zboss/adapter/zbossAdapter.js");
+                return new ZBOSSAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions);
+            }
+            case "zoh": {
+                const { ZoHAdapter } = await import("./zoh/adapter/zohAdapter.js");
+                return new ZoHAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions);
+            }
+            // @deprecated
+            case "ezsp": {
+                const { EZSPAdapter } = await import("./ezsp/adapter/ezspAdapter.js");
+                return new EZSPAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions);
+            }
+            default: {
+                throw new Error(`Adapter '${discovered.adapter}' does not exists, possible options: zstack, ember, deconz, zigate, zboss, zoh, ezsp`);
+            }
+        }
+    }
+}
+exports.Adapter = Adapter;
+exports.default = Adapter;
+//# sourceMappingURL=adapter.js.map

package/dist/adapter/adapter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adapter.js","sourceRoot":"","sources":["../../src/adapter/adapter.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,8DAAiC;AAIjC,kDAAoC;AAGpC,yDAAmD;AAanD,MAAsB,OAAQ,SAAQ,qBAAM,CAAC,YAA6B;IAC/D,qBAAqB,CAAU;IAC/B,cAAc,CAAuB;IAClC,cAAc,CAAwB;IACtC,cAAc,CAAwB;IACtC,iBAAiB,CAA2B;IAC5C,UAAU,CAAS;IAE7B,YACI,cAAqC,EACrC,iBAA2C,EAC3C,UAAkB,EAClB,cAAqC;QAErC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC;QAClC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,gBAAgB,CAAC,WAAW,CAAC;QACvD,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;IAED;;OAEG;IAEI,MAAM,CAAC,KAAK,CAAC,MAAM,CACtB,cAAqC,EACrC,iBAA2C,EAC3C,UAAkB,EAClB,cAAqC,EACrC,aAA4B;QAE5B,MAAM,UAAU,GAAG,MAAM,IAAA,kCAAe,EAAC,iBAAiB,CAAC,OAAO,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC;QAC5F,iBAAiB,CAAC,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC;QAC/C,iBAAiB,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QACzC,IAAI,iBAAiB,CAAC,QAAQ,KAAK,SAAS,IAAI,UAAU,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YAChF,iBAAiB,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACrD,CAAC;QACD,IAAI,iBAAiB,CAAC,MAAM,KAAK,SAAS,IAAI,UAAU,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAC5E,iBAAiB,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC;QACjD,CAAC;QAED,QAAQ,UAAU,CAAC,OAAO,EAAE,CAAC;YACzB,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACZ,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,oCAAoC,CAAC,CAAC;gBAE3E,OAAO,IAAI,aAAa,CAAC,cAAc,EAAE,iBAAiB,EAAE,UAAU,EAAE,cAAc,EAAE,aAAa,CAAC,CAAC;YAC3G,CAAC;YACD,KAAK,OAAO,CAAC,CAAC,CAAC;gBACX,MAAM,EAAC,YAAY,EAAC,GAAG,MAAM,MAAM,CAAC,iCAAiC,CAAC,CAAC;gBAEvE,OAAO,IAAI,YAAY,CAAC,cAAc,EAAE,iBAAiB,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;YAC3F,CAAC;YACD,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACZ,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,mCAAmC,CAAC,CAAC;gBAE1E,OAAO,IAAI,aAAa,CAAC,cAAc,EAAE,iBAAiB,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;YAC5F,CAAC;YACD,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACZ,MAAM,EAAC,aAAa,EAAC,GAAG,MAAM,MAAM,CAAC,mCAAmC,CAAC,CAAC;gBAE1E,OAAO,IAAI,aAAa,CAAC,cAAc,EAAE,iBAAiB,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;YAC5F,CAAC;YACD,KAAK,OAAO,CAAC,CAAC,CAAC;gBACX,MAAM,EAAC,YAAY,EAAC,GAAG,MAAM,MAAM,CAAC,iCAAiC,CAAC,CAAC;gBAEvE,OAAO,IAAI,YAAY,CAAC,cAAc,EAAE,iBAAiB,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;YAC3F,CAAC;YACD,KAAK,KAAK,CAAC,CAAC,CAAC;gBACT,MAAM,EAAC,UAAU,EAAC,GAAG,MAAM,MAAM,CAAC,6BAA6B,CAAC,CAAC;gBAEjE,OAAO,IAAI,UAAU,CAAC,cAAc,EAAE,iBAAiB,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;YACzF,CAAC;YACD,cAAc;YACd,KAAK,MAAM,CAAC,CAAC,CAAC;gBACV,MAAM,EAAC,WAAW,EAAC,GAAG,MAAM,MAAM,CAAC,+BAA+B,CAAC,CAAC;gBAEpE,OAAO,IAAI,WAAW,CAAC,cAAc,EAAE,iBAAiB,EAAE,UAAU,EAAE,cAAc,CAAC,CAAC;YAC1F,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,YAAY,UAAU,CAAC,OAAO,sFAAsF,CAAC,CAAC;YAC1I,CAAC;QACL,CAAC;IACL,CAAC;CAsGJ;AA3LD,0BA2LC;AAED,kBAAe,OAAO,CAAC"}

package/dist/adapter/adapterDiscovery.d.ts

@@ -0,0 +1,34 @@
+import type { PortInfo } from "@serialport/bindings-cpp";
+import type { TsType } from ".";
+import type { Adapter, DiscoverableUsbAdapter, UsbAdapterFingerprint } from "./tstype";
+declare function matchUsbFingerprint(portInfo: PortInfo, entries: UsbAdapterFingerprint[], isWindows: boolean, conflictProne: boolean): [path: PortInfo["path"], score: number, fingerprint: UsbAdapterFingerprint] | undefined;
+export declare function matchUsbAdapter(adapter: Adapter, path: string): Promise<UsbAdapterFingerprint | false>;
+export declare function findUsbAdapterBestMatch(adapter: Adapter | undefined, portInfo: PortInfo, isWindows: boolean): [DiscoverableUsbAdapter, NonNullable<ReturnType<typeof matchUsbFingerprint>>] | undefined;
+export declare function findUsbAdapter(adapter?: Adapter, path?: string): Promise<TsType.SerialPortOptions | undefined>;
+export declare function findMdnsAdapter(path: string): Promise<TsType.SerialPortOptions>;
+export declare function findTcpAdapter(path: string, adapter?: Adapter): TsType.SerialPortOptions;
+/**
+ * Discover adapter using mDNS, TCP or USB.
+ *
+ * @param adapter The adapter type.
+ *   - mDNS: Unused.
+ *   - TCP: Required, cannot discover at this time.
+ *   - USB: Optional, limits the discovery to the specified adapter type.
+ * @param path The path to the adapter.
+ *   - mDNS: Required, serves to initiate the discovery.
+ *   - TCP: Required, cannot discover at this time.
+ *   - USB: Optional, limits the discovery to the specified path.
+ * @returns adapter An adapter type supported by Z2M. While result is TS-typed, this should be validated against actual values before use.
+ * @returns path Path to adapter.
+ */
+export declare function discoverAdapter(adapter?: Adapter, path?: string): Promise<TsType.SerialPortOptions>;
+type AllDevices = (TsType.SerialPortOptions & {
+    name: string;
+    path: string;
+})[];
+/**
+ * @returns List of all serial and mDNS devices found, with matching `adapter` if available
+ */
+export declare function findAllDevices(): Promise<AllDevices>;
+export {};
+//# sourceMappingURL=adapterDiscovery.d.ts.map