@zwave-js/cc 10.20.0 → 11.0.0-beta.0

package/build/cc/ConfigurationCC.js

@@ -463,7 +463,7 @@ exports.ConfigurationCCValues = Object.freeze({
         (parameter, bitMask) => parameter, (parameter, bitMask) => bitMask, ({ property, propertyKey }) => typeof property === "number" &&
             (typeof propertyKey === "number" || propertyKey == undefined), 
         // Metadata is determined dynamically depending on other factors
-        undefined, { supportsEndpoints: false }),
+        undefined),
     }),
 });
 function createConfigurationCCInstance(applHost, endpoint) {
@@ -551,6 +551,16 @@ function reInterpretSignedValue(value, valueSize, targetFormat) {
     serializeValue(raw, 0, valueSize, safe_1.ConfigValueFormat.SignedInteger, value);
     return parseValue(raw, valueSize, targetFormat);
 }
+function getParamInformationFromConfigFile(applHost, nodeId, endpointIndex) {
+    const deviceConfig = applHost.getDeviceConfig?.(nodeId);
+    if (endpointIndex === 0) {
+        return (deviceConfig?.paramInformation ??
+            deviceConfig?.endpoints?.get(0)?.paramInformation);
+    }
+    else {
+        return deviceConfig?.endpoints?.get(endpointIndex)?.paramInformation;
+    }
+}
 let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
     constructor() {
         super(...arguments);
@@ -692,7 +702,7 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
         const { valueBitMask, allowUnexpectedResponse } = options ?? {};
         const cc = new ConfigurationCCGet(this.applHost, {
             nodeId: this.endpoint.nodeId,
-            // Don't set an endpoint here, Configuration is device specific, not endpoint specific
+            endpoint: this.endpoint.index,
             parameter,
             allowUnexpectedResponse,
         });
@@ -709,6 +719,7 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
             return (0, safe_1.parsePartial)(response.value, valueBitMask, isSignedPartial(valueBitMask, paramInfo.format));
         }
         this.applHost.controllerLog.logNode(this.endpoint.nodeId, {
+            endpoint: this.endpoint.index,
             message: `Received unexpected ConfigurationReport (param = ${response.parameter}, value = ${response.value.toString()})`,
             direction: "inbound",
             level: "error",
@@ -730,7 +741,7 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
             (0, safe_1.isConsecutiveArray)(distinctParameters)) {
             const cc = new ConfigurationCCBulkGet(this.applHost, {
                 nodeId: this.endpoint.nodeId,
-                // Don't set an endpoint here, Configuration is device specific, not endpoint specific
+                endpoint: this.endpoint.index,
                 parameters: distinctParameters,
             });
             const response = await this.applHost.sendCommand(cc, this.commandOptions);
@@ -743,7 +754,7 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
             for (const parameter of distinctParameters) {
                 const cc = new ConfigurationCCGet(this.applHost, {
                     nodeId: this.endpoint.nodeId,
-                    // Don't set an endpoint here, Configuration is device specific, not endpoint specific
+                    endpoint: this.endpoint.index,
                     parameter,
                 });
                 const response = await this.applHost.sendCommand(cc, this.commandOptions);
@@ -782,7 +793,7 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
         }
         const cc = new ConfigurationCCSet(this.applHost, {
             nodeId: this.endpoint.nodeId,
-            // Don't set an endpoint here, Configuration is device specific, not endpoint specific
+            endpoint: this.endpoint.index,
             resetToDefault: false,
             parameter: normalized.parameter,
             value,
@@ -810,29 +821,48 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
         if (canUseBulkSet) {
             const cc = new ConfigurationCCBulkSet(this.applHost, {
                 nodeId: this.endpoint.nodeId,
-                // Don't set an endpoint here, Configuration is device specific, not endpoint specific
+                endpoint: this.endpoint.index,
                 parameters: allParams.map((v) => v.parameter),
                 valueSize: allParams[0].valueSize,
                 valueFormat: allParams[0].valueFormat,
                 values: allParams.map((v) => v.value),
                 handshake: true,
             });
-            return this.applHost.sendCommand(cc, this.commandOptions);
+            // The handshake flag is set, so we expect a BulkReport in response
+            const result = await this.applHost.sendCommand(cc, this.commandOptions);
+            // If we did receive a response, we also received the updated parameters,
+            // so if any one was not accepted, we know by looking at the values.
+            // Translate the result into a SupervisionResult by comparing the values
+            if (result) {
+                const sentValues = cc.values;
+                const receivedValues = [...result.values.values()];
+                const success = sentValues.length === receivedValues.length &&
+                    sentValues.every((v, i) => v === receivedValues[i]);
+                return {
+                    status: success
+                        ? safe_1.SupervisionStatus.Success
+                        : safe_1.SupervisionStatus.Fail,
+                };
+            }
+            else {
+                return undefined;
+            }
         }
         else {
             this.assertSupportsCommand(_Types_1.ConfigurationCommand, _Types_1.ConfigurationCommand.Set);
+            const supervisionResults = [];
             for (const { parameter, value, valueSize, valueFormat, } of allParams) {
                 const cc = new ConfigurationCCSet(this.applHost, {
                     nodeId: this.endpoint.nodeId,
-                    // Don't set an endpoint here, Configuration is device specific, not endpoint specific
+                    endpoint: this.endpoint.index,
                     parameter,
                     value,
                     valueSize,
                     valueFormat,
                 });
-                // TODO: handle intermediate errors
-                await this.applHost.sendCommand(cc, this.commandOptions);
+                supervisionResults.push(await this.applHost.sendCommand(cc, this.commandOptions));
             }
+            return (0, safe_1.mergeSupervisionResults)(supervisionResults);
         }
     }
     /**
@@ -849,7 +879,7 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
         this.assertSupportsCommand(_Types_1.ConfigurationCommand, _Types_1.ConfigurationCommand.Set);
         const cc = new ConfigurationCCSet(this.applHost, {
             nodeId: this.endpoint.nodeId,
-            // Don't set an endpoint here, Configuration is device specific, not endpoint specific
+            endpoint: this.endpoint.index,
             parameter,
             resetToDefault: true,
         });
@@ -866,7 +896,7 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
             this.supportsCommand(_Types_1.ConfigurationCommand.BulkSet)) {
             const cc = new ConfigurationCCBulkSet(this.applHost, {
                 nodeId: this.endpoint.nodeId,
-                // Don't set an endpoint here, Configuration is device specific, not endpoint specific
+                endpoint: this.endpoint.index,
                 parameters,
                 resetToDefault: true,
             });
@@ -876,7 +906,7 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
             this.assertSupportsCommand(_Types_1.ConfigurationCommand, _Types_1.ConfigurationCommand.Set);
             const CCs = (0, arrays_1.distinct)(parameters).map((parameter) => new ConfigurationCCSet(this.applHost, {
                 nodeId: this.endpoint.nodeId,
-                // Don't set an endpoint here, Configuration is device specific, not endpoint specific
+                endpoint: this.endpoint.index,
                 parameter,
                 resetToDefault: true,
             }));
@@ -892,7 +922,7 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
         this.assertSupportsCommand(_Types_1.ConfigurationCommand, _Types_1.ConfigurationCommand.DefaultReset);
         const cc = new ConfigurationCCDefaultReset(this.applHost, {
             nodeId: this.endpoint.nodeId,
-            // Don't set an endpoint here, Configuration is device specific, not endpoint specific
+            endpoint: this.endpoint.index,
         });
         await this.applHost.sendCommand(cc, this.commandOptions);
     }
@@ -902,7 +932,7 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
         this.assertPhysicalEndpoint(this.endpoint);
         const cc = new ConfigurationCCPropertiesGet(this.applHost, {
             nodeId: this.endpoint.nodeId,
-            // Don't set an endpoint here, Configuration is device specific, not endpoint specific
+            endpoint: this.endpoint.index,
             parameter,
         });
         const response = await this.applHost.sendCommand(cc, this.commandOptions);
@@ -928,7 +958,7 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
         this.assertPhysicalEndpoint(this.endpoint);
         const cc = new ConfigurationCCNameGet(this.applHost, {
             nodeId: this.endpoint.nodeId,
-            // Don't set an endpoint here, Configuration is device specific, not endpoint specific
+            endpoint: this.endpoint.index,
             parameter,
         });
         const response = await this.applHost.sendCommand(cc, this.commandOptions);
@@ -941,7 +971,7 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
         this.assertPhysicalEndpoint(this.endpoint);
         const cc = new ConfigurationCCInfoGet(this.applHost, {
             nodeId: this.endpoint.nodeId,
-            // Don't set an endpoint here, Configuration is device specific, not endpoint specific
+            endpoint: this.endpoint.index,
             parameter,
         });
         const response = await this.applHost.sendCommand(cc, this.commandOptions);
@@ -965,12 +995,16 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
         // Get-type commands are only possible in singlecast
         this.assertPhysicalEndpoint(this.endpoint);
         // TODO: Reduce the priority of the messages
-        this.applHost.controllerLog.logNode(this.endpoint.nodeId, `Scanning available parameters...`);
+        this.applHost.controllerLog.logNode(this.endpoint.nodeId, {
+            endpoint: this.endpoint.index,
+            message: `Scanning available parameters...`,
+        });
         const ccInstance = createConfigurationCCInstance(this.applHost, this.endpoint);
         for (let param = 1; param <= 255; param++) {
             // Check if the parameter is readable
             let originalValue;
             this.applHost.controllerLog.logNode(this.endpoint.nodeId, {
+                endpoint: this.endpoint.index,
                 message: `  trying param ${param}...`,
                 direction: "outbound",
             });
@@ -987,6 +1021,7 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
     valueSize = ${ccInstance.getParamInformation(this.applHost, param).valueSize}
     value     = ${originalValue.toString()}`;
                     this.applHost.controllerLog.logNode(this.endpoint.nodeId, {
+                        endpoint: this.endpoint.index,
                         message: logMessage,
                         direction: "inbound",
                     });
@@ -1024,7 +1059,7 @@ let ConfigurationCC = class ConfigurationCC extends CommandClass_1.CommandClass
             direction: "none",
         });
         const deviceConfig = applHost.getDeviceConfig?.(node.id);
-        const paramInfo = deviceConfig?.paramInformation;
+        const paramInfo = getParamInformationFromConfigFile(applHost, node.id, this.endpointIndex);
         if (paramInfo) {
             applHost.controllerLog.logNode(node.id, {
                 endpoint: this.endpointIndex,
@@ -1033,6 +1068,7 @@ let ConfigurationCC = class ConfigurationCC extends CommandClass_1.CommandClass
             });
             this.deserializeParamInformationFromConfig(applHost, paramInfo);
         }
+        const documentedParamNumbers = new Set(Array.from(paramInfo?.keys() ?? []).map((k) => k.parameter));
         if (this.version >= 3) {
             applHost.controllerLog.logNode(node.id, {
                 endpoint: this.endpointIndex,
@@ -1067,14 +1103,16 @@ let ConfigurationCC = class ConfigurationCC extends CommandClass_1.CommandClass
                     direction: "outbound",
                 });
                 // Query properties and the next param
-                const props = await api.getProperties(param);
+                const props = await api.getProperties(param).catch(
+                // If querying the properties fails, don't abort the entire interview
+                () => undefined);
                 if (!props) {
                     applHost.controllerLog.logNode(node.id, {
                         endpoint: this.endpointIndex,
-                        message: `Querying parameter #${param} information timed out, skipping interview...`,
+                        message: `Querying parameter #${param} information timed out, skipping scan...`,
                         level: "warn",
                     });
-                    return;
+                    break;
                 }
                 const { nextParameter, ...properties } = props;
                 let logMessage;
@@ -1082,14 +1120,21 @@ let ConfigurationCC = class ConfigurationCC extends CommandClass_1.CommandClass
                     logMessage = `Parameter #${param} is unsupported. Next parameter: ${nextParameter}`;
                 }
                 else {
-                    // Query name and info only if the parameter is supported, but skip the query for bugged devices
                     let name;
-                    if (!deviceConfig?.compat?.skipConfigurationNameQuery) {
-                        name = await api.getName(param);
-                    }
-                    // Skip the info query for bugged devices
-                    if (!deviceConfig?.compat?.skipConfigurationInfoQuery) {
-                        await api.getInfo(param);
+                    // Query the name and info for parameters that are NOT defined in a config file
+                    if (!documentedParamNumbers.has(param)) {
+                        // Skip the name query for bugged devices
+                        if (!deviceConfig?.compat?.skipConfigurationNameQuery) {
+                            name = await api.getName(param).catch(
+                            // If querying the name fails, don't abort the entire interview
+                            () => undefined);
+                        }
+                        // Skip the info query for bugged devices
+                        if (!deviceConfig?.compat?.skipConfigurationInfoQuery) {
+                            await api.getInfo(param).catch(
+                            // If querying the info fails, don't abort the entire interview
+                            () => undefined);
+                        }
                     }
                     logMessage = `received information for parameter #${param}:`;
                     if (name) {
@@ -1135,7 +1180,7 @@ alters capabilities: ${!!properties.altersCapabilities}`;
         });
         if (this.version < 3) {
             // V1/V2: Query all values defined in the config file
-            const paramInfo = applHost.getDeviceConfig?.(node.id)?.paramInformation;
+            const paramInfo = getParamInformationFromConfigFile(applHost, node.id, this.endpointIndex);
             if (paramInfo?.size) {
                 // Because partial params share the same parameter number,
                 // we need to remember which ones we have already queried.
@@ -1220,14 +1265,12 @@ alters capabilities: ${!!properties.altersCapabilities}`;
         // Don't trust param information that a node reports if we have already loaded it from a config file
         if (this.isParamInformationFromConfig(applHost))
             return;
-        const valueDB = this.getValueDB(applHost);
-        const valueId = exports.ConfigurationCCValues.paramInformation(parameter, valueBitMask).id;
         // Retrieve the base metadata
         const metadata = this.getParamInformation(applHost, parameter, valueBitMask);
         // Override it with new data
         Object.assign(metadata, info);
         // And store it back
-        valueDB.setMetadata(valueId, metadata);
+        this.setMetadata(applHost, exports.ConfigurationCCValues.paramInformation(parameter, valueBitMask), metadata);
     }
     /**
      * @internal
@@ -1257,6 +1300,7 @@ alters capabilities: ${!!properties.altersCapabilities}`;
     getPartialParamInfos(applHost, parameter) {
         const valueDB = this.getValueDB(applHost);
         return valueDB.findMetadata((id) => id.commandClass === this.ccId &&
+            (id.endpoint ?? 0) === this.endpointIndex &&
             id.property === parameter &&
             id.propertyKey != undefined);
     }
@@ -1275,6 +1319,7 @@ alters capabilities: ${!!properties.altersCapabilities}`;
         const valueDB = this.getValueDB(applHost);
         // Add the other values together
         const otherValues = valueDB.findValues((id) => id.commandClass === this.ccId &&
+            (id.endpoint ?? 0) === this.endpointIndex &&
             id.property === parameter &&
             id.propertyKey != undefined &&
             !partials.some((p) => id.propertyKey === p.bitMask));
@@ -1292,7 +1337,8 @@ alters capabilities: ${!!properties.altersCapabilities}`;
         const valueDB = this.getValueDB(applHost);
         // Clear old param information
         for (const meta of valueDB.getAllMetadata(this.ccId)) {
-            if (typeof meta.property === "number") {
+            if (typeof meta.property === "number" &&
+                (meta.endpoint ?? 0) === this.endpointIndex) {
                 // this is a param information, delete it
                 valueDB.setMetadata(meta, undefined, 
                 // Don't emit the added/updated events, as this will spam applications with untranslated events
@@ -1389,7 +1435,6 @@ let ConfigurationCCReport = class ConfigurationCCReport extends ConfigurationCC
     persistValues(applHost) {
         if (!super.persistValues(applHost))
             return false;
-        const valueDB = this.getValueDB(applHost);
         // Check if the initial assumption of SignedInteger holds true
         const oldParamInformation = this.getParamInformation(applHost, this.parameter);
         if (oldParamInformation.format != undefined &&
@@ -1418,20 +1463,13 @@ let ConfigurationCCReport = class ConfigurationCCReport extends ConfigurationCC
         if (partialParams.length > 0) {
             for (const param of partialParams) {
                 if (typeof param.propertyKey === "number") {
-                    valueDB.setValue({
-                        commandClass: this.ccId,
-                        property: this.parameter,
-                        propertyKey: param.propertyKey,
-                    }, (0, safe_1.parsePartial)(this.value, param.propertyKey, isSignedPartial(param.propertyKey, param.metadata.format)));
+                    this.setValue(applHost, exports.ConfigurationCCValues.paramInformation(this.parameter), (0, safe_1.parsePartial)(this.value, param.propertyKey, isSignedPartial(param.propertyKey, param.metadata.format)));
                 }
             }
         }
         else {
             // This is a single param
-            valueDB.setValue({
-                commandClass: this.ccId,
-                property: this.parameter,
-            }, this.value);
+            this.setValue(applHost, exports.ConfigurationCCValues.paramInformation(this.parameter), this.value);
         }
         return true;
     }
@@ -1702,7 +1740,6 @@ let ConfigurationCCBulkReport = class ConfigurationCCBulkReport extends Configur
     persistValues(applHost) {
         if (!super.persistValues(applHost))
             return false;
-        const valueDB = this.getValueDB(applHost);
         // Store every received parameter
         // eslint-disable-next-line prefer-const
         for (let [parameter, value] of this._values.entries()) {
@@ -1714,10 +1751,7 @@ let ConfigurationCCBulkReport = class ConfigurationCCBulkReport extends Configur
                 value = reInterpretSignedValue(value, this._valueSize, oldParamInformation.format);
                 this._values.set(parameter, value);
             }
-            valueDB.setValue({
-                commandClass: this.ccId,
-                property: parameter,
-            }, value);
+            this.setValue(applHost, exports.ConfigurationCCValues.paramInformation(parameter), value);
         }
         return true;
     }
@@ -1825,7 +1859,6 @@ let ConfigurationCCNameReport = class ConfigurationCCNameReport extends Configur
         if (!super.persistValues(applHost))
             return false;
         this.extendParamInformation(applHost, this.parameter, undefined, {
-            name: this.name,
             label: this.name,
         });
         return true;
@@ -1918,7 +1951,6 @@ let ConfigurationCCInfoReport = class ConfigurationCCInfoReport extends Configur
         if (!super.persistValues(applHost))
             return false;
         this.extendParamInformation(applHost, this.parameter, undefined, {
-            info: this.info,
             description: this.info,
         });
         return true;