Add WattWächter Plus integration by smartcircuits · Pull Request #165238 · home-assistant/core

smartcircuits · 2026-03-09T23:28:52Z

Summary

Add new integration for WattWächter Plus energy monitoring devices by SmartCircuits GmbH
Local polling via SML/OBIS protocol using aio-wattwaechter PyPI library
Supports zeroconf/mDNS discovery and config flow (manual + zeroconf)

Features

Dynamic sensor creation based on known OBIS codes reported by the smart meter (energy, power, voltage, current, frequency, power factor)
Diagnostic sensors (WiFi signal, SSID) disabled by default
Bronze quality scale

Quality

Tests covering config flow, sensor setup, and init
mypy strict typing enabled
Exception translations for all user-facing errors

Follow-up PRs (planned)

Update platform (OTA firmware updates)
Diagnostics support
Reauthentication and reconfigure flows

Documentation

home-assistant/home-assistant.io#44004

Brands

home-assistant/brands#10065

home-assistant

Hi @tJpADUNCcs

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 · 2026-03-09T23:28:59Z

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.

home-assistant

When adding new integrations, limit included platforms to a single platform. Please reduce this PR to a single platform

Copilot

Pull request overview

Adds a new core integration for WattWächter Plus energy monitoring devices (local polling + zeroconf discovery), including dynamic OBIS-based sensors, diagnostics support, and a firmware update entity.

Changes:

Introduces the wattwaechter integration (config flow, coordinator, sensors, update entity, diagnostics, translations/icons/branding).
Registers the integration for zeroconf discovery and generated integration metadata.
Adds a new test suite and CODEOWNERS entries for the integration.

Reviewed changes

Copilot reviewed 19 out of 25 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
`homeassistant/components/wattwaechter/__init__.py`	Sets up the integration, creates client/coordinator, forwards platforms, handles options updates.
`homeassistant/components/wattwaechter/config_flow.py`	Implements user/zeroconf flows plus reauth/reconfigure and options flow.
`homeassistant/components/wattwaechter/const.py`	Defines domain/constants plus known OBIS and diagnostic sensor descriptions.
`homeassistant/components/wattwaechter/coordinator.py`	Polls meter/system data via `DataUpdateCoordinator` and maps auth/connection errors.
`homeassistant/components/wattwaechter/sensor.py`	Creates dynamic OBIS sensors + diagnostic sensors from coordinator data.
`homeassistant/components/wattwaechter/update.py`	Adds firmware update entity with OTA check/install and reboot detection.
`homeassistant/components/wattwaechter/entity.py`	Base entity providing device info (incl. configuration URL + MAC connection).
`homeassistant/components/wattwaechter/diagnostics.py`	Implements diagnostics payload with token/MAC redaction.
`homeassistant/components/wattwaechter/manifest.json`	Declares integration metadata, dependencies, requirements, and zeroconf type.
`homeassistant/components/wattwaechter/strings.json`	Adds config/options/error/exception and entity translations.
`homeassistant/components/wattwaechter/icons.json`	Adds entity icon translations.
`homeassistant/components/wattwaechter/quality_scale.yaml`	Declares quality scale status for the integration.
`homeassistant/components/wattwaechter/brand/icon.png`	Adds integration brand icon (256px).
`homeassistant/components/wattwaechter/brand/icon@2x.png`	Adds integration brand icon (512px).
`homeassistant/generated/zeroconf.py`	Registers `_wattwaechter._tcp.local.` zeroconf service mapping to the domain.
`homeassistant/generated/integrations.json`	Adds generated integration registry entry for `wattwaechter`.
`tests/components/wattwaechter/__init__.py`	Initializes the integration test package.
`tests/components/wattwaechter/conftest.py`	Adds fixtures and test data for the new integration tests.
`tests/components/wattwaechter/test_config_flow.py`	Tests config flow scenarios (user/zeroconf/reauth/reconfigure/options).
`tests/components/wattwaechter/test_init.py`	Tests setup/unload and setup retry behavior.
`tests/components/wattwaechter/test_sensor.py`	Tests OBIS sensor creation (known/unknown/minimal/no data) and diagnostics sensors.
`tests/components/wattwaechter/test_update.py`	Tests update entity (no update/update available/install + error paths + reboot detection).
`CODEOWNERS`	Adds codeowners for the new integration and its tests.

You can also share your feedback on Copilot code review. Take the survey.

homeassistant/components/wattwaechter/update.py

tests/components/wattwaechter/conftest.py

tests/components/wattwaechter/test_config_flow.py

tests/components/wattwaechter/test_init.py

tests/components/wattwaechter/test_sensor.py

tests/components/wattwaechter/test_update.py

Add WattWächter Plus integration for local energy monitoring via SML/OBIS protocol.

home-assistant

Hi @smartcircuits

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!

smartcircuits · 2026-03-10T08:38:11Z

Addressed the Copilot feedback:

Fixed _attr_in_progress = False → None in update.py (1d78171)

Regarding the automated "single platform" comment: this integration provides sensor, update, and diagnostics. Happy to split update into a follow-up PR if required by reviewers.

The tests currently use custom_components.* imports (carried over from the custom component). I'll update them to homeassistant.components.wattwaechter.* once CI workflows are approved and I can verify against the core test runner.

Companion docs PR: home-assistant/home-assistant.io#44004

smartcircuits · 2026-03-20T07:57:18Z

Hi, just checking in on this PR — is there anything we need to adjust on our side? We noticed the CI workflows haven't run yet, presumably because of the first-time contributor approval? Let us know if there's anything we can do to move things along.

Stale

Copilot

Pull request overview

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

homeassistant/components/wattwaechter/config_flow.py

homeassistant/components/wattwaechter/sensor.py

Copilot

Pull request overview

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

homeassistant/components/wattwaechter/sensor.py

homeassistant/components/wattwaechter/coordinator.py

homeassistant/components/wattwaechter/config_flow.py

homeassistant/components/wattwaechter/sensor.py

homeassistant/components/wattwaechter/icons.json

tests/components/wattwaechter/test_sensor.py

Copilot

Pull request overview

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

homeassistant/components/wattwaechter/__init__.py

homeassistant/components/wattwaechter/config_flow.py

homeassistant/components/wattwaechter/coordinator.py

…data

… in sensor tests

Copilot

Pull request overview

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

Copilot · 2026-04-11T22:15:52Z

homeassistant/components/wattwaechter/coordinator.py

+    async def _async_update_data(self) -> MeterData:
+        """Fetch data from the WattWächter device."""
+        try:
+            data = await self.client.meter_data()
+        except WattwaechterNoDataError as err:
+            raise UpdateFailed(
+                translation_domain=DOMAIN,
+                translation_key="no_meter_data",
+                translation_placeholders={"host": self.host},
+            ) from err
+        except WattwaechterAuthenticationError as err:
+            raise ConfigEntryAuthFailed(
+                translation_domain=DOMAIN,
+                translation_key="auth_failed",
+                translation_placeholders={"error": str(err)},
+            ) from err
+        except WattwaechterConnectionError as err:
+            raise UpdateFailed(
+                translation_domain=DOMAIN,
+                translation_key="update_failed",
+                translation_placeholders={"error": str(err)},
+            ) from err
+
+        if data is None:
+            raise UpdateFailed(
+                translation_domain=DOMAIN,
+                translation_key="no_meter_data",
+                translation_placeholders={"host": self.host},
+            )


UpdateFailed (from homeassistant.helpers.update_coordinator) does not support the translation_domain/translation_key/translation_placeholders kwargs, which will raise a TypeError the first time one of these error paths occurs (breaking setup and retries). Use UpdateFailed(<string message>) for coordinator update failures, and keep translated exceptions for user-facing flows/errors where supported (e.g., ConfigEntryAuthFailed).

Copilot · 2026-04-11T22:15:53Z

homeassistant/components/wattwaechter/config_flow.py

+                return self.async_show_form(
+                    step_id="zeroconf_confirm",
+                    data_schema=vol.Schema(
+                        {
+                            vol.Required(CONF_TOKEN): str,
+                        }
+                    ),
+                    description_placeholders={
+                        "model": self._model or "WattWächter Plus",
+                        "firmware": self._fw_version or "unknown",
+                        "host": self._host or "",
+                        "device_id": self._device_id or "",
+                    },
+                )


The zeroconf_confirm token form schema + description_placeholders block is duplicated in the same method for the error retry case (later in async_step_zeroconf_confirm). Consider extracting a small helper (e.g., _show_zeroconf_token_form(errors: dict[str, str] | None = None)) so future changes (new placeholders, validation, optional token behavior) don’t require updating multiple copies.

Stale

smartcircuits · 2026-04-11T22:38:12Z

Hi @joostlek

Thanks again for your review — really appreciate you taking the time! Sorry for the delayed response, I was on vacation.

I've addressed all your feedback from the last round and also cleaned up a few additional things:

Coordinator now raises UpdateFailed on WattwaechterNoDataError to preserve last known data
ConfigEntryNotReady via first refresh when no meter data is available
except clause syntax fixed
Removed leftover diagnostic sensor icons and unused _LOGGER
device_name stores "" instead of None in config entry data
Sensor tests refactored to use unique_id-based entity registry lookups
Added test for auth error during coordinator first refresh
Type annotations on all test parameters and fixtures

Looking forward to your next review whenever you get a chance. Thanks!

Copilot

Pull request overview

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

homeassistant/components/wattwaechter/sensor.py

homeassistant/components/wattwaechter/entity.py

Copilot AI review requested due to automatic review settings March 9, 2026 23:28

home-assistant bot added cla-needed has-tests new-integration labels Mar 9, 2026

home-assistant bot previously requested changes Mar 9, 2026

View reviewed changes

home-assistant bot added the integration: wattwaechter label Mar 9, 2026

home-assistant bot marked this pull request as draft March 9, 2026 23:28

home-assistant bot added quality-scale labels Mar 9, 2026

home-assistant bot previously requested changes Mar 9, 2026

View reviewed changes

Copilot started reviewing on behalf of smartcircuits March 9, 2026 23:29 View session

Copilot AI reviewed Mar 9, 2026

View reviewed changes

smartcircuits mentioned this pull request Mar 9, 2026

Add WattWächter Plus integration docs home-assistant/home-assistant.io#44004

Draft

8 tasks

add wattwaechter integration

d19d94d

Add WattWächter Plus integration for local energy monitoring via SML/OBIS protocol.

smartcircuits force-pushed the add-wattwaechter-integration branch from 0fef350 to d19d94d Compare March 9, 2026 23:35

home-assistant bot previously requested changes Mar 9, 2026

View reviewed changes

home-assistant bot added cla-recheck cla-signed and removed cla-recheck cla-needed labels Mar 9, 2026

fix _attr_in_progress: use None instead of False

1d78171

fix codeowner to smartcircuits

0d9e034

smartcircuits marked this pull request as ready for review March 31, 2026 23:30

Copilot AI review requested due to automatic review settings March 31, 2026 23:30

Copilot started reviewing on behalf of smartcircuits April 11, 2026 17:52 View session

Copilot AI reviewed Apr 11, 2026

View reviewed changes

smartcircuits added 2 commits April 11, 2026 20:00

fix except clause syntax for python 3.12 compatibility

a2d2b8f

raise ConfigEntryNotReady when no meter data available on first poll

20aac42

Copilot AI review requested due to automatic review settings April 11, 2026 18:06

Copilot started reviewing on behalf of smartcircuits April 11, 2026 18:07 View session

Copilot AI reviewed Apr 11, 2026

View reviewed changes

smartcircuits added 2 commits April 11, 2026 20:14

remove PARALLEL_UPDATES constant

3b0fcf8

import WattwaechterConfigEntry from coordinator instead of package root

1b817b0

Copilot AI review requested due to automatic review settings April 11, 2026 18:15

Copilot started reviewing on behalf of smartcircuits April 11, 2026 18:16 View session

Copilot AI reviewed Apr 11, 2026

View reviewed changes

homeassistant/components/wattwaechter/__init__.py Show resolved Hide resolved

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

homeassistant/components/wattwaechter/coordinator.py Show resolved Hide resolved

smartcircuits added 9 commits April 11, 2026 20:25

restore PARALLEL_UPDATES and add None guard for mypy

27e6a0d

raise UpdateFailed on WattwaechterNoDataError to preserve last known …

1597e2f

…data

store empty string instead of None for device_name in config entry data

e21b584

remove unused _LOGGER from sensor module

172231c

remove leftover wifi diagnostic sensor icons

e700542

use entity registry unique_id lookups instead of hardcoded entity IDs…

33923f3

… in sensor tests

use unknown error instead of cannot_connect when device_id is missing

d4c5a36

add test for auth error during coordinator first refresh

1a90ac9

add missing tests for full codecov coverage

6c78fd5

Copilot AI review requested due to automatic review settings April 11, 2026 22:12

Copilot started reviewing on behalf of smartcircuits April 11, 2026 22:13 View session

Copilot AI reviewed Apr 11, 2026

View reviewed changes

smartcircuits marked this pull request as ready for review April 11, 2026 22:38

smartcircuits requested a review from Copilot April 11, 2026 22:40

Copilot started reviewing on behalf of smartcircuits April 11, 2026 22:41 View session

Copilot AI reviewed Apr 11, 2026

View reviewed changes

homeassistant/components/wattwaechter/sensor.py Show resolved Hide resolved

homeassistant/components/wattwaechter/entity.py Show resolved Hide resolved

Uh oh!

Conversation

smartcircuits commented Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Features

Quality

Follow-up PRs (planned)

Documentation

Brands

Uh oh!

home-assistant bot left a comment

Choose a reason for hiding this comment

Uh oh!

home-assistant bot commented Mar 9, 2026

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!

Uh oh!

home-assistant bot left a comment

Choose a reason for hiding this comment

Uh oh!

smartcircuits commented Mar 10, 2026

Uh oh!

smartcircuits commented Mar 20, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

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!

Uh oh!

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!

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 Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 11, 2026

Choose a reason for hiding this comment

Uh oh!

smartcircuits commented Apr 11, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

smartcircuits commented Mar 9, 2026 •

edited

Loading