Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 137 additions & 0 deletions source/_integrations/gridx.markdown
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
Comment on lines +1 to +16
Copy link

Copilot AI Apr 1, 2026

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.

Copilot uses AI. Check for mistakes.
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.
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use “email” instead of “e-mail” to match common usage and the Microsoft writing style used across the docs.

Suggested change
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 uses AI. Check for mistakes.
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.
Comment on lines +66 to +70
Copy link

Copilot AI Apr 1, 2026

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.

Suggested change
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.

Copilot uses AI. Check for mistakes.
{% endconfiguration_basic %}

## Supported functionality

### Sensors

The integration creates live power sensors for the main system and, when available, for attached subsystems.

Examples include:

- **Live power sensors** for photovoltaic production, consumption, grid power, self-consumption, and self-sufficiency.
- **Grid meter sensors** for cumulative import and export energy.
- **Battery sensors** for state of charge, power, remaining charge, charge, and discharge.
- **EV charger sensors** for charging power, state of charge, per-phase current, and total charged energy.
- **Heat pump and heater sensors** when those devices are exposed by the gridX account.
- **Daily historical sensors** for today's production, consumption, feed-in, supply, and direct-consumption values.

Some optional sensors are disabled by default to avoid clutter when they are less commonly used.

## Data updates

The integration polls the gridX cloud API on two schedules:

- Live data is refreshed every 30 seconds.
- Historical daily totals are refreshed every hour.

Daily historical totals are recalculated for the current local day.

## Known limitations

- The integration currently supports only the **E.ON Home** gridX realm.
- The integration depends on the availability of the gridX cloud service and your provider account.
- Sensors for batteries, EV chargers, heat pumps, and heaters are only available when those devices are part of your installation and exposed by the gridX API.
- If the account authenticates successfully but no systems are returned, the integration cannot be set up.

## Troubleshooting

### Setup fails with an authentication error

If setup reports invalid authentication:

1. Verify that you can still sign in to the provider's gridX app with the same credentials.
2. Confirm that you selected the correct provider realm.
3. Re-enter the password carefully, especially if it was copied from a password manager.

### Setup fails because no data is available

If setup completes authentication but still fails to connect:

1. Make sure the account is linked to an active gridX-based energy system.
2. Check in the provider app whether the installation is visible and current data is available.
3. Wait a few minutes and try again if the provider cloud service is temporarily unavailable.

### Sensors become unavailable

If the integration was working previously and sensors become unavailable:

1. Check your internet connection.
2. Verify that the provider app can still show current system data.
3. Reload the integration from **Settings** > **Devices & services**.
4. Reauthenticate the integration if your account credentials changed.

## Removing the integration

This integration follows standard integration removal. No extra cleanup steps are required.

{% include integrations/remove_device_service.md %}
Loading