Set station name as device name in GIOS #155762

mik-laj · 2025-11-03T23:22:49Z

Breaking change

Proposed change

This change supersedes: #155741

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: Remove 'Name' field from config flow in gios home-assistant.io#41588
Link to developer documentation pull request:
Link to frontend pull request:

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 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 · 2025-11-03T23:22:56Z

Hey there @bieniu, mind taking a look at this pull request as it has been labeled with an integration (gios) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of gios can trigger bot actions by commenting:

@home-assistant close Closes the pull request.
@home-assistant rename Awesome new title Renames the pull request.
@home-assistant reopen Reopen the pull request.
@home-assistant unassign gios Removes the current integration label and assignees on the pull request, add the integration domain after the command.
@home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
@home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

Copilot

Pull Request Overview

This PR removes the user-configurable device name from the GIOS integration config flow and instead uses the station name from the GIOS API. For backward compatibility, existing configurations with a custom name will continue to use it, while new setups will use the station name with translation support.

Key changes:

Config flow no longer allows users to set custom device names
Device names are now derived from the station name via API (with translation support for new configs)
Backward compatibility maintained for existing configs with CONF_NAME in their data

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
homeassistant/components/gios/config_flow.py	Removed `CONF_NAME` import and name field from config flow schema
homeassistant/components/gios/sensor.py	Updated device info creation to use station name with translation support, while maintaining backward compatibility for existing configs with custom names
homeassistant/components/gios/strings.json	Added device translation key for station name formatting
tests/components/gios/conftest.py	Updated mock config entry to remove `CONF_NAME` from test data
tests/components/gios/test_config_flow.py	Removed `CONF_NAME` import and from test config data
tests/components/gios/test_init.py	Added test for device naming behavior based on config data (with/without `CONF_NAME`)
tests/components/gios/test_sensor.py	Updated entity IDs in tests to reflect new naming based on station name
tests/components/gios/snapshots/*.ambr	Updated snapshots to reflect new entity naming scheme

Comments suppressed due to low confidence (1)

homeassistant/components/gios/sensor.py:18

The CONF_NAME import is still present but is now only used with .get() method on line 187. Since this is for backward compatibility with existing config entries, the import is actually still needed and should remain. However, it would be clearer to add a comment explaining this is kept for backward compatibility with existing configurations.

from homeassistant.const import CONCENTRATION_MICROGRAMS_PER_CUBIC_METER, CONF_NAME

homeassistant/components/gios/sensor.py

Co-authored-by: Copilot <[email protected]>

bieniu · 2025-11-17T20:21:15Z

homeassistant/components/gios/strings.json

  },
+  "device": {
+    "station": {
+      "name": "Station {station_name}"


TBH I see no reason to add the word "Station" to the device name. Other integrations simply use the name/location of the measurement/weather station.

I removed the prefix.

bieniu · 2025-11-17T20:30:59Z

homeassistant/components/gios/sensor.py

+        else:
+            device_info_kwargs["translation_key"] = "station"
+            device_info_kwargs["translation_placeholders"] = {"station_name": station_name}
+        self._attr_device_info = DeviceInfo(**device_info_kwargs)


I would move the creation of device info to the coordinator module:

self.device_info = DeviceInfo( entry_type=DeviceEntryType.SERVICE, identifiers={(DOMAIN, str(gios.station_id))}, manufacturer=MANUFACTURER, name=config_entry.data.get(CONF_NAME) or gios.station_name, configuration_url=URL.format(station_id=gios.station_id), )

and only add here self._attr_device_info = coordinator.device_info

I moved device info to coordinator.

joostlek

Tests are failing

home-assistant · 2025-11-21T23:08:11Z

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.

frenck · 2025-11-23T19:40:21Z

homeassistant/components/gios/config_flow.py

                        mode=SelectSelectorMode.DROPDOWN,
                    ),
-                ),
-                vol.Optional(CONF_NAME, default=self.hass.config.location_name): str,


Name was removed here, but not removed from the translations file (string.json), which still needs to be cleaned up.

Good catch. Removed.

frenck · 2025-11-23T19:42:12Z

homeassistant/components/gios/coordinator.py

        )

+        station_id = gios.station_id
+        assert station_id is not None


We shouldn't be using assert in production code. In general the use means we either have a logic error (or could improve logic) or there might be a typing issue/improvement that could result the need for it.

We have this check here because the API client can be initialized with an optional station_id parameter, but in our case, the client is always initialized with a specific station ID. The client without a station ID is used in config_flow to retrieve the list of available stations.
https://github.com/bieniu/gios/blob/871ea652a27216f87645a0161b823f500cd7a944/gios/__init__.py#L51
Here is Gios client initialization code:

core/homeassistant/components/gios/__init__.py

Line 45 in 9aec7b1

gios = await Gios.create(websession, station_id)

I added if TYPE_CHECKING to avoid this code in production code.

homeassistant/components/gios/coordinator.py

homeassistant/components/gios/config_flow.py

bieniu · 2025-11-24T20:48:34Z

Documentation should be updated

mik-laj · 2025-11-24T21:23:27Z

Documentation should be updated

Here is PR: home-assistant/home-assistant.io#41588

homeassistant/components/gios/config_flow.py

homeassistant/components/gios/coordinator.py

bieniu · 2025-11-24T21:46:03Z

tests/components/gios/snapshots/test_diagnostics.ambr

  dict({
    'config_entry': dict({
      'data': dict({
-        'name': 'Home',


name should remain.

Please align the config entry for tests; sometimes the name is there, sometimes it's not. And I think we should leave the station name as Home to prove that the "old" tests pass with the new code.

One more thing... please, if you think the PR is ready, click Ready for review button. Without that, it's unclear whether to look at the changes or wait because you're still working.

We don't have a `name` field in this object and this is expected as now the user cannot pass a `name` field during integration setup. The name is automatically generated as it is core of this change.

Thanks for pointing that out. I appreciate the reminder. I was planning to take one more pass over everything before marking the PR as ready for review.

Also, thanks for being so consistent and thorough with the reviews.

home-assistant bot added cla-signed has-tests integration: gios labels Nov 3, 2025

home-assistant bot assigned bieniu Nov 3, 2025

home-assistant bot added the Quality Scale: No score label Nov 3, 2025

mik-laj force-pushed the gios-fix-5 branch 2 times, most recently from c05e0af to 1156200 Compare November 4, 2025 07:09

Set station name as device name in GIOS (II)

ce9f7b3

mik-laj force-pushed the gios-fix-5 branch from 1156200 to ce9f7b3 Compare November 16, 2025 19:59

mik-laj mentioned this pull request Nov 16, 2025

Remove 'Name' field from config flow in gios home-assistant/home-assistant.io#41588

Draft

8 tasks

mik-laj marked this pull request as ready for review November 16, 2025 20:04

mik-laj requested a review from bieniu as a code owner November 16, 2025 20:04

Copilot AI review requested due to automatic review settings November 16, 2025 20:04

Copilot started reviewing on behalf of mik-laj November 16, 2025 20:04 View session

Copilot finished reviewing on behalf of mik-laj November 16, 2025 20:05

Copilot AI reviewed Nov 16, 2025

View reviewed changes

homeassistant/components/gios/sensor.py Outdated Show resolved Hide resolved

mik-laj and others added 2 commits November 16, 2025 21:23

Update homeassistant/components/gios/sensor.py

b6d67da

Co-authored-by: Copilot <[email protected]>

fixup! Set station name as device name in GIOS (II)

f73ade1

bieniu added the new-feature label Nov 16, 2025

bieniu reviewed Nov 17, 2025

View reviewed changes

joostlek requested changes Nov 21, 2025

View reviewed changes

home-assistant bot marked this pull request as draft November 21, 2025 23:08

fixup! fixup! Set station name as device name in GIOS (II)

1fda7d6

mik-laj marked this pull request as ready for review November 23, 2025 18:39

home-assistant bot requested a review from joostlek November 23, 2025 18:39

frenck requested changes Nov 23, 2025

View reviewed changes

home-assistant bot marked this pull request as draft November 23, 2025 19:42

fixup! fixup! fixup! Set station name as device name in GIOS (II)

61d4b7b

Add comment about TYPE_CHECKING

383bf35

mik-laj marked this pull request as ready for review November 23, 2025 22:28

home-assistant bot requested a review from frenck November 23, 2025 22:28

bieniu requested changes Nov 24, 2025

View reviewed changes

home-assistant bot marked this pull request as draft November 24, 2025 20:46

bieniu added the docs-missing label Nov 24, 2025

Add downgrade compatiblity + smal code cleanup

dbdfc29

bieniu removed the docs-missing label Nov 24, 2025

bieniu reviewed Nov 24, 2025

View reviewed changes

mik-laj and others added 3 commits November 24, 2025 22:49

Set CONF_NAME in config_flow

a67088f

Test Name 1 => Home

48fbbc4

Merge branch 'dev' into gios-fix-5

d1a8f68

mik-laj marked this pull request as ready for review November 26, 2025 17:03

home-assistant bot requested a review from bieniu November 26, 2025 17:03

Merge branch 'dev' into gios-fix-5

e7461c6

Uh oh!

Set station name as device name in GIOS #155762

Are you sure you want to change the base?

Set station name as device name in GIOS #155762

Conversation

mik-laj commented Nov 3, 2025 • edited by bieniu 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 Nov 3, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

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!

joostlek left a comment

Choose a reason for hiding this comment

Uh oh!

home-assistant bot commented Nov 21, 2025

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bieniu commented Nov 24, 2025

Uh oh!

mik-laj commented Nov 24, 2025

Uh oh!

Uh oh!

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mik-laj commented Nov 3, 2025 •

edited by bieniu

Loading