zwave-js 15.6.0 → 15.7.0

package/build/cjs/lib/_version.d.ts

@@ -1,3 +1,3 @@
-export declare const PACKAGE_VERSION = "15.6.0";
+export declare const PACKAGE_VERSION = "15.7.0";
 export declare const PACKAGE_NAME = "zwave-js";
 //# sourceMappingURL=_version.d.ts.map

package/build/cjs/lib/_version.js

@@ -22,7 +22,7 @@ __export(version_exports, {
   PACKAGE_VERSION: () => PACKAGE_VERSION
 });
 module.exports = __toCommonJS(version_exports);
-const PACKAGE_VERSION = "15.6.0";
+const PACKAGE_VERSION = "15.7.0";
 const PACKAGE_NAME = "zwave-js";
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/build/cjs/lib/_version.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/lib/_version.ts"],
-  "sourcesContent": ["// This file is auto-generated by the codegen maintenance script\nexport const PACKAGE_VERSION = \"15.6.0\";\nexport const PACKAGE_NAME = \"zwave-js\";\n"],
+  "sourcesContent": ["// This file is auto-generated by the codegen maintenance script\nexport const PACKAGE_VERSION = \"15.7.0\";\nexport const PACKAGE_NAME = \"zwave-js\";\n"],
   "mappings": ";;;;;;;;;;;;;;;;;;AAAA;;;;;;AACO,MAAM,kBAAkB;AACxB,MAAM,eAAe;",
   "names": []
 }

package/build/cjs/lib/zniffer/Zniffer.d.ts

@@ -142,5 +142,14 @@ export declare class Zniffer extends TypedEventTarget<ZnifferEventCallbacks> {
      * Must be called under any circumstances.
      */
     destroy(): Promise<void>;
+    /**
+     * Loads captured frames from a `.zlf` file that was written by the official Zniffer application or Z-Wave JS.
+     */
+    loadCaptureFromFile(filePath: string): Promise<void>;
+    /**
+     * Load captured frames from a buffer
+     */
+    loadCaptureFromBuffer(buffer: Uint8Array): Promise<void>;
+    private parseFrame;
 }
 //# sourceMappingURL=Zniffer.d.ts.map

package/build/cjs/lib/zniffer/Zniffer.js

@@ -29,7 +29,8 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 var Zniffer_exports = {};
 __export(Zniffer_exports, {
-  Zniffer: () => Zniffer
+  Zniffer: () => Zniffer,
+  parseZLFEntry: () => parseZLFEntry
 });
 module.exports = __toCommonJS(Zniffer_exports);
 var import_cc = require("@zwave-js/cc");
@@ -335,106 +336,22 @@ supported frequencies: ${[...this._supportedFrequencies].map(([region, name]) =>
    */
   async handleDataMessage(msg, capture) {
     try {
-      let convertedRSSI;
-      if (this._options.convertRSSI && this._chipType) {
-        convertedRSSI = tryConvertRSSI(msg.rssiRaw, this._chipType);
-      }
-      if (msg.frameType === import_serial.ZnifferFrameType.BeamStart || msg.frameType === import_serial.ZnifferFrameType.BeamStop) {
-        const beam = (0, import_MPDU.parseBeamFrame)(msg);
-        beam.frameInfo.rssi = convertedRSSI;
-        this.znifferLog.beam(beam);
-        const frame2 = (0, import_MPDU.beamToFrame)(beam);
-        capture.parsedFrame = frame2;
-        this.emit("frame", frame2, capture.frameData);
+      const frame = await this.parseFrame(msg);
+      capture.parsedFrame = frame.external;
+      if (frame.internal instanceof import_MPDU.ZWaveBeamStart || frame.internal instanceof import_MPDU.LongRangeBeamStart || frame.internal instanceof import_MPDU.BeamStop) {
+        this.znifferLog.beam(frame.internal);
+        this.emit("frame", frame.external, capture.frameData);
         return;
       }
-      if (!msg.checksumOK) {
+      if (frame.internal === void 0) {
         this.znifferLog.crcError(msg);
-        const frame2 = (0, import_MPDU.znifferDataMessageToCorruptedFrame)(msg);
-        capture.parsedFrame = frame2;
-        this.emit("corrupted frame", frame2, capture.frameData);
+        this.emit("corrupted frame", frame.external, capture.frameData);
         return;
       }
-      const mpdu = (0, import_MPDU.parseMPDU)(msg);
-      mpdu.frameInfo.rssi = convertedRSSI;
-      let destSecurityManager;
-      let destSecurityManager2;
-      let destSecurityManagerLR;
-      let destNodeId = 255;
-      let cc;
-      if (mpdu.payload.length > 0 && mpdu.headerType !== import_core.MPDUHeaderType.Acknowledgement) {
-        if ("destinationNodeId" in mpdu) {
-          destNodeId = mpdu.destinationNodeId;
-          ({
-            securityManager: destSecurityManager,
-            securityManager2: destSecurityManager2,
-            securityManagerLR: destSecurityManagerLR
-          } = await this.getSecurityManagers(mpdu.destinationNodeId));
-        }
-        const frameType = mpdu.headerType === import_core.MPDUHeaderType.Multicast ? "multicast" : destNodeId === import_core.NODE_ID_BROADCAST || destNodeId === import_core.NODE_ID_BROADCAST_LR ? "broadcast" : "singlecast";
-        try {
-          cc = await import_cc.CommandClass.parse(mpdu.payload, {
-            homeId: mpdu.homeId,
-            ownNodeId: destNodeId,
-            sourceNodeId: mpdu.sourceNodeId,
-            frameType,
-            securityManager: destSecurityManager,
-            securityManager2: destSecurityManager2,
-            securityManagerLR: destSecurityManagerLR,
-            ...this.parsingContext
-          });
-        } catch (e) {
-          console.error(e.stack);
-        }
-      }
-      this.znifferLog.mpdu(mpdu, cc);
-      const frame = (0, import_MPDU.mpduToFrame)(mpdu, cc);
-      capture.parsedFrame = frame;
-      this.emit("frame", frame, capture.frameData);
-      if (cc?.ccId === import_core.CommandClasses["Security 2"]) {
-        const securityManagers = await this.getSecurityManagers(mpdu.sourceNodeId);
-        const isLR = (0, import_core.isLongRangeNodeId)(mpdu.sourceNodeId) || (0, import_core.isLongRangeNodeId)(destNodeId);
-        const senderSecurityManager = isLR ? securityManagers.securityManagerLR : securityManagers.securityManager2;
-        const destSecurityManager3 = isLR ? destSecurityManagerLR : destSecurityManager2;
-        if (senderSecurityManager && destSecurityManager3) {
-          if (cc instanceof import_cc.Security2CCNonceGet) {
-            senderSecurityManager.deleteNonce(destNodeId);
-            destSecurityManager3.deleteNonce(mpdu.sourceNodeId);
-          } else if (cc instanceof import_cc.Security2CCNonceReport && cc.SOS) {
-            senderSecurityManager.setSPANState(destNodeId, {
-              type: import_core.SPANState.LocalEI,
-              receiverEI: cc.receiverEI
-            });
-            destSecurityManager3.storeRemoteEI(mpdu.sourceNodeId, cc.receiverEI);
-          } else if (cc instanceof import_cc.Security2CCMessageEncapsulation) {
-            const senderEI = cc.getSenderEI();
-            if (senderEI) {
-              const receiverSPANState = destSecurityManager3.getSPANState(mpdu.sourceNodeId);
-              if (receiverSPANState.type === import_core.SPANState.SPAN) {
-                senderSecurityManager.setSPANState(destNodeId, receiverSPANState);
-              }
-            }
-          }
-        }
-      } else if (cc?.ccId === import_core.CommandClasses.Security && cc instanceof import_cc.SecurityCCNonceReport) {
-        const senderSecurityManager = (await this.getSecurityManagers(mpdu.sourceNodeId)).securityManager;
-        const destSecurityManager3 = (await this.getSecurityManagers(destNodeId)).securityManager;
-        if (senderSecurityManager && destSecurityManager3) {
-          senderSecurityManager.setNonce({
-            issuer: mpdu.sourceNodeId,
-            nonceId: senderSecurityManager.getNonceId(cc.nonce)
-          }, {
-            nonce: cc.nonce,
-            receiver: destNodeId
-          }, { free: true });
-          destSecurityManager3.setNonce({
-            issuer: mpdu.sourceNodeId,
-            nonceId: senderSecurityManager.getNonceId(cc.nonce)
-          }, {
-            nonce: cc.nonce,
-            receiver: destNodeId
-          }, { free: true });
-        }
+      if (frame.internal instanceof import_MPDU.ZWaveMPDU || frame.internal instanceof import_MPDU.LongRangeMPDU) {
+        this.znifferLog.mpdu(frame.internal, frame.cc);
+        this.emit("frame", frame.external, capture.frameData);
+        return;
       }
     } catch (e) {
       console.error(e);
@@ -661,11 +578,146 @@ supported frequencies: ${[...this._supportedFrequencies].map(([region, name]) =>
     this._logContainer.destroy();
     this._destroyPromise.resolve();
   }
+  /**
+   * Loads captured frames from a `.zlf` file that was written by the official Zniffer application or Z-Wave JS.
+   */
+  async loadCaptureFromFile(filePath) {
+    const buffer = await this.bindings.fs.readFile(filePath);
+    await this.loadCaptureFromBuffer(buffer);
+  }
+  /**
+   * Load captured frames from a buffer
+   */
+  async loadCaptureFromBuffer(buffer) {
+    let { bytesRead: offset } = parseZLFHeader(buffer);
+    this.clearCapturedFrames();
+    let accumulator;
+    while (offset < buffer.length) {
+      const { bytesRead, complete, type, entry, msg, accumulator: newAccumulator } = parseZLFEntry(buffer, offset, accumulator);
+      if (bytesRead <= 0)
+        break;
+      offset += bytesRead;
+      if (complete) {
+        accumulator = void 0;
+      } else {
+        accumulator = newAccumulator;
+        continue;
+      }
+      if (type === import_serial.ZnifferMessageType.Data) {
+        entry.parsedFrame = // FIXME: Figure out which values the Zniffer application actually stores
+        // as RSSI. Both the attempted conversion and the raw values seem wrong.
+        (await this.parseFrame(msg, false)).external;
+        this._capturedFrames.push(entry);
+      }
+    }
+  }
+  async parseFrame(msg, convertRSSI = this._options.convertRSSI ?? false) {
+    let convertedRSSI;
+    if (convertRSSI && this._chipType) {
+      convertedRSSI = tryConvertRSSI(msg.rssiRaw, this._chipType);
+    }
+    if (msg.frameType === import_serial.ZnifferFrameType.BeamStart || msg.frameType === import_serial.ZnifferFrameType.BeamStop) {
+      const beam = (0, import_MPDU.parseBeamFrame)(msg);
+      beam.frameInfo.rssi = convertedRSSI;
+      return {
+        internal: beam,
+        external: (0, import_MPDU.beamToFrame)(beam)
+      };
+    }
+    if (!msg.checksumOK) {
+      return {
+        internal: void 0,
+        external: (0, import_MPDU.znifferDataMessageToCorruptedFrame)(msg)
+      };
+    }
+    const mpdu = (0, import_MPDU.parseMPDU)(msg);
+    mpdu.frameInfo.rssi = convertedRSSI;
+    let destSecurityManager;
+    let destSecurityManager2;
+    let destSecurityManagerLR;
+    let destNodeId = 255;
+    let cc;
+    if (mpdu.payload.length > 0 && mpdu.headerType !== import_core.MPDUHeaderType.Acknowledgement) {
+      if ("destinationNodeId" in mpdu) {
+        destNodeId = mpdu.destinationNodeId;
+        ({
+          securityManager: destSecurityManager,
+          securityManager2: destSecurityManager2,
+          securityManagerLR: destSecurityManagerLR
+        } = await this.getSecurityManagers(mpdu.destinationNodeId));
+      }
+      const frameType = mpdu.headerType === import_core.MPDUHeaderType.Multicast ? "multicast" : destNodeId === import_core.NODE_ID_BROADCAST || destNodeId === import_core.NODE_ID_BROADCAST_LR ? "broadcast" : "singlecast";
+      try {
+        cc = await import_cc.CommandClass.parse(mpdu.payload, {
+          homeId: mpdu.homeId,
+          ownNodeId: destNodeId,
+          sourceNodeId: mpdu.sourceNodeId,
+          frameType,
+          securityManager: destSecurityManager,
+          securityManager2: destSecurityManager2,
+          securityManagerLR: destSecurityManagerLR,
+          ...this.parsingContext
+        });
+      } catch (e) {
+        console.error(e.stack);
+      }
+    }
+    if (cc?.ccId === import_core.CommandClasses["Security 2"]) {
+      const securityManagers = await this.getSecurityManagers(mpdu.sourceNodeId);
+      const isLR = (0, import_core.isLongRangeNodeId)(mpdu.sourceNodeId) || (0, import_core.isLongRangeNodeId)(destNodeId);
+      const senderSecurityManager = isLR ? securityManagers.securityManagerLR : securityManagers.securityManager2;
+      const destSecurityManager3 = isLR ? destSecurityManagerLR : destSecurityManager2;
+      if (senderSecurityManager && destSecurityManager3) {
+        if (cc instanceof import_cc.Security2CCNonceGet) {
+          senderSecurityManager.deleteNonce(destNodeId);
+          destSecurityManager3.deleteNonce(mpdu.sourceNodeId);
+        } else if (cc instanceof import_cc.Security2CCNonceReport && cc.SOS) {
+          senderSecurityManager.setSPANState(destNodeId, {
+            type: import_core.SPANState.LocalEI,
+            receiverEI: cc.receiverEI
+          });
+          destSecurityManager3.storeRemoteEI(mpdu.sourceNodeId, cc.receiverEI);
+        } else if (cc instanceof import_cc.Security2CCMessageEncapsulation) {
+          const senderEI = cc.getSenderEI();
+          if (senderEI) {
+            const receiverSPANState = destSecurityManager3.getSPANState(mpdu.sourceNodeId);
+            if (receiverSPANState.type === import_core.SPANState.SPAN) {
+              senderSecurityManager.setSPANState(destNodeId, receiverSPANState);
+            }
+          }
+        }
+      }
+    } else if (cc?.ccId === import_core.CommandClasses.Security && cc instanceof import_cc.SecurityCCNonceReport) {
+      const senderSecurityManager = (await this.getSecurityManagers(mpdu.sourceNodeId)).securityManager;
+      const destSecurityManager3 = (await this.getSecurityManagers(destNodeId)).securityManager;
+      if (senderSecurityManager && destSecurityManager3) {
+        senderSecurityManager.setNonce({
+          issuer: mpdu.sourceNodeId,
+          nonceId: senderSecurityManager.getNonceId(cc.nonce)
+        }, {
+          nonce: cc.nonce,
+          receiver: destNodeId
+        }, { free: true });
+        destSecurityManager3.setNonce({
+          issuer: mpdu.sourceNodeId,
+          nonceId: senderSecurityManager.getNonceId(cc.nonce)
+        }, {
+          nonce: cc.nonce,
+          receiver: destNodeId
+        }, { free: true });
+      }
+    }
+    return {
+      internal: mpdu,
+      cc,
+      external: (0, import_MPDU.mpduToFrame)(mpdu, cc)
+    };
+  }
 }
 function captureToZLFEntry(capture) {
   const buffer = new import_shared.Bytes(14 + capture.rawData.length).fill(0);
   let ticks = BigInt(capture.timestamp.getTime()) * 10000n + 621355968000000000n;
-  ticks = ticks | 4000000000000000n;
+  ticks = ticks | 2n << 62n;
   buffer.writeBigUInt64LE(ticks, 0);
   const direction = 0;
   buffer[8] = direction | 1;
@@ -675,8 +727,94 @@ function captureToZLFEntry(capture) {
   return buffer;
 }
 __name(captureToZLFEntry, "captureToZLFEntry");
+function parseZLFHeader(buffer) {
+  if (buffer.length < 2048) {
+    throw new import_core.ZWaveError("Invalid ZLF file: header too small", import_core.ZWaveErrorCodes.Argument_Invalid);
+  }
+  const bytes = import_shared.Bytes.view(buffer);
+  const znifferVersion = bytes[0];
+  const checksum = bytes.readUInt16BE(2046);
+  return {
+    znifferVersion,
+    checksum,
+    bytesRead: 2048
+  };
+}
+__name(parseZLFHeader, "parseZLFHeader");
+function parseZLFEntry(buffer, offset, accumulator) {
+  const bytes = import_shared.Bytes.view(buffer.subarray(offset));
+  if (bytes.length < 14) {
+    throw new import_core.ZWaveError("Invalid ZLF file: entry truncated", import_core.ZWaveErrorCodes.PacketFormat_Truncated);
+  }
+  const ticks = bytes.readBigUInt64LE(0);
+  const timeStampMask = (1n << 62n) - 1n;
+  const jsTimestamp = Number(((ticks & timeStampMask) - 621355968000000000n) / 10000n);
+  const timestamp = new Date(jsTimestamp);
+  const rawDataLength = bytes[9];
+  const totalLength = 14 + rawDataLength;
+  if (bytes.length < totalLength) {
+    throw new import_core.ZWaveError("Invalid ZLF file: entry truncated", import_core.ZWaveErrorCodes.PacketFormat_Truncated);
+  }
+  const eod = bytes[totalLength - 1];
+  if (eod !== 254) {
+    return {
+      complete: true,
+      bytesRead: totalLength
+    };
+  }
+  let rawData = bytes.subarray(13, totalLength - 1);
+  if (accumulator) {
+    rawData = import_shared.Bytes.concat([
+      accumulator.rawData,
+      rawData
+    ]);
+  }
+  try {
+    const msg = import_serial.ZnifferMessage.parse(rawData);
+    const entry = {
+      timestamp,
+      rawData,
+      frameData: msg.payload
+    };
+    if (msg instanceof import_serial.ZnifferDataMessage) {
+      return {
+        complete: true,
+        bytesRead: totalLength,
+        type: import_serial.ZnifferMessageType.Data,
+        msg,
+        entry
+      };
+    } else {
+      return {
+        complete: true,
+        bytesRead: totalLength,
+        type: import_serial.ZnifferMessageType.Command,
+        msg,
+        entry
+      };
+    }
+  } catch (e) {
+    if ((0, import_core.isZWaveError)(e) && e.code === import_core.ZWaveErrorCodes.PacketFormat_Truncated) {
+      accumulator ??= {
+        timestamp,
+        rawData: new import_shared.Bytes(),
+        frameData: new import_shared.Bytes()
+        // Cannot be determined yet
+      };
+      accumulator.rawData = rawData;
+      return {
+        complete: false,
+        bytesRead: totalLength,
+        accumulator
+      };
+    }
+    throw e;
+  }
+}
+__name(parseZLFEntry, "parseZLFEntry");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  Zniffer
+  Zniffer,
+  parseZLFEntry
 });
 //# sourceMappingURL=Zniffer.js.map