Add Rointe integration #83069

tggm · 2022-12-01T19:41:55Z

Proposed change

This integration provides support for electrical radiators manufactured by Rointe. This is an initial implementation that supports some of Rointe's products:

D-Series Radiator
Towel Rails
Thermostat.

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)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

The integration uses cloud polling via a REST API owned by Rointe. Config flow requires the user to login to the API and then select which particular installation they want to add to HA.

It's currently available via HACS on https://github.com/tggm/rointe-hacs/

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request: Rointe integration home-assistant.io#25118

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.

To help with the load of incoming pull requests:

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

homeassistant/components/rointe/const.py

homeassistant/components/rointe/__init__.py

homeassistant/components/rointe/rointe_entity.py

homeassistant/components/rointe/climate.py

homeassistant/components/rointe/sensor.py

tggm · 2022-12-06T23:30:05Z

Thank you for the first look at this @bachya. It was indeed in a very rough state. I cleaned some of the issue and will ping you when I manage to clear the rest.

This latest commit contains a reauth flow I've been working. It also contains a bunch of debug statements which I added to help another user setup this integration (it's currently available via HACS so I have a couple of people beta testing this).

bachya · 2022-12-06T23:32:35Z

This latest commit contains a reauth flow I've been working. It also contains a bunch of debug statements which I added to help another user setup this integration (it's currently available via HACS so I have a couple of people beta testing this).

Per my previous comment, I would recommend that you do a reauth flow in a separate PR—this PR already has plenty in it.

tggm · 2022-12-06T23:34:30Z

Per my previous comment, I would recommend that you do a reauth flow in a separate PR—this PR already has plenty in it.

Will do.

tggm · 2022-12-07T19:56:30Z

@bachya I cleared up the issues. I changed async_unload_entry a bit and during testing I noticed that when removing the integration and then adding it again the entities do not show up (shown as unavailable). They do however appear after rebooting HASS.

No errors, everything appears OK in logs, both removing and adding again. Maybe async_unload_entry is still not correct

tggm · 2022-12-07T22:40:27Z

@bachya I fixed the problem with unloading the integration. It was a stupid error where I was using a class variable to store my entities.

I also updated the code to use async_forward_entry_setups() according to this post

Finally I removed some useless code from async_unload_entry that I'd copied from another integration.

homeassistant/components/rointe/__init__.py

homeassistant/components/rointe/climate.py

homeassistant/components/rointe/coordinator.py

homeassistant/components/rointe/config_flow.py

homeassistant/components/rointe/coordinator.py

bachya

You're doing great—keep going!

homeassistant/components/rointe/__init__.py

homeassistant/components/rointe/climate.py

homeassistant/components/rointe/device_manager.py

homeassistant/components/rointe/sensor.py

tggm · 2022-12-15T11:51:56Z

Hi @bachya,

Are there any other tasks you want me to work to help with the review?

homeassistant/components/rointe/__init__.py

homeassistant/components/rointe/climate.py

homeassistant/components/rointe/const.py

homeassistant/components/rointe/sensor_descriptions.py

tests/components/rointe/test_config_flow.py

tggm · 2022-12-18T17:58:02Z

What are the test coverage targets for files other than config_flow.py ?

bachya · 2022-12-18T18:47:52Z

What are the test coverage targets for files other than config_flow.py ?

Depends on your objective. Config flow tests are required; (almost) everything else is discretionary.

More info: https://developers.home-assistant.io/docs/integration_quality_scale_index?_highlight=coverage#gold-

gjohansson-ST

First pass for cleanups.
Please rebase after the cleanups.

homeassistant/components/rointe/.gitignore

homeassistant/components/rointe/const.py

homeassistant/components/rointe/coordinator.py

homeassistant/components/rointe/manifest.json

homeassistant/components/rointe/rointe_entity.py

homeassistant/components/rointe/translations/en.json

homeassistant/components/rointe/climate.py

homeassistant/components/rointe/entity.py

homeassistant/components/rointe/climate.py

homeassistant/components/rointe/config_flow.py

joostlek · 2024-01-02T08:50:33Z

homeassistant/components/rointe/config_flow.py

+
+    async def async_step_installation(
+        self, user_input: dict[str, Any] | None
+    ) -> FlowResult:


Okay so apparently 1 account can lead to more installations? Can you maybe elaborate on what an installation is? Usually we have the guideline that 1 (cloud) account = 1 config entry.

Essentially it represents a house/home. It's part of their hierarchy: Installations -> Zones -> Devices.

During configuration the user must pick one installation (for the majority of cases there will only be one option available). The Installation ID is then stored as it is required to retrieve devices.

homeassistant/components/rointe/config_flow.py

joostlek · 2024-01-02T08:51:51Z

homeassistant/components/rointe/coordinator.py

+            update_interval=ROINTE_API_REFRESH_INTERVAL,
+        )
+
+        self.unregistered_keys = {platform: {} for platform in PLATFORMS}


What's a key?

In that context a "key" is the unique identifier of each device. It's determined by the manufacturer's API

By the way, do you have discord? Can you maybe pop me a message? (@joostlek)

Suggested change

self.unregistered_keys = {platform: {} for platform in PLATFORMS}

joostlek · 2024-01-02T20:43:55Z

homeassistant/components/rointe/config_flow.py

+        self, user_input: dict[str, Any] | None = None
+    ) -> FlowResult:
+        """Select the installation."""
+        if not user_input or CONF_INSTALLATION not in user_input:


Suggested change

if not user_input or CONF_INSTALLATION not in user_input:

if not user_input:

joostlek · 2024-01-02T20:44:54Z

homeassistant/components/rointe/config_flow.py

+                data_schema=vol.Schema(
+                    {
+                        vol.Required(CONF_INSTALLATION): vol.In(
+                            self.step_user_installations


What will be fetched? Do we now only show a list of random numbers or can we also get a list of names with the installation id? This way it can be more user friendly since we can pass a name/value pair

There will be a list of names yes. Each installation has a name. Example:

joostlek · 2024-01-02T21:03:02Z

homeassistant/components/rointe/coordinator.py

+            update_interval=ROINTE_API_REFRESH_INTERVAL,
+        )
+
+        self.unregistered_keys = {platform: {} for platform in PLATFORMS}


By the way, do you have discord? Can you maybe pop me a message? (@joostlek)

joostlek · 2024-01-02T22:14:46Z

homeassistant/components/rointe/coordinator.py

+            update_interval=ROINTE_API_REFRESH_INTERVAL,
+        )
+
+        self.unregistered_keys = {platform: {} for platform in PLATFORMS}


Suggested change

self.unregistered_keys = {platform: {} for platform in PLATFORMS}

joostlek · 2024-01-02T22:15:10Z

homeassistant/components/rointe/coordinator.py

+
+        new_devices = await self.device_manager.update()
+
+        for platform in PLATFORMS:
+            self.unregistered_keys[platform].update(
+                {
+                    device_id: device
+                    for device_id, device in new_devices.items()
+                    if device_id not in self.unregistered_keys[platform]
+                }
+            )
+
+        for device in new_devices.values():
+            device_update_info(self.hass, device)
+
+        return new_devices


Suggested change

new_devices = await self.device_manager.update()

for platform in PLATFORMS:

self.unregistered_keys[platform].update(

{

device_id: device

for device_id, device in new_devices.items()

if device_id not in self.unregistered_keys[platform]

}

)

for device in new_devices.values():

device_update_info(self.hass, device)

return new_devices

return await self.device_manager.update()

homeassistant/components/rointe/coordinator.py

joostlek · 2024-01-02T22:15:32Z

homeassistant/components/rointe/coordinator.py

+
+
+@callback
+def device_update_info(hass: HomeAssistant, rointe_device: RointeDevice) -> None:
+    """Update device registry info."""
+
+    LOGGER.debug("Updating device registry info for %s", rointe_device.name)
+
+    dev_registry = dr.async_get(hass)
+
+    if device := dev_registry.async_get_device(
+        identifiers={(DOMAIN, rointe_device.id)},
+    ):
+        dev_registry.async_update_device(
+            device.id, sw_version=rointe_device.firmware_version
+        )


Suggested change

@callback

def device_update_info(hass: HomeAssistant, rointe_device: RointeDevice) -> None:

"""Update device registry info."""

LOGGER.debug("Updating device registry info for %s", rointe_device.name)

dev_registry = dr.async_get(hass)

if device := dev_registry.async_get_device(

identifiers={(DOMAIN, rointe_device.id)},

):

dev_registry.async_update_device(

device.id, sw_version=rointe_device.firmware_version

)

homeassistant/components/rointe/climate.py

github-actions · 2024-04-04T16:05:30Z

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.
If you are the author of this PR, please leave a comment if you want to keep it open. Also, please rebase your PR onto the latest dev branch to ensure that it's up to date with the latest changes.
Thank you for your contribution!

home-assistant bot added cla-signed new-integration integration: rointe labels Dec 1, 2022

tggm mentioned this pull request Dec 1, 2022

Rointe integration home-assistant/home-assistant.io#25118

Closed

8 tasks

tggm force-pushed the rointe-integration branch 2 times, most recently from 50fe6fc to b73e3af Compare December 1, 2022 21:11

tggm marked this pull request as ready for review December 3, 2022 17:46

tggm force-pushed the rointe-integration branch from 8043d3e to 30e8cce Compare December 6, 2022 19:37

bachya reviewed Dec 6, 2022

View reviewed changes

tggm force-pushed the rointe-integration branch from cf88d69 to e8e09ee Compare December 7, 2022 13:52

tggm requested a review from bachya December 8, 2022 17:21

bachya reviewed Dec 8, 2022

View reviewed changes

tggm force-pushed the rointe-integration branch from 35594e7 to 5a3720b Compare December 9, 2022 17:08

tggm requested a review from bachya December 9, 2022 17:12

bachya reviewed Dec 9, 2022

View reviewed changes

tggm force-pushed the rointe-integration branch from f0098d1 to e394f72 Compare December 10, 2022 09:52

tggm requested a review from bachya December 10, 2022 10:24

bachya reviewed Dec 15, 2022

View reviewed changes

bachya changed the title ~~Rointe integration~~ Add Rointe integration Dec 15, 2022

tggm force-pushed the rointe-integration branch 2 times, most recently from fd36f0c to 6639879 Compare December 18, 2022 11:51

tggm requested a review from bachya December 18, 2022 11:57

gjohansson-ST requested changes Sep 26, 2023

View reviewed changes

home-assistant bot marked this pull request as draft September 26, 2023 07:26

tggm force-pushed the rointe-integration branch from b3ee8d2 to 7fba29c Compare September 26, 2023 13:06

tggm requested a review from gjohansson-ST September 27, 2023 21:03

tggm marked this pull request as ready for review October 5, 2023 09:33

emontnemery requested changes Nov 22, 2023

View reviewed changes

home-assistant bot marked this pull request as draft November 22, 2023 20:29

tggm force-pushed the rointe-integration branch 2 times, most recently from 8e7d96e to 20936eb Compare December 24, 2023 17:53

tggm requested a review from emontnemery December 24, 2023 17:54

tggm mentioned this pull request Dec 28, 2023

Target temperature shown in HA doesn’t always match tggm/rointe-radiators#6

Closed

tggm marked this pull request as ready for review December 29, 2023 22:52

tggm added 2 commits December 30, 2023 00:35

Rointe Integration

bae514e

PR fixes

7a80011

tggm force-pushed the rointe-integration branch from e0b6f79 to 7a80011 Compare December 30, 2023 00:35

MartinHjelmare marked this pull request as draft December 30, 2023 00:40

PR Fixes

601b346

tggm marked this pull request as ready for review December 30, 2023 18:15

tggm requested a review from MartinHjelmare December 30, 2023 18:15

joostlek requested changes Jan 2, 2024

View reviewed changes

home-assistant bot marked this pull request as draft January 2, 2024 08:53

PR Fixes

28c9e65

tggm requested a review from joostlek January 2, 2024 19:28

joostlek requested changes Jan 2, 2024

View reviewed changes

MartinHjelmare removed their request for review February 3, 2024 06:55

github-actions bot added the stale label Apr 4, 2024

github-actions bot closed this Apr 11, 2024

github-actions bot locked and limited conversation to collaborators Apr 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Rointe integration #83069

Add Rointe integration #83069

tggm commented Dec 1, 2022 •

edited

Loading

tggm commented Dec 6, 2022

bachya commented Dec 6, 2022

tggm commented Dec 6, 2022

tggm commented Dec 7, 2022

tggm commented Dec 7, 2022

bachya left a comment

tggm commented Dec 15, 2022

tggm commented Dec 18, 2022

bachya commented Dec 18, 2022

gjohansson-ST left a comment

joostlek Jan 2, 2024

tggm Jan 2, 2024

joostlek Jan 2, 2024

tggm Jan 2, 2024

joostlek Jan 2, 2024

joostlek Jan 2, 2024

joostlek Jan 2, 2024

joostlek Jan 2, 2024

tggm Jan 2, 2024

joostlek Jan 2, 2024

joostlek Jan 2, 2024

joostlek Jan 2, 2024

joostlek Jan 2, 2024

github-actions bot commented Apr 4, 2024

	if not user_input or CONF_INSTALLATION not in user_input:
	if not user_input:

Add Rointe integration #83069

Add Rointe integration #83069

Conversation

tggm commented Dec 1, 2022 • edited Loading

Proposed change

Type of change

Additional information

Checklist

tggm commented Dec 6, 2022

bachya commented Dec 6, 2022

tggm commented Dec 6, 2022

tggm commented Dec 7, 2022

tggm commented Dec 7, 2022

bachya left a comment

Choose a reason for hiding this comment

tggm commented Dec 15, 2022

tggm commented Dec 18, 2022

bachya commented Dec 18, 2022

gjohansson-ST 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

Choose a reason for hiding this comment

github-actions bot commented Apr 4, 2024

tggm commented Dec 1, 2022 •

edited

Loading