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

package/build/cc/ConfigurationCC.js

@@ -5,7 +5,6 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
-var _a, _b;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigurationCCDefaultReset = exports.ConfigurationCCPropertiesGet = exports.ConfigurationCCPropertiesReport = exports.ConfigurationCCInfoGet = exports.ConfigurationCCInfoReport = exports.ConfigurationCCNameGet = exports.ConfigurationCCNameReport = exports.ConfigurationCCBulkGet = exports.ConfigurationCCBulkReport = exports.ConfigurationCCBulkSet = exports.ConfigurationCCSet = exports.ConfigurationCCGet = exports.ConfigurationCCReport = exports.ConfigurationCC = exports.ConfigurationCCAPI = exports.ConfigurationCCValues = exports.ConfigurationCCError = void 0;
 function __assertType(argName, typeName, boundHasError) {
@@ -104,18 +103,6 @@ const __assertType__ConfigurationCCAPISetOptions = $o => {
     function _undefined($o) {
         return $o !== undefined ? {} : null;
     }
-    function _ignore() {
-        return null;
-    }
-    function su__number__11_9_9_9_eu($o) {
-        const conditions = [_number, _ignore];
-        for (const condition of conditions) {
-            const error = condition($o);
-            if (!error)
-                return null;
-        }
-        return {};
-    }
     function _3($o) {
         if (typeof $o !== "object" || $o === null || Array.isArray($o))
             return {};
@@ -125,7 +112,7 @@ const __assertType__ConfigurationCCAPISetOptions = $o => {
                 return error;
         }
         if ("value" in $o && $o["value"] !== undefined) {
-            const error = su__number__11_9_9_9_eu($o["value"]);
+            const error = _number($o["value"]);
             if (error)
                 return error;
         }
@@ -142,17 +129,17 @@ const __assertType__ConfigurationCCAPISetOptions = $o => {
         }
         return null;
     }
-    function _13($o) {
-        return $o !== 2 ? {} : null;
-    }
-    function _14($o) {
+    function _9($o) {
         return $o !== 1 ? {} : null;
     }
-    function _15($o) {
+    function _10($o) {
+        return $o !== 2 ? {} : null;
+    }
+    function _11($o) {
         return $o !== 4 ? {} : null;
     }
-    function su__13__14__15_eu($o) {
-        const conditions = [_13, _14, _15];
+    function su__9__10__11_eu($o) {
+        const conditions = [_9, _10, _11];
         for (const condition of conditions) {
             const error = condition($o);
             if (!error)
@@ -160,7 +147,7 @@ const __assertType__ConfigurationCCAPISetOptions = $o => {
         }
         return {};
     }
-    function su__17__18__19__20_eu($o) {
+    function su__13__14__15__16_eu($o) {
         return ![0, 1, 2, 3].includes($o) ? {} : null;
     }
     function _5($o) {
@@ -172,21 +159,21 @@ const __assertType__ConfigurationCCAPISetOptions = $o => {
                 return error;
         }
         if ("value" in $o && $o["value"] !== undefined) {
-            const error = su__number__11_9_9_9_eu($o["value"]);
+            const error = _number($o["value"]);
             if (error)
                 return error;
         }
         else
             return {};
         if ("valueSize" in $o && $o["valueSize"] !== undefined) {
-            const error = su__13__14__15_eu($o["valueSize"]);
+            const error = su__9__10__11_eu($o["valueSize"]);
             if (error)
                 return error;
         }
         else
             return {};
         if ("valueFormat" in $o && $o["valueFormat"] !== undefined) {
-            const error = su__17__18__19__20_eu($o["valueFormat"]);
+            const error = su__13__14__15__16_eu($o["valueFormat"]);
             if (error)
                 return error;
         }
@@ -261,18 +248,6 @@ const __assertType__sa_su_si__4__5_ei_si__4__7_ei_si__4__9_ei_eu_ea_2 = $o => {
     function _undefined($o) {
         return $o !== undefined ? {} : null;
     }
-    function _ignore() {
-        return null;
-    }
-    function su__number__13_11_11_11_eu($o) {
-        const conditions = [_number, _ignore];
-        for (const condition of conditions) {
-            const error = condition($o);
-            if (!error)
-                return null;
-        }
-        return {};
-    }
     function _5($o) {
         if (typeof $o !== "object" || $o === null || Array.isArray($o))
             return {};
@@ -282,7 +257,7 @@ const __assertType__sa_su_si__4__5_ei_si__4__7_ei_si__4__9_ei_eu_ea_2 = $o => {
                 return error;
         }
         if ("value" in $o && $o["value"] !== undefined) {
-            const error = su__number__13_11_11_11_eu($o["value"]);
+            const error = _number($o["value"]);
             if (error)
                 return error;
         }
@@ -299,17 +274,17 @@ const __assertType__sa_su_si__4__5_ei_si__4__7_ei_si__4__9_ei_eu_ea_2 = $o => {
         }
         return null;
     }
-    function _15($o) {
-        return $o !== 2 ? {} : null;
-    }
-    function _16($o) {
+    function _11($o) {
         return $o !== 1 ? {} : null;
     }
-    function _17($o) {
+    function _12($o) {
+        return $o !== 2 ? {} : null;
+    }
+    function _13($o) {
         return $o !== 4 ? {} : null;
     }
-    function su__15__16__17_eu($o) {
-        const conditions = [_15, _16, _17];
+    function su__11__12__13_eu($o) {
+        const conditions = [_11, _12, _13];
         for (const condition of conditions) {
             const error = condition($o);
             if (!error)
@@ -317,7 +292,7 @@ const __assertType__sa_su_si__4__5_ei_si__4__7_ei_si__4__9_ei_eu_ea_2 = $o => {
         }
         return {};
     }
-    function su__19__20__21__22_eu($o) {
+    function su__15__16__17__18_eu($o) {
         return ![0, 1, 2, 3].includes($o) ? {} : null;
     }
     function _7($o) {
@@ -329,21 +304,21 @@ const __assertType__sa_su_si__4__5_ei_si__4__7_ei_si__4__9_ei_eu_ea_2 = $o => {
                 return error;
         }
         if ("value" in $o && $o["value"] !== undefined) {
-            const error = su__number__13_11_11_11_eu($o["value"]);
+            const error = _number($o["value"]);
             if (error)
                 return error;
         }
         else
             return {};
         if ("valueSize" in $o && $o["valueSize"] !== undefined) {
-            const error = su__15__16__17_eu($o["valueSize"]);
+            const error = su__11__12__13_eu($o["valueSize"]);
             if (error)
                 return error;
         }
         else
             return {};
         if ("valueFormat" in $o && $o["valueFormat"] !== undefined) {
-            const error = su__19__20__21__22_eu($o["valueFormat"]);
+            const error = su__15__16__17__18_eu($o["valueFormat"]);
             if (error)
                 return error;
         }
@@ -562,9 +537,25 @@ function getParamInformationFromConfigFile(applHost, nodeId, endpointIndex) {
     }
 }
 let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
-    constructor() {
-        super(...arguments);
-        this[_a] = async ({ property, propertyKey }, value) => {
+    supportsCommand(cmd) {
+        switch (cmd) {
+            case _Types_1.ConfigurationCommand.Get:
+            case _Types_1.ConfigurationCommand.Set:
+                return true; // This is mandatory
+            case _Types_1.ConfigurationCommand.BulkGet:
+            case _Types_1.ConfigurationCommand.BulkSet:
+                return this.version >= 2;
+            case _Types_1.ConfigurationCommand.NameGet:
+            case _Types_1.ConfigurationCommand.InfoGet:
+            case _Types_1.ConfigurationCommand.PropertiesGet:
+                return this.version >= 3;
+            case _Types_1.ConfigurationCommand.DefaultReset:
+                return this.version >= 4;
+        }
+        return super.supportsCommand(cmd);
+    }
+    get [API_1.SET_VALUE]() {
+        return async function ({ property, propertyKey }, value) {
             // Config parameters are addressed with numeric properties/keys
             if (typeof property !== "number") {
                 (0, API_1.throwUnsupportedProperty)(this.ccId, property);
@@ -649,7 +640,9 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
             }
             return result;
         };
-        this[_b] = async ({ property, propertyKey, }) => {
+    }
+    get [API_1.POLL_VALUE]() {
+        return async function ({ property, propertyKey }) {
             // Config parameters are addressed with numeric properties/keys
             if (typeof property !== "number") {
                 (0, API_1.throwUnsupportedProperty)(this.ccId, property);
@@ -660,23 +653,6 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
             return this.get(property, { valueBitMask: propertyKey });
         };
     }
-    supportsCommand(cmd) {
-        switch (cmd) {
-            case _Types_1.ConfigurationCommand.Get:
-            case _Types_1.ConfigurationCommand.Set:
-                return true; // This is mandatory
-            case _Types_1.ConfigurationCommand.BulkGet:
-            case _Types_1.ConfigurationCommand.BulkSet:
-                return this.version >= 2;
-            case _Types_1.ConfigurationCommand.NameGet:
-            case _Types_1.ConfigurationCommand.InfoGet:
-            case _Types_1.ConfigurationCommand.PropertiesGet:
-                return this.version >= 3;
-            case _Types_1.ConfigurationCommand.DefaultReset:
-                return this.version >= 4;
-        }
-        return super.supportsCommand(cmd);
-    }
     /**
      * Requests the current value of a given config parameter from the device.
      * This may timeout and return `undefined` if the node does not respond.
@@ -1041,7 +1017,6 @@ let ConfigurationCCAPI = class ConfigurationCCAPI extends API_1.CCAPI {
         }
     }
 };
-_a = API_1.SET_VALUE, _b = API_1.POLL_VALUE;
 ConfigurationCCAPI = __decorate([
     (0, CommandClassDecorators_1.API)(safe_1.CommandClasses.Configuration)
 ], ConfigurationCCAPI);
@@ -1435,31 +1410,42 @@ let ConfigurationCCReport = class ConfigurationCCReport extends ConfigurationCC
     persistValues(applHost) {
         if (!super.persistValues(applHost))
             return false;
-        // Check if the initial assumption of SignedInteger holds true
-        const oldParamInformation = this.getParamInformation(applHost, this.parameter);
-        if (oldParamInformation.format != undefined &&
-            oldParamInformation.format !== safe_1.ConfigValueFormat.SignedInteger) {
+        // This parameter may be a partial param in the following cases:
+        // * a config file defines it as such
+        // * it was reported by the device as a bit field
+        const partialParams = this.getPartialParamInfos(applHost, this.parameter);
+        let cachedValueFormat;
+        if (partialParams.length > 0) {
+            // This is a partial param. All definitions should have the same format, so we just take the first one
+            cachedValueFormat = partialParams[0].metadata.format;
+        }
+        else {
+            // Check if the initial assumption of SignedInteger holds true
+            const oldParamInformation = this.getParamInformation(applHost, this.parameter);
+            cachedValueFormat = oldParamInformation.format;
+            // On older CC versions, these reports may be the only way we can retrieve the value size
+            // Therefore we store it here
+            this.extendParamInformation(applHost, this.parameter, undefined, {
+                valueSize: this.valueSize,
+            });
+            if (this.version < 3 &&
+                !this.isParamInformationFromConfig &&
+                oldParamInformation.min == undefined &&
+                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));
+            }
+        }
+        // We may have to re-interpret the value as unsigned, depending on the cached value format
+        if (cachedValueFormat != undefined &&
+            cachedValueFormat !== safe_1.ConfigValueFormat.SignedInteger) {
             // Re-interpret the value with the new 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,
-            type: oldParamInformation.format === safe_1.ConfigValueFormat.BitField
-                ? "number[]"
-                : "number",
-        });
-        if (this.version < 3 &&
-            !this.isParamInformationFromConfig &&
-            oldParamInformation.min == undefined &&
-            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.value = reInterpretSignedValue(this.value, this.valueSize, cachedValueFormat);
         }
         // 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);
         if (partialParams.length > 0) {
             for (const param of partialParams) {
                 if (typeof param.propertyKey === "number") {
@@ -1478,10 +1464,7 @@ let ConfigurationCCReport = class ConfigurationCCReport extends ConfigurationCC
             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);
+        serializeValue(this.payload, 2, this.valueSize, this.valueFormat ?? safe_1.ConfigValueFormat.SignedInteger, this.value);
         return super.serialize();
     }
     toLogEntry(applHost) {
@@ -1858,9 +1841,31 @@ let ConfigurationCCNameReport = class ConfigurationCCNameReport extends Configur
     persistValues(applHost) {
         if (!super.persistValues(applHost))
             return false;
-        this.extendParamInformation(applHost, this.parameter, undefined, {
-            label: this.name,
-        });
+        // Bitfield parameters that are not documented in a config file
+        // are split into multiple partial parameters. We need to set the name for
+        // all of them.
+        const partialParams = this.getPartialParamInfos(applHost, this.parameter);
+        if (partialParams.length === 0) {
+            this.extendParamInformation(applHost, this.parameter, undefined, {
+                label: this.name,
+            });
+        }
+        else {
+            for (const param of partialParams) {
+                const paramNumber = param.property;
+                const bitMask = param.propertyKey;
+                const bitNumber = Math.log2(bitMask) % 1 === 0
+                    ? Math.log2(bitMask)
+                    : undefined;
+                let label = `${this.name} - ${bitMask}`;
+                if (bitNumber != undefined) {
+                    label += ` (bit ${bitNumber})`;
+                }
+                this.extendParamInformation(applHost, paramNumber, bitMask, {
+                    label,
+                });
+            }
+        }
         return true;
     }
     serialize() {
@@ -1950,9 +1955,38 @@ let ConfigurationCCInfoReport = class ConfigurationCCInfoReport extends Configur
     persistValues(applHost) {
         if (!super.persistValues(applHost))
             return false;
-        this.extendParamInformation(applHost, this.parameter, undefined, {
-            description: this.info,
-        });
+        // Bitfield parameters that are not documented in a config file
+        // are split into multiple partial parameters. We need to set the description for
+        // all of them. However, these can get very long, so we put the reported
+        // description on the first partial param, and refer to it from the others
+        const partialParams = this.getPartialParamInfos(applHost, this.parameter).sort((a, b) => (a.propertyKey ?? 0) -
+            (b.propertyKey ?? 0));
+        if (partialParams.length === 0) {
+            this.extendParamInformation(applHost, this.parameter, undefined, {
+                description: this.info,
+            });
+        }
+        else {
+            let firstParamLabel;
+            for (const param of partialParams) {
+                const paramNumber = param.property;
+                const bitMask = param.propertyKey;
+                // We put the description on the first partial param
+                const description = firstParamLabel
+                    ? `Refer to ${firstParamLabel}`
+                    : this.info;
+                this.extendParamInformation(applHost, paramNumber, bitMask, {
+                    description,
+                });
+                // Then we store the name of the first param to refer to it on the
+                // following partial params
+                if (firstParamLabel == undefined) {
+                    firstParamLabel =
+                        this.getParamInformation(applHost, paramNumber, bitMask)
+                            .label ?? `parameter ${paramNumber} - ${bitMask}`;
+                }
+            }
+        }
         return true;
     }
     serialize() {
@@ -2037,7 +2071,10 @@ let ConfigurationCCPropertiesReport = class ConfigurationCCPropertiesReport exte
             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) {
+                if (this.valueFormat === safe_1.ConfigValueFormat.BitField) {
+                    this.minValue = 0;
+                }
+                else {
                     this.minValue = parseValue(this.payload.slice(3), this.valueSize, this.valueFormat);
                 }
                 this.maxValue = parseValue(this.payload.slice(3 + this.valueSize), this.valueSize, this.valueFormat);
@@ -2090,17 +2127,10 @@ let ConfigurationCCPropertiesReport = class ConfigurationCCPropertiesReport exte
             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
-                ? "number"
-                : "number[]";
-            const paramInfo = (0, safe_1.stripUndefined)({
-                type: valueType,
+            const baseInfo = {
+                type: "number",
                 format: this.valueFormat,
                 valueSize: this.valueSize,
-                min: this.minValue,
-                max: this.maxValue,
-                default: this.defaultValue,
                 requiresReInclusion: this.altersCapabilities,
                 readable: true,
                 writeable: !this.isReadonly,
@@ -2108,8 +2138,31 @@ let ConfigurationCCPropertiesReport = class ConfigurationCCPropertiesReport exte
                 isAdvanced: this.isAdvanced,
                 noBulkSupport: this.noBulkSupport,
                 isFromConfig: false,
-            });
-            this.extendParamInformation(applHost, this.parameter, undefined, paramInfo);
+            };
+            if (this.valueFormat !== safe_1.ConfigValueFormat.BitField) {
+                const paramInfo = (0, safe_1.stripUndefined)({
+                    ...baseInfo,
+                    min: this.minValue,
+                    max: this.maxValue,
+                    default: this.defaultValue,
+                });
+                this.extendParamInformation(applHost, this.parameter, undefined, paramInfo);
+            }
+            else {
+                // Bit fields are split into multiple single-bit partial parameters
+                const bits = this.maxValue;
+                let mask = 1;
+                while (mask <= bits) {
+                    const paramInfo = (0, safe_1.stripUndefined)({
+                        ...baseInfo,
+                        min: 0,
+                        max: 1,
+                        default: this.defaultValue & mask ? 1 : 0,
+                    });
+                    this.extendParamInformation(applHost, this.parameter, mask, paramInfo);
+                    mask <<= 1;
+                }
+            }
         }
         return true;
     }
@@ -2224,10 +2277,10 @@ function isSafeValue(value, size, format) {
             break;
         case safe_1.ConfigValueFormat.UnsignedInteger:
         case safe_1.ConfigValueFormat.Enumerated:
+        case safe_1.ConfigValueFormat.BitField:
             minValue = 0;
             maxValue = Math.pow(2, 8 * size);
             break;
-        case safe_1.ConfigValueFormat.BitField:
         default:
             throw new Error("not implemented");
     }
@@ -2240,9 +2293,8 @@ function parseValue(raw, size, format) {
             return raw.readIntBE(0, size);
         case safe_1.ConfigValueFormat.UnsignedInteger:
         case safe_1.ConfigValueFormat.Enumerated:
-            return raw.readUIntBE(0, size);
         case safe_1.ConfigValueFormat.BitField:
-            return new Set((0, safe_1.parseBitMask)(raw.slice(0, size)));
+            return raw.readUIntBE(0, size);
     }
 }
 function throwInvalidValueError(value, parameter, valueSize, valueFormat) {
@@ -2264,13 +2316,9 @@ function serializeValue(payload, offset, size, format, value) {
             return;
         case safe_1.ConfigValueFormat.UnsignedInteger:
         case safe_1.ConfigValueFormat.Enumerated:
+        case safe_1.ConfigValueFormat.BitField:
             payload.writeUIntBE(value, offset, size);
             return;
-        case safe_1.ConfigValueFormat.BitField: {
-            const mask = (0, safe_1.encodeBitMask)([...value.values()], size * 8);
-            mask.copy(payload, offset);
-            return;
-        }
     }
 }
 //# sourceMappingURL=ConfigurationCC.js.map