zigbee-herdsman 0.51.0 → 0.52.0

package/dist/adapter/ember/adapter/requestQueue.d.ts

@@ -1,67 +0,0 @@
-import { SLStatus } from "../enums";
-export declare const MAX_SEND_ATTEMPTS = 3;
-export declare const HIGH_COUNT = 4;
-export declare const BUSY_DEFER_MSEC = 500;
-export declare const NETWORK_DOWN_DEFER_MSEC = 1500;
-export declare class EmberRequestQueue {
-    private readonly dispatchInterval;
-    /** If true, the queue is currently busy dispatching. */
-    private dispatching;
-    /** The queue holding requests to be sent. */
-    private queue;
-    /** Queue with requests that should take priority over the above queue. */
-    private priorityQueue;
-    constructor(dispatchInterval: number);
-    /**
-     * Number of requests in both regular and priority queues.
-     */
-    get totalQueued(): number;
-    /**
-     * If true, total queued requests count is considered high.
-     */
-    get isHigh(): boolean;
-    /**
-     * Empty each queue.
-     */
-    clear(): void;
-    /**
-     * Prevent sending requests (usually due to NCP being reset).
-     */
-    stopDispatching(): void;
-    /**
-     * Allow sending requests.
-     * Must be called after init.
-     */
-    startDispatching(): void;
-    /**
-     * Store a function in the queue to be resolved when appropriate.
-     * @param function The function to enqueue. Upon dispatch:
-     *     - if its return value is one of MAX_MESSAGE_LIMIT_REACHED, NETWORK_BUSY, NETWORK_DOWN,
-     *       queue will defer dispatching and keep the function in the queue; reject otherwise.
-     *     - if it throws, it is expected to throw `EzspStatus`, and will act same as above if one of NOT_CONNECTED, NO_TX_SPACE; reject otherwise.
-     *     - any other value will result in the function being removed from the queue.
-     * @param reject The `reject` of the Promise wrapping the `enqueue` call
-     *     (`resolve` is done in `func` directly to have typing on results & control on exec).
-     * @param prioritize If true, function will be enqueued in the priority queue. Defaults to false.
-     * @returns new length of the queue.
-     */
-    enqueue(func: () => Promise<SLStatus>, reject: (reason: Error) => void, prioritize?: boolean): number;
-    /**
-     * Dispatch the head of the queue.
-     *
-     * If request `func` throws, catch error and reject the request. `ezsp${x}` functions throw `EzspError`.
-     *
-     * If request `func` resolves but has an error, look at what error, and determine if should retry or remove the request from queue.
-     *
-     * If request `func` resolves without error, remove request from queue.
-     *
-     * WARNING: Because of this logic for "internal retries", any error thrown by `func` will not immediatedly bubble back to Adapter/Controller
-     */
-    private dispatch;
-    /**
-     * Defer dispatching for the specified duration (in msec).
-     * @param msec
-     */
-    private defer;
-}
-//# sourceMappingURL=requestQueue.d.ts.map

package/dist/adapter/ember/adapter/requestQueue.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"requestQueue.d.ts","sourceRoot":"","sources":["../../../../src/adapter/ember/adapter/requestQueue.ts"],"names":[],"mappings":"AACA,OAAO,EAAa,QAAQ,EAAC,MAAM,UAAU,CAAC;AAc9C,eAAO,MAAM,iBAAiB,IAAI,CAAC;AACnC,eAAO,MAAM,UAAU,IAAI,CAAC;AAC5B,eAAO,MAAM,eAAe,MAAM,CAAC;AACnC,eAAO,MAAM,uBAAuB,OAAO,CAAC;AAE5C,qBAAa,iBAAiB;IAC1B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,wDAAwD;IACxD,OAAO,CAAC,WAAW,CAAU;IAC7B,6CAA6C;IAC7C,OAAO,CAAC,KAAK,CAA2B;IACxC,0EAA0E;IAC1E,OAAO,CAAC,aAAa,CAA2B;gBAEpC,gBAAgB,EAAE,MAAM;IAOpC;;OAEG;IACH,IAAI,WAAW,IAAI,MAAM,CAExB;IAED;;OAEG;IACH,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;OAEG;IACI,KAAK,IAAI,IAAI;IAOpB;;OAEG;IACI,eAAe,IAAI,IAAI;IAM9B;;;OAGG;IACI,gBAAgB,IAAI,IAAI;IAQ/B;;;;;;;;;;;OAWG;IACI,OAAO,CAAC,IAAI,EAAE,MAAM,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC,MAAM,EAAE,KAAK,KAAK,IAAI,EAAE,UAAU,GAAE,OAAe,GAAG,MAAM;IAUnH;;;;;;;;;;OAUG;YACW,QAAQ;IA0DtB;;;OAGG;IACH,OAAO,CAAC,KAAK;CAKhB"}

package/dist/adapter/ember/adapter/requestQueue.js

@@ -1,159 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EmberRequestQueue = exports.NETWORK_DOWN_DEFER_MSEC = exports.BUSY_DEFER_MSEC = exports.HIGH_COUNT = exports.MAX_SEND_ATTEMPTS = void 0;
-const logger_1 = require("../../../utils/logger");
-const enums_1 = require("../enums");
-const NS = 'zh:ember:queue';
-;
-exports.MAX_SEND_ATTEMPTS = 3;
-exports.HIGH_COUNT = 4;
-exports.BUSY_DEFER_MSEC = 500;
-exports.NETWORK_DOWN_DEFER_MSEC = 1500;
-class EmberRequestQueue {
-    dispatchInterval;
-    /** If true, the queue is currently busy dispatching. */
-    dispatching;
-    /** The queue holding requests to be sent. */
-    queue;
-    /** Queue with requests that should take priority over the above queue. */
-    priorityQueue;
-    constructor(dispatchInterval) {
-        this.dispatchInterval = dispatchInterval || 5;
-        this.dispatching = false;
-        this.queue = [];
-        this.priorityQueue = [];
-    }
-    /**
-     * Number of requests in both regular and priority queues.
-     */
-    get totalQueued() {
-        return this.queue.length + this.priorityQueue.length;
-    }
-    /**
-     * If true, total queued requests count is considered high.
-     */
-    get isHigh() {
-        return this.totalQueued > exports.HIGH_COUNT;
-    }
-    /**
-     * Empty each queue.
-     */
-    clear() {
-        this.queue = [];
-        this.priorityQueue = [];
-        logger_1.logger.info(`Request queues cleared.`, NS);
-    }
-    /**
-     * Prevent sending requests (usually due to NCP being reset).
-     */
-    stopDispatching() {
-        this.dispatching = false;
-        logger_1.logger.info(`Request dispatching stopped; queue=${this.queue.length} priorityQueue=${this.priorityQueue.length}`, NS);
-    }
-    /**
-     * Allow sending requests.
-     * Must be called after init.
-     */
-    startDispatching() {
-        this.dispatching = true;
-        setTimeout(this.dispatch.bind(this), 1);
-        logger_1.logger.info(`Request dispatching started.`, NS);
-    }
-    /**
-     * Store a function in the queue to be resolved when appropriate.
-     * @param function The function to enqueue. Upon dispatch:
-     *     - if its return value is one of MAX_MESSAGE_LIMIT_REACHED, NETWORK_BUSY, NETWORK_DOWN,
-     *       queue will defer dispatching and keep the function in the queue; reject otherwise.
-     *     - if it throws, it is expected to throw `EzspStatus`, and will act same as above if one of NOT_CONNECTED, NO_TX_SPACE; reject otherwise.
-     *     - any other value will result in the function being removed from the queue.
-     * @param reject The `reject` of the Promise wrapping the `enqueue` call
-     *     (`resolve` is done in `func` directly to have typing on results & control on exec).
-     * @param prioritize If true, function will be enqueued in the priority queue. Defaults to false.
-     * @returns new length of the queue.
-     */
-    enqueue(func, reject, prioritize = false) {
-        logger_1.logger.debug(`Status queue=${this.queue.length} priorityQueue=${this.priorityQueue.length}.`, NS);
-        return (prioritize ? this.priorityQueue : this.queue).push({
-            sendAttempts: 0,
-            func,
-            reject,
-        });
-    }
-    /**
-     * Dispatch the head of the queue.
-     *
-     * If request `func` throws, catch error and reject the request. `ezsp${x}` functions throw `EzspError`.
-     *
-     * If request `func` resolves but has an error, look at what error, and determine if should retry or remove the request from queue.
-     *
-     * If request `func` resolves without error, remove request from queue.
-     *
-     * WARNING: Because of this logic for "internal retries", any error thrown by `func` will not immediatedly bubble back to Adapter/Controller
-     */
-    async dispatch() {
-        if (!this.dispatching) {
-            return;
-        }
-        let fromPriorityQueue = true;
-        let entry = this.priorityQueue[0]; // head of queue if any, priority first
-        if (!entry) {
-            fromPriorityQueue = false;
-            entry = this.queue[0];
-        }
-        if (entry) {
-            entry.sendAttempts++; // enqueued at zero
-            if (entry.sendAttempts > exports.MAX_SEND_ATTEMPTS) {
-                entry.reject(new Error(`Failed ${exports.MAX_SEND_ATTEMPTS} attempts to send`));
-            }
-            else {
-                // NOTE: refer to `enqueue()` comment to keep logic in sync with expectations, adjust comment on change.
-                try {
-                    const status = (await entry.func());
-                    // XXX: add NOT_READY?
-                    if ((status === enums_1.SLStatus.ZIGBEE_MAX_MESSAGE_LIMIT_REACHED) || (status === enums_1.SLStatus.BUSY)) {
-                        logger_1.logger.debug(`Dispatching deferred: Adapter busy.`, NS);
-                        this.defer(exports.BUSY_DEFER_MSEC);
-                    }
-                    else if (status === enums_1.SLStatus.NETWORK_DOWN) {
-                        logger_1.logger.debug(`Dispatching deferred: Network not ready`, NS);
-                        this.defer(exports.NETWORK_DOWN_DEFER_MSEC);
-                    }
-                    else {
-                        // success
-                        (fromPriorityQueue ? this.priorityQueue : this.queue).shift();
-                        if (status !== enums_1.SLStatus.OK) {
-                            entry.reject(new Error(enums_1.SLStatus[status]));
-                        }
-                    }
-                }
-                catch (err) { // EzspStatusError from ezsp${x} commands, except for stuff rejected by OneWaitress, but that's never "retry"
-                    if (err.code === enums_1.EzspStatus.NO_TX_SPACE) {
-                        logger_1.logger.debug(`Dispatching deferred: Host busy.`, NS);
-                        this.defer(exports.BUSY_DEFER_MSEC);
-                    }
-                    else if (err.code === enums_1.EzspStatus.NOT_CONNECTED) {
-                        logger_1.logger.debug(`Dispatching deferred: Network not ready`, NS);
-                        this.defer(exports.NETWORK_DOWN_DEFER_MSEC);
-                    }
-                    else {
-                        (fromPriorityQueue ? this.priorityQueue : this.queue).shift();
-                        entry.reject(err);
-                    }
-                }
-            }
-        }
-        if (this.dispatching) {
-            setTimeout(this.dispatch.bind(this), this.dispatchInterval);
-        }
-    }
-    /**
-     * Defer dispatching for the specified duration (in msec).
-     * @param msec
-     */
-    defer(msec) {
-        this.stopDispatching();
-        setTimeout(this.startDispatching.bind(this), msec);
-    }
-}
-exports.EmberRequestQueue = EmberRequestQueue;
-//# sourceMappingURL=requestQueue.js.map

package/dist/adapter/ember/adapter/requestQueue.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"requestQueue.js","sourceRoot":"","sources":["../../../../src/adapter/ember/adapter/requestQueue.ts"],"names":[],"mappings":";;;AAAA,kDAA6C;AAC7C,oCAA8C;AAG9C,MAAM,EAAE,GAAG,gBAAgB,CAAC;AAS3B,CAAC;AAEW,QAAA,iBAAiB,GAAG,CAAC,CAAC;AACtB,QAAA,UAAU,GAAG,CAAC,CAAC;AACf,QAAA,eAAe,GAAG,GAAG,CAAC;AACtB,QAAA,uBAAuB,GAAG,IAAI,CAAC;AAE5C,MAAa,iBAAiB;IACT,gBAAgB,CAAS;IAC1C,wDAAwD;IAChD,WAAW,CAAU;IAC7B,6CAA6C;IACrC,KAAK,CAA2B;IACxC,0EAA0E;IAClE,aAAa,CAA2B;IAEhD,YAAY,gBAAwB;QAChC,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QACzB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;IAC5B,CAAC;IAED;;OAEG;IACH,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,WAAW,GAAG,kBAAU,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,KAAK;QACR,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QAExB,eAAM,CAAC,IAAI,CAAC,yBAAyB,EAAE,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,eAAe;QAClB,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC;QAEzB,eAAM,CAAC,IAAI,CAAC,sCAAsC,IAAI,CAAC,KAAK,CAAC,MAAM,kBAAkB,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;IAC1H,CAAC;IAED;;;OAGG;IACI,gBAAgB;QACnB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;QAExB,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;QAExC,eAAM,CAAC,IAAI,CAAC,8BAA8B,EAAE,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;OAWG;IACI,OAAO,CAAC,IAA6B,EAAE,MAA+B,EAAE,aAAsB,KAAK;QACtG,eAAM,CAAC,KAAK,CAAC,gBAAgB,IAAI,CAAC,KAAK,CAAC,MAAM,kBAAkB,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC,CAAC;QAElG,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC;YACvD,YAAY,EAAE,CAAC;YACf,IAAI;YACJ,MAAM;SACT,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;OAUG;IACK,KAAK,CAAC,QAAQ;QAClB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACpB,OAAO;QACX,CAAC;QAED,IAAI,iBAAiB,GAAG,IAAI,CAAC;QAC7B,IAAI,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA,uCAAuC;QAEzE,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,iBAAiB,GAAG,KAAK,CAAC;YAC1B,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC1B,CAAC;QAED,IAAI,KAAK,EAAE,CAAC;YACR,KAAK,CAAC,YAAY,EAAE,CAAC,CAAA,mBAAmB;YAExC,IAAI,KAAK,CAAC,YAAY,GAAG,yBAAiB,EAAE,CAAC;gBACzC,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,UAAU,yBAAiB,mBAAmB,CAAC,CAAC,CAAC;YAC5E,CAAC;iBAAM,CAAC;gBACJ,wGAAwG;gBACxG,IAAI,CAAC;oBACD,MAAM,MAAM,GAAa,CAAC,MAAM,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC;oBAE9C,sBAAsB;oBACtB,IAAI,CAAC,MAAM,KAAK,gBAAQ,CAAC,gCAAgC,CAAC,IAAI,CAAC,MAAM,KAAK,gBAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;wBACvF,eAAM,CAAC,KAAK,CAAC,qCAAqC,EAAE,EAAE,CAAC,CAAC;wBACxD,IAAI,CAAC,KAAK,CAAC,uBAAe,CAAC,CAAC;oBAChC,CAAC;yBAAM,IAAI,MAAM,KAAK,gBAAQ,CAAC,YAAY,EAAE,CAAC;wBAC1C,eAAM,CAAC,KAAK,CAAC,yCAAyC,EAAE,EAAE,CAAC,CAAC;wBAC5D,IAAI,CAAC,KAAK,CAAC,+BAAuB,CAAC,CAAC;oBACxC,CAAC;yBAAM,CAAC;wBACJ,UAAU;wBACV,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;wBAE9D,IAAI,MAAM,KAAK,gBAAQ,CAAC,EAAE,EAAE,CAAC;4BACzB,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,gBAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;wBAC9C,CAAC;oBACL,CAAC;gBACL,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC,CAAA,6GAA6G;oBACxH,IAAK,GAAiB,CAAC,IAAI,KAAK,kBAAU,CAAC,WAAW,EAAE,CAAC;wBACrD,eAAM,CAAC,KAAK,CAAC,kCAAkC,EAAE,EAAE,CAAC,CAAC;wBACrD,IAAI,CAAC,KAAK,CAAC,uBAAe,CAAC,CAAC;oBAChC,CAAC;yBAAM,IAAK,GAAiB,CAAC,IAAI,KAAK,kBAAU,CAAC,aAAa,EAAE,CAAC;wBAC9D,eAAM,CAAC,KAAK,CAAC,yCAAyC,EAAE,EAAE,CAAC,CAAC;wBAC5D,IAAI,CAAC,KAAK,CAAC,+BAAuB,CAAC,CAAC;oBACxC,CAAC;yBAAM,CAAC;wBACJ,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,CAAC;wBAC9D,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;oBACtB,CAAC;gBACL,CAAC;YACL,CAAC;QACL,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAChE,CAAC;IACL,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,IAAY;QACtB,IAAI,CAAC,eAAe,EAAE,CAAC;QAEvB,UAAU,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;CACJ;AAjKD,8CAiKC"}