Add new integration for AiDot #137504

s1eedz · 2025-02-06T03:07:53Z

Breaking change

Proposed change

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:
Link to documentation pull request: Add new integration for AiDot home-assistant.io#37320
Link to developer documentation pull request:
Link to frontend pull request:
This uses the third-party python-aidot Python module available at https://github.com/AiDot-Development-Team/python-AiDot

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
I have followed the perfect PR recommendations
The code has been formatted using Ruff (ruff format 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.

To help with the load of incoming pull requests:

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

home-assistant

Hi @HongBryan

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

home-assistant · 2025-02-06T03:07:58Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Stale

s1eedz

Hi all,
Do I need to modify anything in this current PR? I see that there has been no new news for a long time. What is wrong with this PR? What can I modify so that it can be merged smoothly?
Regards

homeassistant/components/aidot/__init__.py

homeassistant/components/aidot/config_flow.py

homeassistant/components/aidot/light.py

zweckj · 2025-02-17T08:26:27Z

Hi all, Do I need to modify anything in this current PR? I see that there has been no new news for a long time. What is wrong with this PR? What can I modify so that it can be merged smoothly? Regards

Two weeks is not a long time with a backlog of over 500 PRs. Just be patient please.

zweckj

this is also missing a quality_scale.yaml file, matching our quality scale and reaching at least bronze

homeassistant/components/aidot/manifest.json

homeassistant/components/aidot/const.py

homeassistant/components/aidot/__init__.py

homeassistant/components/aidot/config_flow.py

home-assistant

Hello @s1eedz,

When attempting to inspect the commits of your pull request for CLA signature status among all authors we encountered commit(s) which were not linked to a GitHub account, thus not allowing us to determine their status(es).

The commits that are missing a linked GitHub account are the following:

cd8ba2ad67e19dd9b83c108e0ecd664cd8b71d13 - This commit has something that looks like an email address ([email protected]). Maybe try linking that to GitHub?.

Unfortunately, we are unable to accept this pull request until this situation is corrected.

Here are your options:

If you had an email address set for the commit that simply wasn't linked to your GitHub account you can link that email now and it will retroactively apply to your commits. The simplest way to do this is to click the link to one of the above commits and look for a blue question mark in a blue circle in the top left. Hovering over that bubble will show you what email address you used. Clicking on that button will take you to your email address settings on GitHub. Just add the email address on that page and you're all set. GitHub has more information about this option in their help center.
If you didn't use an email address at all, it was an invalid email, or it's one you can't link to your GitHub, you will need to change the authorship information of the commit and your global Git settings so this doesn't happen again going forward. GitHub provides some great instructions on how to change your authorship information in their help center.
- If you only made a single commit you should be able to run
```
git commit --amend --author="Author Name <[email protected]>"
```
  (substituting "Author Name" and "[email protected]" for your actual information) to set the authorship information.
- If you made more than one commit and the commit with the missing authorship information is not the most recent one you have two options:
  1. You can re-create all commits missing authorship information. This is going to be the easiest solution for developers that aren't extremely confident in their Git and command line skills.
  2. You can use this script that GitHub provides to rewrite history. Please note: this should be used only if you are very confident in your abilities and understand its impacts.
- Whichever method you choose, I will come by to re-check the pull request once you push the fixes to this branch.

We apologize for this inconvenience, especially since it usually bites new contributors to Home Assistant. We hope you understand the need for us to protect ourselves and the great community we all have built legally. The best thing to come out of this is that you only need to fix this once and it benefits the entire Home Assistant and GitHub community.

Thanks, I look forward to checking this PR again soon! ❤️

Stale

homeassistant/components/aidot/__init__.py

homeassistant/components/aidot/config_flow.py

homeassistant/components/aidot/coordinator.py

homeassistant/components/aidot/config_flow.py

zweckj · 2025-02-20T08:04:50Z

homeassistant/components/aidot/__init__.py

+        entry.data[CONF_DEVICE_LIST],
+        entry.data[CONF_LOGIN_RESPONSE],
+        entry.data[CONF_PRODUCT_LIST],


Suggested change

entry.data[CONF_DEVICE_LIST],

entry.data[CONF_LOGIN_RESPONSE],

entry.data[CONF_PRODUCT_LIST],

you already pass the entry, you can get it in the corodinator

zweckj · 2025-02-20T08:05:39Z

homeassistant/components/aidot/__init__.py

+    def discover(dev_id, event: Mapping[str, Any]):
+        hass.bus.async_fire(dev_id, event)
+
+    try:
+        await Discover().broadcast_message(
+            discover, coordinator.login_response[CONF_ID]
+        )
+    except OSError as err:
+        raise ConfigEntryError from err


move that to _async_setup in the coordinator

zweckj · 2025-02-20T08:06:51Z

homeassistant/components/aidot/__init__.py

+        entry.data[CONF_LOGIN_RESPONSE],
+        entry.data[CONF_PRODUCT_LIST],
+    )
+    entry.runtime_data = coordinator


Suggested change

entry.runtime_data = coordinator

await coordinator.async_config_entry_first_refresh()

entry.runtime_data = coordinator

refresh the coordinator once

zweckj · 2025-02-20T08:07:46Z

homeassistant/components/aidot/config_flow.py

+                    self.house_list = await self.__login_control.async_get_houses(
+                        self.hass, self.accessToken
+                    )
+                    if self.house_list is None or len(self.house_list) == 0:


Suggested change

if self.house_list is None or len(self.house_list) == 0:

if not self.house_list:

achieves the same

zweckj · 2025-02-20T08:08:40Z

homeassistant/components/aidot/config_flow.py

+        input_username: str = ""
+        input_password: str = ""


Suggested change

input_username: str = ""

input_password: str = ""

zweckj · 2025-02-20T08:09:11Z

homeassistant/components/aidot/config_flow.py

+            input_username = user_input[CONF_USERNAME]
+            input_password = user_input[CONF_PASSWORD]


Suggested change

input_username = user_input[CONF_USERNAME]

input_password = user_input[CONF_PASSWORD]

I don't like signle use variables

zweckj · 2025-02-20T08:10:32Z

homeassistant/components/aidot/config_flow.py

+            input_password = user_input[CONF_PASSWORD]
+            try:
+                self.login_response = await self.__login_control.async_post_login(
+                    self.hass,


why do you pass a HomeAssistant object to your lib? That's very likely an indication that's something's off, your lib shouldn't need to know about HA specific objects

zweckj · 2025-02-20T08:11:17Z

homeassistant/components/aidot/config_flow.py

+                vol.Required(CONF_USERNAME, default=input_username): str,
+                vol.Required(CONF_PASSWORD, default=input_password): str,
+            }
+        )


you can do self.add_suggested_values_to_schema if you got user input to avoid those variables

zweckj · 2025-02-20T08:13:10Z

homeassistant/components/aidot/config_flow.py

+            try:
+                # get device_list
+                device_list: list[
+                    dict[str, Any]
+                ] = await self.__login_control.async_get_devices(
+                    self.hass, self.accessToken, selected_house[CONF_ID]
+                )
+                product_list: list[dict[str, Any]] = []
+                if device_list is not None:
+                    # get product_list
+                    productIds = ",".join(
+                        [item[CONF_PRODUCT_ID] for item in device_list]
+                    )
+                    product_list = await self.__login_control.async_get_products(
+                        self.hass, self.accessToken, productIds
+                    )


don't get those here and store them in the entry. We can get them in the coordinator later

zweckj · 2025-02-20T08:14:38Z

homeassistant/components/aidot/coordinator.py

+type AidotConfigEntry = ConfigEntry[AidotCoordinator]
+
+
+class AidotCoordinator:


how are you planning to update your entities? Currently you're not updating anything. The coordinator will need an _async_update method (except if you're planning to push updates to HA)

We only save the list data here and will not make any updates. We notify HA of device status updates through async_update_ha_state

but that would mean the light is out of sync with HA if it gets controlled from elsewhere

Are you saying that I need to write a schedule here to retrieve the device list, and once the device list is updated, it will be synchronized to the page in real time. Can I rephrase it so that when the user clicks to reload the module, I can pull down the device list again and synchronize it? If I go to our server regularly to pull the device list, wouldn't it be too wasteful of resources, because the device list usually doesn't change unless a new device is added

no one is talking about real time. The coordinator will automatically poll an endpoint, but we should think how you want to update the state of your devices (not the devices necessarily, but that's also something we do, but not in the first step)

Okay, I will make changes based on your suggestions. Thank you for your suggestion

s1eedz and others added 9 commits July 7, 2024 22:43

Add new integration for aidot

c38868b

fix ci work run error

83ec82c

fix ci work run error 2

beda1a9

modify the test data and code

43bf742

Modifying unit tests

6ea582a

Increase unit test coverage

a0d89a8

Increase unit test coverage

ac5cfdd

Increase unit test coverage

b338428

完善单元测试

2e7a9e0

home-assistant bot previously requested changes Feb 6, 2025

View reviewed changes

home-assistant bot added cla-needed has-tests integration: aidot new-integration labels Feb 6, 2025

home-assistant bot marked this pull request as draft February 6, 2025 03:07

s1eedz changed the title ~~Feature/aidot wifi lights improve~~ Add new integration for AiDot Feb 6, 2025

This was referenced Feb 6, 2025

Add new integration for AiDot home-assistant/home-assistant.io#37320

Open

Add icons to Aidot domain home-assistant/brands#6504

Open

home-assistant bot added cla-recheck cla-signed and removed cla-recheck cla-needed labels Feb 6, 2025

add owner

159b788

HongBryan approved these changes Feb 6, 2025

View reviewed changes

s1eedz marked this pull request as ready for review February 6, 2025 08:41

Merge branch 'dev' into feature/aidot-wifi-lights-improve

5ee7657

s1eedz commented Feb 12, 2025

View reviewed changes

CloCkWeRX reviewed Feb 15, 2025

View reviewed changes

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

CloCkWeRX reviewed Feb 15, 2025

View reviewed changes

homeassistant/components/aidot/config_flow.py Outdated Show resolved Hide resolved

CloCkWeRX reviewed Feb 15, 2025

View reviewed changes

homeassistant/components/aidot/light.py Outdated Show resolved Hide resolved

Fix

d47971b

Update config_flow.py

68866f7

zweckj requested changes Feb 17, 2025

View reviewed changes

home-assistant bot marked this pull request as draft February 17, 2025 08:36

home-assistant bot previously requested changes Feb 18, 2025

View reviewed changes

home-assistant bot added cla-error quality-scale labels Feb 18, 2025

s1eedz force-pushed the feature/aidot-wifi-lights-improve branch from cd8ba2a to 64532e9 Compare February 18, 2025 11:59

fix and add quality_scale.yaml

477146f

s1eedz force-pushed the feature/aidot-wifi-lights-improve branch from 64532e9 to 477146f Compare February 18, 2025 12:02

s1eedz marked this pull request as ready for review February 18, 2025 12:19

home-assistant bot requested a review from zweckj February 18, 2025 12:19

zweckj marked this pull request as draft February 18, 2025 12:27

Remove non-conforming codes

2af0696

s1eedz marked this pull request as ready for review February 19, 2025 06:47

zweckj requested changes Feb 19, 2025

View reviewed changes

home-assistant bot marked this pull request as draft February 19, 2025 07:52

HongBryan added 3 commits February 19, 2025 16:41

Remove VERSION and CONNECTION_CLASS from config_flow.py

87acc91

use entry.runtime_data instead and fix

d371f97

Fix

37a0912

s1eedz marked this pull request as ready for review February 20, 2025 07:17

home-assistant bot requested a review from zweckj February 20, 2025 07:17

zweckj reviewed Feb 20, 2025

View reviewed changes

zweckj requested changes Feb 20, 2025

View reviewed changes

home-assistant bot marked this pull request as draft February 20, 2025 08:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add new integration for AiDot #137504

Add new integration for AiDot #137504

s1eedz commented Feb 6, 2025 •

edited

Loading

home-assistant bot left a comment

home-assistant bot commented Feb 6, 2025

s1eedz left a comment •

edited

Loading

zweckj commented Feb 17, 2025

zweckj left a comment

home-assistant bot left a comment

zweckj Feb 20, 2025

zweckj Feb 20, 2025

zweckj Feb 20, 2025

zweckj Feb 20, 2025

zweckj Feb 20, 2025

zweckj Feb 20, 2025

zweckj Feb 20, 2025

zweckj Feb 20, 2025

zweckj Feb 20, 2025

zweckj Feb 20, 2025

s1eedz Feb 20, 2025 •

edited

Loading

zweckj Feb 20, 2025

s1eedz Feb 20, 2025 •

edited

Loading

zweckj Feb 20, 2025

s1eedz Feb 20, 2025

	entry.data[CONF_DEVICE_LIST],
	entry.data[CONF_LOGIN_RESPONSE],
	entry.data[CONF_PRODUCT_LIST],

	entry.runtime_data = coordinator
	await coordinator.async_config_entry_first_refresh()
	entry.runtime_data = coordinator

	if self.house_list is None or len(self.house_list) == 0:
	if not self.house_list:

		input_username = user_input[CONF_USERNAME]
		input_password = user_input[CONF_PASSWORD]

		type AidotConfigEntry = ConfigEntry[AidotCoordinator]


		class AidotCoordinator:

Add new integration for AiDot #137504

Are you sure you want to change the base?

Add new integration for AiDot #137504

Conversation

s1eedz commented Feb 6, 2025 • edited Loading

Breaking change

Proposed change

Type of change

Additional information

Checklist

home-assistant bot left a comment

Choose a reason for hiding this comment

home-assistant bot commented Feb 6, 2025

s1eedz left a comment • edited Loading

Choose a reason for hiding this comment

zweckj commented Feb 17, 2025

zweckj left a comment

Choose a reason for hiding this comment

home-assistant bot 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

s1eedz Feb 20, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s1eedz Feb 20, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

s1eedz commented Feb 6, 2025 •

edited

Loading

s1eedz left a comment •

edited

Loading

s1eedz Feb 20, 2025 •

edited

Loading

s1eedz Feb 20, 2025 •

edited

Loading