Add device_info and unique_id by postlund · Pull Request #8 · postlund/dlink_hnap

postlund · 2020-07-28T05:16:50Z

Device information should now be shown under Configuration -> Devices. As unique_id is set, it should also be possible to edit the entity in the UI, e.g. change name.

Molodax · 2020-07-28T11:12:40Z

It doesn't seem to be working:

2020-07-28 12:59:51 ERROR (MainThread) [custom_components.dlink_hnap.binary_sensor] failed to update motion sensor
Traceback (most recent call last):
  File "/config/custom_components/dlink_hnap/binary_sensor.py", line 134, in async_update
    last_trigger = await self._sensor.latest_trigger()
  File "/config/custom_components/dlink_hnap/dlink.py", line 202, in latest_trigger
    if "GetLatestDetection" in self.client.actions:
TypeError: argument of type 'NoneType' is not iterable
2020-07-28 12:59:51 ERROR (MainThread) [custom_components.dlink_hnap.binary_sensor] failed to update motion sensor
Traceback (most recent call last):
  File "/config/custom_components/dlink_hnap/binary_sensor.py", line 134, in async_update
    last_trigger = await self._sensor.latest_trigger()
  File "/config/custom_components/dlink_hnap/dlink.py", line 202, in latest_trigger
    if "GetLatestDetection" in self.client.actions:
TypeError: argument of type 'NoneType' is not iterable
2020-07-28 12:59:51 ERROR (MainThread) [custom_components.dlink_hnap.binary_sensor] failed to update water sensor
Traceback (most recent call last):
  File "/config/custom_components/dlink_hnap/binary_sensor.py", line 163, in async_update
    water_detected = await self._sensor.water_detected()
  File "/config/custom_components/dlink_hnap/dlink.py", line 231, in water_detected
    if not self._soap_actions:
AttributeError: 'WaterSensor' object has no attribute '_soap_actions'
2020-07-28 12:59:51 ERROR (MainThread) [homeassistant.components.binary_sensor] Error while setting up dlink_hnap platform for binary_sensor
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/helpers/entity_platform.py", line 187, in _async_setup_platform
    await asyncio.gather(*pending)
  File "/usr/src/homeassistant/homeassistant/helpers/entity_platform.py", line 293, in async_add_entities
    await asyncio.gather(*tasks)
  File "/usr/src/homeassistant/homeassistant/helpers/entity_platform.py", line 330, in _async_add_entity
    if entity.unique_id is not None:
  File "/config/custom_components/dlink_hnap/binary_sensor.py", line 106, in unique_id
    return self._sensor.mac
  File "/config/custom_components/dlink_hnap/dlink.py", line 194, in mac
    return self._settings.get("DeviceMacId")
AttributeError: 'coroutine' object has no attribute 'get'
2020-07-28 12:59:56 ERROR (MainThread) [custom_components.dlink_hnap.binary_sensor] failed to update water sensor
Traceback (most recent call last):
  File "/config/custom_components/dlink_hnap/binary_sensor.py", line 163, in async_update
    water_detected = await self._sensor.water_detected()
  File "/config/custom_components/dlink_hnap/dlink.py", line 231, in water_detected
    if not self._soap_actions:
AttributeError: 'WaterSensor' object has no attribute '_soap_actions'
2020-07-28 13:00:01 ERROR (MainThread) [custom_components.dlink_hnap.binary_sensor] failed to update water sensor
Traceback (most recent call last):
  File "/config/custom_components/dlink_hnap/binary_sensor.py", line 163, in async_update
    water_detected = await self._sensor.water_detected()
  File "/config/custom_components/dlink_hnap/dlink.py", line 231, in water_detected
    if not self._soap_actions:
AttributeError: 'WaterSensor' object has no attribute '_soap_actions'
2020-07-28 13:00:06 ERROR (MainThread) [custom_components.dlink_hnap.binary_sensor] failed to update water sensor
Traceback (most recent call last):
  File "/config/custom_components/dlink_hnap/binary_sensor.py", line 163, in async_update
    water_detected = await self._sensor.water_detected()
  File "/config/custom_components/dlink_hnap/dlink.py", line 231, in water_detected
    if not self._soap_actions:
AttributeError: 'WaterSensor' object has no attribute '_soap_actions'

postlund · 2020-07-28T17:55:11Z

New update pushed, hopefully fixes the issues! 🤞

Molodax · 2020-07-28T19:37:13Z

New update pushed, hopefully fixes the issues! 🤞

There are still some issues :/:

2020-07-28 21:29:49 ERROR (MainThread) [custom_components.dlink_hnap.dlink] log list: OrderedDict([('@xmlns', 'http://purenetworks.com/HNAP1/'), ('GetMotionDetectorLogsResult', 'ERROR')])
2020-07-28 21:29:49 ERROR (MainThread) [custom_components.dlink_hnap.binary_sensor] failed to update motion sensor
Traceback (most recent call last):
File "/config/custom_components/dlink_hnap/binary_sensor.py", line 134, in async_update
last_trigger = await self._sensor.latest_trigger()
File "/config/custom_components/dlink_hnap/dlink.py", line 212, in latest_trigger
log_list = resp["MotionDetectorLogList"]
KeyError: 'MotionDetectorLogList'
2020-07-28 21:29:49 ERROR (MainThread) [custom_components.dlink_hnap.dlink] log list: OrderedDict([('@xmlns', 'http://purenetworks.com/HNAP1/'), ('GetMotionDetectorLogsResult', 'ERROR')])
2020-07-28 21:29:49 ERROR (MainThread) [custom_components.dlink_hnap.binary_sensor] failed to update motion sensor
Traceback (most recent call last):
File "/config/custom_components/dlink_hnap/binary_sensor.py", line 134, in async_update
last_trigger = await self._sensor.latest_trigger()
File "/config/custom_components/dlink_hnap/dlink.py", line 212, in latest_trigger
log_list = resp["MotionDetectorLogList"]
KeyError: 'MotionDetectorLogList'

Molodax · 2020-07-28T19:42:10Z

It also says fo the sensors in UI :/

'This entity does not have a unique ID, therefore its settings cannot be managed from the UI.'

ebear5 · 2020-07-28T20:26:44Z

same result for me

postlund · 2020-07-28T20:32:24Z

It was a stupid asyncio mistake (didn't await properly). Should be fixed now! Ran pylint on the code a fixed quite a few issues here and there, hope it works better now!

I believe that the ui saying it does not have unique id is a direct consequence of the error above.

ebear5 · 2020-07-28T21:01:24Z

I'm still getting: 'This entity does not have a unique ID, therefore its settings cannot be managed from the UI.'

Molodax · 2020-07-28T21:01:26Z

It was a stupid asyncio mistake (didn't await properly). Should be fixed now! Ran pylint on the code a fixed quite a few issues here and there, hope it works better now!

I believe that the ui saying it does not have unique id is a direct consequence of the error above.

I'm afraid there is still some issue left :/:

2020-07-28 22:52:39 ERROR (MainThread) [custom_components.dlink_hnap.dlink] log list: OrderedDict([('@xmlns', 'http://purenetworks.com/HNAP1/'), ('GetMotionDetectorLogsResult', 'ERROR')])
NoneType: None
2020-07-28 22:52:39 ERROR (MainThread) [custom_components.dlink_hnap.binary_sensor] failed to update motion sensor
Traceback (most recent call last):
  File "/config/custom_components/dlink_hnap/binary_sensor.py", line 128, in async_update
    last_trigger = await self._sensor.latest_trigger()
  File "/config/custom_components/dlink_hnap/dlink.py", line 206, in latest_trigger
    log_list = resp["MotionDetectorLogList"]
KeyError: 'MotionDetectorLogList'
2020-07-28 22:52:39 ERROR (MainThread) [custom_components.dlink_hnap.dlink] log list: OrderedDict([('@xmlns', 'http://purenetworks.com/HNAP1/'), ('GetMotionDetectorLogsResult', 'ERROR')])
NoneType: None
2020-07-28 22:52:39 ERROR (MainThread) [custom_components.dlink_hnap.binary_sensor] failed to update motion sensor
Traceback (most recent call last):
  File "/config/custom_components/dlink_hnap/binary_sensor.py", line 128, in async_update
    last_trigger = await self._sensor.latest_trigger()
  File "/config/custom_components/dlink_hnap/dlink.py", line 206, in latest_trigger
    log_list = resp["MotionDetectorLogList"]
KeyError: 'MotionDetectorLogList'
2020-07-28 22:52:43 ERROR (MainThread) [custom_components.dlink_hnap.dlink] log list: OrderedDict([('@xmlns', 'http://purenetworks.com/HNAP1/'), ('GetMotionDetectorLogsResult', 'ERROR')])
NoneType: None
2020-07-28 22:52:43 ERROR (MainThread) [custom_components.dlink_hnap.binary_sensor] failed to update motion sensor
Traceback (most recent call last):
  File "/config/custom_components/dlink_hnap/binary_sensor.py", line 128, in async_update
    last_trigger = await self._sensor.latest_trigger()
  File "/config/custom_components/dlink_hnap/dlink.py", line 206, in latest_trigger
    log_list = resp["MotionDetectorLogList"]
KeyError: 'MotionDetectorLogList'

postlund · 2020-07-29T19:56:55Z

So, the problem is this. Which "function" that is ought to be used to figure out latest motion, depends on the firmware version. D-link changed it at some point. I fetch the list of all supported functions and look for "the new" one and use that if available, otherwise fall back to the old method. For some reason that list doesn't seem to be fetched correctly/at all/when it should, so defection falls back to the old function which your device (with newer firmware) does not support. I don't really understand why, but I have tried to revert the behavior a bit. Can you try the latest version?

ebear5 · 2020-07-29T21:12:40Z

Still no unique id

postlund · 2020-07-30T07:26:58Z

Now I have resurrected an old sensor so that I can actually try the code myself... Latest push now works with unique_id, but I guess I need to use config entries in order to use the device registry. I will look into that. It should pave the way to support config flow and discovery in a simple way too.

ebear5 · 2020-07-30T14:28:29Z

The work you're doing is sincerely appreciated

Molodax · 2020-07-31T17:25:25Z

Now I have resurrected an old sensor so that I can actually try the code myself... Latest push now works with unique_id, but I guess I need to use config entries in order to use the device registry. I will look into that. It should pave the way to support config flow and discovery in a simple way too.

There are some improvements so the sensors have setting now, however, the sensors don't update anymore:

2020-07-31 19:05:53 ERROR (MainThread) [custom_components.dlink_hnap.dlink] log list: OrderedDict([('@xmlns', 'http://purenetworks.com/HNAP1/'), ('GetMotionDetectorLogsResult', 'ERROR')])
NoneType: None
2020-07-31 19:05:53 ERROR (MainThread) [custom_components.dlink_hnap.binary_sensor] failed to update motion sensor
Traceback (most recent call last):
File "/config/custom_components/dlink_hnap/binary_sensor.py", line 130, in async_update
last_trigger = await self._sensor.latest_trigger()
File "/config/custom_components/dlink_hnap/dlink.py", line 210, in latest_trigger
log_list = resp["MotionDetectorLogList"]
KeyError: 'MotionDetectorLogList'
2020-07-31 19:05:53 ERROR (MainThread) [custom_components.dlink_hnap.dlink] log list: OrderedDict([('@xmlns', 'http://purenetworks.com/HNAP1/'), ('GetMotionDetectorLogsResult', 'ERROR')])
NoneType: None
2020-07-31 19:05:53 ERROR (MainThread) [custom_components.dlink_hnap.binary_sensor] failed to update motion sensor
Traceback (most recent call last):
File "/config/custom_components/dlink_hnap/binary_sensor.py", line 130, in async_update
last_trigger = await self._sensor.latest_trigger()
File "/config/custom_components/dlink_hnap/dlink.py", line 210, in latest_trigger
log_list = resp["MotionDetectorLogList"]
KeyError: 'MotionDetectorLogList'

MichaelB2018 · 2026-03-17T14:41:12Z

This PR is now superseded by #22 (or whatever your PR number is — check). My v2.0.0 rewrite includes everything this PR was trying to achieve and more:

device_info — Full device registry support with manufacturer, model, firmware version, and hardware version via a base entity class
unique_id — Uses device serial number from config entries, so all entities are fully manageable in the UI
Config entries / device registry — Full config flow with UI setup, SSDP auto-discovery, and options flow — exactly the direction @postlund mentioned was needed here
The bugs encountered in this PR (KeyError: 'MotionDetectorLogList', missing await, NoneType in actions) are all resolved in the rewritten HNAP client, which properly handles missing response keys and null values.

See #22 for the full v2.0.0 changes.

postlund mentioned this pull request Jul 28, 2020

Add support for DCH-S160 #2

Merged

postlund force-pushed the device_info branch from e7918d3 to 0802b4f Compare July 28, 2020 17:54

postlund force-pushed the device_info branch from 0802b4f to ff6effe Compare July 28, 2020 20:30

postlund force-pushed the device_info branch from ff6effe to 6822230 Compare July 29, 2020 19:52

Add device_info and unique_id

1bb8ef4

postlund force-pushed the device_info branch from 6822230 to 1bb8ef4 Compare July 30, 2020 07:24

MichaelB2018 mentioned this pull request Mar 17, 2026

feat: Add config flow, SSDP discovery, coordinator, sensors v2.0.0 #22

Open

Uh oh!

Conversation

postlund commented Jul 28, 2020

Uh oh!

Molodax commented Jul 28, 2020 • edited by postlund Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

postlund commented Jul 28, 2020

Uh oh!

Molodax commented Jul 28, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Molodax commented Jul 28, 2020

Uh oh!

ebear5 commented Jul 28, 2020

Uh oh!

postlund commented Jul 28, 2020

Uh oh!

ebear5 commented Jul 28, 2020

Uh oh!

Molodax commented Jul 28, 2020 • edited by postlund Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

postlund commented Jul 29, 2020

Uh oh!

ebear5 commented Jul 29, 2020

Uh oh!

postlund commented Jul 30, 2020

Uh oh!

ebear5 commented Jul 30, 2020

Uh oh!

Molodax commented Jul 31, 2020

Uh oh!

MichaelB2018 commented Mar 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Molodax commented Jul 28, 2020 •

edited by postlund

Loading

Molodax commented Jul 28, 2020 •

edited

Loading

Molodax commented Jul 28, 2020 •

edited by postlund

Loading