zigbee-herdsman 0.55.5 → 0.56.0

package/dist/adapter/ember/adapter/emberAdapter.js

@@ -38,7 +38,6 @@ const ZSpec = __importStar(require("../../../zspec"));
 const Zcl = __importStar(require("../../../zspec/zcl"));
 const Zdo = __importStar(require("../../../zspec/zdo"));
 const buffaloZdo_1 = require("../../../zspec/zdo/buffaloZdo");
-const events_1 = require("../../events");
 const serialPortUtils_1 = __importDefault(require("../../serialPortUtils"));
 const socketPortUtils_1 = __importDefault(require("../../socketPortUtils"));
 const consts_1 = require("../consts");
@@ -103,7 +102,6 @@ const BACKUP_OLDEST_SUPPORTED_EZSP_VERSION = 12;
  * NOTE: This is blocking the request queue, so we shouldn't go crazy high.
  */
 const BROADCAST_NETWORK_KEY_SWITCH_WAIT_TIME = 15000;
-const QUEUE_HIGH_COUNT = 4;
 const QUEUE_MAX_SEND_ATTEMPTS = 3;
 const QUEUE_BUSY_DEFER_MSEC = 500;
 const QUEUE_NETWORK_DOWN_DEFER_MSEC = 1500;
@@ -140,8 +138,8 @@ const TRUST_CENTER_ADDRESS_CACHE_SIZE = 2;
  * Removing `ENABLE_ROUTE_DISCOVERY` leads to devices that won't reconnect/go offline, and various other issues. Keeping it for now.
  */
 exports.DEFAULT_APS_OPTIONS = enums_1.EmberApsOption.RETRY | enums_1.EmberApsOption.ENABLE_ROUTE_DISCOVERY | enums_1.EmberApsOption.ENABLE_ADDRESS_DISCOVERY;
-/** Time for a ZDO request to get a callback response. ASH is 2400*6 for ACK timeout. */
-const DEFAULT_ZDO_REQUEST_TIMEOUT = 15000; // msec
+/** Time for a request to get a callback response. ASH is 2400*6 for ACK timeout. */
+const DEFAULT_REQUEST_TIMEOUT = 15000; // msec
 /** Time for a network-related request to get a response (usually via event). */
 const DEFAULT_NETWORK_REQUEST_TIMEOUT = 10000; // nothing on the network to bother requests, should be much faster than this
 /** Time between watchdog counters reading/clearing */
@@ -183,17 +181,33 @@ class EmberAdapter extends __1.Adapter {
     multicastTable;
     constructor(networkOptions, serialPortOptions, backupPath, adapterOptions) {
         super(networkOptions, serialPortOptions, backupPath, adapterOptions);
+        this.version = {
+            ezsp: 0,
+            revision: 'unknown',
+            build: 0,
+            major: 0,
+            minor: 0,
+            patch: 0,
+            special: 0,
+            type: enums_1.EmberVersionType.GA,
+        };
+        this.zdoRequestSequence = 0; // start at 1
+        this.interpanLock = false;
+        this.networkCache = (0, initters_1.initNetworkCache)();
+        this.manufacturerCode = DEFAULT_MANUFACTURER_CODE; // will be set in NCP in initEzsp
+        this.multicastTable = [];
         this.stackConfig = this.loadStackConfig();
         this.queue = new utils_1.Queue(this.adapterOptions.concurrent || 16); // ORed to avoid 0 (not checked in settings/queue constructor)
         this.oneWaitress = new oneWaitress_1.EmberOneWaitress();
         this.ezsp = new ezsp_1.Ezsp(serialPortOptions);
-        this.ezsp.on(ezsp_1.EzspEvents.ZDO_RESPONSE, this.onZDOResponse.bind(this));
-        this.ezsp.on(ezsp_1.EzspEvents.INCOMING_MESSAGE, this.onIncomingMessage.bind(this));
-        this.ezsp.on(ezsp_1.EzspEvents.TOUCHLINK_MESSAGE, this.onTouchlinkMessage.bind(this));
-        this.ezsp.on(ezsp_1.EzspEvents.STACK_STATUS, this.onStackStatus.bind(this));
-        this.ezsp.on(ezsp_1.EzspEvents.TRUST_CENTER_JOIN, this.onTrustCenterJoin.bind(this));
-        this.ezsp.on(ezsp_1.EzspEvents.MESSAGE_SENT, this.onMessageSent.bind(this));
-        this.ezsp.on(ezsp_1.EzspEvents.GREENPOWER_MESSAGE, this.onGreenpowerMessage.bind(this));
+        this.ezsp.on('zdoResponse', this.onZDOResponse.bind(this));
+        this.ezsp.on('incomingMessage', this.onIncomingMessage.bind(this));
+        this.ezsp.on('touchlinkMessage', this.onTouchlinkMessage.bind(this));
+        this.ezsp.on('stackStatus', this.onStackStatus.bind(this));
+        this.ezsp.on('trustCenterJoin', this.onTrustCenterJoin.bind(this));
+        this.ezsp.on('messageSent', this.onMessageSent.bind(this));
+        this.ezsp.on('greenpowerMessage', this.onGreenpowerMessage.bind(this));
+        this.ezsp.once('ncpNeedsResetAndInit', this.onNcpNeedsResetAndInit.bind(this));
     }
     loadStackConfig() {
         // store stack config in same dir as backup
@@ -349,7 +363,7 @@ class EmberAdapter extends __1.Adapter {
                     catch (error) {
                         // remove to allow retry on next occurrence
                         this.multicastTable.splice(tableIdx, 1);
-                        logger_1.logger.error(error, NS);
+                        logger_1.logger.error(error.message, NS);
                     }
                 }
                 break;
@@ -370,13 +384,13 @@ class EmberAdapter extends __1.Adapter {
             logger_1.logger.debug(`<~~~ [ZDO ${Zdo.ClusterId[apsFrame.clusterId]} from=${sender} ${payload ? JSON.stringify(payload) : 'OK'}]`, NS);
             this.oneWaitress.resolveZDO(sender, apsFrame, payload);
             if (apsFrame.clusterId === Zdo.ClusterId.NETWORK_ADDRESS_RESPONSE) {
-                this.emit(events_1.Events.networkAddress, {
+                this.emit('networkAddress', {
                     networkAddress: payload.nwkAddress,
                     ieeeAddr: payload.eui64,
                 });
             }
             else if (apsFrame.clusterId === Zdo.ClusterId.END_DEVICE_ANNOUNCE) {
-                this.emit(events_1.Events.deviceAnnounce, {
+                this.emit('deviceAnnounce', {
                     networkAddress: payload.nwkAddress,
                     ieeeAddr: payload.eui64,
                 });
@@ -408,7 +422,7 @@ class EmberAdapter extends __1.Adapter {
             destinationEndpoint: apsFrame.destinationEndpoint,
         };
         this.oneWaitress.resolveZCL(payload);
-        this.emit(events_1.Events.zclPayload, payload);
+        this.emit('zclPayload', payload);
     }
     /**
      * Emitted from @see Ezsp.ezspMacFilterMatchMessageHandler when the message is a valid InterPAN touchlink message.
@@ -433,7 +447,7 @@ class EmberAdapter extends __1.Adapter {
             destinationEndpoint: endpoint,
         };
         this.oneWaitress.resolveZCL(payload);
-        this.emit(events_1.Events.zclPayload, payload);
+        this.emit('zclPayload', payload);
     }
     /**
      * Emitted from @see Ezsp.ezspGpepIncomingMessageHandler
@@ -472,11 +486,11 @@ class EmberAdapter extends __1.Adapter {
                 destinationEndpoint: ZSpec.GP_ENDPOINT,
             };
             this.oneWaitress.resolveZCL(payload);
-            this.emit(events_1.Events.zclPayload, payload);
+            this.emit('zclPayload', payload);
         }
         catch (err) {
+            /* istanbul ignore next */
             logger_1.logger.error(`<~x~ [GP] Failed creating ZCL payload. Skipping. ${err}`, NS);
-            return;
         }
     }
     /**
@@ -495,7 +509,7 @@ class EmberAdapter extends __1.Adapter {
                 networkAddress: newNodeId,
                 ieeeAddr: newNodeEui64,
             };
-            this.emit(events_1.Events.deviceLeave, payload);
+            this.emit('deviceLeave', payload);
         }
         else {
             if (policyDecision !== enums_1.EmberJoinDecision.DENY_JOIN) {
@@ -510,11 +524,11 @@ class EmberAdapter extends __1.Adapter {
                         logger_1.logger.debug(`[WORKAROUND] Setting coordinator manufacturer code to ${Zcl.ManufacturerCode[joinManufCode]}.`, NS);
                         await this.ezsp.ezspSetManufacturerCode(joinManufCode);
                         this.manufacturerCode = joinManufCode;
-                        this.emit(events_1.Events.deviceJoined, payload);
+                        this.emit('deviceJoined', payload);
                     });
                 }
                 else {
-                    this.emit(events_1.Events.deviceJoined, payload);
+                    this.emit('deviceJoined', payload);
                 }
             }
             else {
@@ -531,17 +545,6 @@ class EmberAdapter extends __1.Adapter {
             logger_1.logger.info(`[ASH COUNTERS] ${ashCounters.join(',')}`, NS);
         });
     }
-    initVariables() {
-        this.ezsp.removeAllListeners(ezsp_1.EzspEvents.NCP_NEEDS_RESET_AND_INIT);
-        clearInterval(this.watchdogCountersHandle);
-        this.queue.clear();
-        this.zdoRequestSequence = 0; // start at 1
-        this.interpanLock = false;
-        this.networkCache = (0, initters_1.initNetworkCache)();
-        this.manufacturerCode = DEFAULT_MANUFACTURER_CODE; // will be set in NCP in initEzsp
-        this.multicastTable = [];
-        this.ezsp.once(ezsp_1.EzspEvents.NCP_NEEDS_RESET_AND_INIT, this.onNcpNeedsResetAndInit.bind(this));
-    }
     /**
      * Proceed to execute the long list of commands required to setup comms between Host<>NCP.
      * This is called by start and on internal reset.
@@ -726,7 +729,7 @@ class EmberAdapter extends __1.Adapter {
         const backup = this.getStoredBackup();
         if (initStatus === enums_1.SLStatus.NOT_JOINED || action === NetworkInitAction.LEFT) {
             // no network
-            if (backup != null) {
+            if (backup != undefined) {
                 if (this.networkOptions.panID === backup.networkOptions.panId &&
                     Buffer.from(this.networkOptions.extendedPanID).equals(backup.networkOptions.extendedPanId) &&
                     this.networkOptions.channelList.includes(backup.logicalChannel) &&
@@ -751,6 +754,7 @@ class EmberAdapter extends __1.Adapter {
         switch (action) {
             case NetworkInitAction.FORM_BACKUP: {
                 logger_1.logger.info(`[INIT TC] Forming from backup.`, NS);
+                // `backup` valid in this `action` path (not detected by TS)
                 /* istanbul ignore next */
                 const keyList = backup.devices.map((device) => {
                     const octets = Array.from(device.ieeeAddress.reverse());
@@ -855,14 +859,14 @@ class EmberAdapter extends __1.Adapter {
      */
     getStoredBackup() {
         if (!(0, fs_1.existsSync)(this.backupPath)) {
-            return null;
+            return undefined;
         }
         let data;
         try {
             data = JSON.parse((0, fs_1.readFileSync)(this.backupPath).toString());
         }
         catch (error) {
-            throw new Error(`[BACKUP] Coordinator backup is corrupted. (${error.message})`);
+            throw new Error(`[BACKUP] Coordinator backup is corrupted. (${error.stack})`);
         }
         if (data.metadata?.format === 'zigpy/open-coordinator-backup' && data.metadata?.version) {
             if (data.metadata?.version !== 1) {
@@ -874,7 +878,7 @@ class EmberAdapter extends __1.Adapter {
             if (data.metadata.internal.ezspVersion < BACKUP_OLDEST_SUPPORTED_EZSP_VERSION) {
                 (0, fs_1.renameSync)(this.backupPath, `${this.backupPath}.old`);
                 logger_1.logger.warning(`[BACKUP] Current backup file is from an unsupported EZSP version. Renaming and ignoring.`, NS);
-                return null;
+                return undefined;
             }
             return utils_1.BackupUtils.fromUnifiedBackup(data);
         }
@@ -987,23 +991,8 @@ class EmberAdapter extends __1.Adapter {
      * @param status
      */
     async onNcpNeedsResetAndInit(status) {
-        logger_1.logger.error(`!!! ADAPTER FATAL ERROR reason=${enums_1.EzspStatus[status]}. !!!`, NS);
-        if (this.queue.count() > QUEUE_HIGH_COUNT) {
-            logger_1.logger.info(`Request queue is high (${this.queue.count()}), triggering full restart to prevent stressing the adapter.`, NS);
-            this.emit(events_1.Events.disconnected);
-        }
-        else {
-            logger_1.logger.info(`Attempting adapter reset...`, NS);
-            try {
-                await this.stop();
-                await (0, utils_1.Wait)(500); // just because
-                await this.start();
-            }
-            catch (err) {
-                logger_1.logger.error(`Failed to reset and init adapter. ${err}`, NS);
-                this.emit(events_1.Events.disconnected);
-            }
-        }
+        logger_1.logger.error(`Adapter fatal error: ${enums_1.EzspStatus[status]}`, NS);
+        this.emit('disconnected');
     }
     //---- START Events
     //---- END Events
@@ -1196,8 +1185,8 @@ class EmberAdapter extends __1.Adapter {
      */
     async emberPermitJoining(duration, broadcastMgmtPermitJoin) {
         let status = await this.ezsp.ezspPermitJoining(duration);
-        let apsFrame = null;
-        let messageTag = null;
+        let apsFrame;
+        let messageTag;
         logger_1.logger.debug(`Permit joining for ${duration} sec. status=${[status]}`, NS);
         if (broadcastMgmtPermitJoin) {
             // `authentication`: TC significance always 1 (zb specs)
@@ -1306,17 +1295,17 @@ class EmberAdapter extends __1.Adapter {
     static async autoDetectPath() {
         const paths = await serialPortUtils_1.default.find(autoDetectDefinitions);
         paths.sort((a, b) => (a < b ? -1 : 1));
-        return paths.length > 0 ? paths[0] : null;
+        return paths.length > 0 ? paths[0] : undefined;
     }
     async start() {
         logger_1.logger.info(`======== Ember Adapter Starting ========`, NS);
-        this.initVariables();
         const result = await this.initEzsp();
         return result;
     }
     async stop() {
+        clearInterval(this.watchdogCountersHandle);
         await this.ezsp.stop();
-        this.initVariables();
+        this.ezsp.removeAllListeners();
         logger_1.logger.info(`======== Ember Adapter Stopped ========`, NS);
     }
     // queued, non-InterPAN
@@ -1388,14 +1377,11 @@ class EmberAdapter extends __1.Adapter {
             if (nkStatus !== enums_1.SLStatus.OK) {
                 throw new Error(`[BACKUP] Failed to export Network Key with status=${enums_1.SLStatus[nkStatus]}.`);
             }
-            const zbChannels = Array.from(Array(ZSpec.NUM_802_15_4_CHANNELS), (e, i) => i + ZSpec.MIN_802_15_4_CHANNEL_NUMBER);
             return {
                 networkOptions: {
                     panId: netParams.panId, // uint16_t
                     extendedPanId: Buffer.from(netParams.extendedPanId),
-                    channelList: zbChannels
-                        .map(/* istanbul ignore next */ (c) => ((2 ** c) & netParams.channels ? c : null))
-                        .filter((x) => x),
+                    channelList: ZSpec.Utils.uint32MaskToChannels(netParams.channels),
                     networkKey: networkKey.contents,
                     networkKeyDistribute: false,
                 },
@@ -1570,7 +1556,7 @@ class EmberAdapter extends __1.Adapter {
                     target: networkAddress,
                     apsFrame,
                     responseClusterId: Zdo.ClusterId.PERMIT_JOINING_RESPONSE,
-                }, DEFAULT_ZDO_REQUEST_TIMEOUT);
+                }, DEFAULT_REQUEST_TIMEOUT);
             });
         }
         else {
@@ -1618,7 +1604,7 @@ class EmberAdapter extends __1.Adapter {
                     target: networkAddress,
                     apsFrame,
                     responseClusterId: Zdo.ClusterId.LQI_TABLE_RESPONSE,
-                }, DEFAULT_ZDO_REQUEST_TIMEOUT);
+                }, DEFAULT_REQUEST_TIMEOUT);
                 for (const entry of result.entryList) {
                     neighbors.push({
                         ieeeAddr: entry.eui64,
@@ -1655,7 +1641,7 @@ class EmberAdapter extends __1.Adapter {
                     target: networkAddress,
                     apsFrame,
                     responseClusterId: Zdo.ClusterId.ROUTING_TABLE_RESPONSE,
-                }, DEFAULT_ZDO_REQUEST_TIMEOUT);
+                }, DEFAULT_REQUEST_TIMEOUT);
                 for (const entry of result.entryList) {
                     table.push({
                         destinationAddress: entry.destinationAddress,
@@ -1688,7 +1674,7 @@ class EmberAdapter extends __1.Adapter {
                 target: networkAddress,
                 apsFrame,
                 responseClusterId: Zdo.ClusterId.NODE_DESCRIPTOR_RESPONSE,
-            }, DEFAULT_ZDO_REQUEST_TIMEOUT);
+            }, DEFAULT_REQUEST_TIMEOUT);
             let type = 'Unknown';
             switch (result.logicalType) {
                 case 0x0:
@@ -1723,7 +1709,7 @@ class EmberAdapter extends __1.Adapter {
                 target: networkAddress,
                 apsFrame,
                 responseClusterId: Zdo.ClusterId.ACTIVE_ENDPOINTS_RESPONSE,
-            }, DEFAULT_ZDO_REQUEST_TIMEOUT);
+            }, DEFAULT_REQUEST_TIMEOUT);
             return { endpoints: result.endpointList };
         }, networkAddress);
     }
@@ -1740,7 +1726,7 @@ class EmberAdapter extends __1.Adapter {
                 target: networkAddress,
                 apsFrame,
                 responseClusterId: Zdo.ClusterId.SIMPLE_DESCRIPTOR_RESPONSE,
-            }, DEFAULT_ZDO_REQUEST_TIMEOUT);
+            }, DEFAULT_REQUEST_TIMEOUT);
             return {
                 profileID: result.profileId,
                 endpointID: result.endpoint,
@@ -1756,7 +1742,7 @@ class EmberAdapter extends __1.Adapter {
             this.checkInterpanLock();
             const zdoPayload = buffaloZdo_1.BuffaloZdo.buildBindRequest(sourceIeeeAddress, sourceEndpoint, clusterID, type === 'group' ? Zdo.MULTICAST_BINDING : Zdo.UNICAST_BINDING, destinationAddressOrGroup, // not used with MULTICAST_BINDING
             destinationAddressOrGroup, // not used with UNICAST_BINDING
-            destinationEndpoint);
+            destinationEndpoint ?? 0);
             const [status, apsFrame] = await this.sendZDORequest(destinationNetworkAddress, Zdo.ClusterId.BIND_REQUEST, zdoPayload, exports.DEFAULT_APS_OPTIONS);
             if (status !== enums_1.SLStatus.OK) {
                 throw new Error(`[ZDO] Failed bind request for '${destinationNetworkAddress}' destination '${destinationAddressOrGroup}' endpoint '${destinationEndpoint}' with status=${enums_1.SLStatus[status]}.`);
@@ -1765,7 +1751,7 @@ class EmberAdapter extends __1.Adapter {
                 target: destinationNetworkAddress,
                 apsFrame,
                 responseClusterId: Zdo.ClusterId.BIND_RESPONSE,
-            }, DEFAULT_ZDO_REQUEST_TIMEOUT);
+            }, DEFAULT_REQUEST_TIMEOUT);
         }, destinationNetworkAddress);
     }
     // queued, non-InterPAN
@@ -1774,7 +1760,7 @@ class EmberAdapter extends __1.Adapter {
             this.checkInterpanLock();
             const zdoPayload = buffaloZdo_1.BuffaloZdo.buildUnbindRequest(sourceIeeeAddress, sourceEndpoint, clusterID, type === 'group' ? Zdo.MULTICAST_BINDING : Zdo.UNICAST_BINDING, destinationAddressOrGroup, // not used with MULTICAST_BINDING
             destinationAddressOrGroup, // not used with UNICAST_BINDING
-            destinationEndpoint);
+            destinationEndpoint ?? 0);
             const [status, apsFrame] = await this.sendZDORequest(destinationNetworkAddress, Zdo.ClusterId.UNBIND_REQUEST, zdoPayload, exports.DEFAULT_APS_OPTIONS);
             if (status !== enums_1.SLStatus.OK) {
                 throw new Error(`[ZDO] Failed unbind request for '${destinationNetworkAddress}' destination '${destinationAddressOrGroup}' endpoint '${destinationEndpoint}' with status=${enums_1.SLStatus[status]}.`);
@@ -1783,7 +1769,7 @@ class EmberAdapter extends __1.Adapter {
                 target: destinationNetworkAddress,
                 apsFrame,
                 responseClusterId: Zdo.ClusterId.UNBIND_RESPONSE,
-            }, DEFAULT_ZDO_REQUEST_TIMEOUT);
+            }, DEFAULT_REQUEST_TIMEOUT);
         }, destinationNetworkAddress);
     }
     // queued, non-InterPAN
@@ -1799,7 +1785,7 @@ class EmberAdapter extends __1.Adapter {
                 target: networkAddress,
                 apsFrame,
                 responseClusterId: Zdo.ClusterId.LEAVE_RESPONSE,
-            }, DEFAULT_ZDO_REQUEST_TIMEOUT);
+            }, DEFAULT_REQUEST_TIMEOUT);
         }, networkAddress);
     }
     //---- ZCL
@@ -1807,7 +1793,7 @@ class EmberAdapter extends __1.Adapter {
     async sendZclFrameToEndpoint(ieeeAddr, networkAddress, endpoint, zclFrame, timeout, disableResponse, disableRecovery, sourceEndpoint) {
         const sourceEndpointInfo = (sourceEndpoint && endpoints_1.FIXED_ENDPOINTS.find((epi) => epi.endpoint === sourceEndpoint)) || endpoints_1.FIXED_ENDPOINTS[0];
         const command = zclFrame.command;
-        let commandResponseId = null;
+        let commandResponseId;
         if (command.response !== undefined && disableResponse === false) {
             commandResponseId = command.response;
         }
@@ -1824,7 +1810,7 @@ class EmberAdapter extends __1.Adapter {
             sequence: 0, // set by stack
         };
         // don't RETRY if no response expected
-        if (commandResponseId == null) {
+        if (commandResponseId === undefined) {
             apsFrame.options &= ~enums_1.EmberApsOption.RETRY;
         }
         const data = zclFrame.toBuffer();
@@ -1870,7 +1856,7 @@ class EmberAdapter extends __1.Adapter {
                 }
                 logger_1.logger.debug(`~x~> [ZCL to=${networkAddress}] Failed to send request attempt ${i}/${QUEUE_MAX_SEND_ATTEMPTS} with status=${enums_1.SLStatus[status]}.`, NS);
             }
-            if (commandResponseId != null) {
+            if (commandResponseId !== undefined) {
                 // NOTE: aps sequence number will have been set by send function
                 const result = await this.oneWaitress.startWaitingFor({
                     target: networkAddress,
@@ -1880,7 +1866,6 @@ class EmberAdapter extends __1.Adapter {
                 }, timeout);
                 return result;
             }
-            return null;
         }, networkAddress);
     }
     // queued, non-InterPAN
@@ -2015,7 +2000,7 @@ class EmberAdapter extends __1.Adapter {
             }
             // NOTE: can use ezspRawTransmitCompleteHandler if needed here
             const result = await this.oneWaitress.startWaitingFor({
-                target: null,
+                target: undefined,
                 apsFrame: apsFrame,
                 zclSequence: zclFrame.header.transactionSequenceNumber,
                 commandIdentifier: command.response,