availability_whitelist

[Kryzek]

As requested at #2204

Tested with my environment

With

  availability_timeout: 120
  availability_whitelist: ['0x00124b001d3ab1b9','0x001788010278b40a']

in configuration.yaml

I get this behaviour as wanted:

zigbee2mqtt:debug 2019-11-22 14:08:09: Received Zigbee message from '0x00124b001d3ab1b9', type 'readResponse', cluster 'genBasic', data '{"zclVersion":1}' from endpoint 11 with groupID 0
zigbee2mqtt:debug 2019-11-22 14:08:09: Successfully pinged '0x00124b001d3ab1b9'
...
zigbee2mqtt:info  2019-11-22 14:08:19: MQTT publish: topic 'zigbee/0x001788010278b40a/availability', payload 'offline'
zigbee2mqtt:error 2019-11-22 14:08:19: Failed to ping '0x001788010278b40a'
...
zigbee2mqtt:debug 2019-11-22 14:18:11: Successfully pinged '0x00124b001d3ab1b9'
zigbee2mqtt:debug 2019-11-22 14:18:49: Failed to ping '0x001788010278b40a'

Hope I did not break anything else while at it.

Closes #2204

[Koenkk]

This feature looks good to me, if you can add the missing tests than this can be merged, see https://github.com/Koenkk/zigbee2mqtt/blob/master/test/deviceAvailability.test.js#L207 for inspiration.

[Kryzek]

If my Google-Fu is not terribly bad, the goal is to get npm test -- --coverage to run without errors?

[Koenkk]

Yes: npm run test-with-coverage. The coverage report (index.html) can be found after this in the coverage folder.

[Kryzek]

I'll be damned! Tests passed! 💪

[Kryzek]

Also updated documentation Koenkk/zigbee2mqtt.io#165

[Koenkk]

I reshuffled the logic a bit, tests are still passing, is this OK for you?

[Kryzek]

Wow... I really overthought this. ’return this.whitelist.includes(device.ieeeAddr);’ does return also false... So much cleaner now.

How about those forcePinged devices, should those be checked before?

[Koenkk]

Forced pinged devices is a list of end devices which can be pinged, however the whitelist does basically the same. It would be strange if a device is NOT in the whitelist but is still pinged.

[Kryzek]

Makes sense.

I’m happy with your changes since they make same as mine but just much more elegant way.

[Koenkk]

Thanks!