zigbee-herdsman 4.5.0 → 5.0.0

package/src/controller/model/endpoint.ts

@@ -124,9 +124,12 @@ export class Endpoint extends Entity {
 
         return this._configuredReportings.map((entry, index) => {
             const cluster = Zcl.Utils.getCluster(entry.cluster, entry.manufacturerCode, device.customClusters);
-            const attribute: ZclTypes.Attribute = cluster.hasAttribute(entry.attrId)
-                ? cluster.getAttribute(entry.attrId)
-                : {ID: entry.attrId, name: `attr${index}`, type: Zcl.DataType.UNKNOWN, manufacturerCode: undefined};
+            const attribute: ZclTypes.Attribute = cluster.getAttribute(entry.attrId) ?? {
+                ID: entry.attrId,
+                name: `attr${index}`,
+                type: Zcl.DataType.UNKNOWN,
+                manufacturerCode: undefined,
+            };
 
             return {
                 cluster,
@@ -276,19 +279,26 @@ export class Endpoint extends Entity {
 
     public saveClusterAttributeKeyValue(clusterKey: number | string, list: KeyValue): void {
         const cluster = this.getCluster(clusterKey);
-        if (!this.clusters[cluster.name]) this.clusters[cluster.name] = {attributes: {}};
 
-        for (const [attribute, value] of Object.entries(list)) {
-            this.clusters[cluster.name].attributes[attribute] = value;
+        if (!this.clusters[cluster.name]) {
+            this.clusters[cluster.name] = {attributes: {}};
+        }
+
+        for (const attribute in list) {
+            this.clusters[cluster.name].attributes[attribute] = list[attribute];
         }
     }
 
     public getClusterAttributeValue(clusterKey: number | string, attributeKey: number | string): number | string | undefined {
         const cluster = this.getCluster(clusterKey);
-        const attribute = cluster.getAttribute(attributeKey);
 
         if (this.clusters[cluster.name] && this.clusters[cluster.name].attributes) {
-            return this.clusters[cluster.name].attributes[attribute.name];
+            // XXX: used to throw (behavior changed in #1455)
+            const attribute = cluster.getAttribute(attributeKey);
+
+            if (attribute) {
+                return this.clusters[cluster.name].attributes[attribute.name];
+            }
         }
 
         return undefined;
@@ -368,8 +378,9 @@ export class Endpoint extends Entity {
         const payload: {attrId: number; dataType: number; attrData: number | string | boolean}[] = [];
 
         for (const [nameOrID, value] of Object.entries(attributes)) {
-            if (cluster.hasAttribute(nameOrID)) {
-                const attribute = cluster.getAttribute(nameOrID);
+            const attribute = cluster.getAttribute(nameOrID);
+
+            if (attribute) {
                 payload.push({attrId: attribute.ID, attrData: value, dataType: attribute.type});
             } else if (!Number.isNaN(Number(nameOrID))) {
                 payload.push({attrId: Number(nameOrID), attrData: value.value, dataType: value.type});
@@ -393,8 +404,9 @@ export class Endpoint extends Entity {
 
         const payload: {attrId: number; dataType: number; attrData: number | string | boolean}[] = [];
         for (const [nameOrID, value] of Object.entries(attributes)) {
-            if (cluster.hasAttribute(nameOrID)) {
-                const attribute = cluster.getAttribute(nameOrID);
+            const attribute = cluster.getAttribute(nameOrID);
+
+            if (attribute) {
                 payload.push({attrId: attribute.ID, attrData: value, dataType: attribute.type});
             } else if (!Number.isNaN(Number(nameOrID))) {
                 payload.push({attrId: Number(nameOrID), attrData: value.value, dataType: value.type});
@@ -418,8 +430,9 @@ export class Endpoint extends Entity {
 
         for (const [nameOrID, value] of Object.entries(attributes)) {
             if (value.status !== undefined) {
-                if (cluster.hasAttribute(nameOrID)) {
-                    const attribute = cluster.getAttribute(nameOrID);
+                const attribute = cluster.getAttribute(nameOrID);
+
+                if (attribute) {
                     payload.push({attrId: attribute.ID, status: value.status});
                 } else if (!Number.isNaN(Number(nameOrID))) {
                     payload.push({attrId: Number(nameOrID), status: value.status});
@@ -450,10 +463,20 @@ export class Endpoint extends Entity {
             optionsWithDefaults.manufacturerCode,
             "read",
         );
-
         const payload: {attrId: number}[] = [];
+
         for (const attribute of attributes) {
-            payload.push({attrId: typeof attribute === "number" ? attribute : cluster.getAttribute(attribute).ID});
+            if (typeof attribute === "number") {
+                payload.push({attrId: attribute});
+            } else {
+                const attr = cluster.getAttribute(attribute);
+
+                if (attr) {
+                    payload.push({attrId: attr.ID});
+                } else {
+                    logger.warning(`Ignoring unknown attribute ${attribute} in cluster ${cluster.name}`, NS);
+                }
+            }
         }
 
         const resultFrame = await this.zclCommand(clusterKey, "read", payload, optionsWithDefaults, attributes, true);
@@ -476,8 +499,9 @@ export class Endpoint extends Entity {
         const cluster = this.getCluster(clusterKey);
         const payload: {attrId: number; status: number; dataType: number; attrData: number | string}[] = [];
         for (const [nameOrID, value] of Object.entries(attributes)) {
-            if (cluster.hasAttribute(nameOrID)) {
-                const attribute = cluster.getAttribute(nameOrID);
+            const attribute = cluster.getAttribute(nameOrID);
+
+            if (attribute) {
                 payload.push({attrId: attribute.ID, attrData: value, dataType: attribute.type, status: 0});
             } else if (!Number.isNaN(Number(nameOrID))) {
                 payload.push({attrId: Number(nameOrID), attrData: value.value, dataType: value.type, status: 0});
@@ -688,10 +712,13 @@ export class Endpoint extends Entity {
             if (typeof item.attribute === "object") {
                 dataType = item.attribute.type;
                 attrId = item.attribute.ID;
-            } else if (cluster.hasAttribute(item.attribute)) {
+            } else {
                 const attribute = cluster.getAttribute(item.attribute);
-                dataType = attribute.type;
-                attrId = attribute.ID;
+
+                if (attribute) {
+                    dataType = attribute.type;
+                    attrId = attribute.ID;
+                }
             }
 
             return {
@@ -890,8 +917,9 @@ export class Endpoint extends Entity {
                 }
 
                 // we fall back to caller|cluster provided manufacturerCode
-                if (cluster.hasAttribute(attributeID)) {
-                    const attribute = cluster.getAttribute(attributeID);
+                const attribute = cluster.getAttribute(attributeID);
+
+                if (attribute) {
                     return attribute.manufacturerCode === undefined ? fallbackManufacturerCode : attribute.manufacturerCode;
                 }
 

package/src/controller/model/group.ts

@@ -261,8 +261,9 @@ export class Group extends Entity {
         const payload: {attrId: number; dataType: number; attrData: number | string | boolean}[] = [];
 
         for (const [nameOrID, value] of Object.entries(attributes)) {
-            if (cluster.hasAttribute(nameOrID)) {
-                const attribute = cluster.getAttribute(nameOrID);
+            const attribute = cluster.getAttribute(nameOrID);
+
+            if (attribute) {
                 payload.push({attrId: attribute.ID, attrData: value, dataType: attribute.type});
             } else if (!Number.isNaN(Number(nameOrID))) {
                 payload.push({attrId: Number(nameOrID), attrData: value.value, dataType: value.type});
@@ -308,7 +309,17 @@ export class Group extends Entity {
         const payload: {attrId: number}[] = [];
 
         for (const attribute of attributes) {
-            payload.push({attrId: typeof attribute === "number" ? attribute : cluster.getAttribute(attribute).ID});
+            if (typeof attribute === "number") {
+                payload.push({attrId: attribute});
+            } else {
+                const attr = cluster.getAttribute(attribute);
+
+                if (attr) {
+                    payload.push({attrId: attr.ID});
+                } else {
+                    logger.warning(`Ignoring unknown attribute ${attribute} in cluster ${cluster.name}`, NS);
+                }
+            }
         }
 
         const frame = Zcl.Frame.create(

package/src/zspec/zcl/buffaloZcl.ts

@@ -548,13 +548,15 @@ export class BuffaloZcl extends Buffalo {
             while (this.position - start < options.payload.payloadSize) {
                 const attributeID = this.readUInt16();
                 const type = this.readUInt8();
+                /* v8 ignore next */
+                let attribute: string | undefined | number = cluster.getAttribute(attributeID)?.name;
 
-                let attribute: number | string = attributeID;
-                try {
-                    attribute = cluster.getAttribute(attributeID).name;
-                } catch {
+                // number type is only used when going into this if
+                if (!attribute) {
                     // this is spammy because of the many manufacturer-specific attributes not currently used
                     logger.debug(`Unknown attribute ${attributeID} in cluster ${cluster.name}`, NS);
+
+                    attribute = attributeID;
                 }
 
                 frame.attributes[attribute] = this.read(type, options);

package/src/zspec/zcl/definition/tstype.ts

@@ -86,8 +86,7 @@ export interface Cluster {
     commandsResponse: {
         [s: string]: Command;
     };
-    getAttribute: (key: number | string) => Attribute;
-    hasAttribute: (key: number | string) => boolean;
+    getAttribute: (key: number | string) => Attribute | undefined;
     getCommand: (key: number | string) => Command;
     getCommandResponse: (key: number | string) => Command;
 }

package/src/zspec/zcl/utils.ts

@@ -187,7 +187,7 @@ function createCluster(name: string, cluster: ClusterDefinition, manufacturerCod
     const commands: Record<string, Command> = cloneClusterEntriesWithName(cluster.commands);
     const commandsResponse: Record<string, Command> = cloneClusterEntriesWithName(cluster.commandsResponse);
 
-    const getAttributeInternal = (key: number | string): Attribute | undefined => {
+    const getAttribute = (key: number | string): Attribute | undefined => {
         if (typeof key === "number") {
             let partialMatchAttr: Attribute | undefined;
 
@@ -208,29 +208,7 @@ function createCluster(name: string, cluster: ClusterDefinition, manufacturerCod
             return partialMatchAttr;
         }
 
-        for (const attrKey in attributes) {
-            const attr = attributes[attrKey];
-
-            if (attr.name === key) {
-                return attr;
-            }
-        }
-
-        return undefined;
-    };
-
-    const getAttribute = (key: number | string): Attribute => {
-        const result = getAttributeInternal(key);
-        if (!result) {
-            throw new Error(`Cluster '${name}' has no attribute '${key}'`);
-        }
-
-        return result;
-    };
-
-    const hasAttribute = (key: number | string): boolean => {
-        const result = getAttributeInternal(key);
-        return !!result;
+        return attributes[key];
     };
 
     const getCommand = (key: number | string): Command => {
@@ -243,12 +221,10 @@ function createCluster(name: string, cluster: ClusterDefinition, manufacturerCod
                 }
             }
         } else {
-            for (const cmdKey in commands) {
-                const cmd = commands[cmdKey];
+            const cmd = commands[key];
 
-                if (cmd.name === key) {
-                    return cmd;
-                }
+            if (cmd) {
+                return cmd;
             }
         }
 
@@ -265,12 +241,10 @@ function createCluster(name: string, cluster: ClusterDefinition, manufacturerCod
                 }
             }
         } else {
-            for (const cmdKey in commandsResponse) {
-                const cmd = commandsResponse[cmdKey];
+            const cmd = commandsResponse[key];
 
-                if (cmd.name === key) {
-                    return cmd;
-                }
+            if (cmd) {
+                return cmd;
             }
         }
 
@@ -285,7 +259,6 @@ function createCluster(name: string, cluster: ClusterDefinition, manufacturerCod
         commands,
         commandsResponse,
         getAttribute,
-        hasAttribute,
         getCommand,
         getCommandResponse,
     };