zigbee-herdsman 7.0.6 → 8.0.0

package/dist/zspec/zcl/buffaloZcl.js

@@ -37,9 +37,12 @@ exports.BuffaloZcl = void 0;
 const buffalo_1 = require("../../buffalo");
 const logger_1 = require("../../utils/logger");
 const utils_1 = require("../../utils/utils");
+const datatypes_1 = require("./definition/datatypes");
 const enums_1 = require("./definition/enums");
 const Utils = __importStar(require("./utils"));
 const NS = "zh:zcl:buffalo";
+const UINT8_NON_VALUE = datatypes_1.ZCL_TYPE_INVALID_BY_TYPE[datatypes_1.ZclType.Uint8];
+const UINT16_NON_VALUE = datatypes_1.ZCL_TYPE_INVALID_BY_TYPE[datatypes_1.ZclType.Uint16];
 const SEC_KEY_LENGTH = 16;
 const EXTENSION_FIELD_SETS_DATA_TYPE = {
     6: [enums_1.DataType.UINT8],
@@ -47,145 +50,29 @@ const EXTENSION_FIELD_SETS_DATA_TYPE = {
     258: [enums_1.DataType.UINT8, enums_1.DataType.UINT8],
     768: [enums_1.DataType.UINT16, enums_1.DataType.UINT16, enums_1.DataType.UINT16, enums_1.DataType.UINT8, enums_1.DataType.UINT8, enums_1.DataType.UINT8, enums_1.DataType.UINT16, enums_1.DataType.UINT16],
 };
-// UINT8_TMP_FIX: temporary return 0xff instead of Number.NaN
-// Will be replaced by https://github.com/Koenkk/zigbee-herdsman/pull/1503
-// https://github.com/Koenkk/zigbee-herdsman/issues/1498
-// https://github.com/Koenkk/zigbee-herdsman/pull/1510
 class BuffaloZcl extends buffalo_1.Buffalo {
-    writeZclUInt8(value) {
-        this.writeUInt8(value);
-        // See UINT8_TMP_FIX
-        // this.writeUInt8(Number.isNaN(value) ? 0xff : value);
-    }
-    readZclUInt8() {
+    readLengthUInt8() {
         const value = this.readUInt8();
-        return value;
-        // See UINT8_TMP_FIX
-        // return value === 0xff ? Number.NaN : value;
-    }
-    writeZclUInt16(value) {
-        this.writeUInt16(Number.isNaN(value) ? 0xffff : value);
+        return value === UINT8_NON_VALUE ? Number.NaN : value;
     }
-    readZclUInt16() {
+    readLengthUInt16() {
         const value = this.readUInt16();
-        return value === 0xffff ? Number.NaN : value;
-    }
-    writeZclUInt24(value) {
-        this.writeUInt24(Number.isNaN(value) ? 0xffffff : value);
-    }
-    readZclUInt24() {
-        const value = this.readUInt24();
-        return value === 0xffffff ? Number.NaN : value;
-    }
-    writeZclUInt32(value) {
-        this.writeUInt32(Number.isNaN(value) ? 0xffffffff : value);
-    }
-    readZclUInt32() {
-        const value = this.readUInt32();
-        return value === 0xffffffff ? Number.NaN : value;
-    }
-    writeZclUInt40(value) {
-        this.writeUInt40(Number.isNaN(value) ? 0xffffffffff : value);
-    }
-    readZclUInt40() {
-        const value = this.readUInt40();
-        return value === 0xffffffffff ? Number.NaN : value;
-    }
-    writeZclUInt48(value) {
-        this.writeUInt48(Number.isNaN(value) ? 0xffffffffffff : value);
-    }
-    readZclUInt48() {
-        const value = this.readUInt48();
-        return value === 0xffffffffffff ? Number.NaN : value;
-    }
-    writeZclUInt56(value) {
-        this.writeUInt56(value === undefined ? 0xffffffffffffffn : value);
-    }
-    readZclUInt56() {
-        const value = this.readUInt56();
-        return value === 0xffffffffffffffn ? undefined : value;
-    }
-    writeZclUInt64(value) {
-        this.writeUInt64(value === undefined ? 0xffffffffffffffffn : value);
-    }
-    readZclUInt64() {
-        const value = this.readUInt64();
-        return value === 0xffffffffffffffffn ? undefined : value;
-    }
-    writeZclInt8(value) {
-        this.writeInt8(Number.isNaN(value) ? -0x80 : value);
-    }
-    readZclInt8() {
-        const value = this.readInt8();
-        return value === -0x80 ? Number.NaN : value;
-    }
-    writeZclInt16(value) {
-        this.writeInt16(Number.isNaN(value) ? -0x8000 : value);
-    }
-    readZclInt16() {
-        const value = this.readInt16();
-        return value === -0x8000 ? Number.NaN : value;
-    }
-    writeZclInt24(value) {
-        this.writeInt24(Number.isNaN(value) ? -0x800000 : value);
-    }
-    readZclInt24() {
-        const value = this.readInt24();
-        return value === -0x800000 ? Number.NaN : value;
-    }
-    writeZclInt32(value) {
-        this.writeInt32(Number.isNaN(value) ? -0x80000000 : value);
-    }
-    readZclInt32() {
-        const value = this.readInt32();
-        return value === -0x80000000 ? Number.NaN : value;
-    }
-    writeZclInt40(value) {
-        this.writeInt40(Number.isNaN(value) ? -0x8000000000 : value);
-    }
-    readZclInt40() {
-        const value = this.readInt40();
-        return value === -0x8000000000 ? Number.NaN : value;
-    }
-    writeZclInt48(value) {
-        this.writeInt48(Number.isNaN(value) ? -0x800000000000 : value);
-    }
-    readZclInt48() {
-        const value = this.readInt48();
-        return value === -0x800000000000 ? Number.NaN : value;
-    }
-    writeZclInt56(value) {
-        this.writeInt56(value === undefined ? -0x80000000000000n : value);
-    }
-    readZclInt56() {
-        const value = this.readInt56();
-        return value === -0x80000000000000n ? undefined : value;
-    }
-    writeZclInt64(value) {
-        this.writeInt64(value === undefined ? -0x8000000000000000n : value);
-    }
-    readZclInt64() {
-        const value = this.readInt64();
-        return value === -0x8000000000000000n ? undefined : value;
+        return value === UINT16_NON_VALUE ? Number.NaN : value;
     }
     writeOctetStr(value) {
         if (value) {
             this.writeUInt8(value.length);
             this.writeBuffer(value, value.length);
-            /* v8 ignore start */
         }
         else {
-            // ignore because of UINT8_TMP_FIX
-            this.writeUInt8(0xff); // non-value
+            this.writeUInt8(UINT8_NON_VALUE);
         }
-        /* v8 ignore stop */
     }
     readOctetStr() {
-        const length = this.readZclUInt8();
-        // See UINT8_TMP_FIX
-        return length < 0xff ? this.readBuffer(length) : Buffer.from([]); // non-value
-        // return Number.isNaN(length) ? Buffer.from([]) : this.readBuffer(length);
+        const length = this.readLengthUInt8();
+        return Number.isNaN(length) ? Buffer.from([]) : this.readBuffer(length);
     }
+    // TODO: support read/write with specific `length` from attribute metadata (CHAR_STR & LONG_CHAR_STR)
     writeCharStr(value) {
         // In case of an empty string, send 0 length, from the spec:
         // "Setting this sub-field to 0x00 represents a character string with no character data (an “empty string”). Setting
@@ -201,14 +88,12 @@ class BuffaloZcl extends buffalo_1.Buffalo {
             }
         }
         else {
-            this.writeUInt8(0xff); // non-value
+            this.writeUInt8(UINT8_NON_VALUE);
         }
     }
     readCharStr() {
-        const length = this.readZclUInt8();
-        // See UINT8_TMP_FIX
-        return length < 0xff ? this.readUtf8String(length) : ""; // non-value
-        // return Number.isNaN(length) ? "" : this.readUtf8String(length);
+        const length = this.readLengthUInt8();
+        return Number.isNaN(length) ? "" : this.readUtf8String(length);
     }
     writeLongOctetStr(value) {
         if (value) {
@@ -216,11 +101,11 @@ class BuffaloZcl extends buffalo_1.Buffalo {
             this.writeBuffer(value, value.length);
         }
         else {
-            this.writeUInt16(0xffff); // non-value
+            this.writeUInt16(UINT16_NON_VALUE);
         }
     }
     readLongOctetStr() {
-        const length = this.readZclUInt16();
+        const length = this.readLengthUInt16();
         return Number.isNaN(length) ? Buffer.from([]) : this.readBuffer(length);
     }
     writeLongCharStr(value) {
@@ -233,11 +118,11 @@ class BuffaloZcl extends buffalo_1.Buffalo {
             this.writeUtf8String(value);
         }
         else {
-            this.writeUInt16(0xffff); // non-value
+            this.writeUInt16(UINT16_NON_VALUE);
         }
     }
     readLongCharStr() {
-        const length = this.readZclUInt16();
+        const length = this.readLengthUInt16();
         return Number.isNaN(length) ? "" : this.readUtf8String(length);
     }
     writeArray(value) {
@@ -251,13 +136,14 @@ class BuffaloZcl extends buffalo_1.Buffalo {
         }
         else {
             this.writeUInt8(enums_1.DataType.NO_DATA); // XXX: correct value?
-            this.writeUInt16(0xffff); // non-value
+            this.writeUInt16(UINT16_NON_VALUE);
         }
     }
+    // TODO: support read [] with specific length (`arrayLengthSize` & `arrayLengthField`) from parameter metadata
     readArray() {
         const values = [];
         const elementType = this.readUInt8();
-        const numberOfElements = this.readZclUInt16();
+        const numberOfElements = this.readLengthUInt16();
         if (!Number.isNaN(numberOfElements)) {
             // not non-value
             for (let i = 0; i < numberOfElements; i++) {
@@ -276,12 +162,12 @@ class BuffaloZcl extends buffalo_1.Buffalo {
             }
         }
         else {
-            this.writeUInt16(0xffff); // non-value
+            this.writeUInt16(UINT16_NON_VALUE);
         }
     }
     readStruct() {
         const values = [];
-        const numberOfElements = this.readZclUInt16();
+        const numberOfElements = this.readLengthUInt16();
         if (!Number.isNaN(numberOfElements)) {
             // not non-value
             for (let i = 0; i < numberOfElements; i++) {
@@ -293,16 +179,16 @@ class BuffaloZcl extends buffalo_1.Buffalo {
         return values;
     }
     writeToD(value) {
-        this.writeUInt8(value.hours == null || Number.isNaN(value.hours) ? 0xff : value.hours);
-        this.writeUInt8(value.minutes == null || Number.isNaN(value.minutes) ? 0xff : value.minutes);
-        this.writeUInt8(value.seconds == null || Number.isNaN(value.seconds) ? 0xff : value.seconds);
-        this.writeUInt8(value.hundredths == null || Number.isNaN(value.hundredths) ? 0xff : value.hundredths);
+        this.writeUInt8(value.hours == null || Number.isNaN(value.hours) ? UINT8_NON_VALUE : value.hours);
+        this.writeUInt8(value.minutes == null || Number.isNaN(value.minutes) ? UINT8_NON_VALUE : value.minutes);
+        this.writeUInt8(value.seconds == null || Number.isNaN(value.seconds) ? UINT8_NON_VALUE : value.seconds);
+        this.writeUInt8(value.hundredths == null || Number.isNaN(value.hundredths) ? UINT8_NON_VALUE : value.hundredths);
     }
     readToD() {
-        const hours = this.readZclUInt8();
-        const minutes = this.readZclUInt8();
-        const seconds = this.readZclUInt8();
-        const hundredths = this.readZclUInt8();
+        const hours = this.readLengthUInt8();
+        const minutes = this.readLengthUInt8();
+        const seconds = this.readLengthUInt8();
+        const hundredths = this.readLengthUInt8();
         return {
             hours,
             minutes,
@@ -311,16 +197,16 @@ class BuffaloZcl extends buffalo_1.Buffalo {
         };
     }
     writeDate(value) {
-        this.writeUInt8(value.year == null || Number.isNaN(value.year) ? 0xff : value.year - 1900);
-        this.writeUInt8(value.month == null || Number.isNaN(value.month) ? 0xff : value.month);
-        this.writeUInt8(value.dayOfMonth == null || Number.isNaN(value.dayOfMonth) ? 0xff : value.dayOfMonth);
-        this.writeUInt8(value.dayOfWeek == null || Number.isNaN(value.dayOfWeek) ? 0xff : value.dayOfWeek);
+        this.writeUInt8(value.year == null || Number.isNaN(value.year) ? UINT8_NON_VALUE : value.year - 1900);
+        this.writeUInt8(value.month == null || Number.isNaN(value.month) ? UINT8_NON_VALUE : value.month);
+        this.writeUInt8(value.dayOfMonth == null || Number.isNaN(value.dayOfMonth) ? UINT8_NON_VALUE : value.dayOfMonth);
+        this.writeUInt8(value.dayOfWeek == null || Number.isNaN(value.dayOfWeek) ? UINT8_NON_VALUE : value.dayOfWeek);
     }
     readDate() {
-        const year = this.readZclUInt8();
-        const month = this.readZclUInt8();
-        const dayOfMonth = this.readZclUInt8();
-        const dayOfWeek = this.readZclUInt8();
+        const year = this.readLengthUInt8();
+        const month = this.readLengthUInt8();
+        const dayOfMonth = this.readLengthUInt8();
+        const dayOfWeek = this.readLengthUInt8();
         return {
             year: year + 1900, // remains NaN if year is NaN
             month,
@@ -377,10 +263,10 @@ class BuffaloZcl extends buffalo_1.Buffalo {
         for (const entry of value) {
             this.writeUInt16(entry.transitionTime);
             if (entry.heatSetpoint != null) {
-                this.writeUInt16(entry.heatSetpoint);
+                this.writeInt16(entry.heatSetpoint);
             }
             if (entry.coolSetpoint != null) {
-                this.writeUInt16(entry.coolSetpoint);
+                this.writeInt16(entry.coolSetpoint);
             }
         }
     }
@@ -396,10 +282,10 @@ class BuffaloZcl extends buffalo_1.Buffalo {
                 transitionTime: this.readUInt16(),
             };
             if (heat) {
-                entry.heatSetpoint = this.readUInt16();
+                entry.heatSetpoint = this.readInt16();
             }
             if (cool) {
-                entry.coolSetpoint = this.readUInt16();
+                entry.coolSetpoint = this.readInt16();
             }
             result.push(entry);
         }
@@ -647,7 +533,7 @@ class BuffaloZcl extends buffalo_1.Buffalo {
     readMiStruct() {
         const length = this.readUInt8();
         const value = {};
-        if (length === 0xff) {
+        if (length === UINT8_NON_VALUE) {
             return value;
         }
         for (let i = 0; i < length; i++) {
@@ -677,7 +563,7 @@ class BuffaloZcl extends buffalo_1.Buffalo {
             case enums_1.DataType.BITMAP8:
             case enums_1.DataType.UINT8:
             case enums_1.DataType.ENUM8: {
-                this.writeZclUInt8(value);
+                this.writeUInt8(value);
                 break;
             }
             case enums_1.DataType.DATA16:
@@ -686,13 +572,13 @@ class BuffaloZcl extends buffalo_1.Buffalo {
             case enums_1.DataType.ENUM16:
             case enums_1.DataType.CLUSTER_ID:
             case enums_1.DataType.ATTR_ID: {
-                this.writeZclUInt16(value);
+                this.writeUInt16(value);
                 break;
             }
             case enums_1.DataType.DATA24:
             case enums_1.DataType.BITMAP24:
             case enums_1.DataType.UINT24: {
-                this.writeZclUInt24(value);
+                this.writeUInt24(value);
                 break;
             }
             case enums_1.DataType.DATA32:
@@ -700,63 +586,63 @@ class BuffaloZcl extends buffalo_1.Buffalo {
             case enums_1.DataType.UINT32:
             case enums_1.DataType.UTC:
             case enums_1.DataType.BAC_OID: {
-                this.writeZclUInt32(value);
+                this.writeUInt32(value);
                 break;
             }
             case enums_1.DataType.DATA40:
             case enums_1.DataType.BITMAP40:
             case enums_1.DataType.UINT40: {
-                this.writeZclUInt40(value);
+                this.writeUInt40(value);
                 break;
             }
             case enums_1.DataType.DATA48:
             case enums_1.DataType.BITMAP48:
             case enums_1.DataType.UINT48: {
-                this.writeZclUInt48(value);
+                this.writeUInt48(value);
                 break;
             }
             case enums_1.DataType.DATA56:
             case enums_1.DataType.BITMAP56:
             case enums_1.DataType.UINT56: {
-                this.writeZclUInt56(value);
+                this.writeUInt56(value);
                 break;
             }
             case enums_1.DataType.DATA64:
             case enums_1.DataType.BITMAP64:
             case enums_1.DataType.UINT64: {
-                this.writeZclUInt64(value);
+                this.writeUInt64(value);
                 break;
             }
             case enums_1.DataType.INT8: {
-                this.writeZclInt8(value);
+                this.writeInt8(value);
                 break;
             }
             case enums_1.DataType.INT16: {
-                this.writeZclInt16(value);
+                this.writeInt16(value);
                 break;
             }
             case enums_1.DataType.INT24: {
-                this.writeZclInt24(value);
+                this.writeInt24(value);
                 break;
             }
             case enums_1.DataType.INT32: {
-                this.writeZclInt32(value);
+                this.writeInt32(value);
                 break;
             }
             case enums_1.DataType.INT40: {
-                this.writeZclInt40(value);
+                this.writeInt40(value);
                 break;
             }
             case enums_1.DataType.INT48: {
-                this.writeZclInt48(value);
+                this.writeInt48(value);
                 break;
             }
             case enums_1.DataType.INT56: {
-                this.writeZclInt56(value);
+                this.writeInt56(value);
                 break;
             }
             case enums_1.DataType.INT64: {
-                this.writeZclInt64(value);
+                this.writeInt64(value);
                 break;
             }
             // case DataType.SEMI_PREC: {
@@ -902,7 +788,7 @@ class BuffaloZcl extends buffalo_1.Buffalo {
             case enums_1.DataType.BITMAP8:
             case enums_1.DataType.UINT8:
             case enums_1.DataType.ENUM8: {
-                return this.readZclUInt8();
+                return this.readUInt8();
             }
             case enums_1.DataType.DATA16:
             case enums_1.DataType.BITMAP16:
@@ -910,63 +796,63 @@ class BuffaloZcl extends buffalo_1.Buffalo {
             case enums_1.DataType.ENUM16:
             case enums_1.DataType.CLUSTER_ID:
             case enums_1.DataType.ATTR_ID: {
-                return this.readZclUInt16();
+                return this.readUInt16();
             }
             case enums_1.DataType.DATA24:
             case enums_1.DataType.BITMAP24:
             case enums_1.DataType.UINT24: {
-                return this.readZclUInt24();
+                return this.readUInt24();
             }
             case enums_1.DataType.DATA32:
             case enums_1.DataType.BITMAP32:
             case enums_1.DataType.UINT32:
             case enums_1.DataType.UTC:
             case enums_1.DataType.BAC_OID: {
-                return this.readZclUInt32();
+                return this.readUInt32();
             }
             case enums_1.DataType.DATA40:
             case enums_1.DataType.BITMAP40:
             case enums_1.DataType.UINT40: {
-                return this.readZclUInt40();
+                return this.readUInt40();
             }
             case enums_1.DataType.DATA48:
             case enums_1.DataType.BITMAP48:
             case enums_1.DataType.UINT48: {
-                return this.readZclUInt48();
+                return this.readUInt48();
             }
             case enums_1.DataType.DATA56:
             case enums_1.DataType.BITMAP56:
             case enums_1.DataType.UINT56: {
-                return this.readZclUInt56();
+                return this.readUInt56();
             }
             case enums_1.DataType.DATA64:
             case enums_1.DataType.BITMAP64:
             case enums_1.DataType.UINT64: {
-                return this.readZclUInt64();
+                return this.readUInt64();
             }
             case enums_1.DataType.INT8: {
-                return this.readZclInt8();
+                return this.readInt8();
             }
             case enums_1.DataType.INT16: {
-                return this.readZclInt16();
+                return this.readInt16();
             }
             case enums_1.DataType.INT24: {
-                return this.readZclInt24();
+                return this.readInt24();
             }
             case enums_1.DataType.INT32: {
-                return this.readZclInt32();
+                return this.readInt32();
             }
             case enums_1.DataType.INT40: {
-                return this.readZclInt40();
+                return this.readInt40();
             }
             case enums_1.DataType.INT48: {
-                return this.readZclInt48();
+                return this.readInt48();
             }
             case enums_1.DataType.INT56: {
-                return this.readZclInt56();
+                return this.readInt56();
             }
             case enums_1.DataType.INT64: {
-                return this.readZclInt64();
+                return this.readInt64();
             }
             // case DataType.SEMI_PREC: {
             //     // https://tc39.es/proposal-float16array/