Implement read for groups. Koenkk/zigbee2mqtt#4564

Koenkk · Oct 6, 2020 · ffc5ed3 · ffc5ed3
1 parent e8a7ca5
commit ffc5ed3
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 0 deletions.
diff --git a/src/controller/model/group.ts b/src/controller/model/group.ts
@@ -175,6 +175,34 @@ class Group extends Entity {
         }
     }
 
+    public async read(
+        clusterKey: number | string, attributes: string[] | number [], options?: Options
+    ): Promise<void> {
+        options = this.getOptionsWithDefaults(options, Zcl.Direction.CLIENT_TO_SERVER);
+        const cluster = Zcl.Utils.getCluster(clusterKey);
+        const payload: {attrId: number}[] = [];
+        for (const attribute of attributes) {
+            payload.push({attrId: typeof attribute === 'number' ? attribute : cluster.getAttribute(attribute).ID});
+        }
+
+        const frame = Zcl.ZclFrame.create(
+            Zcl.FrameType.GLOBAL, options.direction, true,
+            options.manufacturerCode, options.transactionSequenceNumber ?? ZclTransactionSequenceNumber.next(), 'read',
+            cluster.ID, payload, options.reservedBits
+        );
+
+        const log = `Read ${this.groupID} ${cluster.name}(${JSON.stringify(attributes)}, ${JSON.stringify(options)})`;
+        debug.info(log);
+
+        try {
+            await Entity.adapter.sendZclFrameToGroup(this.groupID, frame, options.srcEndpoint);
+        } catch (error) {
+            error.message = `${log} failed (${error.message})`;
+            debug.error(error.message);
+            throw error;
+        }
+    }
+
     public async command(
         clusterKey: number | string, commandKey: number | string, payload: KeyValue, options?: Options
     ): Promise<void> {

diff --git a/test/controller.test.ts b/test/controller.test.ts
@@ -2333,6 +2333,27 @@ describe('Controller', () => {
         expect(deepClone(controller.getDeviceByIeeeAddr("0x90fd9ffffe4b64ae"))).toStrictEqual(expected);
     });
 
+    it('Read from group', async () => {
+        await controller.start();
+        const group = await controller.createGroup(2);
+        await group.read('genBasic', ['modelId', 0x01], {});
+        expect(mocksendZclFrameToGroup).toBeCalledTimes(1);
+        expect(mocksendZclFrameToGroup.mock.calls[0][0]).toBe(2);
+        expect(deepClone(mocksendZclFrameToGroup.mock.calls[0][1])).toStrictEqual(deepClone(ZclFrame.create(Zcl.FrameType.GLOBAL, Zcl.Direction.CLIENT_TO_SERVER, true, null, 2, 'read', 0, [{"attrId": 5}, {"attrId": 1}])));
+        expect(mocksendZclFrameToGroup.mock.calls[0][2]).toBe(null);
+    });
+
+    it('Read from group fails', async () => {
+        await controller.start();
+        const group = await controller.createGroup(2);
+        mocksendZclFrameToGroup.mockRejectedValueOnce(new Error('timeout'));
+        let error;
+        try {
+            await group.read('genBasic', ['modelId', 0x01], {});
+        } catch (e) { error = e; }
+        expect(error).toStrictEqual(new Error(`Read 2 genBasic(["modelId",1], {"direction":0,"srcEndpoint":null,"reservedBits":0,"manufacturerCode":null,"transactionSequenceNumber":null}) failed (timeout)`));
+    });
+
     it('Write to group', async () => {
         await controller.start();
         const group = await controller.createGroup(2);