zigbee-herdsman 3.5.2 → 4.0.2

package/dist/adapter/ember/uart/ash.js

@@ -18,7 +18,7 @@ const enums_2 = require("./enums");
 const parser_1 = require("./parser");
 const queues_1 = require("./queues");
 const writer_1 = require("./writer");
-const NS = 'zh:ember:uart:ash';
+const NS = "zh:ember:uart:ash";
 /** ASH get rflag in control byte */
 // const ashGetRFlag = (ctrl: number): number => (ctrl & ASH_RFLAG_MASK) >> ASH_RFLAG_BIT;
 /** ASH get nflag in control byte */
@@ -261,13 +261,15 @@ class UartAsh extends node_events_1.EventEmitter {
         this.reTxQueue.tail = undefined;
         this.txFree.link = undefined;
         for (let i = 0; i < consts_1.TX_POOL_BUFFERS; i++) {
-            this.txFree.freeBuffer((this.txPool[i] = new queues_1.EzspBuffer()));
+            this.txPool[i] = new queues_1.EzspBuffer();
+            this.txFree.freeBuffer(this.txPool[i]);
         }
         // All receive buffers are put into rxFree, and rxQueue is empty.
         this.rxQueue.tail = undefined;
         this.rxFree.link = undefined;
         for (let i = 0; i < consts_1.EZSP_HOST_RX_POOL_SIZE; i++) {
-            this.rxFree.freeBuffer((this.rxPool[i] = new queues_1.EzspBuffer()));
+            this.rxPool[i] = new queues_1.EzspBuffer();
+            this.rxFree.freeBuffer(this.rxPool[i]);
         }
     }
     /**
@@ -277,12 +279,11 @@ class UartAsh extends node_events_1.EventEmitter {
         if (this.closing) {
             return false;
         }
+        // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
         if (socketPortUtils_1.default.isTcpPath(this.portOptions.path)) {
             return this.socketPort ? !this.socketPort.closed : false;
         }
-        else {
-            return this.serialPort ? this.serialPort.isOpen : false;
-        }
+        return this.serialPort ? this.serialPort.isOpen : false;
     }
     /**
      * Get max wait time before response is considered timed out.
@@ -324,25 +325,27 @@ class UartAsh extends node_events_1.EventEmitter {
      */
     async initPort() {
         await this.closePort(); // will do nothing if nothing's open
+        // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
         if (!socketPortUtils_1.default.isTcpPath(this.portOptions.path)) {
             const serialOpts = {
+                // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
                 path: this.portOptions.path,
-                baudRate: typeof this.portOptions.baudRate === 'number' ? this.portOptions.baudRate : 115200,
-                rtscts: typeof this.portOptions.rtscts === 'boolean' ? this.portOptions.rtscts : false,
+                baudRate: typeof this.portOptions.baudRate === "number" ? this.portOptions.baudRate : 115200,
+                rtscts: typeof this.portOptions.rtscts === "boolean" ? this.portOptions.rtscts : false,
                 autoOpen: false,
-                parity: 'none',
+                parity: "none",
                 stopBits: 1,
                 xon: false,
                 xoff: false,
             };
             // enable software flow control if RTS/CTS not enabled in config
             if (!serialOpts.rtscts) {
-                logger_1.logger.info(`RTS/CTS config is off, enabling software flow control.`, NS);
+                logger_1.logger.info("RTS/CTS config is off, enabling software flow control.", NS);
                 serialOpts.xon = true;
                 serialOpts.xoff = true;
             }
             // @ts-expect-error Jest testing
-            if (this.portOptions.binding != undefined) {
+            if (this.portOptions.binding !== undefined) {
                 // @ts-expect-error Jest testing
                 serialOpts.binding = this.portOptions.binding;
             }
@@ -350,12 +353,12 @@ class UartAsh extends node_events_1.EventEmitter {
             this.serialPort = new serialPort_1.SerialPort(serialOpts);
             this.writer.pipe(this.serialPort);
             this.serialPort.pipe(this.parser);
-            this.parser.on('data', this.onFrame.bind(this));
+            this.parser.on("data", this.onFrame.bind(this));
             try {
                 await this.serialPort.asyncOpen();
-                logger_1.logger.info(`Serial port opened`, NS);
-                this.serialPort.once('close', this.onPortClose.bind(this));
-                this.serialPort.on('error', this.onPortError.bind(this));
+                logger_1.logger.info("Serial port opened", NS);
+                this.serialPort.once("close", this.onPortClose.bind(this));
+                this.serialPort.on("error", this.onPortError.bind(this));
             }
             catch (error) {
                 await this.stop();
@@ -363,6 +366,7 @@ class UartAsh extends node_events_1.EventEmitter {
             }
         }
         else {
+            // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
             const info = socketPortUtils_1.default.parseTcpPath(this.portOptions.path);
             logger_1.logger.debug(`Opening TCP socket with ${info.host}:${info.port}`, NS);
             this.socketPort = new node_net_1.Socket();
@@ -370,23 +374,30 @@ class UartAsh extends node_events_1.EventEmitter {
             this.socketPort.setKeepAlive(true, 15000);
             this.writer.pipe(this.socketPort);
             this.socketPort.pipe(this.parser);
-            this.parser.on('data', this.onFrame.bind(this));
+            this.parser.on("data", this.onFrame.bind(this));
             return await new Promise((resolve, reject) => {
                 const openError = async (err) => {
                     await this.stop();
                     reject(err);
                 };
-                this.socketPort.on('connect', () => {
-                    logger_1.logger.debug(`Socket connected`, NS);
+                // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
+                this.socketPort.on("connect", () => {
+                    logger_1.logger.debug("Socket connected", NS);
                 });
-                this.socketPort.on('ready', () => {
-                    logger_1.logger.info(`Socket ready`, NS);
-                    this.socketPort.removeListener('error', openError);
-                    this.socketPort.once('close', this.onPortClose.bind(this));
-                    this.socketPort.on('error', this.onPortError.bind(this));
+                // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
+                this.socketPort.on("ready", () => {
+                    logger_1.logger.info("Socket ready", NS);
+                    // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
+                    this.socketPort.removeListener("error", openError);
+                    // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
+                    this.socketPort.once("close", this.onPortClose.bind(this));
+                    // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
+                    this.socketPort.on("error", this.onPortError.bind(this));
                     resolve();
                 });
-                this.socketPort.once('error', openError);
+                // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
+                this.socketPort.once("error", openError);
+                // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
                 this.socketPort.connect(info.port, info.host);
             });
         }
@@ -395,22 +406,22 @@ class UartAsh extends node_events_1.EventEmitter {
      * Handle port closing
      * @param err A boolean for Socket, an Error for serialport
      */
-    async onPortClose(error) {
-        logger_1.logger.info(`Port closed.`, NS);
+    onPortClose(error) {
+        logger_1.logger.info("Port closed.", NS);
         if (error && this.flags !== 0) {
             logger_1.logger.info(`Port close ${error}`, NS);
             this.flags = 0;
-            this.emit('fatalError', enums_1.EzspStatus.ERROR_SERIAL_INIT);
+            this.emit("fatalError", enums_1.EzspStatus.ERROR_SERIAL_INIT);
         }
     }
     /**
      * Handle port error
      * @param error
      */
-    async onPortError(error) {
+    onPortError(error) {
         logger_1.logger.error(`Port ${error}`, NS);
         this.flags = 0;
-        this.emit('fatalError', enums_1.EzspStatus.ERROR_SERIAL_INIT);
+        this.emit("fatalError", enums_1.EzspStatus.ERROR_SERIAL_INIT);
     }
     /**
      * Handle received frame from AshParser.
@@ -422,7 +433,7 @@ class UartAsh extends node_events_1.EventEmitter {
             // ignore the cancel before RSTACK
             if (this.flags & Flag.CONNECTED) {
                 this.counters.rxCancelled += 1;
-                logger_1.logger.warning(`Frame(s) in progress cancelled in [${buffer.toString('hex')}]`, NS);
+                logger_1.logger.warning(`Frame(s) in progress cancelled in [${buffer.toString("hex")}]`, NS);
             }
             // get rid of everything up to the CAN flag and start reading frame from there, no need to loop through bytes in vain
             buffer = buffer.subarray(iCAN + 1);
@@ -430,14 +441,14 @@ class UartAsh extends node_events_1.EventEmitter {
         if (!buffer.length) {
             // skip any CANCEL that results in empty frame (have yet to see one, but just in case...)
             // shouldn't happen for any other reason, unless receiving bad stuff from port?
-            logger_1.logger.debug(`Received empty frame. Skipping.`, NS);
+            logger_1.logger.debug("Received empty frame. Skipping.", NS);
             return;
         }
         const status = this.receiveFrame(buffer);
         this.sendExec(); // always trigger to cover all cases
         if (status !== enums_1.EzspStatus.SUCCESS && status !== enums_1.EzspStatus.ASH_IN_PROGRESS && status !== enums_1.EzspStatus.NO_RX_DATA) {
             logger_1.logger.error(`Error while parsing received frame, status=${enums_1.EzspStatus[status]}.`, NS);
-            this.emit('fatalError', enums_1.EzspStatus.HOST_FATAL_ERROR);
+            this.emit("fatalError", enums_1.EzspStatus.HOST_FATAL_ERROR);
             return;
         }
     }
@@ -453,7 +464,7 @@ class UartAsh extends node_events_1.EventEmitter {
         if (!this.portOpen || this.flags & Flag.CONNECTED) {
             return enums_1.EzspStatus.ERROR_INVALID_CALL;
         }
-        logger_1.logger.info(`======== ASH starting ========`, NS);
+        logger_1.logger.info("======== ASH starting ========", NS);
         try {
             if (this.serialPort) {
                 await this.serialPort.asyncFlush(); // clear read/write buffers
@@ -470,10 +481,10 @@ class UartAsh extends node_events_1.EventEmitter {
         for (let i = 0; i < CONFIG_TIME_RST; i += CONFIG_TIME_RST_CHECK) {
             this.sendExec();
             if (this.flags & Flag.CONNECTED) {
-                logger_1.logger.info(`======== ASH started ========`, NS);
+                logger_1.logger.info("======== ASH started ========", NS);
                 return enums_1.EzspStatus.SUCCESS;
             }
-            else if (this.hostError !== enums_1.EzspStatus.NO_ERROR || this.ncpError !== enums_1.EzspStatus.NO_ERROR) {
+            if (this.hostError !== enums_1.EzspStatus.NO_ERROR || this.ncpError !== enums_1.EzspStatus.NO_ERROR) {
                 // don't wait for inevitable fail, bail early, let retry logic in EZSP layer do its thing
                 break;
             }
@@ -489,7 +500,7 @@ class UartAsh extends node_events_1.EventEmitter {
         this.closing = true;
         this.logCounters();
         await this.closePort();
-        logger_1.logger.info(`======== ASH stopped ========`, NS);
+        logger_1.logger.info("======== ASH stopped ========", NS);
     }
     /**
      * Close port and remove listeners.
@@ -525,7 +536,7 @@ class UartAsh extends node_events_1.EventEmitter {
         if (this.closing) {
             return enums_1.EzspStatus.ERROR_INVALID_CALL;
         }
-        logger_1.logger.info(`======== ASH Adapter reset ========`, NS);
+        logger_1.logger.info("======== ASH Adapter reset ========", NS);
         // ask ncp to reset itself using RST frame
         try {
             if (!this.portOpen) {
@@ -569,7 +580,7 @@ class UartAsh extends node_events_1.EventEmitter {
         if (len < consts_1.ASH_MIN_DATA_FIELD_LEN) {
             return enums_1.EzspStatus.DATA_FRAME_TOO_SHORT;
         }
-        else if (len > consts_1.ASH_MAX_DATA_FIELD_LEN) {
+        if (len > consts_1.ASH_MAX_DATA_FIELD_LEN) {
             return enums_1.EzspStatus.DATA_FRAME_TOO_LONG;
         }
         if (!(this.flags & Flag.CONNECTED)) {
@@ -603,7 +614,7 @@ class UartAsh extends node_events_1.EventEmitter {
                 if (this.ackRx !== expectedFrm) {
                     this.counters.rxAckTimeouts += 1;
                     this.adjustAckPeriod(true);
-                    logger_1.logger.debug(`Timer expired waiting for ACK for ${reTx ? 'frmReTx' : 'frmTx'}=${expectedFrm}, ackRx=${this.ackRx}`, NS);
+                    logger_1.logger.debug(`Timer expired waiting for ACK for ${reTx ? "frmReTx" : "frmTx"}=${expectedFrm}, ackRx=${this.ackRx}`, NS);
                     if (++this.timeouts >= consts_1.ASH_MAX_TIMEOUTS) {
                         this.hostDisconnect(enums_1.EzspStatus.ASH_ERROR_TIMEOUTS);
                         return;
@@ -660,7 +671,7 @@ class UartAsh extends node_events_1.EventEmitter {
                         len = 1;
                         this.flags &= ~(Flag.RST | Flag.NAK | Flag.ACK);
                         this.sendState = SendState.SHFRAME;
-                        logger_1.logger.debug(`---> [FRAME type=RST]`, NS);
+                        logger_1.logger.debug("---> [FRAME type=RST]", NS);
                     }
                     else if (this.flags & (Flag.NAK | Flag.ACK)) {
                         if (this.flags & Flag.NAK) {
@@ -685,13 +696,14 @@ class UartAsh extends node_events_1.EventEmitter {
                     else if (this.flags & Flag.RETX) {
                         // Retransmitting DATA frames for error recovery
                         // buffer assumed valid from loop logic
+                        // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
                         buffer = this.reTxQueue.getNthEntry((0, math_1.mod8)(this.frmTx - this.frmReTx));
                         len = buffer.len + 1;
                         this.txSHBuffer[0] = enums_2.AshFrameType.DATA | (this.frmReTx << consts_1.ASH_FRMNUM_BIT) | (this.frmRx << consts_1.ASH_ACKNUM_BIT) | consts_1.ASH_RFLAG_MASK;
                         this.sendState = SendState.RETX_DATA;
                         logger_1.logger.debug(`---> [FRAME type=DATA_RETX frmReTx=${this.frmReTx} frmRx=${this.frmRx}](ackRx=${this.ackRx} frmTx=${this.frmTx})`, NS);
                     }
-                    else if (this.ackTx != this.frmRx) {
+                    else if (this.ackTx !== this.frmRx) {
                         // An ACK should be generated
                         this.flags |= Flag.ACK;
                         break;
@@ -733,6 +745,7 @@ class UartAsh extends node_events_1.EventEmitter {
                     // sending OR resending data frame
                     if (this.txOffset !== 0xff) {
                         // buffer assumed valid from loop logic
+                        // biome-ignore lint/style/noNonNullAssertion: ignored using `--suppress`
                         inByte = this.txOffset ? buffer.data[this.txOffset - 1] : this.txSHBuffer[0];
                         outByte = this.encodeByte(0, inByte);
                         this.writer.writeByte(outByte);
@@ -794,22 +807,22 @@ class UartAsh extends node_events_1.EventEmitter {
             case enums_1.EzspStatus.ASH_BAD_CRC:
                 this.counters.rxCrcErrors += 1;
                 this.rejectFrame();
-                logger_1.logger.error(`Received frame with CRC error`, NS);
+                logger_1.logger.error("Received frame with CRC error", NS);
                 return enums_1.EzspStatus.NO_RX_DATA;
             case enums_1.EzspStatus.ASH_COMM_ERROR:
                 this.counters.rxCommErrors += 1;
                 this.rejectFrame();
-                logger_1.logger.error(`Received frame with comm error`, NS);
+                logger_1.logger.error("Received frame with comm error", NS);
                 return enums_1.EzspStatus.NO_RX_DATA;
             case enums_1.EzspStatus.ASH_TOO_SHORT:
                 this.counters.rxTooShort += 1;
                 this.rejectFrame();
-                logger_1.logger.error(`Received frame shorter than minimum`, NS);
+                logger_1.logger.error("Received frame shorter than minimum", NS);
                 return enums_1.EzspStatus.NO_RX_DATA;
             case enums_1.EzspStatus.ASH_TOO_LONG:
                 this.counters.rxTooLong += 1;
                 this.rejectFrame();
-                logger_1.logger.error(`Received frame longer than maximum`, NS);
+                logger_1.logger.error("Received frame longer than maximum", NS);
                 return enums_1.EzspStatus.NO_RX_DATA;
             case enums_1.EzspStatus.ASH_ERROR_XON_XOFF:
                 return this.hostDisconnect(status);
@@ -853,10 +866,10 @@ class UartAsh extends node_events_1.EventEmitter {
                 this.timeouts = 0;
                 this.setAckPeriod(CONFIG_ACK_TIME_INIT);
                 this.flags = Flag.CONNECTED | Flag.ACK;
-                logger_1.logger.info(`======== ASH connected ========`, NS);
+                logger_1.logger.info("======== ASH connected ========", NS);
                 return enums_1.EzspStatus.SUCCESS;
             }
-            else if (frameType === enums_2.AshFrameType.ERROR) {
+            if (frameType === enums_2.AshFrameType.ERROR) {
                 logger_1.logger.error(`Received ERROR from adapter while connecting, with code=${enums_2.NcpFailedCode[this.rxSHBuffer[2]]}.`, NS);
                 // let Ezsp retry logic handle error
                 // return this.ncpDisconnect(EzspStatus.ASH_NCP_FATAL_ERROR);
@@ -917,24 +930,22 @@ class UartAsh extends node_events_1.EventEmitter {
                     this.rxQueue.addTail(this.rxDataBuffer); // add frame to receive queue
                     logger_1.logger.debug(`<--- ${frameStr} Added to rxQueue`, NS);
                     this.counters.rxData += this.rxDataBuffer.len;
-                    setImmediate(() => this.emit('frame'));
+                    setImmediate(() => this.emit("frame"));
                     return enums_1.EzspStatus.SUCCESS;
                 }
+                // frame is out of sequence
+                if (this.rxSHBuffer[0] & consts_1.ASH_RFLAG_MASK) {
+                    // if retransmitted, force ACK
+                    this.counters.rxDuplicates += 1;
+                    this.flags |= Flag.ACK;
+                }
                 else {
-                    // frame is out of sequence
-                    if (this.rxSHBuffer[0] & consts_1.ASH_RFLAG_MASK) {
-                        // if retransmitted, force ACK
-                        this.counters.rxDuplicates += 1;
-                        this.flags |= Flag.ACK;
-                    }
-                    else {
-                        // 1st OOS? then set REJ, send NAK
-                        if ((this.flags & Flag.REJ) === 0) {
-                            this.counters.rxOutOfSequence += 1;
-                            logger_1.logger.debug(`<-x- ${frameStr} Out of sequence: expected ${this.frmRx}; got ${frmNum}.`, NS);
-                        }
-                        this.rejectFrame();
+                    // 1st OOS? then set REJ, send NAK
+                    if ((this.flags & Flag.REJ) === 0) {
+                        this.counters.rxOutOfSequence += 1;
+                        logger_1.logger.debug(`<-x- ${frameStr} Out of sequence: expected ${this.frmRx}; got ${frmNum}.`, NS);
                     }
+                    this.rejectFrame();
                 }
                 break;
             }
@@ -956,7 +967,7 @@ class UartAsh extends node_events_1.EventEmitter {
                 return this.ncpDisconnect(enums_1.EzspStatus.ASH_NCP_FATAL_ERROR);
             case enums_2.AshFrameType.INVALID:
                 // reject invalid frames
-                logger_1.logger.debug(`<-x- [FRAME type=${frameTypeStr}] Rejecting. ${this.rxSHBuffer.toString('hex')}`, NS);
+                logger_1.logger.debug(`<-x- [FRAME type=${frameTypeStr}] Rejecting. ${this.rxSHBuffer.toString("hex")}`, NS);
                 this.rejectFrame();
                 break;
         }
@@ -1059,7 +1070,7 @@ class UartAsh extends node_events_1.EventEmitter {
      * If not already retransmitting, and there are unacked frames, start retransmitting after the last frame that was acked.
      */
     startRetransmission() {
-        if (!(this.flags & Flag.RETX) && this.ackRx != this.frmTx) {
+        if (!(this.flags & Flag.RETX) && this.ackRx !== this.frmTx) {
             this.stopAckTimer();
             this.frmReTx = this.ackRx;
             this.flags |= Flag.RETX | Flag.CAN;
@@ -1075,7 +1086,7 @@ class UartAsh extends node_events_1.EventEmitter {
             // Set/clear NR flag based on the number of buffers free
             if (this.rxFree.length < CONFIG_NR_LOW_LIMIT) {
                 this.flags |= Flag.NR;
-                logger_1.logger.warning(`NOT READY - Signaling adapter`, NS);
+                logger_1.logger.warning("NOT READY - Signaling adapter", NS);
             }
             else if (this.rxFree.length > CONFIG_NR_HIGH_LIMIT) {
                 this.flags &= ~Flag.NR;
@@ -1233,12 +1244,12 @@ class UartAsh extends node_events_1.EventEmitter {
             }
             return this.encodeStuffByte(byte);
         }
-        else if (this.encodeState === 1) {
+        if (this.encodeState === 1) {
             // CRC high byte
             this.encodeState = 2;
             return this.encodeStuffByte(this.encodeCrc >> 8);
         }
-        else if (this.encodeState === 2) {
+        if (this.encodeState === 2) {
             // CRC low byte
             this.encodeState = 3;
             return this.encodeStuffByte(this.encodeCrc & 0xff);
@@ -1258,9 +1269,7 @@ class UartAsh extends node_events_1.EventEmitter {
             this.encodeFlip = byte ^ consts_1.ASH_FLIP;
             return enums_2.AshReservedByte.ESCAPE;
         }
-        else {
-            return byte;
-        }
+        return byte;
     }
     /**
      * Decode received byte.
@@ -1294,7 +1303,7 @@ class UartAsh extends node_events_1.EventEmitter {
                     this.decodeFlip = 0; // ignore isolated data escape between flags
                     break;
                 }
-                else if (this.decodeLen === 0xff) {
+                if (this.decodeLen === 0xff) {
                     status = enums_1.EzspStatus.ASH_COMM_ERROR;
                 }
                 else if (this.decodeCrc !== (this.decodeByte2 << 8) + this.decodeByte1) {
@@ -1594,7 +1603,7 @@ class UartAsh extends node_events_1.EventEmitter {
      * Used on ASH layer stop to get 'pre-stop state'.
      */
     logCounters() {
-        logger_1.logger.info(`ASH COUNTERS since last clear:`, NS);
+        logger_1.logger.info("ASH COUNTERS since last clear:", NS);
         logger_1.logger.info(`  Total frames: RX=${this.counters.rxAllFrames}, TX=${this.counters.txAllFrames}`, NS);
         logger_1.logger.info(`  Cancelled   : RX=${this.counters.rxCancelled}, TX=${this.counters.txCancelled}`, NS);
         logger_1.logger.info(`  DATA frames : RX=${this.counters.rxDataFrames}, TX=${this.counters.txDataFrames}`, NS);