fix: Fix configure failing when configuring too many attributes at once #8129

Author: Koenkk

src/lib/modernExtend.ts

@@ -48,6 +48,7 @@ import {
     noOccupancySince,
     postfixWithEndpointName,
     precisionRound,
+    splitArrayIntoChunks,
 } from './utils';
 
 function getEndpointsWithCluster(device: Zh.Device, cluster: string | number, type: 'input' | 'output') {
@@ -107,28 +108,37 @@ export async function setupAttributes(
             `Configure reporting: ${configureReporting}, read: ${read} for ${ieeeAddr}/${endpoint.ID} ${cluster} ${JSON.stringify(config)}`,
             'zhc:setupattribute',
         );
+
+        // Split into chunks of 4 to prevent to message becoming too big.
+        const chunks = splitArrayIntoChunks(config, 4);
+
         if (configureReporting) {
             await endpoint.bind(cluster, coordinatorEndpoint);
-            await endpoint.configureReporting(
-                cluster,
-                config.map((a) => ({
-                    minimumReportInterval: convertReportingConfigTime(a.min),
-                    maximumReportInterval: convertReportingConfigTime(a.max),
-                    reportableChange: a.change,
-                    attribute: a.attribute,
-                })),
-            );
-        }
-        if (read) {
-            try {
-                // Don't fail configuration if reading this attribute fails
-                // https://github.com/Koenkk/zigbee-herdsman-converters/pull/7074
-                await endpoint.read(
+            for (const chunk of chunks) {
+                await endpoint.configureReporting(
                     cluster,
-                    config.map((a) => (isString(a) ? a : isObject(a.attribute) ? a.attribute.ID : a.attribute)),
+                    chunk.map((a) => ({
+                        minimumReportInterval: convertReportingConfigTime(a.min),
+                        maximumReportInterval: convertReportingConfigTime(a.max),
+                        reportableChange: a.change,
+                        attribute: a.attribute,
+                    })),
                 );
-            } catch (e) {
-                logger.debug(`Reading attribute failed: ${e}`, 'zhc:setupattribute');
+            }
+        }
+
+        if (read) {
+            for (const chunk of chunks) {
+                try {
+                    // Don't fail configuration if reading this attribute fails
+                    // https://github.com/Koenkk/zigbee-herdsman-converters/pull/7074
+                    await endpoint.read(
+                        cluster,
+                        chunk.map((a) => (isString(a) ? a : isObject(a.attribute) ? a.attribute.ID : a.attribute)),
+                    );
+                } catch (e) {
+                    logger.debug(`Reading attribute failed: ${e}`, 'zhc:setupattribute');
+                }
             }
         }
     }

src/lib/utils.ts

@@ -726,6 +726,17 @@ export function isLightExpose(expose: Expose): expose is Light {
     return expose?.type === 'light';
 }
 
+export function splitArrayIntoChunks<T>(arr: T[], chunkSize: number): T[][] {
+    const result = [];
+
+    for (let i = 0; i < arr.length; i += chunkSize) {
+        const chunk = arr.slice(i, i + chunkSize);
+        result.push(chunk);
+    }
+
+    return result;
+}
+
 exports.noOccupancySince = noOccupancySince;
 exports.getOptions = getOptions;
 exports.isLegacyEnabled = isLegacyEnabled;

test/modernExtend.test.ts

@@ -1,6 +1,7 @@
 import fz from '../src/converters/fromZigbee';
 import {repInterval} from '../src/lib/constants';
 import {fromZigbee as lumiFz} from '../src/lib/lumi';
+import {setupAttributes} from '../src/lib/modernExtend';
 import {philipsFz} from '../src/lib/philips';
 import {assertDefintion, mockDevice, reportingItem} from './utils';
 
@@ -429,4 +430,41 @@ describe('ModernExtend', () => {
             },
         });
     });
+
+    test('Setup attributes', async () => {
+        const device = mockDevice({modelID: '', endpoints: [{inputClusters: ['haElectricalMeasurement']}]});
+        const deviceEp = device.endpoints[0];
+        const coordinator = mockDevice({modelID: '', endpoints: [{}]});
+        const coordinatorEp = coordinator.endpoints[0];
+        const config = {min: 0, max: 10, change: 1};
+        const expectedConfig = {maximumReportInterval: 10, minimumReportInterval: 0, reportableChange: 1};
+
+        await setupAttributes(deviceEp, coordinator.endpoints[0], 'haElectricalMeasurement', [
+            {attribute: '1', ...config},
+            {attribute: '2', ...config},
+            {attribute: '3', ...config},
+            {attribute: '4', ...config},
+            {attribute: '5', ...config},
+            {attribute: '6', ...config},
+        ]);
+
+        expect(deviceEp.bind).toHaveBeenCalledTimes(1);
+        expect(deviceEp.bind).toHaveBeenCalledWith('haElectricalMeasurement', coordinatorEp);
+
+        expect(deviceEp.configureReporting).toHaveBeenCalledTimes(2);
+        expect(deviceEp.configureReporting).toHaveBeenNthCalledWith(1, 'haElectricalMeasurement', [
+            {attribute: '1', ...expectedConfig},
+            {attribute: '2', ...expectedConfig},
+            {attribute: '3', ...expectedConfig},
+            {attribute: '4', ...expectedConfig},
+        ]);
+        expect(deviceEp.configureReporting).toHaveBeenNthCalledWith(2, 'haElectricalMeasurement', [
+            {attribute: '5', ...expectedConfig},
+            {attribute: '6', ...expectedConfig},
+        ]);
+
+        expect(deviceEp.read).toHaveBeenCalledTimes(2);
+        expect(deviceEp.read).toHaveBeenNthCalledWith(1, 'haElectricalMeasurement', ['1', '2', '3', '4']);
+        expect(deviceEp.read).toHaveBeenNthCalledWith(2, 'haElectricalMeasurement', ['5', '6']);
+    });
 });