-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Add WattWächter Plus integration docs #44004
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
smartcircuits
wants to merge
7
commits into
home-assistant:next
Choose a base branch
from
SmartCircuits-GmbH:add-wattwaechter-docs
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+152
−0
Open
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
f1a3a6d
add wattwaechter integration docs
smartcircuits 777bdcc
Remove non-existent glossary term ref to fix build
c0ffeeca7 630b591
fix codeowner to smartcircuits
smartcircuits c28b893
update docs to match slimmed-down core PR
smartcircuits 889e003
apply style review suggestions
smartcircuits 2e81e8f
remove redundant configuration parameters heading
smartcircuits 1370d91
fix duplicate 'via the' typo
smartcircuits File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| --- | ||
| title: WattWächter Plus | ||
| description: Instructions on how to integrate WattWächter Plus into Home Assistant. | ||
| ha_category: | ||
| - Energy | ||
| - Sensor | ||
| ha_release: 2026.4 | ||
| ha_iot_class: Local Polling | ||
| ha_config_flow: true | ||
| ha_codeowners: | ||
| - '@smartcircuits' | ||
| ha_domain: wattwaechter | ||
| ha_platforms: | ||
| - sensor | ||
| ha_zeroconf: true | ||
| ha_integration_type: device | ||
| ha_quality_scale: bronze | ||
| works_with: | ||
| - local | ||
| --- | ||
|
|
||
| The **WattWächter Plus** {% term integration %} connects Home Assistant to a [WattWächter Plus](https://wattwächter.de) energy monitoring device by [SmartCircuits GmbH](https://smartcircuits.de). The device reads data from your smart electricity meter via the SML/OBIS protocol and exposes it over a local HTTP API. All communication stays on your local network — no cloud service is involved. | ||
|
|
||
| Use this integration to monitor your electricity consumption, feed-in, voltage, current, and power factor. The collected data can be used in the [Energy dashboard](/home-energy-management). | ||
|
|
||
| ## Supported devices | ||
|
|
||
| - **WattWächter Plus**: ESP-based smart meter reader with SML/OBIS support. Connects to your meter's optical interface and provides real-time energy data via a local HTTP API. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| The WattWächter Plus must be connected to your local network and reachable from Home Assistant. Set up your device using the [WattWächter documentation](https://docs.wattwächter.de) before adding it to Home Assistant. | ||
smartcircuits marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| {% include integrations/config_flow.md %} | ||
|
|
||
| The integration supports automatic discovery via mDNS. If your device is on the same network, it will appear automatically in the discovered integrations. | ||
|
|
||
smartcircuits marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| ### Configuration parameters | ||
|
|
||
smartcircuits marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| {% configuration_basic %} | ||
| Host: | ||
| description: "The IP address or hostname of your WattWächter Plus device." | ||
| API token: | ||
| description: "The API token for authentication (optional, only required if token-based authentication is enabled on the device)." | ||
| {% endconfiguration_basic %} | ||
|
|
||
| ## Supported functionality | ||
|
|
||
| The WattWächter Plus provides sensors based on what your smart meter reports via the SML/OBIS protocol. Not all meters expose every value — only the available sensors are shown in the integration. | ||
smartcircuits marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### Energy sensors | ||
|
|
||
| - **Total consumption (kWh)**: Total energy imported since installation of your smart meter. | ||
| - **Total feed-in (kWh)**: Total energy exported (fed back into the grid). | ||
| - **Consumption tariff 1 / 2 (kWh)**: Energy consumption per tariff, if your meter supports dual tariffs. | ||
| - **Feed-in tariff 1 / 2 (kWh)**: Energy feed-in per tariff. | ||
|
|
||
| ### Power sensors | ||
|
|
||
| - **Active power (W)**: Current power being consumed or fed in. Negative values indicate feed-in. | ||
| - **Active power L1 / L2 / L3 (W)**: Active power per phase. | ||
|
|
||
| ### Voltage and current sensors | ||
|
|
||
| - **Voltage L1 / L2 / L3 (V)**: Voltage per phase. | ||
| - **Current L1 / L2 / L3 (A)**: Current per phase. | ||
|
|
||
| ### Other sensors | ||
|
|
||
| - **Grid frequency (Hz)**: The current grid frequency. | ||
| - **Power factor / Power factor L1 / L2 / L3**: The power factor (total and per phase). | ||
|
|
||
| ### Diagnostic sensors | ||
|
|
||
| The following sensors are created with the diagnostic entity category and are disabled by default: | ||
|
|
||
| - **WiFi signal (dBm)**: The wireless signal strength of the device. | ||
| - **WiFi SSID**: The wireless network name the device is connected to. | ||
smartcircuits marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Data updates | ||
|
|
||
| The integration {% term polling polls %} your WattWächter Plus device locally every 120 seconds. Each poll fetches the meter data (SML/OBIS readings) and system information. | ||
smartcircuits marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## Actions | ||
|
|
||
| This integration does not provide additional actions. | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Add your energy data to the Energy dashboard | ||
|
|
||
| The WattWächter Plus integration provides energy sensors that can be used in the Energy dashboard. To add your data, follow the steps in the [Energy dashboard documentation](/home-energy-management). | ||
|
|
||
| Use the **Total consumption** sensor for grid consumption and the **Total feed-in** sensor for energy returned to the grid. | ||
|
|
||
| ### Get notified on high power consumption | ||
|
|
||
| {% details "Example YAML automation" %} | ||
| {% raw %} | ||
|
|
||
| ```yaml | ||
| alias: "High power consumption alert" | ||
| description: "Notify when power consumption exceeds 4 kW for 5 minutes." | ||
| triggers: | ||
| - trigger: numeric_state | ||
| entity_id: sensor.wattwaechter_plus_active_power | ||
smartcircuits marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| above: 4000 | ||
| for: | ||
| minutes: 5 | ||
| actions: | ||
| - action: notify.mobile_app_phone | ||
| data: | ||
| title: "High power consumption" | ||
| message: >- | ||
| WattWächter reports | ||
| {{ states('sensor.wattwaechter_plus_active_power') }} W. | ||
| ``` | ||
|
|
||
| {% endraw %} | ||
| {% enddetails %} | ||
|
|
||
| Replace the threshold and `notify` target with the values appropriate for your setup. | ||
|
|
||
| ## Known limitations | ||
|
|
||
| ### Sensor availability depends on your smart meter | ||
|
|
||
| Not all smart meters expose the same OBIS codes. For example, some meters do not report per-phase voltage or current. The integration can only show data that your meter provides. | ||
|
|
||
| ### Smart meter PIN unlock required for full precision | ||
|
|
||
| Most smart meters need to be unlocked with a PIN from your energy provider before they expose detailed meter data. Without the PIN, many meters only report integer values (no decimal places) and may not provide per-phase readings. Contact your energy provider to request the PIN and enter it on your smart meter to unlock extended data. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Device is not discovered automatically | ||
|
|
||
| - Make sure the WattWächter Plus is connected to the same network as Home Assistant. | ||
| - Verify the device is powered on and reachable (try accessing its web interface in a browser). | ||
| - You can always add the device manually by entering its IP address. | ||
|
|
||
| ### Authentication failed | ||
|
|
||
| - If you have set an API token on the device, make sure you enter it correctly during setup. | ||
smartcircuits marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### No sensor data available | ||
|
|
||
| - If the device is reachable but shows no meter sensors, your smart meter may not be connected or not yet sending data. Check the device's web interface to verify SML data is being received. | ||
| - The optical reader head must be properly aligned with your meter's optical interface. | ||
|
|
||
| ## Removing the integration | ||
|
|
||
| This integration follows standard integration removal. No extra steps are required. | ||
|
|
||
| {% include integrations/remove_device_service.md %} | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.