Add NASweb integration #98118

nasWebio · 2023-08-09T15:15:14Z

Breaking change

Proposed change

Add integration for WEBIO controller.
WEBIO is a specialized microprocessor controller that integrates building automation, intrusion and access control systems.
Eventually device will include few different platforms: switch, sensor, alarm control panel, climate.
Initial PR is limited to implement only relay switches.

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 documentation for NASweb integration home-assistant.io#28516

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

home-assistant · 2023-08-09T15:15:18Z

Hello @nasWebio,

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:

66612caef344449e963355b206748719580d7e33 - This commit has something that looks like an email address (lsum@chomtech.pl). 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@address.com>"
```
  (substituting "Author Name" and "email@address.com" 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! ❤️

home-assistant · 2023-08-09T15:23:58Z

Hi @nasWebio

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!

homeassistant/components/nasweb/config_flow.py

homeassistant/components/nasweb/switch.py

github-actions · 2023-12-09T15:04:45Z

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!

nasWebio · 2023-12-11T09:50:57Z

Still waiting for the review

emontnemery

Some initial comments.

homeassistant/components/nasweb/__init__.py

homeassistant/components/nasweb/coordinator.py

homeassistant/components/nasweb/relay_switch.py

emontnemery · 2024-10-15T07:54:44Z

(Close + Open to run CI against the tip of dev)

emontnemery · 2024-10-15T12:07:50Z

I think the integration is in a good shape now @nasWebio 👍

One concern though: Integrations added to the Home Assistant core repo should be useful for residential users. Looking at your web page, I get the impression you're rather targeting commercial building automation?

nasWebio · 2024-10-17T15:17:02Z

Thank you for your feedback! It's true that our current products are targeted mainly towards commercial building automation. However, we are actively developing a product for the residential market to expand our offering. Home Assistant integration is key to this, as we recognize its importance for homeowners and smart home enthusiasts.
This integration will help us reach residential users and ensure seamless automation for home environments.

emontnemery · 2024-10-21T14:14:54Z

@nasWebio Thanks for confirming! Based on your response, I'd suggest to initially publish your integration as a custom integration installable via HACS. Once the product intended for residential use materializes, you're most welcome to open another PR to add your integration to Home Assistant Core.

chomtech · 2024-10-22T07:33:15Z

@nasWebio I think this is ready for merge soon 👍 There are some old unresolved review comments, can you please go through them and reply to them all? Please don't mark them as resolved yourself. If you need some help getting the PR across the finish line, you're most welcome to contact me on Discord, my username there is @emontnemery.

Hello, and thank you for taking the time to review our integration and share your insights. I truly appreciate your effort and attention to detail!
The nasWebio device is a home and SOHO version of the enterprise Webio system. It has been available for over a year, featuring embedded software for home burglary alarms, one-wire detectors, digital inputs, relay outputs, and some camera-event automation. We’ve already sold several hundred units, many of which use Tuya integration, so this is definitely a real product, not a concept.
I believe moving this to HACS wouldn't be necessary at this stage. Before we started the HA integration process, I had the chance to discuss our approach with Uwe from Nabu Casa. I shared my thoughts and vision for HA, which I’ve been using in my own home. As a result, I chose to shift focus from developing our own cloud solution to embracing the power and versatility of Home Assistant.
Once again, thank you for your support and for helping us refine this integration. If there are any additional comments or feedback, I’d be happy to address them.

emontnemery · 2024-10-22T10:10:42Z

@chomtech thanks for the additional context, with that in mind I think it's OK to accept this integration as a core integration 👍

emontnemery · 2024-10-22T10:21:18Z

The link to the product page in the documentation PR, https://autoidentyfikacja.pl/pl/p/NASweb/262, is not working. Is there another link?

nasWebio · 2024-10-22T12:36:23Z

Link was outdated. Documentation is updated with correct link:
https://www.chomtech.pl/produkt/naswebio-multisystemowy-sterownik-automatyki-budynkowej/

emontnemery

I must have missed the lack of checks for serial number. We should store that as the config entry's unique ID.

emontnemery · 2024-10-23T17:44:02Z

homeassistant/components/nasweb/config_flow.py

+                _LOGGER.exception("Unexpected exception")
+                errors["base"] = "unknown"
+            else:
+                return self.async_create_entry(title=info["title"], data=user_input)


We should set the unique ID to the serial number of the device, and abort the flow if there's already a config entry for the same device. Documentation: https://developers.home-assistant.io/docs/config_entries_config_flow_handler#managing-unique-ids-in-config-flows

emontnemery · 2024-10-23T17:46:04Z

homeassistant/components/nasweb/__init__.py

+DATA_NASWEB: HassKey[NASwebData] = HassKey(DOMAIN)
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: NASwebConfigEntry) -> bool:


During setup, we should check that the serial number of the device we're connecting to is matching the stored serial number (the config entry's unique ID), in case the device's IP address has changed.

emontnemery · 2024-10-23T17:48:08Z

homeassistant/components/nasweb/__init__.py

+    if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS):
+        nasweb_data = hass.data[DATA_NASWEB]
+        coordinator = entry.runtime_data
+        serial = coordinator.webio_api.get_serial_number()


Change to config entry's unique id

emontnemery · 2024-10-23T17:48:17Z

homeassistant/components/nasweb/switch.py

+        async_add_entities(entities_to_add)
+        entity_registry = er.async_get(hass)
+        for index in removed:
+            unique_id = f"{DOMAIN}.{coordinator.webio_api.get_serial_number()}.relay_switch.{index}"


Change to config entry's unique id

emontnemery

Please update config entry tests:

Assert the config entry's unique id is the serial number of the device
Add a test where we try to add the same device twice, the flow should be aborted

homeassistant/components/nasweb/config_flow.py

emontnemery

One more remark

homeassistant/components/nasweb/config_flow.py

emontnemery

LGTM, thanks for the patience with the review @nasWebio 👍

home-assistant bot added cla-error has-tests new-integration integration: nasweb labels Aug 9, 2023

nasWebio mentioned this pull request Aug 9, 2023

Add documentation for NASweb integration home-assistant/home-assistant.io#28516

Merged

8 tasks

nasWebio force-pushed the nasweb branch from 66612ca to b84f1f3 Compare August 9, 2023 15:23

home-assistant bot added the cla-needed label Aug 9, 2023

home-assistant bot added cla-recheck cla-signed and removed cla-recheck cla-needed labels Aug 9, 2023

nasWebio force-pushed the nasweb branch from b84f1f3 to 3fd233c Compare August 9, 2023 15:27

gjohansson-ST removed the cla-error label Aug 13, 2023

nasWebio force-pushed the nasweb branch from 3fd233c to 2b37b20 Compare August 16, 2023 10:29

nasWebio mentioned this pull request Aug 16, 2023

Add icon and logo for nasweb integration home-assistant/brands#4592

Merged

11 tasks

IsakNyberg reviewed Aug 22, 2023

View reviewed changes

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

homeassistant/components/nasweb/switch.py Outdated Show resolved Hide resolved

homeassistant/components/nasweb/switch.py Outdated Show resolved Hide resolved

nasWebio force-pushed the nasweb branch from 2b37b20 to a8c82b9 Compare August 23, 2023 15:10

nasWebio requested a review from IsakNyberg August 28, 2023 15:14

nasWebio force-pushed the nasweb branch from a8c82b9 to a14da15 Compare September 8, 2023 15:07

nasWebio force-pushed the nasweb branch from a14da15 to 14e42ed Compare September 28, 2023 14:47

nasWebio force-pushed the nasweb branch from 14e42ed to a335c13 Compare October 10, 2023 14:13

github-actions bot added the stale label Dec 9, 2023

github-actions bot removed the stale label Dec 11, 2023

emontnemery closed this Dec 14, 2023

emontnemery reopened this Dec 14, 2023

emontnemery requested changes Dec 14, 2023

View reviewed changes

emontnemery reopened this Oct 15, 2024

emontnemery closed this Oct 15, 2024

emontnemery reopened this Oct 15, 2024

emontnemery requested changes Oct 23, 2024

View reviewed changes

home-assistant bot marked this pull request as draft October 23, 2024 17:49

Use serial number as config entry id

a7596cc

nasWebio marked this pull request as ready for review October 24, 2024 12:42

home-assistant bot requested a review from emontnemery October 24, 2024 12:42

emontnemery requested changes Nov 7, 2024

View reviewed changes

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

home-assistant bot marked this pull request as draft November 7, 2024 09:28

nasWebio added 2 commits November 7, 2024 15:08

Catch AbortFlow exception

3f04e9f

Update tests to check ConfigEntry Unique ID

d9ac106

nasWebio marked this pull request as ready for review November 7, 2024 14:42

home-assistant bot requested a review from emontnemery November 7, 2024 14:42

emontnemery requested changes Nov 8, 2024

View reviewed changes

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

home-assistant bot marked this pull request as draft November 8, 2024 08:17

Remove unnecessary form abort

c1bf8f0

nasWebio marked this pull request as ready for review November 8, 2024 09:29

home-assistant bot requested a review from emontnemery November 8, 2024 09:29

emontnemery approved these changes Nov 8, 2024

View reviewed changes

emontnemery merged commit ed1366f into home-assistant:dev Nov 8, 2024
42 checks passed

github-actions bot locked and limited conversation to collaborators Nov 9, 2024

		DATA_NASWEB: HassKey[NASwebData] = HassKey(DOMAIN)


		async def async_setup_entry(hass: HomeAssistant, entry: NASwebConfigEntry) -> bool:

Uh oh!

Add NASweb integration #98118

Add NASweb integration #98118

Uh oh!

Conversation

nasWebio commented Aug 9, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking change

Proposed change

Type of change

Additional information

Checklist

Uh oh!

home-assistant bot commented Aug 9, 2023

Uh oh!

home-assistant bot commented Aug 9, 2023

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Dec 9, 2023

Uh oh!

nasWebio commented Dec 11, 2023

Uh oh!

emontnemery 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!

Uh oh!

Uh oh!

emontnemery commented Oct 15, 2024

Uh oh!

emontnemery commented Oct 15, 2024

Uh oh!

nasWebio commented Oct 17, 2024

Uh oh!

emontnemery commented Oct 21, 2024

Uh oh!

chomtech commented Oct 22, 2024

Uh oh!

emontnemery commented Oct 22, 2024

Uh oh!

emontnemery commented Oct 22, 2024

Uh oh!

nasWebio commented Oct 22, 2024

Uh oh!

emontnemery left a comment

Choose a reason for hiding this comment

Uh oh!

emontnemery Oct 23, 2024

Choose a reason for hiding this comment

Uh oh!

emontnemery Oct 23, 2024

Choose a reason for hiding this comment

Uh oh!

emontnemery Oct 23, 2024

Choose a reason for hiding this comment

Uh oh!

emontnemery Oct 23, 2024

Choose a reason for hiding this comment

Uh oh!

emontnemery left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

emontnemery left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

emontnemery left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

nasWebio commented Aug 9, 2023 •

edited

Loading