zigbee-herdsman 0.55.5 → 0.56.2

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

@@ -1,10 +1,10 @@
 "use strict";
+/* istanbul ignore file */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UartAsh = exports.AshEvents = exports.CONFIG_TX_K = void 0;
-/* istanbul ignore file */
+exports.UartAsh = exports.CONFIG_TX_K = void 0;
 const net_1 = require("net");
 const stream_1 = require("stream");
 const utils_1 = require("../../../utils");
@@ -78,13 +78,6 @@ const CONFIG_NR_HIGH_LIMIT = 12; // RX_FREE_HW
 const CONFIG_NR_TIME = 480;
 /** Read/write max bytes count at stream level */
 const CONFIG_HIGHWATER_MARK = 256;
-var AshEvents;
-(function (AshEvents) {
-    /** When the ASH protocol detects a fatal error (bubbles up to restart adapter). */
-    AshEvents["FATAL_ERROR"] = "fatalError";
-    /** When a frame has been parsed and queued in the rxQueue. */
-    AshEvents["FRAME"] = "frame";
-})(AshEvents || (exports.AshEvents = AshEvents = {}));
 /**
  * ASH Protocol handler.
  */
@@ -184,10 +177,10 @@ class UartAsh extends stream_1.EventEmitter {
     constructor(options) {
         super();
         this.portOptions = options;
-        this.serialPort = null;
-        this.socketPort = null;
-        this.writer = null;
-        this.parser = null;
+        this.serialPort = undefined;
+        this.socketPort = undefined;
+        this.writer = new writer_1.AshWriter({ highWaterMark: CONFIG_HIGHWATER_MARK });
+        this.parser = new parser_1.AshParser({ readableHighWaterMark: CONFIG_HIGHWATER_MARK });
         this.txPool = new Array(consts_1.TX_POOL_BUFFERS);
         this.txQueue = new queues_1.EzspQueue();
         this.reTxQueue = new queues_1.EzspQueue();
@@ -195,59 +188,6 @@ class UartAsh extends stream_1.EventEmitter {
         this.rxPool = new Array(consts_1.EZSP_HOST_RX_POOL_SIZE);
         this.rxQueue = new queues_1.EzspQueue();
         this.rxFree = new queues_1.EzspFreeList();
-    }
-    /**
-     * Check if port is valid, open, and not closing.
-     */
-    get portOpen() {
-        if (this.closing) {
-            return false;
-        }
-        if (socketPortUtils_1.default.isTcpPath(this.portOptions.path)) {
-            return this.socketPort && !this.socketPort.closed;
-        }
-        else {
-            return this.serialPort && this.serialPort.isOpen;
-        }
-    }
-    /**
-     * Get max wait time before response is considered timed out.
-     */
-    get responseTimeout() {
-        return consts_1.ASH_MAX_TIMEOUTS * CONFIG_ACK_TIME_MAX;
-    }
-    /**
-     * Indicates if the host is in the Connected state.
-     * If not, the host and NCP cannot exchange DATA frames.
-     * Note that this function does not actively confirm that communication with NCP is healthy, but simply returns its last known status.
-     *
-     * @returns
-     * - true  - host and NCP can exchange DATA frames
-     * - false - host and NCP cannot now exchange DATA frames
-     */
-    get connected() {
-        return (this.flags & Flag.CONNECTED) !== 0;
-    }
-    /**
-     * Has nothing to do...
-     */
-    get idle() {
-        return (!this.decodeInProgress && // don't have a partial frame
-            // && (this.serial.readAvailable() === EzspStatus.NO_RX_DATA) // no rx data
-            this.rxQueue.empty && // no rx frames to process
-            !this.ncpHasCallbacks && // no pending callbacks
-            this.flags === Flag.CONNECTED && // no pending ACKs, NAKs, etc.
-            this.ackTx === this.frmRx && // do not need to send an ACK
-            this.ackRx === this.frmTx && // not waiting to receive an ACK
-            this.sendState === SendState.IDLE && // nothing being transmitted now
-            this.txQueue.empty // nothing waiting to transmit
-        // && this.serial.outputIsIdle()          // nothing in OS buffers or UART FIFO
-        );
-    }
-    /**
-     * Initialize ASH variables, timers and queues, but not the serial port
-     */
-    initVariables() {
         this.closing = false;
         this.txSHBuffer = Buffer.alloc(consts_1.SH_TX_BUFFER_LEN);
         this.rxSHBuffer = Buffer.alloc(consts_1.SH_RX_BUFFER_LEN);
@@ -263,12 +203,13 @@ class UartAsh extends stream_1.EventEmitter {
         this.frmRx = 0;
         this.frmReTxHead = 0;
         this.timeouts = 0;
-        this.rxDataBuffer = null;
+        this.rxDataBuffer = undefined;
         this.rxLen = 0;
         // init to "start of frame" default
         this.encodeCount = 0;
         this.encodeState = 0;
         this.encodeEscFlag = false;
+        this.encodeFlip = 0;
         this.encodeCrc = 0xffff;
         this.txOffset = 0;
         // init to "start of frame" default
@@ -284,7 +225,6 @@ class UartAsh extends stream_1.EventEmitter {
         this.ncpHasCallbacks = false;
         this.stopAckTimer();
         this.stopNrTimer();
-        this.initQueues();
         this.counters = {
             txData: 0,
             txAllFrames: 0,
@@ -316,25 +256,68 @@ class UartAsh extends stream_1.EventEmitter {
             rxOutOfSequence: 0,
             rxAckTimeouts: 0,
         };
-    }
-    /**
-     * Initializes all queues and free lists.
-     * All receive buffers are put into rxFree, and rxQueue is empty.
-     * All transmit buffers are put into txFree, and txQueue and reTxQueue are empty.
-     */
-    initQueues() {
-        this.txQueue.tail = null;
-        this.reTxQueue.tail = null;
-        this.txFree.link = null;
+        // All transmit buffers are put into txFree, and txQueue and reTxQueue are empty.
+        this.txQueue.tail = undefined;
+        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.rxQueue.tail = null;
-        this.rxFree.link = null;
+        // 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()));
         }
     }
+    /**
+     * Check if port is valid, open, and not closing.
+     */
+    get portOpen() {
+        if (this.closing) {
+            return false;
+        }
+        if (socketPortUtils_1.default.isTcpPath(this.portOptions.path)) {
+            return this.socketPort ? !this.socketPort.closed : false;
+        }
+        else {
+            return this.serialPort ? this.serialPort.isOpen : false;
+        }
+    }
+    /**
+     * Get max wait time before response is considered timed out.
+     */
+    get responseTimeout() {
+        return consts_1.ASH_MAX_TIMEOUTS * CONFIG_ACK_TIME_MAX;
+    }
+    /**
+     * Indicates if the host is in the Connected state.
+     * If not, the host and NCP cannot exchange DATA frames.
+     * Note that this function does not actively confirm that communication with NCP is healthy, but simply returns its last known status.
+     *
+     * @returns
+     * - true  - host and NCP can exchange DATA frames
+     * - false - host and NCP cannot now exchange DATA frames
+     */
+    get connected() {
+        return (this.flags & Flag.CONNECTED) !== 0;
+    }
+    /**
+     * Has nothing to do...
+     */
+    get idle() {
+        return (!this.decodeInProgress && // don't have a partial frame
+            // && (this.serial.readAvailable() === EzspStatus.NO_RX_DATA) // no rx data
+            this.rxQueue.empty && // no rx frames to process
+            !this.ncpHasCallbacks && // no pending callbacks
+            this.flags === Flag.CONNECTED && // no pending ACKs, NAKs, etc.
+            this.ackTx === this.frmRx && // do not need to send an ACK
+            this.ackRx === this.frmTx && // not waiting to receive an ACK
+            this.sendState === SendState.IDLE && // nothing being transmitted now
+            this.txQueue.empty // nothing waiting to transmit
+        // && this.serial.outputIsIdle()          // nothing in OS buffers or UART FIFO
+        );
+    }
     /**
      * Init the serial or socket port and hook parser/writer.
      * NOTE: This is the only function that throws/rejects in the ASH layer (caught by resetNcp and turned into an EzspStatus).
@@ -358,16 +341,14 @@ class UartAsh extends stream_1.EventEmitter {
                 serialOpts.xon = true;
                 serialOpts.xoff = true;
             }
-            //@ts-expect-error Jest testing
-            if (this.portOptions.binding != null) {
-                //@ts-expect-error Jest testing
+            // @ts-expect-error Jest testing
+            if (this.portOptions.binding != undefined) {
+                // @ts-expect-error Jest testing
                 serialOpts.binding = this.portOptions.binding;
             }
             logger_1.logger.debug(`Opening serial port with ${JSON.stringify(serialOpts)}`, NS);
             this.serialPort = new serialPort_1.SerialPort(serialOpts);
-            this.writer = new writer_1.AshWriter({ highWaterMark: CONFIG_HIGHWATER_MARK });
             this.writer.pipe(this.serialPort);
-            this.parser = new parser_1.AshParser({ readableHighWaterMark: CONFIG_HIGHWATER_MARK });
             this.serialPort.pipe(this.parser);
             this.parser.on('data', this.onFrame.bind(this));
             try {
@@ -387,9 +368,7 @@ class UartAsh extends stream_1.EventEmitter {
             this.socketPort = new net_1.Socket();
             this.socketPort.setNoDelay(true);
             this.socketPort.setKeepAlive(true, 15000);
-            this.writer = new writer_1.AshWriter({ highWaterMark: CONFIG_HIGHWATER_MARK });
             this.writer.pipe(this.socketPort);
-            this.parser = new parser_1.AshParser({ readableHighWaterMark: CONFIG_HIGHWATER_MARK });
             this.socketPort.pipe(this.parser);
             this.parser.on('data', this.onFrame.bind(this));
             return new Promise((resolve, reject) => {
@@ -421,7 +400,7 @@ class UartAsh extends stream_1.EventEmitter {
         if (error && this.flags !== 0) {
             logger_1.logger.info(`Port close ${error}`, NS);
             this.flags = 0;
-            this.emit(AshEvents.FATAL_ERROR, enums_1.EzspStatus.ERROR_SERIAL_INIT);
+            this.emit('fatalError', enums_1.EzspStatus.ERROR_SERIAL_INIT);
         }
     }
     /**
@@ -431,7 +410,7 @@ class UartAsh extends stream_1.EventEmitter {
     async onPortError(error) {
         logger_1.logger.info(`Port ${error}`, NS);
         this.flags = 0;
-        this.emit(AshEvents.FATAL_ERROR, enums_1.EzspStatus.ERROR_SERIAL_INIT);
+        this.emit('fatalError', enums_1.EzspStatus.ERROR_SERIAL_INIT);
     }
     /**
      * Handle received frame from AshParser.
@@ -458,7 +437,7 @@ class UartAsh extends stream_1.EventEmitter {
         setImmediate(this.sendExec.bind(this)); // always trigger to cover all cases (also triggered in Ezsp layer when a DATA frame is emitted)
         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(AshEvents.FATAL_ERROR, enums_1.EzspStatus.HOST_FATAL_ERROR);
+            this.emit('fatalError', enums_1.EzspStatus.HOST_FATAL_ERROR);
             return;
         }
     }
@@ -476,7 +455,7 @@ class UartAsh extends stream_1.EventEmitter {
         }
         logger_1.logger.info(`======== ASH starting ========`, NS);
         try {
-            if (this.serialPort != null) {
+            if (this.serialPort) {
                 await this.serialPort.asyncFlush(); // clear read/write buffers
             }
             else {
@@ -510,7 +489,6 @@ class UartAsh extends stream_1.EventEmitter {
         this.closing = true;
         this.logCounters();
         await this.closePort();
-        this.initVariables();
         logger_1.logger.info(`======== ASH stopped ========`, NS);
     }
     /**
@@ -547,8 +525,6 @@ class UartAsh extends stream_1.EventEmitter {
             return enums_1.EzspStatus.ERROR_INVALID_CALL;
         }
         logger_1.logger.info(`======== ASH Adapter reset ========`, NS);
-        this.initVariables();
-        let status;
         // ask ncp to reset itself using RST frame
         try {
             if (!this.portOpen) {
@@ -559,8 +535,8 @@ class UartAsh extends stream_1.EventEmitter {
         }
         catch (err) {
             logger_1.logger.error(`Failed to init port with error ${err}`, NS);
-            this.hostError = status;
-            return enums_1.EzspStatus.HOST_FATAL_ERROR;
+            this.hostError = enums_1.EzspStatus.HOST_FATAL_ERROR;
+            return this.hostError;
         }
     }
     /**
@@ -599,7 +575,7 @@ class UartAsh extends stream_1.EventEmitter {
             return enums_1.EzspStatus.NOT_CONNECTED;
         }
         const buffer = this.txFree.allocBuffer();
-        if (buffer == null) {
+        if (buffer === undefined) {
             return enums_1.EzspStatus.NO_TX_SPACE;
         }
         inBuf.copy(buffer.data, 0, 0, len);
@@ -617,7 +593,7 @@ class UartAsh extends stream_1.EventEmitter {
         let outByte = 0x00;
         let inByte = 0x00;
         let len = 0;
-        let buffer = null;
+        let buffer;
         // Check for received acknowledgement timer expiry
         if (this.ackTimerHasExpired()) {
             if (this.flags & Flag.CONNECTED) {
@@ -636,10 +612,10 @@ class UartAsh extends stream_1.EventEmitter {
                 else {
                     this.stopAckTimer();
                 }
-            }
-            else {
-                this.hostDisconnect(enums_1.EzspStatus.ASH_ERROR_RESET_FAIL);
-            }
+            } /* else {
+                this.hostDisconnect(EzspStatus.ASH_ERROR_RESET_FAIL);
+            }*/
+            // let Ezsp layer retry logic handle timeout
         }
         while (this.writer.writeAvailable()) {
             // Send ASH_CAN character immediately, ahead of any other transmit data
@@ -659,7 +635,7 @@ class UartAsh extends stream_1.EventEmitter {
                 continue;
             }
             switch (this.sendState) {
-                case SendState.IDLE:
+                case SendState.IDLE: {
                     // In between frames - do some housekeeping and decide what to send next
                     // If retransmitting, set the next frame to send to the last ackNum
                     // received, then check to see if retransmission is now complete.
@@ -707,6 +683,7 @@ class UartAsh extends stream_1.EventEmitter {
                     }
                     else if (this.flags & Flag.RETX) {
                         // Retransmitting DATA frames for error recovery
+                        // buffer assumed valid from loop logic
                         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;
@@ -737,7 +714,8 @@ class UartAsh extends stream_1.EventEmitter {
                     outByte = this.encodeByte(len, this.txSHBuffer[0]);
                     this.writer.writeByte(outByte);
                     break;
-                case SendState.SHFRAME:
+                }
+                case SendState.SHFRAME: {
                     // sending short frame
                     if (this.txOffset !== 0xff) {
                         inByte = this.txSHBuffer[this.txOffset];
@@ -748,10 +726,12 @@ class UartAsh extends stream_1.EventEmitter {
                         this.sendState = SendState.IDLE;
                     }
                     break;
+                }
                 case SendState.TX_DATA:
-                case SendState.RETX_DATA:
+                case SendState.RETX_DATA: {
                     // sending OR resending data frame
                     if (this.txOffset !== 0xff) {
+                        // buffer assumed valid from loop logic
                         inByte = this.txOffset ? buffer.data[this.txOffset - 1] : this.txSHBuffer[0];
                         outByte = this.encodeByte(0, inByte);
                         this.writer.writeByte(outByte);
@@ -772,6 +752,7 @@ class UartAsh extends stream_1.EventEmitter {
                         this.sendState = SendState.IDLE;
                     }
                     break;
+                }
             }
         }
         this.writer.writeFlush();
@@ -844,11 +825,11 @@ class UartAsh extends stream_1.EventEmitter {
         //    not a DATA frame
         if (frameType === enums_2.AshFrameType.DATA) {
             if (!(this.flags & Flag.CONNECTED) || ashGetFrmNum(this.rxSHBuffer[0]) !== this.frmRx) {
-                this.freeNonNullRxBuffer();
+                this.freeAllocatedRxBuffer();
             }
         }
         else {
-            this.freeNonNullRxBuffer();
+            this.freeAllocatedRxBuffer();
         }
         const frameTypeStr = enums_2.AshFrameType[frameType];
         logger_1.logger.debug(`<--- [FRAME type=${frameTypeStr}]`, NS);
@@ -876,7 +857,8 @@ class UartAsh extends stream_1.EventEmitter {
             }
             else 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);
-                return this.ncpDisconnect(enums_1.EzspStatus.ASH_NCP_FATAL_ERROR);
+                // let Ezsp retry logic handle error
+                // return this.ncpDisconnect(EzspStatus.ASH_NCP_FATAL_ERROR);
             }
             return enums_1.EzspStatus.ASH_IN_PROGRESS;
         }
@@ -912,7 +894,7 @@ class UartAsh extends stream_1.EventEmitter {
         }
         // Process frames received while connected
         switch (frameType) {
-            case enums_2.AshFrameType.DATA:
+            case enums_2.AshFrameType.DATA: {
                 frmNum = ashGetFrmNum(this.rxSHBuffer[0]);
                 const frameStr = `[FRAME type=${frameTypeStr} ackNum=${ackNum} frmNum=${frmNum}](frmRx=${this.frmRx})`;
                 if (frmNum === this.frmRx) {
@@ -934,7 +916,7 @@ class UartAsh extends stream_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(AshEvents.FRAME));
+                    setImmediate(() => this.emit('frame'));
                     return enums_1.EzspStatus.SUCCESS;
                 }
                 else {
@@ -954,6 +936,7 @@ class UartAsh extends stream_1.EventEmitter {
                     }
                 }
                 break;
+            }
             case enums_2.AshFrameType.ACK:
                 // already fully processed
                 break;
@@ -998,7 +981,7 @@ class UartAsh extends stream_1.EventEmitter {
         let outByte = 0x00;
         if (!this.decodeInProgress) {
             this.rxLen = 0;
-            this.rxDataBuffer = null;
+            this.rxDataBuffer = undefined;
         }
         for (const inByte of buffer) {
             // 0xFF byte signals a callback is pending when between frames in synchronous (polled) callback mode.
@@ -1015,7 +998,7 @@ class UartAsh extends stream_1.EventEmitter {
             [status, outByte, this.rxLen] = this.decodeByte(inByte, outByte, this.rxLen);
             // discard an invalid frame
             if (status !== enums_1.EzspStatus.ASH_IN_PROGRESS && status !== enums_1.EzspStatus.SUCCESS) {
-                this.freeNonNullRxBuffer();
+                this.freeAllocatedRxBuffer();
                 break;
             }
             // if input byte produced an output byte
@@ -1031,14 +1014,14 @@ class UartAsh extends stream_1.EventEmitter {
                     if (this.rxLen === consts_1.SH_RX_BUFFER_LEN + 1) {
                         // alloc buffer, copy prior data
                         this.rxDataBuffer = this.rxFree.allocBuffer();
-                        if (this.rxDataBuffer !== null) {
+                        if (this.rxDataBuffer !== undefined) {
                             // const len = SH_RX_BUFFER_LEN - 1;
                             // (void) memcpy(this.rxDataBuffer.data, this.shRxBuffer + 1, SH_RX_BUFFER_LEN - 1);
                             this.rxSHBuffer.copy(this.rxDataBuffer.data, 0, 1, consts_1.SH_RX_BUFFER_LEN);
                             this.rxDataBuffer.len = consts_1.SH_RX_BUFFER_LEN - 1;
                         }
                     }
-                    if (this.rxDataBuffer !== null) {
+                    if (this.rxDataBuffer !== undefined) {
                         // copy next byte to buffer
                         this.rxDataBuffer.data[index - 1] = outByte; // -1 since control is omitted
                         this.rxDataBuffer.len = index;
@@ -1054,10 +1037,10 @@ class UartAsh extends stream_1.EventEmitter {
     /**
      *
      */
-    freeNonNullRxBuffer() {
-        if (this.rxDataBuffer !== null) {
+    freeAllocatedRxBuffer() {
+        if (this.rxDataBuffer !== undefined) {
             this.rxFree.freeBuffer(this.rxDataBuffer);
-            this.rxDataBuffer = null;
+            this.rxDataBuffer = undefined;
         }
     }
     /**