zigbee-clusters 2.7.2 → 2.8.0

package/lib/Cluster.js

@@ -403,29 +403,39 @@ class Cluster extends EventEmitter {
   /**
    * Command which reads a given set of attributes from the remote cluster.
    * Note: do not mix regular and manufacturer specific attributes.
-   * @param {string[]} attributeNames
+   * @param {Array<string | number>} attributes - Attribute names or numeric IDs
    * @param {object} [opts=] - Optional parameters
-   * @param {number} [opts.timeout] - Optional timeout in milliseconds for waiting for response
-   * @returns {Promise<Object.<string, unknown>>} - Object with values (e.g. `{ onOff: true }`)
+   * @param {number} [opts.timeout] - Optional timeout in ms
+   * @returns {Promise<Object.<string, unknown>>} - Keyed by attribute name or
+   * numeric ID
    */
-  async readAttributes(attributeNames, opts) {
-    if (attributeNames instanceof Array === false) {
-      throw new Error('Expected attribute names array, as of zigbee-clusters@2.0.0 call readAttributes([\'myAttr\'])');
+  async readAttributes(attributes, opts) {
+    if (attributes instanceof Array === false) {
+      throw new Error('Expected attributes array, as of zigbee-clusters@2.0.0 call readAttributes([\'myAttr\'])');
     }
 
-    if (!attributeNames.length) {
-      attributeNames = Object.keys(this.constructor.attributes);
-    }
-    const mismatch = attributeNames.find(n => !this.constructor.attributes[n]);
-    if (mismatch) {
-      throw new TypeError(`${mismatch} is not a valid attribute of ${this.name}`);
+    if (!attributes.length) {
+      attributes = Object.keys(this.constructor.attributes);
     }
 
     const idToName = {};
-    const attrIds = new Set(attributeNames.map(a => {
-      idToName[this.constructor.attributes[a].id] = a;
-      return this.constructor.attributes[a].id;
-    }));
+    const numericIds = new Set();
+    const attrIds = new Set();
+    for (const attr of attributes) {
+      if (typeof attr === 'number') {
+        if (!Number.isInteger(attr) || attr < 0 || attr > 0xFFFF) {
+          throw new TypeError(`${attr} is not a valid numeric attribute ID for ${this.name}, must be an integer between 0 and 0xFFFF`);
+        }
+        numericIds.add(attr);
+        if (idToName[attr] === undefined) idToName[attr] = attr;
+        attrIds.add(attr);
+      } else if (this.constructor.attributes[attr]) {
+        idToName[this.constructor.attributes[attr].id] = attr;
+        attrIds.add(this.constructor.attributes[attr].id);
+      } else {
+        throw new TypeError(`${attr} is not a valid attribute of ${this.name}`);
+      }
+    }
 
     const resultObj = {};
     while (attrIds.size) {
@@ -433,19 +443,23 @@ class Cluster extends EventEmitter {
       const manufacturerId = this._checkForManufacturerSpecificAttributes(Array.from(attrIds));
       debug(this.logId, 'read attributes', [...attrIds], manufacturerId ? `manufacturer specific id ${manufacturerId}` : '');
 
-      const { attributes } = await super.readAttributes({
+      const response = await super.readAttributes({
         attributes: [...attrIds],
         manufacturerId,
       }, opts);
 
-      debug(this.logId, 'read attributes result', { attributes });
-      const result = this.constructor.attributeArrayStatusDataType.fromBuffer(attributes, 0);
+      debug(this.logId, 'read attributes result', response);
+      const { attributeArrayStatusDataType } = this.constructor;
+      const result = attributeArrayStatusDataType.fromBuffer(response.attributes, 0);
       if (!result.length) break;
 
       result.forEach(a => {
         attrIds.delete(a.id);
         if (a.status === 'SUCCESS') {
           resultObj[idToName[a.id]] = a.value;
+          if (numericIds.has(a.id) && idToName[a.id] !== a.id) {
+            resultObj[a.id] = a.value;
+          }
         }
       });
     }
@@ -690,8 +704,13 @@ class Cluster extends EventEmitter {
     for (const attr of attributes) {
       const attribute = this.constructor.attributesById[attr.id];
       const discoveredAttribute = {
-        acl: attr.acl,
+        acl: {
+          readable: !!attr.acl.readable,
+          writable: !!attr.acl.writable,
+          reportable: !!attr.acl.reportable,
+        },
         id: attr.id,
+        dataTypeId: attr.dataTypeId,
       };
 
       // If the attribute is implemented in zigbee-clusters add name

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zigbee-clusters",
-  "version": "2.7.2",
+  "version": "2.8.0",
   "description": "Zigbee Cluster Library for Node.js",
   "main": "index.js",
   "types": "index.d.ts",