Add new Hotspring Integration by Moustachauve · Pull Request #177992 · home-assistant/core

Moustachauve · 2026-08-02T01:55:28Z

Proposed change

This PR introduces a new Hotspring integration to control hot tubs that are equipped with the official Connected Spa Kit from Hotspring.

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 initial Hot Spring integration documentation home-assistant.io#47201
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 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.

home-assistant

When adding new integrations, limit included platforms to a single platform. While we appreciate the effort, reviewing larger than necessary PRs slows down the review process. Please reduce this PR to a single platform. See the review process for more details.

Copilot

Pull request overview

Adds a local-polling Hot Spring spa integration with configuration, diagnostics, and water-heater control.

Changes:

Adds config-entry setup, polling, and reconfiguration.
Exposes spa temperature through a water-heater entity.
Adds diagnostics, tests, dependency metadata, and generated registration.

Reviewed changes

Copilot reviewed 18 out of 20 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
`.strict-typing`	Enables strict typing.
`homeassistant/components/hotspring/__init__.py`	Sets up and unloads the integration.
`homeassistant/components/hotspring/config_flow.py`	Implements setup and reconfiguration flows.
`homeassistant/components/hotspring/const.py`	Defines integration constants.
`homeassistant/components/hotspring/coordinator.py`	Polls the spa API.
`homeassistant/components/hotspring/diagnostics.py`	Exposes diagnostic data.
`homeassistant/components/hotspring/entity.py`	Defines shared entity metadata.
`homeassistant/components/hotspring/icons.json`	Adds icon metadata.
`homeassistant/components/hotspring/manifest.json`	Declares integration metadata and dependency.
`homeassistant/components/hotspring/strings.json`	Adds configuration-flow strings.
`homeassistant/components/hotspring/water_heater.py`	Implements temperature control.
`homeassistant/generated/config_flows.py`	Registers the config flow.
`homeassistant/generated/integrations.json`	Registers generated integration metadata.
`requirements_all.txt`	Adds `python-hotspring`.
`tests/components/hotspring/__init__.py`	Adds platform setup helper.
`tests/components/hotspring/conftest.py`	Adds fixtures and API mocks.
`tests/components/hotspring/test_config_flow.py`	Tests setup and reconfiguration.
`tests/components/hotspring/test_diagnostics.py`	Tests diagnostics.
`tests/components/hotspring/test_init.py`	Tests entry lifecycle and setup failure.
`tests/components/hotspring/test_water_heater.py`	Tests state and temperature control.

Copilot

Pull request overview

Copilot reviewed 21 out of 23 changed files in this pull request and generated no new comments.

Suppressed comments (4)

tests/components/hotspring/test_diagnostics.py:21

Commit the generated Syrupy snapshot for this assertion. There is no tests/components/hotspring/snapshots/test_diagnostics.ambr, so this test reports a missing snapshot and fails in normal CI runs.

    assert (
        await get_diagnostics_for_config_entry(hass, hass_client, init_integration)
        == snapshot

tests/components/hotspring/test_water_heater.py:34

Commit the generated Syrupy snapshots for this test. No Hot Spring snapshot files are present, so the state and entity-registry snapshot assertions fail as missing snapshots in normal CI runs.

    assert state == snapshot

homeassistant/components/hotspring/config_flow.py:34

Handle HotSpringError in this validation path as well. The same update() call is treated as raising both HotSpringConnectionError and HotSpringError by the coordinator, so a known API/response failure currently escapes the config flow instead of returning a form error.

            except HotSpringConnectionError:
                errors["base"] = "cannot_connect"

homeassistant/components/hotspring/diagnostics.py:11

Redact the spa's ssid field from diagnostics. The current SpaInfo payload includes the user's Wi-Fi network name, so diagnostics exports expose network-identifying data; other integrations redact this field (for example, homeassistant/components/aosmith/diagnostics.py:24).

TO_REDACT = {"unique_id", "mac_address"}

- Handle HotSpringError in config flow - Redact hostname and ssid from diagnostics payload - Add exception translations for UpdateFailed and HomeAssistantError - Add approved Syrupy test snapshots

Copilot

Pull request overview

Copilot reviewed 23 out of 25 changed files in this pull request and generated no new comments.

Copilot

Pull request overview

Copilot reviewed 20 out of 23 changed files in this pull request and generated no new comments.

Suppressed comments (3)

homeassistant/components/hotspring/quality_scale.yaml:56

Mark diagnostics as todo rather than exempt. Planning diagnostics for a follow-up means the rule applies but is not implemented; established quality-scale metadata represents this as todo (for example, homeassistant/components/energyid/quality_scale.yaml:64-66), while exemptions are reserved for integrations with no diagnosable data.

  diagnostics:
    status: exempt
    comment: Diagnostics will be added in a follow-up PR.

tests/components/hotspring/test_water_heater.py:60

Use an in-range temperature in this successful service test. The default test unit system is Celsius and this entity advertises a 40 °C maximum, so 103 is converted to 217.4 °F—well beyond the device's 104 °F maximum—and the permissive mock masks that this is not a valid successful device call.

            ATTR_TEMPERATURE: 103,

homeassistant/components/hotspring/coordinator.py:48

Add a setup/update test for this HotSpringError branch. The setup test only injects HotSpringConnectionError, so the invalid_response translation path is currently unverified even though it has distinct behavior and dedicated handling.

        except HotSpringError as error:

Copilot

Pull request overview

Copilot reviewed 20 out of 22 changed files in this pull request and generated no new comments.

Suppressed comments (2)

homeassistant/components/hotspring/quality_scale.yaml:56

Mark diagnostics as todo until the rule is implemented. Deferring diagnostics to a follow-up means the rule is incomplete, not exempt; other integrations represent this state as diagnostics: todo.

  diagnostics:
    status: exempt
    comment: Diagnostics will be added in a follow-up PR.

tests/components/hotspring/test_water_heater.py:60

Use a temperature within the entity's advertised range in this success-path test. The test environment uses Celsius, so 103 is converted to 217.4°F, well above the entity's 104°F maximum, and therefore verifies an invalid command that a real spa may reject.

    mock_hotspring.set_temperature.assert_called_once_with(217.4)

…emperature values

…ater heater components

Copilot

Pull request overview

Copilot reviewed 20 out of 23 changed files in this pull request and generated no new comments.

erwindouna

Thanks for adding the new integration, @Moustachauve! Here's an initial review. :)

erwindouna · 2026-08-02T13:58:00Z

+            raise UpdateFailed(
+                translation_domain=DOMAIN,
+                translation_key="cannot_connect",
+                translation_placeholders={"error": str(error)},


Errors are badly translatable. I advise to omit them. :)

erwindouna · 2026-08-02T14:02:09Z

This is not allowed to be part of the PR.

home-assistant · 2026-08-02T14:05:23Z

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.

erwindouna · 2026-08-02T14:05:43Z

Side note: do we also need to add branding?

Moustachauve · 2026-08-02T15:43:37Z

Side note: do we also need to add branding?

Yes, it's in home-assistant/brands#10898.

Thanks for the review, will work on the comments tonight!

Copilot

Pull request overview

Copilot reviewed 20 out of 22 changed files in this pull request and generated no new comments.

Suppressed comments (1)

homeassistant/components/hotspring/quality_scale.yaml:37

Mark action-exceptions as done instead of exempt. This integration exposes water_heater.set_temperature and translates its dependency failures (water_heater.py:63-68), matching the established declaration in homewizard/quality_scale.yaml:38; the current claim that it has no actions is inaccurate.

  action-exceptions:
    status: exempt
    comment: Integration does not have custom actions.

…onnect

Copilot

Pull request overview

Copilot reviewed 20 out of 22 changed files in this pull request and generated no new comments.

Moustachauve added 4 commits July 29, 2026 22:32

Add Hot Spring integration

ee7f743

Add handling for HotSpringConnectionError in data update

be7f9fe

Simplify Hot Spring exception handling and clarify HNA in config flow

285f431

Remove zeroconf discovery from initial PR

2265a95

Copilot AI review requested due to automatic review settings August 2, 2026 01:55

home-assistant Bot added cla-signed has-tests new-integration integration: hotspring labels Aug 2, 2026

home-assistant Bot requested changes Aug 2, 2026

View reviewed changes

Copilot started reviewing on behalf of Moustachauve August 2, 2026 01:56 View session

Copilot AI reviewed Aug 2, 2026

View reviewed changes

Moustachauve mentioned this pull request Aug 2, 2026

Add initial Hot Spring integration documentation home-assistant/home-assistant.io#47201

Open

8 tasks

Add quality scale and error translation keys

313ba68

Moustachauve mentioned this pull request Aug 2, 2026

Add Hotspring Brand home-assistant/brands#10898

Open

10 tasks

Copilot AI review requested due to automatic review settings August 2, 2026 02:19

Merge remote-tracking branch 'upstream/dev' into hotspring-init

d221285

Copilot started reviewing on behalf of Moustachauve August 2, 2026 02:20 View session

Copilot AI reviewed Aug 2, 2026

View reviewed changes

Address review feedback for Hot Spring

d8c421d

- Handle HotSpringError in config flow - Redact hostname and ssid from diagnostics payload - Add exception translations for UpdateFailed and HomeAssistantError - Add approved Syrupy test snapshots

Copilot AI review requested due to automatic review settings August 2, 2026 02:36

Copilot started reviewing on behalf of Moustachauve August 2, 2026 02:37 View session

Copilot AI reviewed Aug 2, 2026

View reviewed changes

Remove diagnostics support and related tests for Hot Spring integration

6acd63b

Copilot AI review requested due to automatic review settings August 2, 2026 02:46

Copilot started reviewing on behalf of Moustachauve August 2, 2026 02:47 View session

Moustachauve marked this pull request as ready for review August 2, 2026 02:50

Moustachauve requested a review from a team as a code owner August 2, 2026 02:50

Copilot AI reviewed Aug 2, 2026

View reviewed changes

Revert accidental change in mdi_icons.py

66ca955

Copilot AI review requested due to automatic review settings August 2, 2026 02:53

Copilot started reviewing on behalf of Moustachauve August 2, 2026 02:53 View session

Mark diagnostic and discovery as todo instead of exempt

d9d0774

Copilot AI reviewed Aug 2, 2026

View reviewed changes

Moustachauve added 3 commits August 2, 2026 03:01

Refactor Hot Spring tests to handle multiple error types and adjust t…

f63884b

…emperature values

Implement exception handling for Hot Spring API calls in entity and w…

5ef2363

…ater heater components

Update python-hotspring requirement to version 1.0.1

a2b32f3

Copilot AI review requested due to automatic review settings August 2, 2026 03:35

Copilot started reviewing on behalf of Moustachauve August 2, 2026 03:36 View session

Copilot AI reviewed Aug 2, 2026

View reviewed changes

erwindouna requested changes Aug 2, 2026

View reviewed changes

home-assistant Bot marked this pull request as draft August 2, 2026 14:05

Implement reviewer comment fixes

bfaaeb6

Copilot AI review requested due to automatic review settings August 3, 2026 02:45

Copilot started reviewing on behalf of Moustachauve August 3, 2026 02:45 View session

Copilot AI reviewed Aug 3, 2026

View reviewed changes

test: remove redundant mock_hotspring fixture from test_form_cannot_c…

e486f56

…onnect

Copilot AI review requested due to automatic review settings August 3, 2026 02:56

Copilot started reviewing on behalf of Moustachauve August 3, 2026 02:56 View session

Copilot AI reviewed Aug 3, 2026

View reviewed changes

Uh oh!

Uh oh!

Conversation

Moustachauve commented Aug 2, 2026 • edited 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!

home-assistant Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

erwindouna left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

erwindouna Aug 2, 2026

Choose a reason for hiding this comment

Uh oh!

erwindouna Aug 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

home-assistant Bot commented Aug 2, 2026

Uh oh!

erwindouna commented Aug 2, 2026

Uh oh!

Moustachauve commented Aug 2, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Moustachauve commented Aug 2, 2026 •

edited

Loading