zigbee-herdsman 0.55.5 → 0.56.0

package/dist/adapter/ember/ezsp/ezsp.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Ezsp = exports.EzspEvents = void 0;
+exports.Ezsp = void 0;
 /* istanbul ignore file */
 const events_1 = __importDefault(require("events"));
 const utils_1 = require("../../../utils");
@@ -65,24 +65,6 @@ const ZA_MAX_HOPS = 12;
  * Customers who call ezspSend functions directly must use message tags outside this mask.
  */
 const MESSAGE_TAG_MASK = 0x7f;
-var EzspEvents;
-(function (EzspEvents) {
-    //-- An error was detected that requires resetting the NCP.
-    EzspEvents["NCP_NEEDS_RESET_AND_INIT"] = "NCP_NEEDS_RESET_AND_INIT";
-    //-- ezspIncomingMessageHandler
-    EzspEvents["ZDO_RESPONSE"] = "ZDO_RESPONSE";
-    EzspEvents["INCOMING_MESSAGE"] = "INCOMING_MESSAGE";
-    //-- ezspMacFilterMatchMessageHandler
-    EzspEvents["TOUCHLINK_MESSAGE"] = "TOUCHLINK_MESSAGE";
-    //-- ezspStackStatusHandler
-    EzspEvents["STACK_STATUS"] = "STACK_STATUS";
-    //-- ezspTrustCenterJoinHandler
-    EzspEvents["TRUST_CENTER_JOIN"] = "TRUST_CENTER_JOIN";
-    //-- ezspMessageSentHandler
-    EzspEvents["MESSAGE_SENT"] = "MESSAGE_SENT";
-    //-- ezspGpepIncomingMessageHandler
-    EzspEvents["GREENPOWER_MESSAGE"] = "GREENPOWER_MESSAGE";
-})(EzspEvents || (exports.EzspEvents = EzspEvents = {}));
 /**
  * Host EZSP layer.
  *
@@ -113,18 +95,25 @@ class Ezsp extends events_1.default {
     /** Sequence used for EZSP send() tagging. static uint8_t */
     sendSequence;
     queue;
-    /** Awaiting response resolve/timer struct. Null if not waiting for response. */
+    /** Awaiting response resolve/timer struct. undefined if not waiting for response. */
     responseWaiter;
     /** Counter for Queue Full errors */
     counterErrQueueFull;
     constructor(options) {
         super();
         this.frameContents = Buffer.alloc(consts_2.EZSP_MAX_FRAME_LENGTH);
-        this.buffalo = new buffalo_1.EzspBuffalo(this.frameContents);
+        this.buffalo = new buffalo_1.EzspBuffalo(this.frameContents, 0);
         this.callbackFrameContents = Buffer.alloc(consts_2.EZSP_MAX_FRAME_LENGTH);
-        this.callbackBuffalo = new buffalo_1.EzspBuffalo(this.callbackFrameContents);
+        this.callbackBuffalo = new buffalo_1.EzspBuffalo(this.callbackFrameContents, 0);
         this.queue = new utils_1.Queue(1);
         this.ash = new ash_1.UartAsh(options);
+        this.version = 0;
+        this.frameLength = 0;
+        this.callbackFrameLength = 0;
+        this.initialVersionSent = false;
+        this.frameSequence = -1; // start at 0
+        this.sendSequence = 0; // start at 1
+        this.counterErrQueueFull = 0;
     }
     /**
      * Returns the number of EZSP responses that have been received by the serial
@@ -148,25 +137,9 @@ class Ezsp extends events_1.default {
         const id = this.callbackBuffalo.getFrameId();
         return `[CBFRAME: ID=${id}:"${enums_2.EzspFrameID[id]}" Seq=${this.callbackFrameContents[consts_2.EZSP_SEQUENCE_INDEX]} Len=${this.callbackFrameLength}]`;
     }
-    initVariables() {
-        this.ash.removeAllListeners(ash_1.AshEvents.FATAL_ERROR);
-        this.ash.removeAllListeners(ash_1.AshEvents.FRAME);
-        this.queue.clear();
-        this.frameContents.fill(0);
-        this.frameLength = 0;
-        this.buffalo.setPosition(0);
-        this.callbackFrameContents.fill(0);
-        this.callbackFrameLength = 0;
-        this.callbackBuffalo.setPosition(0);
-        this.initialVersionSent = false;
-        this.frameSequence = -1; // start at 0
-        this.sendSequence = 0; // start at 1
-        this.counterErrQueueFull = 0;
-    }
     async start() {
         logger_1.logger.info(`======== EZSP starting ========`, NS);
-        this.initVariables();
-        let status;
+        let status = enums_1.EzspStatus.HOST_FATAL_ERROR;
         for (let i = 0; i < MAX_INIT_ATTEMPTS; i++) {
             status = await this.ash.resetNcp();
             // fail early if we couldn't even get the port set up
@@ -177,8 +150,8 @@ class Ezsp extends events_1.default {
             if (status === enums_1.EzspStatus.SUCCESS) {
                 logger_1.logger.info(`======== EZSP started ========`, NS);
                 // registered after reset sequence
-                this.ash.on(ash_1.AshEvents.FRAME, this.onAshFrame.bind(this));
-                this.ash.on(ash_1.AshEvents.FATAL_ERROR, this.onAshFatalError.bind(this));
+                this.ash.on('frame', this.onAshFrame.bind(this));
+                this.ash.on('fatalError', this.onAshFatalError.bind(this));
                 return status;
             }
         }
@@ -190,7 +163,7 @@ class Ezsp extends events_1.default {
      */
     async stop() {
         await this.ash.stop();
-        this.initVariables();
+        this.ash.removeAllListeners();
         logger_1.logger.info(`======== EZSP stopped ========`, NS);
     }
     /**
@@ -210,18 +183,18 @@ class Ezsp extends events_1.default {
         return this.ash.connected;
     }
     /**
-     * Triggered by @see AshEvents.FATAL_ERROR
+     * Triggered by @see 'FATAL_ERROR'
      */
     onAshFatalError(status) {
-        this.emit(EzspEvents.NCP_NEEDS_RESET_AND_INIT, status);
+        this.emit('ncpNeedsResetAndInit', status);
     }
     /**
-     * Triggered by @see AshEvents.FRAME
+     * Triggered by @see 'FRAME'
      */
     onAshFrame() {
         // trigger housekeeping in ASH layer
         this.ash.sendExec();
-        const buffer = this.ash.rxQueue.getPrecedingEntry(null);
+        const buffer = this.ash.rxQueue.getPrecedingEntry();
         if (buffer == null) {
             // something is seriously wrong
             logger_1.logger.error(`Found no buffer in queue but ASH layer sent signal that one was available.`, NS);
@@ -249,11 +222,11 @@ class Ezsp extends events_1.default {
             this.frameLength = buffer.len;
             logger_1.logger.debug(`<=== ${this.frameToString}`, NS);
             this.ash.rxFree.freeBuffer(buffer); // always
-            if (this.responseWaiter != null) {
+            if (this.responseWaiter !== undefined) {
                 const status = this.validateReceivedFrame(this.buffalo);
                 clearTimeout(this.responseWaiter.timer);
                 this.responseWaiter.resolve(status);
-                this.responseWaiter = null; // done, gc
+                this.responseWaiter = undefined; // done, gc
             }
             else {
                 logger_1.logger.debug(`Received response while not expecting one. Ignoring.`, NS);
@@ -289,7 +262,7 @@ class Ezsp extends events_1.default {
             status !== enums_1.EzspStatus.ERROR_OVERFLOW &&
             status !== enums_1.EzspStatus.ERROR_QUEUE_FULL &&
             status !== enums_1.EzspStatus.ERROR_WRONG_DIRECTION) {
-            this.emit(EzspEvents.NCP_NEEDS_RESET_AND_INIT, status);
+            this.emit('ncpNeedsResetAndInit', status);
         }
     }
     nextFrameSequence() {
@@ -384,7 +357,7 @@ class Ezsp extends events_1.default {
                 }
             }
             catch (error) {
-                this.responseWaiter = null;
+                this.responseWaiter = undefined;
                 logger_1.logger.debug(`=x=> ${frameString} ${error}`, NS);
                 if (error instanceof ezspError_1.EzspError) {
                     status = error.code;
@@ -919,7 +892,7 @@ class Ezsp extends events_1.default {
                     (apsFrame.sourceEndpoint === ZSpec.GP_ENDPOINT &&
                         apsFrame.destinationEndpoint === ZSpec.GP_ENDPOINT &&
                         apsFrame.options & enums_1.EmberApsOption.USE_ALIAS_SEQUENCE_NUMBER)) {
-                    nwkRadius = apsFrame.radius;
+                    nwkRadius = apsFrame.radius ?? nwkRadius;
                     nwkAlias = alias;
                 }
                 [status, apsSequence] = await this.ezspSendMulticast(apsFrame, nwkRadius, 0, // broadcast addr
@@ -932,14 +905,12 @@ class Ezsp extends events_1.default {
                     (apsFrame.sourceEndpoint == ZSpec.GP_ENDPOINT &&
                         apsFrame.destinationEndpoint == ZSpec.GP_ENDPOINT &&
                         apsFrame.options & enums_1.EmberApsOption.USE_ALIAS_SEQUENCE_NUMBER)) {
-                    nwkRadius = apsFrame.radius;
+                    nwkRadius = apsFrame.radius ?? nwkRadius;
                     nwkAlias = alias;
                 }
                 [status, apsSequence] = await this.ezspSendBroadcast(nwkAlias, indexOrDestination, sequence, apsFrame, nwkRadius, messageTag, message);
                 break;
             }
-            default:
-                break;
         }
         apsFrame.sequence = apsSequence;
         // NOTE: match `~~~>` from adapter since this is just a wrapper for it
@@ -2123,7 +2094,7 @@ class Ezsp extends events_1.default {
      */
     ezspStackStatusHandler(status) {
         logger_1.logger.debug(`ezspStackStatusHandler(): callback called with: [status=${enums_1.SLStatus[status]}]`, NS);
-        this.emit(EzspEvents.STACK_STATUS, status);
+        this.emit('stackStatus', status);
     }
     /**
      * This function will start a scan.
@@ -3884,11 +3855,11 @@ class Ezsp extends events_1.default {
      * @param messageContents uint8_t * The unicast message supplied by the Host. The message contents are only included here if the decision
      *        for the messageContentsInCallback policy is messageTagAndContentsInCallback.
      */
-    ezspMessageSentHandler(status, type, indexOrDestination, apsFrame, messageTag, messageContents = undefined) {
+    ezspMessageSentHandler(status, type, indexOrDestination, apsFrame, messageTag, messageContents) {
         logger_1.logger.debug(`ezspMessageSentHandler(): callback called with: [status=${enums_1.SLStatus[status]}], [type=${enums_1.EmberOutgoingMessageType[type]}], ` +
             `[indexOrDestination=${indexOrDestination}], [apsFrame=${JSON.stringify(apsFrame)}], [messageTag=${messageTag}]` +
             (messageContents ? `, [messageContents=${messageContents.toString('hex')}]` : ''), NS);
-        this.emit(EzspEvents.MESSAGE_SENT, status, type, indexOrDestination, apsFrame, messageTag);
+        this.emit('messageSent', status, type, indexOrDestination, apsFrame, messageTag);
     }
     /**
      * Sends a route request packet that creates routes from every node in the
@@ -4104,10 +4075,10 @@ class Ezsp extends events_1.default {
         logger_1.logger.debug(`ezspIncomingMessageHandler(): callback called with: [type=${enums_1.EmberIncomingMessageType[type]}], [apsFrame=${JSON.stringify(apsFrame)}], ` +
             `[packetInfo:${JSON.stringify(packetInfo)}], [messageContents=${messageContents.toString('hex')}]`, NS);
         if (apsFrame.profileId === Zdo.ZDO_PROFILE_ID) {
-            this.emit(EzspEvents.ZDO_RESPONSE, apsFrame, packetInfo.senderShortId, messageContents);
+            this.emit('zdoResponse', apsFrame, packetInfo.senderShortId, messageContents);
         }
         else if (apsFrame.profileId === ZSpec.HA_PROFILE_ID || apsFrame.profileId === ZSpec.WILDCARD_PROFILE_ID) {
-            this.emit(EzspEvents.INCOMING_MESSAGE, type, apsFrame, packetInfo.lastHopLqi, packetInfo.senderShortId, messageContents);
+            this.emit('incomingMessage', type, apsFrame, packetInfo.lastHopLqi, packetInfo.senderShortId, messageContents);
         }
         else if (apsFrame.profileId === ZSpec.GP_PROFILE_ID) {
             // only broadcast loopback in here
@@ -4475,7 +4446,7 @@ class Ezsp extends events_1.default {
         // XXX: this is currently causing more problems than not doing it, so disabled for now.
         //      devices should rejoin on ID conflict anyway, so the database isn't out of sync for very long.
         // hijacking the event from `ezspTrustCenterJoinHandler`, and forging a DEVICE_LEFT to avoid another event ending up doing the same logic
-        // this.emit(EzspEvents.TRUST_CENTER_JOIN, id, null, EmberDeviceUpdate.DEVICE_LEFT, EmberJoinDecision.NO_ACTION, NULL_NODE_ID);
+        // this.emit('trustCenterJoin', id, null, EmberDeviceUpdate.DEVICE_LEFT, EmberJoinDecision.NO_ACTION, NULL_NODE_ID);
     }
     /**
      * Write the current node Id, PAN ID, or Node type to the tokens
@@ -4575,7 +4546,7 @@ class Ezsp extends events_1.default {
             return;
         }
         const messageType = apsFrameControl & consts_1.INTERPAN_APS_FRAME_DELIVERY_MODE_MASK;
-        let groupId = null;
+        let groupId = 0; // XXX: looks fine from z2m code?
         switch (messageType) {
             case enums_1.EmberInterpanMessageType.UNICAST:
             case enums_1.EmberInterpanMessageType.BROADCAST: {
@@ -4602,7 +4573,7 @@ class Ezsp extends events_1.default {
         const profileId = msgBuffalo.readUInt16();
         const payload = msgBuffalo.readRest();
         if (profileId === ZSpec.TOUCHLINK_PROFILE_ID && clusterId === cluster_1.Clusters.touchlink.ID) {
-            this.emit(EzspEvents.TOUCHLINK_MESSAGE, sourcePanId, sourceAddress, groupId, packetInfo.lastHopLqi, payload);
+            this.emit('touchlinkMessage', sourcePanId, sourceAddress, groupId, packetInfo.lastHopLqi, payload);
         }
     }
     /**
@@ -5200,7 +5171,7 @@ class Ezsp extends events_1.default {
             const plaintextKey = this.buffalo.readSecManKey();
             const keyData = this.buffalo.readSecManAPSKeyMetadata();
             const status = this.buffalo.readUInt32();
-            return [status, , plaintextKey, keyData];
+            return [status, context, plaintextKey, keyData];
         }
         else {
             const status = this.buffalo.readUInt32();
@@ -5428,7 +5399,7 @@ class Ezsp extends events_1.default {
         logger_1.logger.debug(`ezspTrustCenterJoinHandler(): callback called with: [newNodeId=${newNodeId}], [newNodeEui64=${newNodeEui64}], ` +
             `[status=${enums_1.EmberDeviceUpdate[status]}], [policyDecision=${enums_1.EmberJoinDecision[policyDecision]}], [parentOfNewNodeId=${parentOfNewNodeId}]`, NS);
         // NOTE: this is mostly just passing stuff up to Z2M, so use only one emit for all, let adapter do the rest, no parsing needed
-        this.emit(EzspEvents.TRUST_CENTER_JOIN, newNodeId, newNodeEui64, status, policyDecision, parentOfNewNodeId);
+        this.emit('trustCenterJoin', newNodeId, newNodeEui64, status, policyDecision, parentOfNewNodeId);
     }
     /**
      * This function broadcasts a new encryption key, but does not tell the nodes in
@@ -6687,7 +6658,7 @@ class Ezsp extends events_1.default {
             }
             commandIdentifier = cluster_1.Clusters.greenPower.commands.commissioningNotification.ID;
         }
-        this.emit(EzspEvents.GREENPOWER_MESSAGE, sequenceNumber, commandIdentifier, addr.sourceId, gpdSecurityFrameCounter, gpdCommandId, gpdCommandPayload, gpdLink);
+        this.emit('greenpowerMessage', sequenceNumber, commandIdentifier, addr.sourceId, gpdSecurityFrameCounter, gpdCommandId, gpdCommandPayload, gpdLink);
     }
     /**
      * Retrieves the proxy table entry stored at the passed index.