@zwave-js/cc 10.18.0 → 10.20.0

package/build/cc/ConfigurationCC.js

@@ -1368,30 +1368,38 @@ exports.ConfigurationCC = ConfigurationCC;
 let ConfigurationCCReport = class ConfigurationCCReport extends ConfigurationCC {
     constructor(host, options) {
         super(host, options);
-        // All fields must be present
-        (0, safe_1.validatePayload)(this.payload.length > 2);
-        this._parameter = this.payload[0];
-        this._valueSize = this.payload[1] & 0b111;
-        // Ensure we received a valid report
-        (0, safe_1.validatePayload)(this._valueSize >= 1, this._valueSize <= 4, this.payload.length >= 2 + this._valueSize);
-        // Default to parsing the value as SignedInteger, like the specs say.
-        // We try to re-interpret the value in persistValues()
-        this._value = parseValue(this.payload.slice(2), this._valueSize, safe_1.ConfigValueFormat.SignedInteger);
+        if ((0, CommandClass_1.gotDeserializationOptions)(options)) {
+            // All fields must be present
+            (0, safe_1.validatePayload)(this.payload.length > 2);
+            this.parameter = this.payload[0];
+            this.valueSize = this.payload[1] & 0b111;
+            // Ensure we received a valid report
+            (0, safe_1.validatePayload)(this.valueSize >= 1, this.valueSize <= 4, this.payload.length >= 2 + this.valueSize);
+            // Default to parsing the value as SignedInteger, like the specs say.
+            // We try to re-interpret the value in persistValues()
+            this.value = parseValue(this.payload.slice(2), this.valueSize, safe_1.ConfigValueFormat.SignedInteger);
+        }
+        else {
+            this.parameter = options.parameter;
+            this.value = options.value;
+            this.valueSize = options.valueSize;
+            this.valueFormat = options.valueFormat;
+        }
     }
     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);
+        const oldParamInformation = this.getParamInformation(applHost, this.parameter);
         if (oldParamInformation.format != undefined &&
             oldParamInformation.format !== safe_1.ConfigValueFormat.SignedInteger) {
             // Re-interpret the value with the new format
-            this._value = reInterpretSignedValue(this._value, this._valueSize, oldParamInformation.format);
+            this.value = reInterpretSignedValue(this.value, this.valueSize, oldParamInformation.format);
         }
         // Store the parameter size and value
-        this.extendParamInformation(applHost, this._parameter, undefined, {
-            valueSize: this._valueSize,
+        this.extendParamInformation(applHost, this.parameter, undefined, {
+            valueSize: this.valueSize,
             type: oldParamInformation.format === safe_1.ConfigValueFormat.BitField
                 ? "number[]"
                 : "number",
@@ -1402,19 +1410,19 @@ let ConfigurationCCReport = class ConfigurationCCReport extends ConfigurationCC
             oldParamInformation.max == undefined) {
             const isSigned = oldParamInformation.format == undefined ||
                 oldParamInformation.format === safe_1.ConfigValueFormat.SignedInteger;
-            this.extendParamInformation(applHost, this._parameter, undefined, (0, safe_1.getIntegerLimits)(this._valueSize, isSigned));
+            this.extendParamInformation(applHost, this.parameter, undefined, (0, safe_1.getIntegerLimits)(this.valueSize, isSigned));
         }
         // And store the value itself
         // If we have partial config params defined, we need to split the value
-        const partialParams = this.getPartialParamInfos(applHost, this._parameter);
+        const partialParams = this.getPartialParamInfos(applHost, this.parameter);
         if (partialParams.length > 0) {
             for (const param of partialParams) {
                 if (typeof param.propertyKey === "number") {
                     valueDB.setValue({
                         commandClass: this.ccId,
-                        property: this._parameter,
+                        property: this.parameter,
                         propertyKey: param.propertyKey,
-                    }, (0, safe_1.parsePartial)(this._value, param.propertyKey, isSignedPartial(param.propertyKey, param.metadata.format)));
+                    }, (0, safe_1.parsePartial)(this.value, param.propertyKey, isSignedPartial(param.propertyKey, param.metadata.format)));
                 }
             }
         }
@@ -1422,19 +1430,21 @@ let ConfigurationCCReport = class ConfigurationCCReport extends ConfigurationCC
             // This is a single param
             valueDB.setValue({
                 commandClass: this.ccId,
-                property: this._parameter,
-            }, this._value);
+                property: this.parameter,
+            }, this.value);
         }
         return true;
     }
-    get parameter() {
-        return this._parameter;
-    }
-    get value() {
-        return this._value;
-    }
-    get valueSize() {
-        return this._valueSize;
+    serialize() {
+        this.payload = Buffer.concat([
+            Buffer.from([this.parameter, this.valueSize & 0b111]),
+            Buffer.allocUnsafe(this.valueSize),
+        ]);
+        const valueFormat = typeof this.value === "number"
+            ? this.valueFormat ?? safe_1.ConfigValueFormat.SignedInteger
+            : safe_1.ConfigValueFormat.BitField;
+        serializeValue(this.payload, 2, this.valueSize, valueFormat, this.value);
+        return super.serialize();
     }
     toLogEntry(applHost) {
         return {
@@ -1459,8 +1469,9 @@ let ConfigurationCCGet = class ConfigurationCCGet extends ConfigurationCC {
     constructor(host, options) {
         super(host, options);
         if ((0, CommandClass_1.gotDeserializationOptions)(options)) {
-            // TODO: Deserialize payload
-            throw new safe_1.ZWaveError(`${this.constructor.name}: deserialization not implemented`, safe_1.ZWaveErrorCodes.Deserialization_NotImplemented);
+            (0, safe_1.validatePayload)(this.payload.length >= 1);
+            this.parameter = this.payload[0];
+            this.allowUnexpectedResponse = false;
         }
         else {
             this.parameter = options.parameter;
@@ -1488,8 +1499,14 @@ let ConfigurationCCSet = class ConfigurationCCSet extends ConfigurationCC {
     constructor(host, options) {
         super(host, options);
         if ((0, CommandClass_1.gotDeserializationOptions)(options)) {
-            // TODO: Deserialize payload
-            throw new safe_1.ZWaveError(`${this.constructor.name}: deserialization not implemented`, safe_1.ZWaveErrorCodes.Deserialization_NotImplemented);
+            (0, safe_1.validatePayload)(this.payload.length >= 2);
+            this.parameter = this.payload[0];
+            this.resetToDefault = !!(this.payload[1] & 128);
+            this.valueSize = this.payload[1] & 0b111;
+            // Ensure we received a valid report
+            (0, safe_1.validatePayload)(this.valueSize >= 1, this.valueSize <= 4, this.payload.length >= 2 + this.valueSize);
+            // Parse the value as signed integer. We don't know the format here.
+            this.value = parseValue(this.payload.slice(2), this.valueSize, safe_1.ConfigValueFormat.SignedInteger);
         }
         else {
             this.parameter = options.parameter;
@@ -1809,6 +1826,7 @@ let ConfigurationCCNameReport = class ConfigurationCCNameReport extends Configur
             return false;
         this.extendParamInformation(applHost, this.parameter, undefined, {
             name: this.name,
+            label: this.name,
         });
         return true;
     }
@@ -1879,44 +1897,51 @@ exports.ConfigurationCCNameGet = ConfigurationCCNameGet;
 let ConfigurationCCInfoReport = class ConfigurationCCInfoReport extends ConfigurationCC {
     constructor(host, options) {
         super(host, options);
-        // Parameter and # of reports must be present
-        (0, safe_1.validatePayload)(this.payload.length >= 3);
-        this._parameter = this.payload.readUInt16BE(0);
-        this._reportsToFollow = this.payload[2];
-        if (this._reportsToFollow > 0) {
-            // If more reports follow, the info must at least be one byte
-            (0, safe_1.validatePayload)(this.payload.length >= 4);
+        if ((0, CommandClass_1.gotDeserializationOptions)(options)) {
+            // Parameter and # of reports must be present
+            (0, safe_1.validatePayload)(this.payload.length >= 3);
+            this.parameter = this.payload.readUInt16BE(0);
+            this.reportsToFollow = this.payload[2];
+            if (this.reportsToFollow > 0) {
+                // If more reports follow, the info must at least be one byte
+                (0, safe_1.validatePayload)(this.payload.length >= 4);
+            }
+            this.info = this.payload.slice(3).toString("utf8");
+        }
+        else {
+            this.parameter = options.parameter;
+            this.info = options.info;
+            this.reportsToFollow = options.reportsToFollow;
         }
-        this._info = this.payload.slice(3).toString("utf8");
     }
     persistValues(applHost) {
         if (!super.persistValues(applHost))
             return false;
-        this.extendParamInformation(applHost, this._parameter, undefined, {
-            info: this._info,
+        this.extendParamInformation(applHost, this.parameter, undefined, {
+            info: this.info,
+            description: this.info,
         });
         return true;
     }
-    get parameter() {
-        return this._parameter;
-    }
-    get info() {
-        return this._info;
-    }
-    get reportsToFollow() {
-        return this._reportsToFollow;
+    serialize() {
+        const infoBuffer = Buffer.from(this.info, "utf8");
+        this.payload = Buffer.allocUnsafe(3 + infoBuffer.length);
+        this.payload.writeUInt16BE(this.parameter, 0);
+        this.payload[2] = this.reportsToFollow;
+        infoBuffer.copy(this.payload, 3);
+        return super.serialize();
     }
     getPartialCCSessionId() {
         // Distinguish sessions by the parameter number
-        return { parameter: this._parameter };
+        return { parameter: this.parameter };
     }
     expectMoreMessages() {
-        return this._reportsToFollow > 0;
+        return this.reportsToFollow > 0;
     }
     mergePartialCCs(applHost, partials) {
         // Concat the info
-        this._info = [...partials, this]
-            .map((report) => report._info)
+        this.info = [...partials, this]
+            .map((report) => report.info)
             .reduce((prev, cur) => prev + cur, "");
     }
     toLogEntry(applHost) {
@@ -1938,8 +1963,8 @@ let ConfigurationCCInfoGet = class ConfigurationCCInfoGet extends ConfigurationC
     constructor(host, options) {
         super(host, options);
         if ((0, CommandClass_1.gotDeserializationOptions)(options)) {
-            // TODO: Deserialize payload
-            throw new safe_1.ZWaveError(`${this.constructor.name}: deserialization not implemented`, safe_1.ZWaveErrorCodes.Deserialization_NotImplemented);
+            (0, safe_1.validatePayload)(this.payload.length >= 2);
+            this.parameter = this.payload.readUInt16BE(0);
         }
         else {
             this.parameter = options.parameter;
@@ -1965,128 +1990,153 @@ exports.ConfigurationCCInfoGet = ConfigurationCCInfoGet;
 let ConfigurationCCPropertiesReport = class ConfigurationCCPropertiesReport extends ConfigurationCC {
     constructor(host, options) {
         super(host, options);
-        (0, safe_1.validatePayload)(this.payload.length >= 3);
-        this._parameter = this.payload.readUInt16BE(0);
-        this._valueFormat = (this.payload[2] & 0b111000) >>> 3;
-        this._valueSize = this.payload[2] & 0b111;
-        // GH#1309 Some devices don't tell us the first parameter if we query #0
-        // Instead, they contain 0x000000
-        if (this._valueSize === 0 && this.payload.length < 5) {
-            this._nextParameter = 0;
-            return;
-        }
-        // Ensure the payload contains the two bytes for next parameter
-        const nextParameterOffset = 3 + 3 * this._valueSize;
-        (0, safe_1.validatePayload)(this.payload.length >= nextParameterOffset + 2);
-        if (this.valueSize > 0) {
-            if (this._valueFormat !== safe_1.ConfigValueFormat.BitField) {
-                this._minValue = parseValue(this.payload.slice(3), this._valueSize, this._valueFormat);
+        if ((0, CommandClass_1.gotDeserializationOptions)(options)) {
+            (0, safe_1.validatePayload)(this.payload.length >= 3);
+            this.parameter = this.payload.readUInt16BE(0);
+            this.valueFormat = (this.payload[2] & 0b111000) >>> 3;
+            this.valueSize = this.payload[2] & 0b111;
+            // GH#1309 Some devices don't tell us the first parameter if we query #0
+            // Instead, they contain 0x000000
+            if (this.valueSize === 0 && this.payload.length < 5) {
+                this.nextParameter = 0;
+                return;
+            }
+            // Ensure the payload contains the two bytes for next parameter
+            const nextParameterOffset = 3 + 3 * this.valueSize;
+            (0, safe_1.validatePayload)(this.payload.length >= nextParameterOffset + 2);
+            if (this.valueSize > 0) {
+                if (this.valueFormat !== safe_1.ConfigValueFormat.BitField) {
+                    this.minValue = parseValue(this.payload.slice(3), this.valueSize, this.valueFormat);
+                }
+                this.maxValue = parseValue(this.payload.slice(3 + this.valueSize), this.valueSize, this.valueFormat);
+                this.defaultValue = parseValue(this.payload.slice(3 + 2 * this.valueSize), this.valueSize, this.valueFormat);
+            }
+            if (this.version < 4) {
+                // Read the last 2 bytes to work around nodes not omitting min/max value when their size is 0
+                this.nextParameter = this.payload.readUInt16BE(this.payload.length - 2);
+            }
+            else {
+                this.nextParameter =
+                    this.payload.readUInt16BE(nextParameterOffset);
+                // Ensure the payload contains a byte for the 2nd option flags
+                (0, safe_1.validatePayload)(this.payload.length >= nextParameterOffset + 3);
+                const options1 = this.payload[2];
+                const options2 = this.payload[3 + 3 * this.valueSize + 2];
+                this.altersCapabilities = !!(options1 & 128);
+                this.isReadonly = !!(options1 & 64);
+                this.isAdvanced = !!(options2 & 0b1);
+                this.noBulkSupport = !!(options2 & 0b10);
             }
-            this._maxValue = parseValue(this.payload.slice(3 + this._valueSize), this._valueSize, this._valueFormat);
-            this._defaultValue = parseValue(this.payload.slice(3 + 2 * this._valueSize), this._valueSize, this._valueFormat);
-        }
-        if (this.version < 4) {
-            // Read the last 2 bytes to work around nodes not omitting min/max value when their size is 0
-            this._nextParameter = this.payload.readUInt16BE(this.payload.length - 2);
         }
         else {
-            this._nextParameter =
-                this.payload.readUInt16BE(nextParameterOffset);
-            // Ensure the payload contains a byte for the 2nd option flags
-            (0, safe_1.validatePayload)(this.payload.length >= nextParameterOffset + 3);
-            const options1 = this.payload[2];
-            const options2 = this.payload[3 + 3 * this.valueSize + 2];
-            this._altersCapabilities = !!(options1 & 128);
-            this._isReadonly = !!(options1 & 64);
-            this._isAdvanced = !!(options2 & 0b1);
-            this._noBulkSupport = !!(options2 & 0b10);
+            this.parameter = options.parameter;
+            this.valueSize = options.valueSize;
+            this.valueFormat = options.valueFormat;
+            if (this.valueSize > 0) {
+                if (options.minValue == undefined) {
+                    throw new safe_1.ZWaveError("The minimum value must be set when the value size is non-zero", safe_1.ZWaveErrorCodes.Argument_Invalid);
+                }
+                else if (options.maxValue == undefined) {
+                    throw new safe_1.ZWaveError("The maximum value must be set when the value size is non-zero", safe_1.ZWaveErrorCodes.Argument_Invalid);
+                }
+                else if (options.defaultValue == undefined) {
+                    throw new safe_1.ZWaveError("The default value must be set when the value size is non-zero", safe_1.ZWaveErrorCodes.Argument_Invalid);
+                }
+                this.minValue = options.minValue;
+                this.maxValue = options.maxValue;
+                this.defaultValue = options.defaultValue;
+            }
+            this.nextParameter = options.nextParameter;
+            this.altersCapabilities = options.altersCapabilities;
+            this.isReadonly = options.isReadonly;
+            this.isAdvanced = options.isAdvanced;
+            this.noBulkSupport = options.noBulkSupport;
         }
     }
     persistValues(applHost) {
         if (!super.persistValues(applHost))
             return false;
         // If we actually received parameter info, store it
-        if (this._valueSize > 0) {
-            const valueType = this._valueFormat === safe_1.ConfigValueFormat.SignedInteger ||
-                this._valueFormat === safe_1.ConfigValueFormat.UnsignedInteger
+        if (this.valueSize > 0) {
+            const valueType = this.valueFormat === safe_1.ConfigValueFormat.SignedInteger ||
+                this.valueFormat === safe_1.ConfigValueFormat.UnsignedInteger
                 ? "number"
                 : "number[]";
             const paramInfo = (0, safe_1.stripUndefined)({
                 type: valueType,
-                valueFormat: this._valueFormat,
-                valueSize: this._valueSize,
-                minValue: this._minValue,
-                maxValue: this._maxValue,
-                defaultValue: this._defaultValue,
-                requiresReInclusion: this._altersCapabilities,
-                writeable: !this._isReadonly,
-                isAdvanced: this._isAdvanced,
-                noBulkSupport: this._noBulkSupport,
+                format: this.valueFormat,
+                valueSize: this.valueSize,
+                min: this.minValue,
+                max: this.maxValue,
+                default: this.defaultValue,
+                requiresReInclusion: this.altersCapabilities,
+                readable: true,
+                writeable: !this.isReadonly,
+                allowManualEntry: true,
+                isAdvanced: this.isAdvanced,
+                noBulkSupport: this.noBulkSupport,
+                isFromConfig: false,
             });
-            this.extendParamInformation(applHost, this._parameter, undefined, paramInfo);
+            this.extendParamInformation(applHost, this.parameter, undefined, paramInfo);
         }
         return true;
     }
-    get parameter() {
-        return this._parameter;
-    }
-    get valueSize() {
-        return this._valueSize;
-    }
-    get valueFormat() {
-        return this._valueFormat;
-    }
-    get minValue() {
-        return this._minValue;
-    }
-    get maxValue() {
-        return this._maxValue;
-    }
-    get defaultValue() {
-        return this._defaultValue;
-    }
-    get nextParameter() {
-        return this._nextParameter;
-    }
-    get altersCapabilities() {
-        return this._altersCapabilities;
-    }
-    get isReadonly() {
-        return this._isReadonly;
-    }
-    get isAdvanced() {
-        return this._isAdvanced;
-    }
-    get noBulkSupport() {
-        return this._noBulkSupport;
+    serialize() {
+        this.payload = Buffer.allocUnsafe(3 + // preamble
+            3 * this.valueSize + // min, max, default value
+            2);
+        this.payload.writeUInt16BE(this.parameter, 0);
+        const options1 = (this.altersCapabilities ? 128 : 0) |
+            (this.isReadonly ? 64 : 0) |
+            ((this.valueFormat & 0b111) << 3) |
+            (this.valueSize & 0b111);
+        this.payload[2] = options1;
+        let offset = 3;
+        if (this.valueSize > 0) {
+            serializeValue(this.payload, offset, this.valueSize, this.valueFormat, this.minValue);
+            offset += this.valueSize;
+            serializeValue(this.payload, offset, this.valueSize, this.valueFormat, this.maxValue);
+            offset += this.valueSize;
+            serializeValue(this.payload, offset, this.valueSize, this.valueFormat, this.defaultValue);
+            offset += this.valueSize;
+        }
+        this.payload.writeUInt16BE(this.nextParameter, offset);
+        if (this.version >= 4) {
+            const options2 = (this.isAdvanced ? 0b1 : 0) | (this.noBulkSupport ? 0b10 : 0);
+            this.payload = Buffer.concat([
+                this.payload,
+                Buffer.from([options2]),
+            ]);
+        }
+        return super.serialize();
     }
     toLogEntry(applHost) {
         const message = {
-            "parameter #": this._parameter,
-            "next param #": this._nextParameter,
-            "value size": this._valueSize,
-            "value format": (0, safe_2.getEnumMemberName)(safe_1.ConfigValueFormat, this._valueFormat),
+            "parameter #": this.parameter,
+            "next param #": this.nextParameter,
+            "value size": this.valueSize,
+            "value format": (0, safe_2.getEnumMemberName)(safe_1.ConfigValueFormat, this.valueFormat),
         };
-        if (this._minValue != undefined) {
-            message["min value"] = configValueToString(this._minValue);
+        if (this.minValue != undefined) {
+            message["min value"] = configValueToString(this.minValue);
         }
-        if (this._maxValue != undefined) {
-            message["max value"] = configValueToString(this._maxValue);
+        if (this.maxValue != undefined) {
+            message["max value"] = configValueToString(this.maxValue);
         }
-        if (this._defaultValue != undefined) {
-            message["default value"] = configValueToString(this._defaultValue);
+        if (this.defaultValue != undefined) {
+            message["default value"] = configValueToString(this.defaultValue);
         }
-        if (this._altersCapabilities != undefined) {
-            message["alters capabilities"] = this._altersCapabilities;
+        if (this.altersCapabilities != undefined) {
+            message["alters capabilities"] = this.altersCapabilities;
         }
-        if (this._isReadonly != undefined) {
-            message.readonly = this._isReadonly;
+        if (this.isReadonly != undefined) {
+            message.readonly = this.isReadonly;
         }
-        if (this._isAdvanced != undefined) {
-            message.advanced = this._isAdvanced;
+        if (this.isAdvanced != undefined) {
+            message.advanced = this.isAdvanced;
         }
-        if (this._noBulkSupport != undefined) {
-            message["bulk support"] = !this._noBulkSupport;
+        if (this.noBulkSupport != undefined) {
+            message["bulk support"] = !this.noBulkSupport;
         }
         return {
             ...super.toLogEntry(applHost),
@@ -2102,8 +2152,8 @@ let ConfigurationCCPropertiesGet = class ConfigurationCCPropertiesGet extends Co
     constructor(host, options) {
         super(host, options);
         if ((0, CommandClass_1.gotDeserializationOptions)(options)) {
-            // TODO: Deserialize payload
-            throw new safe_1.ZWaveError(`${this.constructor.name}: deserialization not implemented`, safe_1.ZWaveErrorCodes.Deserialization_NotImplemented);
+            (0, safe_1.validatePayload)(this.payload.length >= 2);
+            this.parameter = this.payload.readUInt16BE(0);
         }
         else {
             this.parameter = options.parameter;