zwave-js 15.25.2 → 15.25.3

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

@@ -1,3 +1,3 @@
-export declare const PACKAGE_VERSION = "15.25.2";
+export declare const PACKAGE_VERSION = "15.25.3";
 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.25.2";
+const PACKAGE_VERSION = "15.25.3";
 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.25.2\";\nexport const PACKAGE_NAME = \"zwave-js\";\n"],
+  "sourcesContent": ["// This file is auto-generated by the codegen maintenance script\nexport const PACKAGE_VERSION = \"15.25.3\";\nexport const PACKAGE_NAME = \"zwave-js\";\n"],
   "mappings": ";;;;;;;;;;;;;;;;;;AAAA;;;;;;AACO,MAAM,kBAAkB;AACxB,MAAM,eAAe;",
   "names": []
 }

package/build/cjs/lib/controller/Controller.js

@@ -567,13 +567,15 @@ let ZWaveController = (() => {
       this._productType = apiCaps.productType;
       this._productId = apiCaps.productId;
       this._supportedFunctionTypes = apiCaps.supportedFunctionTypes;
-      this.driver.controllerLog.print(`received API capabilities:
-  firmware version:    ${this._firmwareVersion}
-  manufacturer ID:     ${(0, import_shared.num2hex)(this._manufacturerId)}
-  product type:        ${(0, import_shared.num2hex)(this._productType)}
-  product ID:          ${(0, import_shared.num2hex)(this._productId)}
-  supported functions: ${this._supportedFunctionTypes.map((fn) => `
-  \xB7 ${import_serial.FunctionType[fn]} (${(0, import_shared.num2hex)(fn)})`).join("")}`);
+      this.driver.controllerLog.print((0, import_core.logText)("received API capabilities:", {
+        nested: (0, import_core.logDict)({
+          "firmware version": this._firmwareVersion,
+          "manufacturer ID": (0, import_shared.num2hex)(this._manufacturerId),
+          "product type": (0, import_shared.num2hex)(this._productType),
+          "product ID": (0, import_shared.num2hex)(this._productId),
+          "supported functions": (0, import_core.logList)(this._supportedFunctionTypes.map((fn) => `${import_serial.FunctionType[fn]} (${(0, import_shared.num2hex)(fn)})`))
+        })
+      }));
       const initData = await this.getSerialApiInitData();
       this.driver.controllerLog.print(`querying version info...`);
       const version = await this.driver.sendMessage(new import_serialapi.GetControllerVersionRequest(), {
@@ -581,25 +583,24 @@ let ZWaveController = (() => {
       });
       this._protocolVersion = version.libraryVersion;
       this._type = version.controllerType;
-      this.driver.controllerLog.print(`received version info:
-  controller type: ${(0, import_shared.getEnumMemberName)(import_core.ZWaveLibraryTypes, this._type)}
-  library version: ${this._protocolVersion}`);
+      this.driver.controllerLog.print((0, import_core.logText)("received version info:", {
+        nested: (0, import_core.logDict)({
+          "controller type": (0, import_shared.getEnumMemberName)(import_core.ZWaveLibraryTypes, this._type),
+          "library version": this._protocolVersion
+        })
+      }));
       if (this.isFunctionSupported(import_serial.FunctionType.GetProtocolVersion)) {
         this.driver.controllerLog.print(`querying protocol version info...`);
         const protocol = await this.driver.sendMessage(new import_serialapi.GetProtocolVersionRequest());
         this._protocolVersion = protocol.protocolVersion;
-        let message = `received protocol version info:
-  protocol type:             ${(0, import_shared.getEnumMemberName)(import_core.ProtocolType, protocol.protocolType)}
-  protocol version:          ${protocol.protocolVersion}`;
-        if (protocol.applicationFrameworkBuildNumber) {
-          message += `
-  appl. framework build no.: ${protocol.applicationFrameworkBuildNumber}`;
-        }
-        if (protocol.gitCommitHash) {
-          message += `
-  git commit hash:           ${protocol.gitCommitHash}`;
-        }
-        this.driver.controllerLog.print(message);
+        this.driver.controllerLog.print((0, import_core.logText)("received protocol version info:", {
+          nested: (0, import_core.logDict)({
+            "protocol type": (0, import_shared.getEnumMemberName)(import_core.ProtocolType, protocol.protocolType),
+            "protocol version": protocol.protocolVersion,
+            "appl. framework build no.": protocol.applicationFrameworkBuildNumber || void 0,
+            "git commit hash": protocol.gitCommitHash || void 0
+          })
+        }));
       }
       this._sdkVersion = (0, import_ZWaveSDKVersions.protocolVersionToSDKVersion)(this._protocolVersion);
       await this.getControllerCapabilities();
@@ -607,8 +608,9 @@ let ZWaveController = (() => {
         this.driver.controllerLog.print(`querying serial API setup capabilities...`);
         const setupCaps = await this.driver.sendMessage(new import_serialapi.SerialAPISetup_GetSupportedCommandsRequest());
         this._supportedSerialAPISetupCommands = setupCaps.supportedCommands;
-        this.driver.controllerLog.print(`supported serial API setup commands:${this._supportedSerialAPISetupCommands.map((cmd) => `
-\xB7 ${(0, import_shared.getEnumMemberName)(import_serialapi.SerialAPISetupCommand, cmd)}`).join("")}`);
+        this.driver.controllerLog.print((0, import_core.logText)("supported serial API setup commands:", {
+          nested: (0, import_core.logList)(this._supportedSerialAPISetupCommands.map((cmd) => (0, import_shared.getEnumMemberName)(import_serialapi.SerialAPISetupCommand, cmd)))
+        }));
       } else {
         this._supportedSerialAPISetupCommands = [];
       }
@@ -621,8 +623,9 @@ let ZWaveController = (() => {
         this._supportsLongRange = false;
         this._supportsLongRangeAutoChannelSelection = false;
       }
-      this.driver.controllerLog.print(`supported Z-Wave features: ${Object.keys(import_Features.ZWaveFeature).filter((k) => /^\d+$/.test(k)).map((k) => parseInt(k)).filter((feat) => this.supportsFeature(feat)).map((feat) => `
-  \xB7 ${(0, import_shared.getEnumMemberName)(import_Features.ZWaveFeature, feat)}`).join("")}`);
+      this.driver.controllerLog.print((0, import_core.logText)("supported Z-Wave features:", {
+        nested: (0, import_core.logList)(Object.keys(import_Features.ZWaveFeature).filter((k) => /^\d+$/.test(k)).map((k) => parseInt(k)).filter((feat) => this.supportsFeature(feat)).map((feat) => (0, import_shared.getEnumMemberName)(import_Features.ZWaveFeature, feat)))
+      }));
       return {
         nodeIds: initData.nodeIds
       };
@@ -638,9 +641,12 @@ let ZWaveController = (() => {
       if (this.isSerialAPISetupCommandSupported(import_serialapi.SerialAPISetupCommand.GetLongRangeMaximumPayloadSize)) {
         this._maxPayloadSizeLR = await this.getMaxPayloadSizeLongRange();
       }
-      this.driver.controllerLog.print(`received Z-Wave Long Range capabilities:
-  max. payload size: ${this._maxPayloadSizeLR} bytes
-  nodes:             ${lrNodeIds.join(", ")}`);
+      this.driver.controllerLog.print((0, import_core.logText)("received Z-Wave Long Range capabilities:", {
+        nested: (0, import_core.logDict)({
+          "max. payload size": `${this._maxPayloadSizeLR} bytes`,
+          nodes: lrNodeIds.join(", ")
+        })
+      }));
       return {
         lrNodeIds
       };
@@ -694,20 +700,21 @@ let ZWaveController = (() => {
             continue;
           }
         }
-        this.driver.controllerLog.print(`supported regions:${[...this._supportedRegions.values()].map((info) => {
-          let ret = `
-\xB7 ${(0, import_shared.getEnumMemberName)(import_core.RFRegion, info.region)}`;
-          if (info.includesRegion != void 0) {
-            ret += ` \xB7 superset of ${(0, import_shared.getEnumMemberName)(import_core.RFRegion, info.includesRegion)}`;
-          }
-          if (info.supportsLongRange) {
-            ret += " \xB7 ZWLR";
-            if (!info.supportsZWave) {
-              ret += " only";
+        this.driver.controllerLog.print((0, import_core.logText)("supported regions:", {
+          nested: (0, import_core.logList)([...this._supportedRegions.values()].map((info) => {
+            let ret = (0, import_shared.getEnumMemberName)(import_core.RFRegion, info.region);
+            if (info.includesRegion != void 0) {
+              ret += ` \xB7 superset of ${(0, import_shared.getEnumMemberName)(import_core.RFRegion, info.includesRegion)}`;
             }
-          }
-          return ret;
-        }).join("")}`);
+            if (info.supportsLongRange) {
+              ret += " \xB7 ZWLR";
+              if (!info.supportsZWave) {
+                ret += " only";
+              }
+            }
+            return ret;
+          }))
+        }));
       }
       if (this.isSerialAPISetupCommandSupported(import_serialapi.SerialAPISetupCommand.GetRFRegion)) {
         this.driver.controllerLog.print(`Querying configured RF region...`);
@@ -794,10 +801,12 @@ let ZWaveController = (() => {
         this.driver.controllerLog.print(`Querying configured Long Range channel information...`);
         const resp = await this.getLongRangeChannel().catch(() => void 0);
         if (resp != void 0) {
-          this.driver.controllerLog.print(`received Z-Wave Long Range channel information:
-  channel:                         ${resp.channel != void 0 ? (0, import_shared.getEnumMemberName)(import_core.LongRangeChannel, resp.channel) : "(unknown)"}
-  supports auto channel selection: ${resp.supportsAutoChannelSelection}
-`);
+          this.driver.controllerLog.print((0, import_core.logText)("received Z-Wave Long Range channel information:", {
+            nested: (0, import_core.logDict)({
+              channel: resp.channel != void 0 ? (0, import_shared.getEnumMemberName)(import_core.LongRangeChannel, resp.channel) : "(unknown)",
+              "supports auto channel selection": resp.supportsAutoChannelSelection
+            })
+          }));
         } else {
           this.driver.controllerLog.print(`Querying the Long Range channel information failed!`, "warn");
         }
@@ -828,9 +837,12 @@ let ZWaveController = (() => {
       const ids = await this.driver.sendMessage(new import_serialapi.GetControllerIdRequest(), { supportCheck: false });
       this._homeId = ids.homeId;
       this._ownNodeId = ids.ownNodeId;
-      this.driver.controllerLog.print(`received controller IDs:
-  home ID:     ${(0, import_shared.num2hex)(this._homeId)}
-  own node ID: ${this._ownNodeId}`);
+      this.driver.controllerLog.print((0, import_core.logText)("received controller IDs:", {
+        nested: (0, import_core.logDict)({
+          "home ID": (0, import_shared.num2hex)(this._homeId),
+          "own node ID": this._ownNodeId
+        })
+      }));
     }
     /**
      * @internal
@@ -1303,14 +1315,15 @@ let ZWaveController = (() => {
         supportedCCs,
         controlledCCs
       });
-      this.driver.controllerLog.print(`finished adding node ${newNode.id}:${newNode.deviceClass ? `
-  basic device class:    ${(0, import_shared.getEnumMemberName)(import_core.BasicDeviceClass, newNode.deviceClass.basic)}
-  generic device class:  ${newNode.deviceClass.generic.label}
-  specific device class: ${newNode.deviceClass.specific.label}` : ""}
-  supported CCs: ${supportedCCs.map((cc) => `
-  \xB7 ${import_core.CommandClasses[cc]} (${(0, import_shared.num2hex)(cc)})`).join("")}
-  controlled CCs: ${controlledCCs.map((cc) => `
-  \xB7 ${import_core.CommandClasses[cc]} (${(0, import_shared.num2hex)(cc)})`).join("")}`);
+      this.driver.controllerLog.print((0, import_core.logText)(`finished adding node ${newNode.id}:`, {
+        nested: (0, import_core.logDict)({
+          "basic device class": newNode.deviceClass ? (0, import_shared.getEnumMemberName)(import_core.BasicDeviceClass, newNode.deviceClass.basic) : void 0,
+          "generic device class": newNode.deviceClass?.generic.label,
+          "specific device class": newNode.deviceClass?.specific.label,
+          "supported CCs": (0, import_core.logList)(supportedCCs.map((cc) => `${import_core.CommandClasses[cc]} (${(0, import_shared.num2hex)(cc)})`)),
+          "controlled CCs": (0, import_core.logList)(controlledCCs.map((cc) => `${import_core.CommandClasses[cc]} (${(0, import_shared.num2hex)(cc)})`))
+        })
+      }));
       this._nodes.set(newNode.id, newNode);
       newNode.markAsAlive();
       if (newNode.protocol == import_core.Protocols.ZWave) {
@@ -1952,8 +1965,9 @@ let ZWaveController = (() => {
         const securityManager = isLongRange ? this.driver.securityManagerLR : this.driver.securityManager2;
         const missingKeys = provisioningEntry.securityClasses.filter((sc) => !securityManager?.hasKeysForSecurityClass(sc));
         if (missingKeys.length > 0) {
-          this.driver.controllerLog.print(`Ignoring inclusion request because the following security classes were granted but have no key configured:${missingKeys.map((sc) => `
-\xB7 ${(0, import_shared.getEnumMemberName)(import_core.SecurityClass, sc)}${isLongRange ? " (Long Range)" : ""}`).join("")}`, "error");
+          this.driver.controllerLog.print((0, import_core.logText)("Ignoring inclusion request because the following security classes were granted but have no key configured:", {
+            nested: (0, import_core.logList)(missingKeys.map((sc) => `${(0, import_shared.getEnumMemberName)(import_core.SecurityClass, sc)}${isLongRange ? " (Long Range)" : ""}`))
+          }), "error");
           return;
         }
         this.driver.controllerLog.print("NWI Home ID found in provisioning list, including node...");
@@ -1998,12 +2012,14 @@ let ZWaveController = (() => {
           deviceClass,
           supportedCCs: nodeInfo.supportedCCs
         });
-        this.driver.controllerLog.print(`Node ${newNode.id} was included by another controller:${newNode.deviceClass ? `
-  basic device class:    ${(0, import_shared.getEnumMemberName)(import_core.BasicDeviceClass, newNode.deviceClass.basic)}
-  generic device class:  ${newNode.deviceClass.generic.label}
-  specific device class: ${newNode.deviceClass.specific.label}` : ""}
-  supported CCs: ${nodeInfo.supportedCCs.map((cc) => `
-  \xB7 ${import_core.CommandClasses[cc]} (${(0, import_shared.num2hex)(cc)})`).join("")}`);
+        this.driver.controllerLog.print((0, import_core.logText)(`Node ${newNode.id} was included by another controller:`, {
+          nested: (0, import_core.logDict)({
+            "basic device class": newNode.deviceClass ? (0, import_shared.getEnumMemberName)(import_core.BasicDeviceClass, newNode.deviceClass.basic) : void 0,
+            "generic device class": newNode.deviceClass?.generic.label,
+            "specific device class": newNode.deviceClass?.specific.label,
+            "supported CCs": (0, import_core.logList)(nodeInfo.supportedCCs.map((cc) => `${import_core.CommandClasses[cc]} (${(0, import_shared.num2hex)(cc)})`))
+          })
+        }));
         await this.updateProxyInclusionMachine({
           value: "NIF",
           nodeInfo,
@@ -2550,10 +2566,9 @@ let ZWaveController = (() => {
         }
         node.dsk = nodePublicKey.subarray(0, 16);
         this.driver.controllerLog.logNode(node.id, {
-          message: `Security S2 bootstrapping successful with these security classes:${[
-            ...node.securityClasses.entries()
-          ].filter(([, v]) => v).map(([k]) => `
-\xB7 ${(0, import_shared.getEnumMemberName)(import_core.SecurityClass, k)}`).join("")}`
+          message: (0, import_core.logText)("Security S2 bootstrapping successful with these security classes:", {
+            nested: (0, import_core.logList)([...node.securityClasses.entries()].filter(([, v]) => v).map(([k]) => (0, import_shared.getEnumMemberName)(import_core.SecurityClass, k)))
+          })
         });
       } catch (e) {
         let errorMessage = `Security S2 bootstrapping failed, the node was not granted any S2 security class`;
@@ -4223,14 +4238,17 @@ let ZWaveController = (() => {
     async getSerialApiInitData() {
       this.driver.controllerLog.print(`querying additional controller information...`);
       const initData = await this.driver.sendMessage(new import_serialapi.GetSerialApiInitDataRequest());
-      this.driver.controllerLog.print(`received additional controller information:
-  Z-Wave API version:         ${initData.zwaveApiVersion.version} (${initData.zwaveApiVersion.kind})${initData.zwaveChipType ? `
-  Z-Wave chip type:           ${typeof initData.zwaveChipType === "string" ? initData.zwaveChipType : `unknown (type: ${(0, import_shared.num2hex)(initData.zwaveChipType.type)}, version: ${(0, import_shared.num2hex)(initData.zwaveChipType.version)})`}` : ""}
-  node type                   ${(0, import_shared.getEnumMemberName)(import_core.NodeType, initData.nodeType)}
-  controller role:            ${initData.isPrimary ? "primary" : "secondary"}
-  controller is the SIS:      ${initData.isSIS}
-  controller supports timers: ${initData.supportsTimers}
-  Z-Wave Classic nodes:       ${initData.nodeIds.join(", ")}`);
+      this.driver.controllerLog.print((0, import_core.logText)("received additional controller information:", {
+        nested: (0, import_core.logDict)({
+          "Z-Wave API version": `${initData.zwaveApiVersion.version} (${initData.zwaveApiVersion.kind})`,
+          "Z-Wave chip type": initData.zwaveChipType ? typeof initData.zwaveChipType === "string" ? initData.zwaveChipType : `unknown (type: ${(0, import_shared.num2hex)(initData.zwaveChipType.type)}, version: ${(0, import_shared.num2hex)(initData.zwaveChipType.version)})` : void 0,
+          "node type": (0, import_shared.getEnumMemberName)(import_core.NodeType, initData.nodeType),
+          "controller role": initData.isPrimary ? "primary" : "secondary",
+          "controller is the SIS": initData.isSIS,
+          "controller supports timers": initData.supportsTimers,
+          "Z-Wave Classic nodes": initData.nodeIds.join(", ")
+        })
+      }));
       const ret = {
         ...(0, import_shared.pick)(initData, [
           "zwaveApiVersion",
@@ -4269,12 +4287,15 @@ let ZWaveController = (() => {
       this._wasRealPrimary = ret.wasRealPrimary;
       this._isSUC = ret.isSUC;
       this._noNodesIncluded = ret.noNodesIncluded;
-      this.driver.controllerLog.print(`received controller capabilities:
-  controller role:      ${(0, import_shared.getEnumMemberName)(import_core.ControllerRole, this.role)}
-  is the SUC:           ${ret.isSUC}
-  started this network: ${!ret.isUsingHomeIdFromOtherNetwork}
-  SIS is present:       ${ret.isSISPresent}
-  was real primary:     ${ret.wasRealPrimary}`);
+      this.driver.controllerLog.print((0, import_core.logText)("received controller capabilities:", {
+        nested: (0, import_core.logDict)({
+          "controller role": (0, import_shared.getEnumMemberName)(import_core.ControllerRole, this.role),
+          "is the SUC": ret.isSUC,
+          "started this network": !ret.isUsingHomeIdFromOtherNetwork,
+          "SIS is present": ret.isSISPresent,
+          "was real primary": ret.wasRealPrimary
+        })
+      }));
       return ret;
     }
     /**
@@ -5118,13 +5139,15 @@ let ZWaveController = (() => {
       const firmwares = [];
       for (let i = 0; i < files.length; i++) {
         const update = files[i];
-        let logMessage = `Downloading firmware update ${i} of ${files.length}...`;
-        if (loglevel === "silly") {
-          logMessage += `
-  URL:       ${update.url}
-  integrity: ${update.integrity}`;
-        }
-        this.driver.controllerLog.logNode(nodeId, logMessage);
+        const logMessage = `Downloading firmware update ${i} of ${files.length}...`;
+        this.driver.controllerLog.logNode(nodeId, {
+          message: loglevel === "silly" ? (0, import_core.logText)(logMessage, {
+            nested: (0, import_core.logDict)({
+              URL: update.url,
+              integrity: update.integrity
+            })
+          }) : logMessage
+        });
         try {
           const firmware = await (0, import_FirmwareUpdateService.downloadFirmwareUpdate)(update);
           firmwares.push(firmware);
@@ -5640,10 +5663,9 @@ let ZWaveController = (() => {
         for (const [secClass, key] of receivedKeys) {
           this.driver.cacheSet(import_NetworkCache.cacheKeys.controller.securityKeys(secClass), key);
         }
-        this.driver.driverLog.print(`Security S2 bootstrapping successful with these security classes:${[
-          ...bootstrappingNode.securityClasses.entries()
-        ].filter(([, v]) => v).map(([k]) => `
-\xB7 ${(0, import_shared.getEnumMemberName)(import_core.SecurityClass, k)}`).join("")}`);
+        this.driver.driverLog.print((0, import_core.logText)("Security S2 bootstrapping successful with these security classes:", {
+          nested: (0, import_core.logList)([...bootstrappingNode.securityClasses.entries()].filter(([, v]) => v).map(([k]) => (0, import_shared.getEnumMemberName)(import_core.SecurityClass, k)))
+        }));
       } catch (e) {
         let errorMessage = `Security S2 bootstrapping failed, no S2 security classes were granted`;
         let result = import_Inclusion.SecurityBootstrapFailure.Unknown;
@@ -5752,10 +5774,14 @@ let ZWaveController = (() => {
           }
           if (grant) {
             this.driver.controllerLog.logNode(nodeId, {
-              message: `Received S2 bootstrap initiation, requesting keys: ${grant.securityClasses.map((sc) => `
-\xB7 ${(0, import_shared.getEnumMemberName)(import_core.SecurityClass, sc)}
-`).join("")}
-  client-side auth: ${grant.clientSideAuth}`
+              message: (0, import_core.logText)("Received S2 bootstrap initiation, requesting keys:", {
+                nested: [
+                  (0, import_core.logList)(grant.securityClasses.map((sc) => (0, import_shared.getEnumMemberName)(import_core.SecurityClass, sc))),
+                  (0, import_core.logDict)({
+                    "client-side auth": grant.clientSideAuth
+                  })
+                ]
+              })
             });
             const bootstrapResult = await this.expectSecurityBootstrapS2(bootstrappingNode, grant, this._joinNetworkOptions?.userCallbacks);
             if (bootstrapResult !== void 0) {