Skip to content

Commit

Permalink
Only do read after write when retrieve_state is enabled. #1349
Browse files Browse the repository at this point in the history
  • Loading branch information
@Koenkk
Koenkk committed Mar 30, 2019
1 parent 35fd1a6 commit 76d7861
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 31 deletions.
6 changes: 3 additions & 3 deletions lib/extension/devicePublish.js
View file
Expand Up @@ -205,10 +205,10 @@ class DevicePublish {
// automatically report a new state when set.
// When reporting is requested for a device (report: true in device-specific settings) we won't
// ever issue a read here, as we assume the device will properly report changes.
// Only do this when the retrieve_state option is enabled for this device.
const deviceSettings = settings.getDevice(entity.ID);
if (topic.type === 'set' && entity.type === 'device'
&& converted.hasOwnProperty('readAfterWriteTime')
&& !(deviceSettings && deviceSettings.report)) {
if (topic.type === 'set' && entity.type === 'device' && converted.hasOwnProperty('readAfterWriteTime') &&
deviceSettings && deviceSettings.retrieve_state) {
const getConverted = converter.convert(key, json[key], json, 'get');
setTimeout(() => {
this.zigbee.publish(
Expand Down
73 changes: 45 additions & 28 deletions test/devicePublish.test.js
View file
Expand Up @@ -63,7 +63,7 @@ describe('DevicePublish', () => {
'0x00000001',
{state: 'ON', brightness: 200});
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(2);
expect(zigbee.publish).toHaveBeenCalledTimes(1);
});

it('Should publish messages to zigbee devices', async () => {
Expand All @@ -88,17 +88,7 @@ describe('DevicePublish', () => {
'0x00000002',
{state: 'ON'});
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(2);
expect(zigbee.publish).toHaveBeenNthCalledWith(2,
'0x00000002',
'device',
'genLevelCtrl',
'read',
'foundation',
[{attrId: 0}],
cfg.default,
null,
expect.any(Function));
expect(zigbee.publish).toHaveBeenCalledTimes(1);
});

it('Should publish messages to zigbee devices when brightness is in %', async () => {
Expand All @@ -122,7 +112,7 @@ describe('DevicePublish', () => {
'0x00000003',
{state: 'ON', brightness: 235});
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(2);
expect(zigbee.publish).toHaveBeenCalledTimes(1);
}
);

Expand All @@ -147,7 +137,7 @@ describe('DevicePublish', () => {
'0x00000004',
{state: 'ON', brightness: 230});
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(2);
expect(zigbee.publish).toHaveBeenCalledTimes(1);
}
);

Expand All @@ -172,7 +162,7 @@ describe('DevicePublish', () => {
'0x00000005',
{color_temp: 222});
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(2);
expect(zigbee.publish).toHaveBeenCalledTimes(1);
});

it('Should publish messages to zigbee devices with color_temp in %', async () => {
Expand All @@ -196,7 +186,7 @@ describe('DevicePublish', () => {
'0x00000006',
{color_temp: 500});
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(2);
expect(zigbee.publish).toHaveBeenCalledTimes(1);
}
);

Expand Down Expand Up @@ -316,7 +306,7 @@ describe('DevicePublish', () => {
null,
expect.any(Function));
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(2);
expect(zigbee.publish).toHaveBeenCalledTimes(1);
expect(publishEntityState).toHaveBeenCalledTimes(1);
expect(publishEntityState).toHaveBeenNthCalledWith(1,
'0x00000011',
Expand Down Expand Up @@ -358,11 +348,7 @@ describe('DevicePublish', () => {
'0x00000012',
{color: {x: 100, y: 50}});
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(4);
expect(zigbee.publish.mock.calls[2][2]).toBe('genLevelCtrl');
expect(zigbee.publish.mock.calls[2][3]).toBe('read');
expect(zigbee.publish.mock.calls[3][2]).toBe('lightingColorCtrl');
expect(zigbee.publish.mock.calls[3][3]).toBe('read');
expect(zigbee.publish).toHaveBeenCalledTimes(2);
}
);

Expand Down Expand Up @@ -394,7 +380,7 @@ describe('DevicePublish', () => {
null,
expect.any(Function));
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(4);
expect(zigbee.publish).toHaveBeenCalledTimes(2);
expect(publishEntityState).toHaveBeenCalledTimes(2);
expect(publishEntityState).toHaveBeenNthCalledWith(1,
'0x00000013',
Expand Down Expand Up @@ -433,7 +419,7 @@ describe('DevicePublish', () => {
null,
expect.any(Function));
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(4);
expect(zigbee.publish).toHaveBeenCalledTimes(2);
expect(publishEntityState).toHaveBeenCalledTimes(2);
expect(publishEntityState).toHaveBeenNthCalledWith(1,
'0x00000014',
Expand Down Expand Up @@ -479,7 +465,7 @@ describe('DevicePublish', () => {
'0x00000015',
{color: {x: 100, y: 50}});
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(3);
expect(zigbee.publish).toHaveBeenCalledTimes(2);
}
);

Expand All @@ -500,7 +486,7 @@ describe('DevicePublish', () => {
null,
expect.any(Function));
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(2);
expect(zigbee.publish).toHaveBeenCalledTimes(1);
expect(publishEntityState).toHaveBeenCalledTimes(1);
expect(publishEntityState).toHaveBeenNthCalledWith(1,
'0x00000016',
Expand All @@ -524,7 +510,7 @@ describe('DevicePublish', () => {
null,
expect.any(Function));
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(2);
expect(zigbee.publish).toHaveBeenCalledTimes(1);
expect(publishEntityState).toHaveBeenCalledTimes(1);
expect(publishEntityState).toHaveBeenNthCalledWith(1,
'0x00000017',
Expand Down Expand Up @@ -553,7 +539,7 @@ describe('DevicePublish', () => {
'0x00000018',
{state: 'ON', brightness: 50});
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(2);
expect(zigbee.publish).toHaveBeenCalledTimes(1);
}
);

Expand Down Expand Up @@ -894,15 +880,39 @@ describe('DevicePublish', () => {
expect(zigbee.publish.mock.calls[1][2]).toBe('lightingColorCtrl');
expect(zigbee.publish.mock.calls[1][3]).toBe('moveToColor');
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(2);
});

it('Should read after write when enabled', async () => {
zigbee.publish.mockClear();
publishEntityState.mockClear();
zigbee.getDevice = () => ({modelId: 'LCT001'});
jest.spyOn(settings, 'getDevice').mockReturnValue({retrieve_state: true});
const msg = {'state': 'ON', 'color': {'x': 0.701, 'y': 0.299}};
devicePublish.onMQTTMessage('zigbee2mqtt/0x00000020/set', JSON.stringify(msg));
expect(zigbee.publish).toHaveBeenCalledTimes(2);
expect(zigbee.publish.mock.calls[0][2]).toBe('genOnOff');
expect(zigbee.publish.mock.calls[0][3]).toBe('on');
expect(zigbee.publish.mock.calls[1][2]).toBe('lightingColorCtrl');
expect(zigbee.publish.mock.calls[1][3]).toBe('moveToColor');
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(4);
expect(zigbee.publish.mock.calls[2][2]).toBe('genLevelCtrl');
expect(zigbee.publish.mock.calls[2][3]).toBe('read');
expect(zigbee.publish.mock.calls[3][2]).toBe('lightingColorCtrl');
expect(zigbee.publish.mock.calls[3][3]).toBe('read');
expect(publishEntityState).toHaveBeenCalledTimes(2);
expect(publishEntityState).toHaveBeenNthCalledWith(1,
'0x00000020',
{state: 'ON'});
expect(publishEntityState).toHaveBeenNthCalledWith(2,
'0x00000020',
{color: {x: 0.701, y: 0.299}});
});

it('Should set state with brightness before color', async () => {
zigbee.publish.mockClear();
publishEntityState.mockClear();
zigbee.getDevice = () => ({modelId: 'LCT001'});
const msg = {'state': 'ON', 'color': {'x': 0.701, 'y': 0.299}, 'transition': 3, 'brightness': 100};
devicePublish.onMQTTMessage('zigbee2mqtt/0x00000021/set', JSON.stringify(msg));
Expand All @@ -911,6 +921,13 @@ describe('DevicePublish', () => {
expect(zigbee.publish.mock.calls[1][2]).toBe('lightingColorCtrl');
await wait(10);
expect(zigbee.publish).toHaveBeenCalledTimes(2);
expect(publishEntityState).toHaveBeenCalledTimes(2);
expect(publishEntityState).toHaveBeenNthCalledWith(1,
'0x00000021',
{state: 'ON', brightness: 100});
expect(publishEntityState).toHaveBeenNthCalledWith(2,
'0x00000021',
{color: {x: 0.701, y: 0.299}});
});

it('Should turn device off when brightness 0 is send', async () => {
Expand Down

0 comments on commit 76d7861

Please sign in to comment.