zigbee-herdsman 6.0.1 → 6.0.3

package/src/adapter/ember/adapter/endpoints.ts

@@ -1,86 +0,0 @@
-import {GP_ENDPOINT, GP_PROFILE_ID, HA_PROFILE_ID} from "../../../zspec/consts";
-import {Clusters} from "../../../zspec/zcl/definition/cluster";
-import type {ClusterId, EmberMulticastId, ProfileId} from "../types";
-
-type FixedEndpointInfo = {
-    /** Actual Zigbee endpoint number. uint8_t */
-    endpoint: number;
-    /** Profile ID of the device on this endpoint. */
-    profileId: ProfileId;
-    /** Device ID of the device on this endpoint. uint16_t*/
-    deviceId: number;
-    /** Version of the device. uint8_t */
-    deviceVersion: number;
-    /** List of server clusters. */
-    inClusterList: readonly ClusterId[];
-    /** List of client clusters. */
-    outClusterList: readonly ClusterId[];
-    /** Network index for this endpoint. uint8_t */
-    networkIndex: number;
-    /** Multicast group IDs to register in the multicast table */
-    multicastIds: readonly EmberMulticastId[];
-};
-
-/**
- * List of endpoints to register.
- *
- * Index 0 is used as default and expected to be the primary network.
- */
-export const FIXED_ENDPOINTS: readonly FixedEndpointInfo[] = [
-    {
-        // primary network
-        endpoint: 1,
-        profileId: HA_PROFILE_ID,
-        deviceId: 0x65, // ?
-        deviceVersion: 1,
-        inClusterList: [
-            Clusters.genBasic.ID, // 0x0000,// Basic
-            Clusters.genIdentify.ID, // 0x0003,// Identify
-            Clusters.genOnOff.ID, // 0x0006,// On/off
-            Clusters.genLevelCtrl.ID, // 0x0008,// Level Control
-            Clusters.genTime.ID, // 0x000A,// Time
-            Clusters.genOta.ID, // 0x0019,// Over the Air Bootloading
-            // Cluster.genPowerProfile.ID,// 0x001A,// Power Profile XXX: missing ZCL cluster def in Z2M?
-            Clusters.lightingColorCtrl.ID, // 0x0300,// Color Control
-        ],
-        outClusterList: [
-            Clusters.genBasic.ID, // 0x0000,// Basic
-            Clusters.genIdentify.ID, // 0x0003,// Identify
-            Clusters.genGroups.ID, // 0x0004,// Groups
-            Clusters.genScenes.ID, // 0x0005,// Scenes
-            Clusters.genOnOff.ID, // 0x0006,// On/off
-            Clusters.genLevelCtrl.ID, // 0x0008,// Level Control
-            Clusters.genPollCtrl.ID, // 0x0020,// Poll Control
-            Clusters.lightingColorCtrl.ID, // 0x0300,// Color Control
-            Clusters.msIlluminanceMeasurement.ID, // 0x0400,// Illuminance Measurement
-            Clusters.msTemperatureMeasurement.ID, // 0x0402,// Temperature Measurement
-            Clusters.msRelativeHumidity.ID, // 0x0405,// Relative Humidity Measurement
-            Clusters.msOccupancySensing.ID, // 0x0406,// Occupancy Sensing
-            Clusters.ssIasZone.ID, // 0x0500,// IAS Zone
-            Clusters.seMetering.ID, // 0x0702,// Simple Metering
-            Clusters.haMeterIdentification.ID, // 0x0B01,// Meter Identification
-            Clusters.haApplianceStatistics.ID, // 0x0B03,// Appliance Statistics
-            Clusters.haElectricalMeasurement.ID, // 0x0B04,// Electrical Measurement
-            Clusters.touchlink.ID, // 0x1000, // touchlink
-        ],
-        networkIndex: 0x00,
-        // - Cluster spec 3.7.2.4.1: group identifier 0x0000 is reserved for the global scene used by the OnOff cluster.
-        // - 901: defaultBindGroup
-        multicastIds: [0, 901],
-    },
-    {
-        // green power
-        endpoint: GP_ENDPOINT,
-        profileId: GP_PROFILE_ID,
-        deviceId: 0x66,
-        deviceVersion: 1,
-        inClusterList: [
-            Clusters.greenPower.ID, // 0x0021,// Green Power
-        ],
-        outClusterList: [
-            Clusters.greenPower.ID, // 0x0021,// Green Power
-        ],
-        networkIndex: 0x00,
-        multicastIds: [0x0b84],
-    },
-];

package/src/adapter/ember/adapter/oneWaitress.ts

@@ -1,324 +0,0 @@
-/* v8 ignore start */
-
-import equals from "fast-deep-equal/es6";
-
-import {TOUCHLINK_PROFILE_ID} from "../../../zspec/consts";
-import type {Eui64, NodeId} from "../../../zspec/tstypes";
-import type {ZclPayload} from "../../events";
-import type {EmberApsFrame} from "../types";
-
-/** Events specific to OneWaitress usage. */
-export enum OneWaitressEvents {
-    STACK_STATUS_NETWORK_UP = "STACK_STATUS_NETWORK_UP",
-    STACK_STATUS_NETWORK_DOWN = "STACK_STATUS_NETWORK_DOWN",
-    STACK_STATUS_NETWORK_OPENED = "STACK_STATUS_NETWORK_OPENED",
-    STACK_STATUS_NETWORK_CLOSED = "STACK_STATUS_NETWORK_CLOSED",
-}
-
-type OneWaitressMatcher = {
-    /**
-     * Matches `indexOrDestination` in `ezspMessageSentHandler` or `sender` in `ezspIncomingMessageHandler`
-     * EUI64 is currently only for NetworkAddress Request/Response
-     * Except for InterPAN touchlink, it should always be present.
-     */
-    target?: NodeId | Eui64;
-    apsFrame: EmberApsFrame;
-    /** Cluster ID for ZDO (because request !== response). */
-    zdoResponseClusterId?: number;
-    /** ZCL frame transaction sequence number */
-    zclSequence?: number;
-    /** Expected command ID for ZCL commands */
-    commandIdentifier?: number;
-};
-
-type OneWaitressEventMatcher = {
-    eventName: string;
-    /** If supplied, keys/values are expected to match with resolve payload. */
-    payload?: {[k: string]: unknown};
-};
-
-interface Waiter<A, B> {
-    id: number;
-    matcher: A;
-    timer?: NodeJS.Timeout;
-    resolve: (payload: B) => void;
-    reject: (error: Error) => void;
-    resolved: boolean;
-    timedout: boolean;
-}
-
-/**
- * The one waitress to rule them all. Hopefully.
- * Careful, she'll burn you if you're late on delivery!
- *
- * NOTE: `messageTag` is unreliable, so not used...
- */
-export class EmberOneWaitress {
-    // biome-ignore lint/suspicious/noExplicitAny: API
-    private readonly waiters: Map<number, Waiter<OneWaitressMatcher, any>>;
-    // NOTE: for now, this could be much simpler (array-like), but more complex events might come into play
-    // biome-ignore lint/suspicious/noExplicitAny: API
-    private readonly eventWaiters: Map<number, Waiter<OneWaitressEventMatcher, any>>;
-    private currentId: number;
-    private currentEventId: number;
-
-    public constructor() {
-        this.waiters = new Map();
-        this.eventWaiters = new Map();
-        this.currentId = 0;
-        this.currentEventId = 0;
-    }
-
-    /**
-     * Reject because of failed delivery notified by `ezspMessageSentHandler`.
-     * NOTE: This checks for APS sequence, which is only valid in `ezspMessageSentHandler`, not `ezspIncomingMessageHandler` (sequence from stack)
-     *
-     * @param target
-     * @param apsFrame
-     * @returns
-     */
-    public deliveryFailedFor(target: number, apsFrame: EmberApsFrame): boolean {
-        for (const [index, waiter] of this.waiters.entries()) {
-            if (waiter.timedout) {
-                this.waiters.delete(index);
-                continue;
-            }
-
-            // no target in touchlink
-            // in `ezspMessageSentHandler`, the clusterId for ZDO is still the request one, so check against apsFrame, not override
-            if (
-                (waiter.matcher.apsFrame.profileId === TOUCHLINK_PROFILE_ID || target === waiter.matcher.target) &&
-                apsFrame.sequence === waiter.matcher.apsFrame.sequence &&
-                apsFrame.profileId === waiter.matcher.apsFrame.profileId &&
-                apsFrame.clusterId === waiter.matcher.apsFrame.clusterId
-            ) {
-                clearTimeout(waiter.timer);
-
-                waiter.resolved = true;
-
-                this.waiters.delete(index);
-                waiter.reject(new Error(`Delivery failed for '${target}'.`));
-
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Resolve ZDO response payload.
-     * @param sender Node ID or EUI64 in the response
-     * @param apsFrame APS Frame in the response
-     * @param payload Payload to resolve
-     * @returns True if resolved a waiter
-     */
-    public resolveZDO(sender: NodeId | Eui64, apsFrame: EmberApsFrame, payload: unknown): boolean {
-        for (const [index, waiter] of this.waiters.entries()) {
-            if (waiter.timedout) {
-                this.waiters.delete(index);
-                continue;
-            }
-
-            if (
-                waiter.matcher.zdoResponseClusterId !== undefined && // skip if not a zdo waiter
-                sender === waiter.matcher.target && // always a sender expected in ZDO
-                apsFrame.profileId === waiter.matcher.apsFrame.profileId && // profileId is a bit redundant here, but...
-                apsFrame.clusterId === waiter.matcher.zdoResponseClusterId
-            ) {
-                clearTimeout(waiter.timer);
-
-                waiter.resolved = true;
-
-                this.waiters.delete(index);
-                waiter.resolve(payload);
-
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Resolve ZCL response payload
-     * @param payload Payload to resolve
-     * @returns True if resolved a waiter
-     */
-    public resolveZCL(payload: ZclPayload): boolean {
-        if (!payload.header) return false;
-
-        for (const [index, waiter] of this.waiters.entries()) {
-            if (waiter.timedout) {
-                this.waiters.delete(index);
-                continue;
-            }
-
-            // no target in touchlink, also no APS sequence, but use the ZCL one instead
-            if (
-                (waiter.matcher.apsFrame.profileId === TOUCHLINK_PROFILE_ID ||
-                    (payload.address === waiter.matcher.target && payload.endpoint === waiter.matcher.apsFrame.destinationEndpoint)) &&
-                (waiter.matcher.zclSequence === undefined || payload.header.transactionSequenceNumber === waiter.matcher.zclSequence) &&
-                (waiter.matcher.commandIdentifier === undefined || payload.header.commandIdentifier === waiter.matcher.commandIdentifier) &&
-                payload.clusterID === waiter.matcher.apsFrame.clusterId
-            ) {
-                clearTimeout(waiter.timer);
-
-                waiter.resolved = true;
-
-                this.waiters.delete(index);
-                waiter.resolve(payload);
-
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    public waitFor<T>(matcher: OneWaitressMatcher, timeout: number): {id: number; start: () => {promise: Promise<T>; id: number}} {
-        this.currentId += 1;
-        const id = this.currentId;
-        this.currentId &= 0xffff; // roll-over every so often - 65535 should be enough not to create conflicts ;-)
-
-        const promise: Promise<T> = new Promise((resolve, reject): void => {
-            const object: Waiter<typeof matcher, T> = {matcher, resolve, reject, timedout: false, resolved: false, id};
-
-            this.waiters.set(id, object);
-        });
-
-        const start = (): {promise: Promise<T>; id: number} => {
-            const waiter = this.waiters.get(id);
-
-            if (waiter && !waiter.resolved && !waiter.timer) {
-                // Capture the stack trace from the caller of start()
-                const error = new Error();
-                Error.captureStackTrace(error);
-
-                waiter.timer = setTimeout((): void => {
-                    error.message = `${JSON.stringify(matcher)} timed out after ${timeout}ms`;
-                    waiter.timedout = true;
-
-                    waiter.reject(error);
-                }, timeout);
-            }
-
-            return {promise, id};
-        };
-
-        return {id, start};
-    }
-
-    /**
-     * Shortcut that starts the timer immediately and returns the promise.
-     * No access to `id`, so no easy cancel.
-     * @param matcher
-     * @param timeout
-     * @returns
-     */
-    public startWaitingFor<T>(matcher: OneWaitressMatcher, timeout: number): Promise<T> {
-        return this.waitFor<T>(matcher, timeout).start().promise;
-    }
-
-    public remove(id: number): void {
-        const waiter = this.waiters.get(id);
-
-        if (waiter) {
-            if (!waiter.timedout && waiter.timer) {
-                clearTimeout(waiter.timer);
-            }
-
-            this.waiters.delete(id);
-        }
-    }
-
-    /**
-     * Matches event name with matcher's, and payload (if any in matcher) using `fast-deep-equal/es6` (all keys & values must match)
-     * @param eventName
-     * @param payload
-     * @returns
-     */
-    public resolveEvent(eventName: string, payload?: {[k: string]: unknown}): boolean {
-        for (const [index, waiter] of this.eventWaiters.entries()) {
-            if (waiter.timedout) {
-                this.eventWaiters.delete(index);
-                continue;
-            }
-
-            if (eventName === waiter.matcher.eventName && (!waiter.matcher.payload || equals(payload, waiter.matcher.payload))) {
-                clearTimeout(waiter.timer);
-
-                waiter.resolved = true;
-
-                this.eventWaiters.delete(index);
-                waiter.resolve(payload);
-
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    public waitForEvent<T>(
-        matcher: OneWaitressEventMatcher,
-        timeout: number,
-        reason?: string,
-    ): {id: number; start: () => {promise: Promise<T>; id: number}} {
-        // NOTE: logic is very much the same as `waitFor`, just different matcher
-        this.currentEventId += 1;
-        const id = this.currentEventId;
-        this.currentEventId &= 0xffff; // roll-over every so often - 65535 should be enough not to create conflicts ;-)
-
-        const promise: Promise<T> = new Promise((resolve, reject): void => {
-            const object: Waiter<typeof matcher, T> = {matcher, resolve, reject, timedout: false, resolved: false, id};
-
-            this.eventWaiters.set(id, object);
-        });
-
-        const start = (): {promise: Promise<T>; id: number} => {
-            const waiter = this.eventWaiters.get(id);
-
-            if (waiter && !waiter.resolved && !waiter.timer) {
-                // Capture the stack trace from the caller of start()
-                const error = new Error();
-                Error.captureStackTrace(error);
-
-                waiter.timer = setTimeout((): void => {
-                    error.message = `${reason ? reason : JSON.stringify(matcher)} timed out after ${timeout}ms`;
-                    waiter.timedout = true;
-
-                    waiter.reject(error);
-                }, timeout);
-            }
-
-            return {promise, id};
-        };
-
-        return {id, start};
-    }
-
-    /**
-     * Shortcut that starts the timer immediately and returns the promise.
-     * No access to `id`, so no easy cancel.
-     * @param matcher
-     * @param timeout
-     * @param reason If supplied, will be used as timeout label, otherwise stringified matcher is.
-     * @returns
-     */
-    public startWaitingForEvent<T>(matcher: OneWaitressEventMatcher, timeout: number, reason?: string): Promise<T> {
-        return this.waitForEvent<T>(matcher, timeout, reason).start().promise;
-    }
-
-    public removeEvent(id: number): void {
-        const waiter = this.eventWaiters.get(id);
-
-        if (waiter) {
-            if (!waiter.timedout && waiter.timer) {
-                clearTimeout(waiter.timer);
-            }
-
-            this.eventWaiters.delete(id);
-        }
-    }
-}