Configuration¶
This page covers the configuration options available for the Dimplex Hub integration.
Config flow¶
The integration uses Home Assistant's config flow, so all configuration is done through the UI. No YAML editing is required.
Authentication options¶
Email / password¶
The recommended method. Enter your Dimplex cloud credentials during setup.
- Pros: Simple, no browser needed after setup, tokens refresh automatically.
- Cons: Requires your Dimplex password.
Manual auth code¶
Provide an OAuth authorisation code captured from a browser session.
- Pros: Does not require storing your Dimplex password in Home Assistant.
- Cons: More steps, the code expires quickly.
See Getting started for the full manual auth code walkthrough.
Options flow¶
After installation, you can enable or disable platforms and tune polling:
- Go to Settings > Devices & Services.
- Find Dimplex Hub and click Configure.
- Adjust any of the following, then click Submit:
| Option | Default | Range | Meaning |
|---|---|---|---|
climate |
on | on/off | Climate entities (temperature + presets). |
sensor |
on | on/off | Room temperature and energy sensors. |
binary_sensor |
on | on/off | Comfort / open-window / setback / connected. |
switch |
on | on/off | EcoStart and open-window-detection toggles. |
| Status poll interval (s) | 30 | 15–3600 | How often temperatures/modes are polled. |
| Energy poll interval (s) | 1800 | 60–86400 | How often the energy report is fetched. |
| Boost duration (min) | 60 | 1–1440 | Default duration for the boost service/preset. |
Disabling a platform removes its entities from Home Assistant without deleting your config entry. Changing any option reloads the integration.
Re-authentication¶
If your tokens expire or are rejected, the integration raises Home Assistant's built-in reauthentication flow against the affected config entry.
- Go to Settings > Devices & Services.
- Find Dimplex Hub and click Reconfigure / Re-authenticate (a notification also links here).
- Choose email/password or the manual auth code, exactly as during initial setup.
Data retention¶
The integration stores the following in the config entry's data field:
| Key | Purpose |
|---|---|
refresh_token |
Long-lived token used to obtain new access tokens. |
access_token |
Short-lived token for API requests. |
expires_at |
Unix timestamp when the access token expires. |
username |
Your Dimplex account email (email/password method only). |
Tokens are never written to plain-text files outside the Home Assistant config storage.
Update interval¶
The integration polls the Dimplex cloud every 30 seconds by default for status (temperatures and modes), and every 30 minutes for the energy report. Both intervals — and the default boost duration — are configurable from the options flow (Configure); see Options flow above. When the energy history stays empty (e.g. idle heaters in summer) the energy poll backs off automatically to reduce cloud load.
Behind a proxy¶
If your Home Assistant instance is behind a proxy, ensure the aiohttp session can reach the Dimplex API endpoints. The integration uses Home Assistant's default aiohttp session, so standard proxy configuration applies.
Multiple accounts¶
You can add the integration multiple times if you have more than one Dimplex account (for example, a personal account and a family account). Each installation will appear as a separate Dimplex Hub entry in Devices & Services.
Uninstalling¶
- Go to Settings > Devices & Services.
- Find Dimplex Hub and click Delete.
- Confirm the deletion.
This removes the config entry and all associated entities. It does not delete your custom Lovelace cards or automations — you will need to remove those manually.