Add binary sensor platform to devolo Home Network by Shutgun · Pull Request #60301 · home-assistant/core

Shutgun · 2021-11-24T18:21:57Z

Proposed change

Add binary sensor platform to devolo Home Network, starting with two entities: Firmware update and if the device is connected directly to the router. As the state of the later cannot be retrieved only from the coordinator, I implemented if differently than the other binary sensor and the existing sensors.

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request: Add binary sensor platform to devolo Home Network home-assistant.io#20427

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
The code has been formatted using Black (black --fast homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

No score or internal
🥈 Silver
🥇 Gold
🏆 Platinum

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

probot-home-assistant · 2021-11-24T18:22:05Z

Hey there @2Fake, mind taking a look at this pull request as it has been labeled with an integration (devolo_home_network) you are listed as a code owner for? Thanks!
_{^{(message by CodeOwnersMention)}}

epenet

I think that you can improve the use of EntityDescription to have only a single DevoloBinarySensorEntity class.

To do this, you can create two module function _is_on_basic and _is_on_extended which take the entity as parameter, and you set value_func to the new module function accordingly.

homeassistant/components/devolo_home_network/binary_sensor.py

Shutgun · 2021-11-25T19:35:50Z

Hi @epenet , thanks for the hint. It just didn't come to my mind to use the complete entity as parameter ...

homeassistant/components/devolo_home_network/binary_sensor.py

tests/components/devolo_home_network/test_binary_sensor.py

bdraco · 2021-11-26T01:44:56Z

homeassistant/components/devolo_home_network/entity.py


-        self._device = device
-        self._device_name = device_name
+        self.device = device
+        self.device_name = device_name

        self._attr_device_info = DeviceInfo(
-            configuration_url=f"http://{self._device.ip}",
-            identifiers={(DOMAIN, str(self._device.serial_number))},
+            configuration_url=f"http://{self.device.ip}",
+            identifiers={(DOMAIN, str(self.device.serial_number))},
            manufacturer="devolo",
-            model=self._device.product,
-            name=self._device_name,
-            sw_version=self._device.firmware_version,
+            model=self.device.product,
+            name=self.device_name,
+            sw_version=self.device.firmware_version,
        )
        self._attr_unique_id = (
-            f"{self._device.serial_number}_{self.entity_description.key}"
+            f"{self.device.serial_number}_{self.entity_description.key}"
        )


Why drop the _?

I access device in _is_connected_to_router and with _ pylint complains about the private access.

Since this is all in __init__, you could simply use device and device_name function arguments instead of self.xxx

hmm, I'm not seeing it. Could you help me out? The signatures of _is_connected_to_router and the lambda (and any possible upcoming sensor) would need to be the same although _is_connected_to_router is most likely the only one needing it and having the information available inside the entity, right? Isn't then accessing entity.device (and by that making it public) cleaner?

You keep the change at the top (lines 24/25):

self.device = device self.device_name = device_name

But in the subsequent lines instead of replacing self._dev... by self.dev... you replace it by dev... (drop the self._)

Got it! I was at a complete different spot in the code ...

tests/components/devolo_home_network/test_binary_sensor.py

tests/components/devolo_home_network/__init__.py

homeassistant/components/devolo_home_network/__init__.py

bdraco · 2022-01-05T02:45:09Z

tests/components/devolo_home_network/test_binary_sensor.py

+
+    # Emulate device failure
+    with patch(
+        "devolo_plc_api.plcnet_api.plcnetapi.PlcNetApi.async_get_network_overview",


Suggested change

"devolo_plc_api.plcnet_api.plcnetapi.PlcNetApi.async_get_network_overview",

"homeassistant.components.devolo_home_network.devolo_plc_api.plcnet_api.plcnetapi.PlcNetApi.async_get_network_overview",

Usually we patch where the library is imported so we don't accidentally patch places we don't want to change

In this case it would probably be better to adjust the mock_device instead

The mock_device is just a collection of patches itself. I'm not seeing, how I could adjust it.

bdraco · 2022-01-05T02:47:02Z

tests/components/devolo_home_network/test_binary_sensor.py

+
+    # Emulate device failure
+    with patch(
+        "devolo_plc_api.device_api.deviceapi.DeviceApi.async_check_firmware_available",


Can you adjust mock_device instead of patching here?

bdraco · 2022-01-05T02:47:06Z

tests/components/devolo_home_network/test_binary_sensor.py

+    # Emulate state change
+    with patch(
+        "devolo_plc_api.device_api.deviceapi.DeviceApi.async_check_firmware_available",
+        new=AsyncMock(return_value={"result": "UPDATE_AVAILABLE"}),


Can you adjust mock_device instead of patching here?

github-actions · 2022-04-05T11:09:48Z

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days.
Thank you for your contributions.

bdraco · 2022-04-05T11:12:10Z

not stale, awaits response (Didn't see the question until now)

Shutgun · 2022-04-05T12:20:06Z

I guess, I should remove the firmware_update_available binary sensor, as update is an own platform by now, right?

Shutgun · 2022-04-25T21:09:50Z

Hi @bdraco , I removed the update sensor, so I guess I'm ready for review.

homeassistant added the cla-signed label Nov 24, 2021

probot-home-assistant bot added has-tests integration: devolo_home_network new-feature new-platform by-code-owner labels Nov 24, 2021

Shutgun mentioned this pull request Nov 24, 2021

Add binary sensor platform to devolo Home Network home-assistant/home-assistant.io#20427

Merged

8 tasks

epenet reviewed Nov 25, 2021

View reviewed changes

homeassistant/components/devolo_home_network/binary_sensor.py Outdated Show resolved Hide resolved

homeassistant/components/devolo_home_network/binary_sensor.py Show resolved Hide resolved

epenet reviewed Nov 25, 2021

View reviewed changes

homeassistant/components/devolo_home_network/binary_sensor.py Outdated Show resolved Hide resolved

epenet reviewed Nov 25, 2021

View reviewed changes

homeassistant/components/devolo_home_network/binary_sensor.py Outdated Show resolved Hide resolved

epenet reviewed Nov 25, 2021

View reviewed changes

tests/components/devolo_home_network/test_binary_sensor.py Outdated Show resolved Hide resolved

bdraco reviewed Nov 26, 2021

View reviewed changes

Shutgun force-pushed the hn_binary_sensor branch from 602e291 to e7d8134 Compare December 3, 2021 18:03

bdraco self-requested a review December 7, 2021 08:41

bdraco reviewed Dec 7, 2021

View reviewed changes

tests/components/devolo_home_network/test_binary_sensor.py Outdated Show resolved Hide resolved

epenet reviewed Dec 7, 2021

View reviewed changes

tests/components/devolo_home_network/__init__.py Outdated Show resolved Hide resolved

frenck added the smash Indicator this PR is close to finish for merging or closing label Jan 4, 2022

bdraco reviewed Jan 5, 2022

View reviewed changes

homeassistant/components/devolo_home_network/__init__.py Outdated Show resolved Hide resolved

bdraco approved these changes Jan 5, 2022

View reviewed changes

bdraco reviewed Jan 5, 2022

View reviewed changes

frenck removed the smash Indicator this PR is close to finish for merging or closing label Jan 5, 2022

Shutgun mentioned this pull request Jan 10, 2022

Bump devolo-plc-api to 0.7.1 #63834

Merged

22 tasks

github-actions bot added the stale label Apr 5, 2022

bdraco self-requested a review April 5, 2022 11:11

bdraco removed the stale label Apr 5, 2022

Shutgun added 9 commits April 25, 2022 20:27

Add binary sensor platform

ca7bd0e

Add tests

46f8438

Switch to single DevoloBinarySensorEntity

ae4cc31

Fix pylint

6053e26

Replace lamba by function

c0b51de

Combine decorators

a5a90a3

Update entity init

8e79d4e

Apply suggestions

1fc0f09

Remove update sensor

e52ab0f

Shutgun force-pushed the hn_binary_sensor branch from de11973 to e52ab0f Compare April 25, 2022 20:56

Shutgun added 2 commits April 25, 2022 20:59

Remove fwupdate coordinator

beaa9c1

Remove unused test code

78cd487

Merge branch 'dev' into hn_binary_sensor

2ce165c

bdraco approved these changes May 9, 2022

View reviewed changes

bdraco merged commit 2b30bda into home-assistant:dev May 9, 2022

Shutgun deleted the hn_binary_sensor branch May 9, 2022 08:34

github-actions bot locked and limited conversation to collaborators May 10, 2022

	"devolo_plc_api.plcnet_api.plcnetapi.PlcNetApi.async_get_network_overview",
	"homeassistant.components.devolo_home_network.devolo_plc_api.plcnet_api.plcnetapi.PlcNetApi.async_get_network_overview",

Uh oh!

Conversation

Shutgun commented Nov 24, 2021

Proposed change

Type of change

Additional information

Checklist

Uh oh!

probot-home-assistant bot commented Nov 24, 2021

Uh oh!

epenet left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Shutgun commented Nov 25, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

epenet Nov 26, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Apr 5, 2022

Uh oh!

bdraco commented Apr 5, 2022

Uh oh!

Shutgun commented Apr 5, 2022

Uh oh!

Shutgun commented Apr 25, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

epenet Nov 26, 2021 •

edited

Loading