HA Discovery fix: energy-cost sensors are always-available

The energy-cost device has only sensors (no online/offline heartbeat), but the
discovery config still declared an availability topic that nothing ever publishes
'online' to — so Home Assistant marked every energy-cost entity 'unavailable'
even though the state topic was being published (visible in MQTT Explorer).

- DeviceInfo gains provides_availability (default True, keeps Modbus behavior).
- _energy_cost_provider sets provides_availability=False.
- build_discovery_payload only emits availability/availability_mode for devices
  that publish a heartbeat; HA treats the rest as always-available.
- Test asserts energy-cost configs omit availability.
This commit is contained in:
2026-06-24 11:54:49 +02:00
parent e8521351d7
commit 7e61b0a938
3 changed files with 51 additions and 2 deletions
+19
View File
@@ -58,6 +58,21 @@ class DeviceInfo:
name: str name: str
"""Human-readable device name (may change; triggers HA discovery re-publish).""" """Human-readable device name (may change; triggers HA discovery re-publish)."""
provides_availability: bool = True
"""Whether this device publishes an availability ("online"/"offline") heartbeat.
When True (the default — e.g. Modbus devices, which have an ``online``
binary_sensor driving availability), the HA Discovery config for each entity
declares an ``availability`` topic and HA marks the entity unavailable until
"online" is published.
When False (e.g. the energy-cost device, which has only sensors and no
heartbeat source), the config omits ``availability`` so HA treats the entity
as *always available* and shows its state as soon as one arrives. Without
this, such entities would stay perpetually ``unavailable`` in HA even though
their state is being published.
"""
@dataclass @dataclass
class ExposableEntity: class ExposableEntity:
@@ -422,9 +437,13 @@ def _energy_cost_provider(session: Session) -> list[ExposableEntity]:
currency = latest_period.currency currency = latest_period.currency
# --- Shared DeviceInfo (2-element identifiers — required by ha_discovery.py [1] access) --- # --- Shared DeviceInfo (2-element identifiers — required by ha_discovery.py [1] access) ---
# provides_availability=False: the energy-cost device has only sensors and no
# online/offline heartbeat, so its entities must be "always available" in HA.
# (Otherwise HA shows them unavailable despite state being published.)
device_info = DeviceInfo( device_info = DeviceInfo(
identifiers=("energy-cost", "energy-cost"), identifiers=("energy-cost", "energy-cost"),
name="Energy Cost", name="Energy Cost",
provides_availability=False,
) )
# --- value_getter: current buy price --- # --- value_getter: current buy price ---
+9 -2
View File
@@ -133,14 +133,21 @@ def build_discovery_payload(
"unique_id": _unique_id(entity), "unique_id": _unique_id(entity),
"name": entity.name, "name": entity.name,
"state_topic": state_t, "state_topic": state_t,
"availability": [{"topic": avail_topic}],
"availability_mode": "all",
"device": { "device": {
"identifiers": list(entity.device.identifiers), "identifiers": list(entity.device.identifiers),
"name": entity.device.name, "name": entity.device.name,
}, },
} }
# Only declare an availability topic for devices that actually publish an
# online/offline heartbeat (e.g. Modbus, via its "online" binary_sensor).
# Devices without a heartbeat (e.g. energy-cost) omit availability so HA
# treats their entities as always-available — otherwise HA would mark them
# ``unavailable`` forever even though their state is being published.
if entity.device.provides_availability:
config["availability"] = [{"topic": avail_topic}]
config["availability_mode"] = "all"
# Component-specific fields # Component-specific fields
if entity.component == "binary_sensor": if entity.component == "binary_sensor":
# "online" binary sensor: payload ON/OFF # "online" binary sensor: payload ON/OFF
+23
View File
@@ -648,6 +648,29 @@ def test_build_discovery_payload_no_index_error_for_energy_entities(energy_db) -
assert "energy-cost" in config["device"]["identifiers"] assert "energy-cost" in config["device"]["identifiers"]
def test_energy_cost_entities_omit_availability_so_ha_shows_them(energy_db) -> None:
"""The energy-cost device has no online/offline heartbeat, so its discovery
config must NOT declare an availability topic — otherwise HA marks the
entities ``unavailable`` forever even though state is being published.
"""
from app.integrations.expose import build_catalog
from app.services.ha_discovery import build_discovery_payload
with Session(energy_db) as session:
catalog = build_catalog(session)
energy_entries = [e for e in catalog if e.entity.key.startswith("energy.")]
assert len(energy_entries) == 4
for entry in energy_entries:
assert entry.entity.device.provides_availability is False
_, config = build_discovery_payload(entry.entity, "homeassistant")
assert "availability" not in config, (
f"energy entity {entry.entity.key} must omit availability (always-available)"
)
assert "availability_mode" not in config
def test_energy_entity_discovery_topics_contain_correct_node_id() -> None: def test_energy_entity_discovery_topics_contain_correct_node_id() -> None:
"""Discovery topic node_id for energy entities must be 'energy-cost' (hyphens → underscores).""" """Discovery topic node_id for energy entities must be 'energy-cost' (hyphens → underscores)."""
from app.integrations.expose import DeviceInfo, ExposableEntity from app.integrations.expose import DeviceInfo, ExposableEntity