Home Assistant: publish counter value for click and action payloads. #959

lib/extension/deviceReceive.js

@@ -183,6 +183,21 @@ class DeviceReceive {
                 this.publishDebounce(device.ieeeAddr, payload, settingsDevice.debounce);
             } else {
                 this.publishEntityState(device.ieeeAddr, payload);
+
+                if (settings.get().homeassistant) {
+                    /**
+                     * Publish an empty value for click and action payload, in this way Home Assistant
+                     * can use Home Assistant entities in automations.
+                     * https://github.com/Koenkk/zigbee2mqtt/issues/959#issuecomment-480341347
+                     */
+                    Object.keys(payload).forEach((key) => {
+                        if (['action', 'click'].includes(key)) {
+                            const counterPayload = {};
+                            counterPayload[key] = '';
+                            this.publishEntityState(device.ieeeAddr, counterPayload);
+                        }
+                    });
+                }
             }
         };
 

test/deviceReceive.test.js

@@ -40,6 +40,16 @@ describe('DeviceReceive', () => {
             expect(publishEntityState.mock.calls[0][1]).toStrictEqual({click: 'single'});
         });
 
+        it('Should handle a zigbee message and counter it when Home Assistant integration is enabled', () => {
+            jest.spyOn(settings, 'get').mockReturnValue({homeassistant: true, advanced: {last_seen: 'disabled'}});
+            const device = {ieeeAddr: '0x12345678'};
+            const message = utils.zigbeeMessage(device, 'genOnOff', 'attReport', {onOff: 1}, 1);
+            deviceReceive.onZigbeeMessage(message, device, WXKG11LM);
+            expect(publishEntityState).toHaveBeenCalledTimes(2);
+            expect(publishEntityState.mock.calls[0][1]).toStrictEqual({click: 'single'});
+            expect(publishEntityState.mock.calls[1][1]).toStrictEqual({click: ''});
+        });
+
         it('Should handle a zigbee message which uses ep (left)', () => {
             const device = {ieeeAddr: '0x12345678'};
             const message = utils.zigbeeMessage(device, 'genOnOff', 'attReport', {onOff: 1}, 1);