Entities¶

This page lists the entity types exposed by the Dimplex Hub integration.

Entity names use Home Assistant’s has_entity_name pattern: the device is the appliance (or hub), and each entity has a short name such as “Room temperature” or “EcoStart”.

Climate¶

One climate entity per room heater. Hot water cylinders get a water heater instead.

Presets¶

A preset is a single, mutually exclusive state: selecting one engages what that preset owns and clears the others, so switching straight from away to eco works as you would expect. Why a preset cannot always show what the appliance is doing: Modes & presets.

Actions¶

• climate.set_temperature — writes the target through the cloud's dedicated setpoint endpoint, so your schedule is left intact. Appliances that reject it fall back to a schedule rewrite. See setting a target.
• climate.set_preset_mode — boost / away / eco / comfort.
• climate.turn_on / climate.turn_off — off engages frost protection and clears boost/away; on clears it again. See why "off" reports 7 °C.
• dimplex.set_advance / dimplex.clear_advance — skip forward to the next schedule period, bringing its setpoint on early.

Full field reference: Actions.

Climate (and most status entities) are unavailable when the cloud returns an empty appliance overview (common when heaters have not telemetered recently).

Sensors¶

Energy attributes¶

Energy data is daily kWh history from the cloud, not live watts. Sensors are unavailable (not 0) when there are no points, and T1 and T2 are never combined — they are separate dual-rate registers.

The lifetime sensors declare total_increasing and are held monotonic: the highest value seen is what gets reported, and it is restored across a restart. That exists because a truncated cloud response would otherwise make the total fall, which Home Assistant reads as a meter reset and re-adds to long-term statistics.

A permanent reduction of the cloud's history cannot be reported as a lower reading, for that same reason — so on its own the hold would over-report silently and for ever. raw_total is what makes that visible: it is the number the cloud is currently sending, so a value below the state (or below peak_total) means the hold is suppressing something, and a suppressed drop of more than 10% logs a warning naming both figures. If raw_total stays below the state across consecutive polls, the cloud has lost history for that appliance — see troubleshooting.

See Energy monitoring for adding these to the Energy Dashboard, the tariff mapping, and the automatic poll back-off when history stays empty.

Binary sensors¶

The appliance mode bitfield is also broken out as four diagnostic binary sensors — Boost active, Away active, Frost protection, Advance active.

These exist because the climate entity folds the whole bitfield into one preset, which is precisely what hid the mode mismatch behind #163: the integration asked for Boost and the heater engaged Advance, with nothing on the dashboard to say so.

Several bits can be set at once, so these four sensors can disagree with preset_mode — the sensors are the appliance's actual state and are the better thing to automate on. See Modes & presets for the whole model. A diagnostics download also lists the engaged modes by name.

Water heater¶

One per hot water cylinder, read-only: the cylinder control endpoints other than holiday are untested, so it offers no controls. Translation key cylinder.

Cylinder sensors (created only for hot water appliances):

The room-heater entities — climate, room temperature, open window, EcoStart, setback, comfort, away, frost, advance, boost duration — are not created for a cylinder.

Holiday¶

The cylinder only counts whole days, so the integration clears Holiday itself at the chosen time. The end time survives a restart, and if it passed while Home Assistant was down, Holiday is cleared on start.

Switches¶

Numbers¶

Created only for appliances whose capability matrix says both setback_read and setback_write — a write that could never be read back would leave the entity showing a stale number forever. The Setback binary sensor reports whether setback is currently engaged, and the Setback temperature sensor reports the same value read-only.

The range offered is the capability matrix's own 7-30 °C. That range is inferred from the app rather than measured — see appliance support.

Selects¶

A configuration entity (not shown by default on the main card), created only for boost-capable appliances (boost in the capability matrix). It is a preference — choosing a value does not start a boost, it sets how long the next boost preset will run. A per-appliance choice here takes precedence over the entry-wide Boost duration option, so each appliance can use its own duration, and the choice survives a restart.

Schedule¶

Diagnostic Schedule sensor per appliance. While the heater is following its timer its state is the active schedule profile — user_timer, home_all_day or out_all_day, taken from the live overview exactly as the official app names it — and otherwise it falls back to the timer mode (manual, user_timer, frost_protection or off). Its periods attribute lists the programme as day / start / end / temperature.

The sensor is read-only. The programme can be copied to other appliances, and one period's target edited, through actions — see edit the weekly schedule.

Heater timers also get a read-only Saved profile sensor (translation key saved_profile). The cloud keeps no link between a timer and the profile it was copied from, so this reports the saved profile whose periods exactly match the cached schedule — or unknown when the timer was edited since. Its profiles attribute lists the saved profile names available to match against. Choosing one of them through the Saved profile select applies it to the heater's active timer slot.

Hot water schedule¶

Heat-pump cylinders get a read-only Hot water schedule sensor instead (translation key hot_water_schedule). Its state summarises the week, e.g. Mon–Sun 00:00 mode 2, and its attributes list each day's periods (start, start_raw, mode) and the current_mode. Mode is shown as the cloud's number because its meaning is not yet known, and start times assume minutes after midnight.

Zones¶

Zone devices appear in the device registry (via hub; appliances via zone when zone id is known). A disabled diagnostic zone sensor anchors each zone device.

Automations¶

Worked examples using these entities live in Automations & blueprints. The diagnostic mode sensors are usually a better trigger than preset_mode, because the appliance can hold several modes at once while the preset can only report one.