Add Grandstream Home integration by wtxu-gs · Pull Request #167872 · home-assistant/core

wtxu-gs · 2026-04-10T07:40:30Z

This integration adds support for Grandstream GDS/GNS/GSC devices.

Features:

System status sensors
Zeroconf discovery

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 Grandstream Home integration documentation
Link to brands pull request: Add grandstream brand assets

Checklist

I understand the code I am submitting and can explain how it works.
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.
Any generated code has been carefully reviewed for correctness and compliance with project standards.

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 diff between library versions and ideally a link to the changelog/release notes 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.

mawoka-myblock · 2026-04-10T08:09:02Z

The source for the library is missing: https://github.com/GrandstreamEngineering/grandstream_home_api

wtxu-gs · 2026-04-10T08:42:26Z

The source for the library is missing: https://github.com/GrandstreamEngineering/grandstream_home_api

It is added now

wtxu-gs · 2026-04-10T09:12:45Z

docs PR: home-assistant/home-assistant.io#44623

edenhaus

I did an initial review until I stopped as this PR is to huge. Some code needs to move to the library and also the config flow is huge. Please refactor the code and make it more readable.

Also the library needs a working workflow to deploy directly to pypi.
As 10.000 changes is to much, can we just add a single device/model in this PR and then add other models in a follow up PR. This PR needs to be a lot smaller

edenhaus · 2026-04-10T11:52:20Z

homeassistant/components/grandstream_home/quality_scale.yaml

+  unique-config-entry: done
+
+  # Silver
+  action-exceptions: done


Please set all rules except the bronze one to todo. As they need to be evaluated after the integration was added

edenhaus · 2026-04-10T11:54:59Z

homeassistant/components/grandstream_home/__init__.py

+async def _handle_existing_device(
+    hass: HomeAssistant, unique_id: str, name: str, device_type: str
+) -> None:
+    """Check and update existing device if found."""
+    device_registry = dr.async_get(hass)
+
+    for dev in device_registry.devices.values():
+        for identifier in dev.identifiers:
+            if identifier[0] == DOMAIN and identifier[1] == unique_id:
+                _LOGGER.info("Found existing device: %s, name: %s", dev.id, dev.name)
+
+                # Update device attributes
+                device_registry.async_update_device(
+                    dev.id,
+                    name=name,
+                    manufacturer="Grandstream",
+                    model=device_type,
+                )
+                return


Why is this needed?

edenhaus · 2026-04-10T11:55:28Z

homeassistant/components/grandstream_home/__init__.py

+        api = await _setup_api_with_error_handling(hass, entry, device_type)
+
+        # Store API in runtime_data (required for Bronze quality scale)
+        entry.runtime_data = {"api": api}


Use a typed classed not a dictionary

edenhaus · 2026-04-10T11:55:49Z

homeassistant/components/grandstream_home/__init__.py

+        hass.data.setdefault(DOMAIN, {})
+        hass.data[DOMAIN][entry.entry_id] = {}


Suggested change

hass.data.setdefault(DOMAIN, {})

hass.data[DOMAIN][entry.entry_id] = {}

Use runtime data instead

edenhaus · 2026-04-10T11:56:43Z

homeassistant/components/grandstream_home/__init__.py

+        raise  # Let auth failures propagate to trigger reauth flow
+    except Exception as e:
+        _LOGGER.exception("Error setting up integration")
+        raise ConfigEntryNotReady("Integration setup failed") from e


We should not put all code into the try catch block. Just put the code in it, which is also raising the specific exceptions

edenhaus · 2026-04-10T12:09:58Z

homeassistant/components/grandstream_home/device.py

+            return self.device_model
+        return self.device_type or "Unknown"
+
+    def _register_device(self) -> None:


Why are you needing this?

device_info is in the most cases enough as the device will be created and also updated. Just make sure to have a unique identifier

edenhaus · 2026-04-10T12:10:21Z

homeassistant/components/grandstream_home/error.py

+"""Custom exceptions for Grandstream Home integration - re-exported from library."""
+
+from grandstream_home_api.error import (
+    GrandstreamError,
+    GrandstreamHAControlDisabledError,
+)
+
+__all__ = [
+    "GrandstreamError",
+    "GrandstreamHAControlDisabledError",
+]


Suggested change

"""Custom exceptions for Grandstream Home integration - re-exported from library."""

from grandstream_home_api.error import (

GrandstreamError,

GrandstreamHAControlDisabledError,

)

__all__ = [

"GrandstreamError",

"GrandstreamHAControlDisabledError",

]

Makes no sense

edenhaus · 2026-04-10T12:11:22Z

homeassistant/components/grandstream_home/manifest.json

+{
+  "domain": "grandstream_home",
+  "name": "Grandstream Home",
+  "codeowners": ["@GrandstreamEngineering"],


You should be the code owner and not a random user. If you want to add them too, then they need to comment on this PR, thats it's fine for them to be code owner

GrandstreamEngineering is an organization

edenhaus · 2026-04-10T12:11:36Z

homeassistant/components/grandstream_home/manifest.json

+  "name": "Grandstream Home",
+  "codeowners": ["@GrandstreamEngineering"],
+  "config_flow": true,
+  "dependencies": [],


Remove empty ones

edenhaus · 2026-04-10T12:12:06Z

homeassistant/components/grandstream_home/sensor.py

+        )
+
+    @staticmethod
+    def _get_by_path(data: dict[str, Any], path: str, index: int | None = None):


Need to be in the libary

home-assistant · 2026-04-10T12:15:38Z

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.

Copilot AI review requested due to automatic review settings April 10, 2026 07:40

home-assistant bot added cla-signed has-tests integration: grandstream_home new-integration quality-scale labels Apr 10, 2026

Copilot started reviewing on behalf of wtxu-gs April 10, 2026 07:41 View session

wtxu-gs force-pushed the feat/grandstream_home branch 2 times, most recently from d30e08d to fef1454 Compare April 10, 2026 07:53

c0ffeeca7 mentioned this pull request Apr 10, 2026

Add Grandstream Home integration documentation home-assistant/home-assistant.io#44617

Closed

7 tasks

wtxu-gs force-pushed the feat/grandstream_home branch 2 times, most recently from 8aad180 to 39a400b Compare April 10, 2026 08:04

wtxu-gs force-pushed the feat/grandstream_home branch 4 times, most recently from f443b7c to aa77908 Compare April 10, 2026 08:37

wtxu-gs force-pushed the feat/grandstream_home branch from aa77908 to 8a3b791 Compare April 10, 2026 08:43

Add Grandstream Home integration

0b3e604

wtxu-gs force-pushed the feat/grandstream_home branch from 8a3b791 to 0b3e604 Compare April 10, 2026 10:19

c0ffeeca7 mentioned this pull request Apr 10, 2026

Add Grandstream Home integration documentation home-assistant/home-assistant.io#44623

Open

8 tasks

edenhaus requested changes Apr 10, 2026

View reviewed changes

home-assistant bot marked this pull request as draft April 10, 2026 12:15

		hass.data.setdefault(DOMAIN, {})
		hass.data[DOMAIN][entry.entry_id] = {}

Uh oh!

Conversation

wtxu-gs commented Apr 10, 2026 • 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!

mawoka-myblock commented Apr 10, 2026

Uh oh!

wtxu-gs commented Apr 10, 2026

Uh oh!

wtxu-gs commented Apr 10, 2026

Uh oh!

edenhaus left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

home-assistant bot commented Apr 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

wtxu-gs commented Apr 10, 2026 •

edited

Loading