Add Zimi Cloud Connect Integration #129876

mhannon11 · 2024-11-05T08:49:05Z

Proposed change

Add support for the Zimi Cloud Connect and Zimi lights in Home Assistant. This is a follow up on an old pull request here: #106449. This pull request answers a list of feedback from @emontnemery and requested changes based from that pull request, in summary those changes are:

Adding support for a single entity (lights) to create as small a PR as possible
Adding full test coverage for the config_flow
Adding async_unload_entry to the init.py
Using the ZCC MAC address for registering unique entry ids
Series of smaller changes

Note: This is the first of hopefully a few sequential pull requests. Further pull requests will deliver support for other Zimi devices.

Dependencies:

zcc-helper: https://pypi.org/project/zcc-helper/

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

This PR fixes or closes issue: fixes #
This PR is related to issue: Add Zimi Cloud Controller integration #106449
Link to documentation pull request: Add Zimi Cloud Controller Documentation home-assistant.io#36668

Checklist

[ X] The code change is tested and works locally.
[ X] Local tests pass. Your PR cannot be merged unless tests pass
[ X] There is no commented out code in this PR.
[X ] I have followed the development checklist
[ X] I have followed the perfect PR recommendations
[ X] The code has been formatted using Ruff (ruff format homeassistant tests)
[ X] 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:

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

To help with the load of incoming pull requests:

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

zweckj

some first feedback

homeassistant/components/zimi/__init__.py

homeassistant/components/zimi/config_flow.py

Co-authored-by: Josef Zweck <24647999+zweckj@users.noreply.github.com>

markhannon · 2024-11-07T10:07:26Z

Hi @zweckj
Thanks for your review - we have responded / updated to each item except for one that we are unsure of. Can you have another looks please?

homeassistant/components/zimi/config_flow.py

homeassistant/components/zimi/light.py

homeassistant/components/zimi/controller.py

homeassistant/components/zimi/__init__.py

homeassistant/components/zimi/light.py

homeassistant/components/zimi/manifest.json

homeassistant/components/zimi/strings.json

frenck · 2024-11-08T22:08:13Z

I've marked this PR a draft, as changes are requested that need to be processed.
Please un-draft it once it is ready for review again by clicking the "Ready for review" button.

Thanks! 👍

../Frenck

Learn more about our pull request process.

…ed for runtime_data)

…ation, simpler defaults, better description data

markhannon · 2025-05-01T21:14:56Z

Fixed a couple of ruff and mypi errors in latest commit

markhannon · 2025-05-02T12:10:33Z

@zweckj Hi Josef, lots of cleanup since you last reviewed, can you review again please?

homeassistant/components/zimi/config_flow.py

homeassistant/components/zimi/strings.json

MartinHjelmare

Thanks!

MartinHjelmare · 2025-05-03T11:56:08Z

Are we ready to merge? If so, please press the Ready for review button.

zweckj · 2025-05-03T12:01:52Z

homeassistant/components/zimi/quality_scale.yaml

+  devices: done
+  entity-category: todo
+  entity-disabled-by-default: todo
+  discovery:


We can’t automatically connect it, but can we not at least discover it to show it’s supported? (Might be that we already discussed this, it’s been a while 😅)

homeassistant/components/zimi/quality_scale.yaml

homeassistant/components/zimi/strings.json

markhannon · 2025-05-04T12:28:18Z

I saw in the last workflow run a couple of failures. The first one is this one:

What should I do here? Is this the setup tools that is pulled in by zcc-helper?

markhannon · 2025-05-04T12:30:11Z

The second error in the workflow is from a code coverage run. I thought I only need test cases for the config_flow?

This seems to say I need test cases for all files in the PR??

https://app.codecov.io/gh/home-assistant/core/pull/129876

Addressed

zweckj · 2025-05-04T14:00:53Z

Thanks - test failures were unrelated 👍 Please share your Discord users (or message me on Discord), so we can add you to the relevant channels.

markhannon · 2025-05-04T23:02:21Z

Thanks - test failures were unrelated 👍 Please share your Discord users (or message me on Discord), so we can add you to the relevant channels.

I am markhannon on Discord

joostlek

Please address the issues in a separate PR

joostlek · 2025-05-04T14:02:26Z

homeassistant/components/zimi/__init__.py

+        config_entry_id=entry.entry_id,
+        identifiers={(DOMAIN, api.mac)},
+        manufacturer=api.brand,
+        name=f"{api.network_name}",


Why is this in an f string? if its typed str | None rather use assert, if its something else use str()

joostlek · 2025-05-05T16:55:27Z

homeassistant/components/zimi/light.py

+    ]
+
+    lights.extend(
+        [ZimiDimmer(device, api) for device in api.lights if device.type == "dimmer"]


Suggested change

[ZimiDimmer(device, api) for device in api.lights if device.type == "dimmer"]

ZimiDimmer(device, api) for device in api.lights if device.type == "dimmer"

joostlek · 2025-05-05T16:56:03Z

homeassistant/components/zimi/light.py

+        if self._device.type != "dimmer":
+            raise ValueError("ZimiDimmer needs a dimmable light")


We should not raise exceptions in a constructor

joostlek · 2025-05-05T17:00:15Z

homeassistant/components/zimi/quality_scale.yaml

+  dependency-transparency:
+    status: done
+    comment: |
+      https://mark_hannon@bitbucket.org/mark_hannon/zcc.git


I don't see an automated action to build and publish the dependency

joostlek · 2025-05-05T17:01:51Z

tests/components/zimi/test_config_flow.py

+    assert result["type"] is FlowResultType.CREATE_ENTRY
+    assert result["data"] == {
+        "host": INPUT_HOST,
+        "port": INPUT_PORT,
+        "mac": format_mac(INPUT_MAC),
+    }
+


We should also assert the unique id

markhannon · 2025-05-05T21:56:09Z

homeassistant/components/zimi/init.py

Thanks - I will gather cleanup feedback and action in #144293

mhannon11 added 4 commits November 5, 2024 08:25

Give entry unique id with MAC, strings.json tweaks

6ff810a

Update codeowners

1b01fff

Add config_flow tests

c260185

Update requirements

24ad13a

home-assistant bot added cla-signed has-tests integration: zimi new-integration labels Nov 5, 2024

mhannon11 changed the title ~~Zimi~~ Add Zimi Cloud Connect Integration Nov 5, 2024

mhannon11 mentioned this pull request Nov 5, 2024

Add Zimi Cloud Controller Documentation home-assistant/home-assistant.io#35578

Closed

5 tasks

zweckj reviewed Nov 5, 2024

View reviewed changes

markhannon and others added 7 commits November 7, 2024 00:52

Update homeassistant/components/zimi/__init__.py

97650a2

Co-authored-by: Josef Zweck <24647999+zweckj@users.noreply.github.com>

Update homeassistant/components/zimi/config_flow.py

c7d9417

Co-authored-by: Josef Zweck <24647999+zweckj@users.noreply.github.com>

Update homeassistant/components/zimi/config_flow.py

7ceaa42

Co-authored-by: Josef Zweck <24647999+zweckj@users.noreply.github.com>

Merge branch 'dev' into zimi

66c0443

Store controller reference in entry.runtime_data instead of hass.data

280f851

Merge branch 'dev' into zimi

d0f51ea

Add typing

6daf1f3

zweckj requested changes Nov 7, 2024

View reviewed changes

Merge branch 'home-assistant:dev' into zimi

d5e03fc

frenck marked this pull request as draft November 8, 2024 22:08

markhannon added 7 commits November 10, 2024 03:47

Removed hass data pop on unload. (No longer needed when hass data mov…

a48f389

…ed for runtime_data)

Refactor config_flow based on feedback from @zweckj with inline valid…

7998adc

…ation, simpler defaults, better description data

Merge branch 'dev' into zimi

7ce11f0

Add Michael to codeowners

1085120

Remove manual debug override in entity

78ed317

Populate via_device

a7917f7

remove empty keys from manifest.json

e7bbf4e

Merge branch 'dev' into zimi

a63f911

MartinHjelmare reviewed May 2, 2025

View reviewed changes

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

Add tests for missing connection exceptions

a29d2d4

NoRi2909 reviewed May 3, 2025

View reviewed changes

homeassistant/components/zimi/strings.json Outdated Show resolved Hide resolved

Added standard invalid_host and timeout strings

18c5d7f

MartinHjelmare approved these changes May 3, 2025

View reviewed changes

zweckj reviewed May 3, 2025

View reviewed changes

mhannon11 marked this pull request as ready for review May 3, 2025 12:07

home-assistant bot requested a review from zweckj May 3, 2025 12:07

markhannon added 2 commits May 3, 2025 22:21

Explain limitations in discovery.

b164e00

Merge branch 'dev' into zimi

bdaebc8

zweckj approved these changes May 4, 2025

View reviewed changes

homeassistant/components/zimi/quality_scale.yaml Outdated Show resolved Hide resolved

homeassistant/components/zimi/quality_scale.yaml Outdated Show resolved Hide resolved

zweckj added 2 commits May 4, 2025 09:58

Update quality_scale.yaml

1806f42

Update quality_scale.yaml

2da20dd

NoRi2909 reviewed May 4, 2025

View reviewed changes

homeassistant/components/zimi/strings.json Outdated Show resolved Hide resolved

Removed duplicate strings with reference

8474ea8

Merge branch 'dev' into zimi

c078712

zweckj merged commit 0953181 into home-assistant:dev May 4, 2025
43 of 44 checks passed

joostlek requested changes May 5, 2025

View reviewed changes

markhannon mentioned this pull request May 5, 2025

Minor cleanup of Zimi Integration #144293

Merged

18 tasks

github-actions bot locked and limited conversation to collaborators May 6, 2025

	[ZimiDimmer(device, api) for device in api.lights if device.type == "dimmer"]
	ZimiDimmer(device, api) for device in api.lights if device.type == "dimmer"

		if self._device.type != "dimmer":
		raise ValueError("ZimiDimmer needs a dimmable light")

Uh oh!

Add Zimi Cloud Connect Integration #129876

Add Zimi Cloud Connect Integration #129876

Uh oh!

Conversation

mhannon11 commented Nov 5, 2024 • edited by zweckj Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Uh oh!

zweckj left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

markhannon commented Nov 7, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

frenck commented Nov 8, 2024

Uh oh!

markhannon commented May 1, 2025

Uh oh!

markhannon commented May 2, 2025

Uh oh!

Uh oh!

Uh oh!

MartinHjelmare left a comment

Choose a reason for hiding this comment

Uh oh!

MartinHjelmare commented May 3, 2025

Uh oh!

zweckj May 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

markhannon commented May 4, 2025

Uh oh!

markhannon commented May 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

zweckj commented May 4, 2025

Uh oh!

markhannon commented May 4, 2025

Uh oh!

joostlek left a comment

Choose a reason for hiding this comment

Uh oh!

joostlek May 4, 2025

Choose a reason for hiding this comment

Uh oh!

joostlek May 5, 2025

Choose a reason for hiding this comment

Uh oh!

joostlek May 5, 2025

Choose a reason for hiding this comment

Uh oh!

joostlek May 5, 2025

Choose a reason for hiding this comment

Uh oh!

joostlek May 5, 2025

mhannon11 commented Nov 5, 2024 •

edited by zweckj

Loading

markhannon commented May 4, 2025 •

edited

Loading