Add renault integration #39605

epenet · 2020-09-03T08:46:28Z

Proposed change

Add integration for monitoring Renault vehicles, to replace custom_component.

Initial PR implements config_flow, with sensor platform.
Follow-up PRs will include device_tracker and services

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: https://community.home-assistant.io/t/renault-zoe-my-renault-and-my-ze-online/111916
Link to documentation pull request: Add new component renault documentation home-assistant.io#14383

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.
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.

frenck

Hi there @epenet!

I've quickly viewed your PR and left some comments to resolve before we can continue the review process. Looking forward to this! 👍

.coveragerc

homeassistant/components/renault/__init__.py

homeassistant/components/renault/pyzeproxy.py

frenck · 2020-09-03T16:24:05Z

Please do not squash the commits, it makes it very hard to review/track progress. We will squash the PR into a single commit on merge.

epenet · 2020-09-03T16:41:07Z

Please do not squash the commits, it makes it very hard to review/track progress. We will squash the PR into a single commit on merge.

I've removed the extra sensors, and the fetching of the API keys.
Promise: future commits won't be squashed.

Quentame

Did not look at config_flow

homeassistant/components/renault/__init__.py

homeassistant/components/renault/pyzeproxy.py

homeassistant/components/renault/pyzevehicleproxy.py

homeassistant/components/renault/sensor.py

homeassistant/components/renault/pyzevehicleproxy.py

homeassistant/components/renault/pyzeproxy.py

homeassistant/components/renault/const.py

homeassistant/components/renault/config_flow.py

epenet · 2020-10-25T11:02:29Z

Thanks @Quentame. I'll work on those changes - but it looks like more work is required on the underlying PyZE library...

epenet · 2020-10-31T21:39:59Z

Thanks @Quentame, I've worked through your review.

epenet · 2021-07-27T13:22:19Z

Rebased due to conflicting files:

.strict-typing
mypy.ini

frenck

✅ I think this looks nice! Considering the size of this PR, I would like to see a second approval from another reviewer though.

Adding a label for that.

homeassistant/components/renault/config_flow.py

balloob · 2021-07-28T19:35:47Z

homeassistant/components/renault/renault_entities.py

+    def extra_state_attributes(self) -> dict[str, Any]:
+        """Return the state attributes of this entity."""
+        last_update = self.data.timestamp if self.data else None
+        return {ATTR_LAST_UPDATE: last_update}


Why is this necessary? States already have last_changed and last_updated attributes

@balloob this is the last time that the Renault vehicle talked to the Renault servers. It is part of the response from the Renault API.
It serves to highlight issues where the HA component is working normally, the Renault servers are working correctly, but the car itself has stopped sending updates.

MartinHjelmare

Please address the comments in a new PR. Thanks!

MartinHjelmare · 2021-07-28T20:10:17Z

homeassistant/components/renault/renault_hub.py

+
+    def __init__(self, hass: HomeAssistant, locale: str) -> None:
+        """Initialise proxy."""
+        LOGGER.debug("Creating RenaultHub")


We don't want side effects in init methods. Please move or remove the logging.

MartinHjelmare · 2021-07-28T20:13:04Z

homeassistant/components/renault/renault_hub.py

+                    # Generate vehicle proxy
+                    vehicle = RenaultVehicleProxy(
+                        hass=self._hass,
+                        vehicle=await self._account.get_api_vehicle(vehicle_link.vin),


Does the vehicle initialization need to be done in sequence or can we use asyncio.gather to do it concurrently?

MartinHjelmare · 2021-07-28T20:16:39Z

homeassistant/components/renault/renault_vehicle.py

+            coordinator = self.coordinators[key]
+            if coordinator.not_supported:
+                # Remove endpoint as it is not supported for this vehicle.
+                LOGGER.error(


Looks like warning may be more appropriate?

MartinHjelmare · 2021-07-28T20:18:38Z

homeassistant/components/renault/sensor.py

+    return entities
+
+
+async def get_vehicle_entities(vehicle: RenaultVehicleProxy) -> list[RenaultDataEntity]:


This doesn't need to be a coroutine function since we don't await inside.

If I move up the list, I still end up with async def async_setup_entry
Is there a non-async version of this method?

No, that function is part of the API, so we can't change that one.

MartinHjelmare · 2021-07-28T20:19:59Z

homeassistant/components/renault/sensor.py

+        return self.data.batteryLevel if self.data else None
+
+    @property
+    def icon(self) -> str:


This isn't needed when setting device class. It's already handled by the frontend. Please remove it.

MartinHjelmare · 2021-07-28T20:39:10Z

tests/components/renault/test_init.py

+        # them to be.
+        assert await async_setup_entry(hass, config_entry)
+        assert DOMAIN in hass.data and config_entry.unique_id in hass.data[DOMAIN]
+        assert isinstance(hass.data[DOMAIN][config_entry.unique_id], RenaultHub)


We want to avoid asserting integration details like the contents of hass.data. Assert the state of the config entry instead.

MartinHjelmare · 2021-07-28T20:39:29Z

tests/components/renault/test_init.py

+        assert DOMAIN in hass.data and config_entry.unique_id in hass.data[DOMAIN]
+        assert isinstance(hass.data[DOMAIN][config_entry.unique_id], RenaultHub)
+
+        renault_hub: RenaultHub = hass.data[DOMAIN][config_entry.unique_id]


Please don't access integration details in the tests. Patch the library and assert the calls made to the mock.

MartinHjelmare · 2021-07-28T20:40:24Z

tests/components/renault/test_init.py

+        )
+
+        # Unload the entry and verify that the data has been removed
+        assert await async_unload_entry(hass, config_entry)


Please use hass.config_entries.async_unload instead.

MartinHjelmare · 2021-07-28T20:40:47Z

tests/components/renault/test_init.py

+    with patch(
+        "renault_api.renault_session.RenaultSession.login",
+        side_effect=aiohttp.ClientConnectionError,
+    ), pytest.raises(ConfigEntryNotReady):


Assert the state of the config entry instead.

MartinHjelmare · 2021-07-28T20:41:35Z

tests/components/renault/test_sensor.py

+    vehicle_proxy = await create_vehicle_proxy(hass, vehicle_type)
+
+    with patch(
+        "homeassistant.components.renault.RenaultHub.vehicles",


Please patch the library instead.

epenet · 2021-07-29T07:01:21Z

Thanks @frenck / @balloob

I will now start work on the comments from @MartinHjelmare

probot-home-assistant bot added new-integration integration: renault labels Sep 3, 2020

homeassistant added the cla-signed label Sep 3, 2020

This was referenced Sep 3, 2020

Add new component renault logo and icon home-assistant/brands#1825

Merged

Add new component renault documentation home-assistant/home-assistant.io#14383

Merged

epenet force-pushed the renault branch from 851f16d to e12987a Compare September 3, 2020 09:31

epenet marked this pull request as ready for review September 3, 2020 10:10

springstan changed the title ~~Add new component renault~~ Add renault integration Sep 3, 2020

frenck requested changes Sep 3, 2020

View reviewed changes

.coveragerc Outdated Show resolved Hide resolved

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

homeassistant/components/renault/pyzeproxy.py Outdated Show resolved Hide resolved

epenet mentioned this pull request Sep 3, 2020

Add flow to grab api keys from MyRenault jamesremuscat/pyze#85

Closed

epenet force-pushed the renault branch from e12987a to 3aee6a5 Compare September 3, 2020 16:12

epenet force-pushed the renault branch from 3aee6a5 to 62d6b5e Compare September 3, 2020 16:38

epenet mentioned this pull request Sep 4, 2020

Add option to use kWh instead of Wh hacf-fr/hassRenaultZE#46

Closed

epenet requested review from frenck and springstan September 24, 2020 09:33

epenet mentioned this pull request Sep 30, 2020

Add repo to HACS hacf-fr/hassRenaultZE#48

Closed

Quentame requested changes Oct 25, 2020

View reviewed changes

epenet force-pushed the renault branch from 3091daa to 66974f8 Compare October 31, 2020 21:30

epenet mentioned this pull request Nov 4, 2020

Do you want me to improve GitHub Actions? hacf-fr/hassRenaultZE#71

Closed

epenet marked this pull request as draft November 12, 2020 13:28

epenet changed the title ~~Add renault integration~~ Draft: Add renault integration Nov 12, 2020

epenet force-pushed the renault branch from 196b724 to 6802589 Compare December 3, 2020 21:20

epenet added 3 commits July 27, 2021 15:21

Updates for test coverage

43b401b

Fix pyupgrade

27faa55

Adjust DeviceInfo

4feefde

epenet force-pushed the renault branch from c204cfb to 4feefde Compare July 27, 2021 13:22

frenck approved these changes Jul 27, 2021

View reviewed changes

frenck added almost-done second-opinion-wanted Add this label when a reviewer needs a second opinion from another member. labels Jul 27, 2021

balloob reviewed Jul 28, 2021

View reviewed changes

homeassistant/components/renault/config_flow.py Show resolved Hide resolved

balloob reviewed Jul 28, 2021

View reviewed changes

balloob approved these changes Jul 28, 2021

View reviewed changes

balloob merged commit 8d84edd into home-assistant:dev Jul 28, 2021

balloob removed the second-opinion-wanted Add this label when a reviewer needs a second opinion from another member. label Jul 28, 2021

frenck pushed a commit that referenced this pull request Jul 28, 2021

Add renault integration (#39605)

a3a687f

MartinHjelmare reviewed Jul 28, 2021

View reviewed changes

epenet deleted the renault branch July 29, 2021 07:00

This was referenced Jul 29, 2021

Renault code quality improvements #53680

Merged

Renault test optimisation #53705

Merged

This was referenced Aug 17, 2021

Add binary sensor platform to Renault integration #54750

Merged

Add device tracker platform to Renault integration #54745

Merged

Add services to Renault integration #54820

Merged

epenet mentioned this pull request Sep 1, 2021

Add reauth to Renault config flow #55547

Merged

22 tasks

This was referenced Oct 11, 2021

Renault entity naming #57371

Closed

Add renault last activity sensors #57750

Merged

epenet mentioned this pull request Nov 18, 2021

Add Uptime Kuma Integration #59395

Closed

22 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add renault integration #39605

Add renault integration #39605

epenet commented Sep 3, 2020 •

edited

Loading

frenck left a comment

frenck commented Sep 3, 2020

epenet commented Sep 3, 2020

Quentame left a comment

epenet commented Oct 25, 2020

epenet commented Oct 31, 2020

epenet commented Jul 27, 2021

frenck left a comment

balloob Jul 28, 2021

epenet Jul 29, 2021

MartinHjelmare left a comment

MartinHjelmare Jul 28, 2021

MartinHjelmare Jul 28, 2021

MartinHjelmare Jul 28, 2021

MartinHjelmare Jul 28, 2021

epenet Jul 29, 2021

MartinHjelmare Jul 29, 2021

MartinHjelmare Jul 28, 2021

MartinHjelmare Jul 28, 2021

MartinHjelmare Jul 28, 2021

MartinHjelmare Jul 28, 2021

MartinHjelmare Jul 28, 2021

MartinHjelmare Jul 28, 2021

epenet commented Jul 29, 2021

		return entities


		async def get_vehicle_entities(vehicle: RenaultVehicleProxy) -> list[RenaultDataEntity]:

Add renault integration #39605

Add renault integration #39605

Conversation

epenet commented Sep 3, 2020 • edited Loading

Proposed change

Type of change

Additional information

Checklist

frenck left a comment

Choose a reason for hiding this comment

frenck commented Sep 3, 2020

epenet commented Sep 3, 2020

Quentame left a comment

Choose a reason for hiding this comment

epenet commented Oct 25, 2020

epenet commented Oct 31, 2020

epenet commented Jul 27, 2021

frenck left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MartinHjelmare left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

epenet commented Jul 29, 2021

epenet commented Sep 3, 2020 •

edited

Loading