-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
Add GridX integration docs #44449
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
base: next
Are you sure you want to change the base?
Add GridX integration docs #44449
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,137 @@ | ||||||||||||||||||||||
| --- | ||||||||||||||||||||||
| title: GridX | ||||||||||||||||||||||
| description: Instructions on how to integrate GridX energy systems within Home Assistant. | ||||||||||||||||||||||
| ha_category: | ||||||||||||||||||||||
| - Energy | ||||||||||||||||||||||
| - Sensor | ||||||||||||||||||||||
| ha_release: 2026.5 | ||||||||||||||||||||||
| ha_iot_class: Cloud Polling | ||||||||||||||||||||||
| ha_config_flow: true | ||||||||||||||||||||||
| ha_codeowners: | ||||||||||||||||||||||
| - '@unl0ck' | ||||||||||||||||||||||
| ha_domain: gridx | ||||||||||||||||||||||
| ha_platforms: | ||||||||||||||||||||||
| - diagnostics | ||||||||||||||||||||||
| - sensor | ||||||||||||||||||||||
| ha_integration_type: device | ||||||||||||||||||||||
| ha_quality_scale: gold | ||||||||||||||||||||||
| --- | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| The **GridX** integration connects Home Assistant to the [gridX](https://gridx.de) energy management platform. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| It lets you monitor a gridX-based home energy system from Home Assistant, including live power flows and daily energy totals for supported devices such as photovoltaic systems, batteries, EV chargers, heat pumps, and smart heaters. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Use cases | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| The GridX integration is useful if you want to: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| - Monitor your household's live energy flow between solar production, home consumption, battery storage, and the grid. | ||||||||||||||||||||||
| - Track cumulative grid import and export values for use in dashboards and automations. | ||||||||||||||||||||||
| - Watch optional subsystems such as an EV charger, heat pump, or smart heater when they are present in your installation. | ||||||||||||||||||||||
| - Build automations around self-consumption, battery charge level, or current grid import/export. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Prerequisites | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Before setting up the integration, make sure you have: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| - A gridX-compatible energy system that is visible in the provider app. | ||||||||||||||||||||||
| - A valid account for the provider's gridX app. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| At the moment, the Home Assistant integration supports **E.ON Home** accounts. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Supported devices | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| The integration supports gridX-based home energy systems that expose data through the gridX cloud platform. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Depending on your installation, Home Assistant can surface sensors for: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| - Photovoltaic production | ||||||||||||||||||||||
| - Household consumption | ||||||||||||||||||||||
| - Grid import and export | ||||||||||||||||||||||
| - Battery state of charge, power, and energy values | ||||||||||||||||||||||
| - EV charging station power, state of charge, currents, and total charged energy | ||||||||||||||||||||||
| - Heat pump power | ||||||||||||||||||||||
| - Smart heater power and temperature | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| Optional sensors are only created with usable values when the corresponding subsystem is available in your gridX installation. | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| ## Setup | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| {% include integrations/config_flow.md %} | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| The integration provides the following fields during setup: | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| {% configuration_basic %} | ||||||||||||||||||||||
| Username: | ||||||||||||||||||||||
| description: The e-mail address you use to sign in to the GridX provider app. | ||||||||||||||||||||||
|
||||||||||||||||||||||
| description: The e-mail address you use to sign in to the GridX provider app. | |
| description: The email address you use to sign in to the GridX provider app. |
Copilot
AI
Apr 1, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In this configuration_basic block, the description lines should be indented with 4 spaces (consistent with other integration docs, like source/_integrations/pjlink.markdown:23-28 and source/_integrations/fritz.markdown:62-75). The current 2-space indentation may render incorrectly in the generated configuration table.
| description: The e-mail address you use to sign in to the GridX provider app. | |
| Password: | |
| description: The password for your GridX provider app account. | |
| Energy provider: | |
| description: The gridX provider realm to use. Currently, only `E.ON Home` is supported. | |
| description: The e-mail address you use to sign in to the GridX provider app. | |
| Password: | |
| description: The password for your GridX provider app account. | |
| Energy provider: | |
| description: The gridX provider realm to use. Currently, only `E.ON Home` is supported. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PR title/description says this change is adding GridX integration docs, but this PR also modifies multiple unrelated integration docs (HTML5, Transmission, FRITZ!Box Tools, PJLink, etc.) and adds dashboard feature docs + images. Please either split this into focused PRs or update the PR title/description to reflect the full scope so review and release notes are accurate.