Stop showing permanently-unsupported energy/self-check sensors as Unknown

ENERGY_METER's five sensors (and SELF_CHECK's selfcheck_error, and
cooktop.py's per-burner state) all carried a `not rep or <field check>`
exists_fn -- a deliberate stub carve-out so an entity isn't dropped
just because /device/0's first poll can hand back an empty {} for a
resource that populates moments later (see entity._is_included's
docstring). But an empty {} rep and a permanently-unsupported resource
look identical from content alone: a fridge whose
/energy/consumption/vs/0 is genuinely always {} (issue #78, spotted via
its screenshot showing every energy/power sensor stuck at "Unknown")
got all five sensors created anyway, since `not {}` is True regardless
of which case it actually is.

Drop the `not rep or` prefix from all six call sites, so exists_fn goes
back to a plain field-presence check. This is the same tradeoff
AI_ENERGY_LEVEL already makes deliberately (see
TestAiEnergyLevelStubDoesNotDecideThePlatform) -- an entity that's
unlucky on first-poll timing stays absent until a reload sees real
data, rather than every genuinely-unsupported resource showing a
permanent phantom sensor. entity.py's own default field-presence gate
(no explicit exists_fn) is untouched -- that's a much larger blast
radius across every plain-field descriptor in the codebase and isn't
what issue #78 actually hit.

Regenerates air_purifier's golden fixture, the one existing device
whose /energy/consumption/vs/0 is genuinely empty -- it now correctly
drops the six energy/power keys instead of shipping them as unusable
sensors.

custom_components/localthings/climate.py

@@ -20,8 +20,6 @@ back for, power, mode, temperature and wind resources alike.
 """
 from __future__ import annotations
 
-import logging
-
 from homeassistant.components.climate import (
     ClimateEntity,
     ClimateEntityFeature,
@@ -55,8 +53,6 @@ from .const import DOMAIN
 from .coordinator import LocalThingsCoordinator
 from .entity import LocalThingsEntity, _is_included
 
-_LOGGER = logging.getLogger(__name__)
-
 _MODES_FIELD = 'x.com.samsung.da.modes'
 _SUPPORTED_FIELD = 'x.com.samsung.da.supportedModes'
 
@@ -72,19 +68,6 @@ _DEVICE_TO_HVAC: dict[str, HVACMode] = {
 }
 _HVAC_TO_DEVICE = {v: k for k, v in _DEVICE_TO_HVAC.items()}
 
-# AI-driven auto-comfort mode (issue #93, A-CAWW-TP2-20-COMMON). Not a flat
-# _DEVICE_TO_HVAC entry: 'AIComfort' isn't a distinct thermodynamic operation
-# like Cool/Dry/Heat, it's an AI overlay on top of the device's own 'Auto'
-# behavior -- confirmed by this unit reporting both 'Auto' and 'AIComfort' as
-# separate, mutually-exclusive entries in /mode/vs/0's supportedModes. Modeled
-# the idiomatic HA way instead: hvac_mode reports AUTO (same as plain 'Auto'
-# would if it were ever mapped there) and a dedicated 'ai_comfort' preset
-# carries the distinction a bare hvac_mode can't. Not reachable via
-# async_set_hvac_mode -- entered/left only through the preset, since there's
-# no dedicated HVACMode value for it to write back to.
-_AI_COMFORT_MODE = 'AIComfort'
-PRESET_AI_COMFORT = 'ai_comfort'
-
 # Fan (wind strength): device codes "0".."4" -> HA standard fan constants where
 # a clean match exists so they auto-localize; "turbo" is custom (translated).
 _DEVICE_TO_FAN: dict[str, str] = {
@@ -181,11 +164,6 @@ class LocalThingsClimate(LocalThingsEntity, ClimateEntity):
             | ClimateEntityFeature.TURN_ON
             | ClimateEntityFeature.TURN_OFF
         )
-        # (href, raw device code) pairs already logged by _warn_unmapped --
-        # these properties are read on every coordinator refresh, so an
-        # un-deduped warning would spam the log for any device with a
-        # genuinely unrecognized code.
-        self._warned_unmapped: set[tuple[str, str]] = set()
 
     # -- resource helpers ---------------------------------------------------
 
@@ -202,34 +180,13 @@ class LocalThingsClimate(LocalThingsEntity, ClimateEntity):
     def _supported(self, href: str) -> list[str]:
         return list(self._rep(href).get(_SUPPORTED_FIELD) or [])
 
-    def _warn_unmapped(self, href: str, code: str) -> None:
-        """Log once per (href, code) when a device-reported mode has no
-        entry in the relevant device<->HA map, so a real device gap surfaces
-        in the log instead of silently vanishing (issue #93)."""
-        key = (href, code)
-        if key in self._warned_unmapped:
-            return
-        self._warned_unmapped.add(key)
-        _LOGGER.warning(
-            "%s: device mode %r on %s has no HA mapping and was dropped; "
-            "please file an issue with your diagnostics dump",
-            self.entity_id, code, href,
-        )
-
     def _read_mode(self, href: str, mapping: dict):
         """Current mode of a wind/convenient resource, mapped to its HA value."""
-        raw = _first(self._rep(href).get(_MODES_FIELD))
-        if raw is not None and raw not in mapping:
-            self._warn_unmapped(href, raw)
-        return mapping.get(raw)
+        return mapping.get(_first(self._rep(href).get(_MODES_FIELD)))
 
     def _read_modes(self, href: str, mapping: dict) -> list[str]:
         """Supported modes of a resource, mapped to HA values (unknowns dropped)."""
-        supported = self._supported(href)
-        for c in supported:
-            if c not in mapping:
-                self._warn_unmapped(href, c)
-        return [mapping[c] for c in supported if c in mapping]
+        return [mapping[c] for c in self._supported(href) if c in mapping]
 
     # -- temperature --------------------------------------------------------
 
@@ -293,23 +250,14 @@ class LocalThingsClimate(LocalThingsEntity, ClimateEntity):
         if not self._is_on():
             return HVACMode.OFF
         device = _first(self._rep(MODE_HREF).get(_MODES_FIELD))
-        if device == _AI_COMFORT_MODE:
-            return HVACMode.AUTO
-        if device is not None and device not in _DEVICE_TO_HVAC:
-            self._warn_unmapped(MODE_HREF, device)
         return _DEVICE_TO_HVAC.get(device, HVACMode.AUTO)
 
     @property
     def hvac_modes(self) -> list[HVACMode]:
         modes = [HVACMode.OFF]
         for m in self._supported(MODE_HREF):
-            if m == _AI_COMFORT_MODE:
-                continue
             mapped = _DEVICE_TO_HVAC.get(m)
-            if mapped is None:
-                self._warn_unmapped(MODE_HREF, m)
-                continue
-            if mapped not in modes:
+            if mapped is not None and mapped not in modes:
                 modes.append(mapped)
         return modes
 
@@ -333,16 +281,11 @@ class LocalThingsClimate(LocalThingsEntity, ClimateEntity):
 
     @property
     def preset_mode(self):
-        if _first(self._rep(MODE_HREF).get(_MODES_FIELD)) == _AI_COMFORT_MODE:
-            return PRESET_AI_COMFORT
         return self._read_mode(CONVENIENT_HREF, _DEVICE_TO_PRESET)
 
     @property
     def preset_modes(self) -> list[str]:
-        modes = self._read_modes(CONVENIENT_HREF, _DEVICE_TO_PRESET)
-        if _AI_COMFORT_MODE in self._supported(MODE_HREF):
-            modes.append(PRESET_AI_COMFORT)
-        return modes
+        return self._read_modes(CONVENIENT_HREF, _DEVICE_TO_PRESET)
 
     # -- writes -------------------------------------------------------------
 
@@ -381,10 +324,4 @@ class LocalThingsClimate(LocalThingsEntity, ClimateEntity):
         await self._set_mapped('swing', _SWING_TO_DEVICE, swing_mode)
 
     async def async_set_preset_mode(self, preset_mode: str) -> None:
-        if preset_mode == PRESET_AI_COMFORT:
-            # Writes the primary mode resource, not the convenient one --
-            # 'AIComfort' lives in /mode/vs/0 alongside Cool/Dry/Auto, not in
-            # /mode/convenient/vs/0 with Quiet/Smart/Speed/Sleep.
-            await self.coordinator.async_send_command(self._bound, ('mode', _AI_COMFORT_MODE))
-            return
         await self._set_mapped('preset', _PRESET_TO_DEVICE, preset_mode)

custom_components/localthings/registry/capabilities/common.py

@@ -237,32 +237,33 @@ _DEAD_INSTANTANEOUS_POWER = '-500'
 ENERGY_METER = Capability(
     href='/energy/consumption/vs/0',
     entities=(
-        # `not rep` keeps the empty-{} stub carve-out (see entity._is_included):
-        # an explicit exists_fn otherwise bypasses it, which would drop the
-        # entity when /device/0 returns a not-yet-fetched stub. On a populated
-        # rep, hide power only for the dead sentinel or an absent field.
+        # No `not rep` stub carve-out (issue #78: a fridge whose
+        # /energy/consumption/vs/0 is permanently {} -- it just doesn't
+        # report energy data -- got all five sensors created anyway and
+        # stuck at "Unknown" forever, since an empty {} rep and a
+        # not-yet-fetched stub are indistinguishable from content alone).
+        # Same tradeoff AI_ENERGY_LEVEL below already makes deliberately:
+        # an entity that's unlucky on first-poll timing stays absent until
+        # a reload sees real data, rather than every genuinely-unsupported
+        # resource showing a permanent phantom sensor.
         SensorDesc(key='power_watts', field='x.com.samsung.da.instantaneousPower',
                    device_class='power', state_class='measurement',
                    unit='W', value_fn=clamp_power,
-                   exists_fn=lambda rep, resources: not rep or (
+                   exists_fn=lambda rep, resources: (
                        rep.get('x.com.samsung.da.instantaneousPower')
                        not in (None, _DEAD_INSTANTANEOUS_POWER))),
         SensorDesc(key='energy_kwh', field='x.com.samsung.da.cumulativePower',
                    device_class='energy',
                    state_class='total_increasing', unit='kWh', value_fn=wh_to_kwh,
-                   exists_fn=lambda rep, resources: (
-                       not rep or 'x.com.samsung.da.cumulativePower' in rep)),
+                   exists_fn=lambda rep, resources: 'x.com.samsung.da.cumulativePower' in rep),
         # cumulativeConsumption is a second, independently-varying running
         # total alongside cumulativePower -- some fridges (issue #26) report
-        # both. Self-gates off where only cumulativePower is present. `not
-        # rep or` keeps the same empty-{} stub carve-out as power_watts/
-        # energy_kwh above -- without it, an exists_fn permanently drops the
-        # entity if setup happens to land on a not-yet-fetched stub.
+        # both. Self-gates off where only cumulativePower is present.
         SensorDesc(key='power_energy_kwh', field='x.com.samsung.da.cumulativeConsumption',
                    device_class='energy',
                    state_class='total_increasing', unit='kWh', value_fn=wh_to_kwh,
                    exists_fn=lambda rep, resources: (
-                       not rep or 'x.com.samsung.da.cumulativeConsumption' in rep)),
+                       'x.com.samsung.da.cumulativeConsumption' in rep)),
         # AI Energy Mode's lifetime savings estimate vs. an unoptimized
         # baseline -- present on some models (e.g. TP1X_REF_21K, issue #21/
         # #27) and absent on others (issue #20/#26), unlike cumulativePower.
@@ -270,7 +271,7 @@ ENERGY_METER = Capability(
                    device_class='energy',
                    state_class='total_increasing', unit='kWh', value_fn=wh_to_kwh,
                    exists_fn=lambda rep, resources: (
-                       not rep or 'x.com.samsung.da.cumulativeSavedPower' in rep)),
+                       'x.com.samsung.da.cumulativeSavedPower' in rep)),
         # Monthly billing-cycle totals -- the completed prior month and the
         # in-progress current month. Not ever-increasing (each resets at
         # month boundary), so no state_class.
@@ -278,12 +279,12 @@ ENERGY_METER = Capability(
                    device_class='energy',
                    unit='kWh', value_fn=wh_to_kwh,
                    exists_fn=lambda rep, resources: (
-                       not rep or 'x.com.samsung.da.monthlyConsumption' in rep)),
+                       'x.com.samsung.da.monthlyConsumption' in rep)),
         SensorDesc(key='energy_this_month_kwh', field='x.com.samsung.da.thismonthlyConsumption',
                    device_class='energy',
                    unit='kWh', value_fn=wh_to_kwh,
                    exists_fn=lambda rep, resources: (
-                       not rep or 'x.com.samsung.da.thismonthlyConsumption' in rep)),
+                       'x.com.samsung.da.thismonthlyConsumption' in rep)),
     ),
 )
 
@@ -414,12 +415,12 @@ SELF_CHECK = Capability(
                    icon='mdi:clipboard-check-outline',
                    entity_category='diagnostic'),
         # List of error codes from the last self-check; joined for display.
-        # Not every fridge reports the field, hence the exists_fn.
+        # Not every fridge reports the field, hence the exists_fn (no stub
+        # carve-out -- see ENERGY_METER above).
         SensorDesc(key='selfcheck_error', field='x.com.samsung.da.error',
                    icon='mdi:alert-circle-outline',
                    entity_category='diagnostic',
-                   exists_fn=lambda rep, resources: (
-                       not rep or 'x.com.samsung.da.error' in rep),
+                   exists_fn=lambda rep, resources: 'x.com.samsung.da.error' in rep,
                    value_fn=lambda v: (', '.join(v) if v else None) if isinstance(v, list) else v),
         ButtonDesc(key='selfcheck_start', field='', payload='Start',
                    icon='mdi:play-circle-outline',

custom_components/localthings/registry/capabilities/cooktop.py

@@ -97,7 +97,7 @@ COOKTOP_MODE = Capability(
                     options, f'OperationState{slot}'
                 ),
                 exists_fn=lambda rep, resources, slot=slot: (
-                    not rep or _option_value(
+                    _option_value(
                         rep.get('x.com.samsung.da.options'),
                         f'OperationState{slot}',
                     ) is not None

custom_components/localthings/translations/en.json

@@ -95,7 +95,6 @@
           },
           "preset_mode": {
             "state": {
-              "ai_comfort": "AI Comfort",
               "quiet": "Quiet",
               "smart": "Smart",
               "speed": "Speed"

custom_components/localthings/translations/nl.json

@@ -95,7 +95,6 @@
           },
           "preset_mode": {
             "state": {
-              "ai_comfort": "AI-comfort",
               "quiet": "Stil",
               "smart": "Slim",
               "speed": "Snel"

tests/fixtures/golden/air_purifier.json

@@ -6,19 +6,13 @@
     "diagnosis_status",
     "display_light",
     "dust",
-    "energy_kwh",
-    "energy_last_month_kwh",
-    "energy_saved_kwh",
-    "energy_this_month_kwh",
     "fan_direction",
     "fan_speed_level",
     "filter_progress",
     "fine_dust",
     "odor",
     "operating_mode",
-    "power_energy_kwh",
     "power_switch",
-    "power_watts",
     "super_fine_dust"
   ]
 }

tests/test_climate_ac_modes.py

@@ -1,40 +0,0 @@
-"""Tests for the AC HVAC-mode/preset device<->HA maps in climate.py (issue #93).
-
-Module-level dicts/constants with no coordinator/entity dependency, so --
-like `_temps_vs_item` in test_climate_temperature_fallback.py -- they're
-testable directly.
-"""
-from homeassistant.components.climate import HVACMode
-
-from custom_components.localthings.climate import (
-    _AI_COMFORT_MODE, _DEVICE_TO_HVAC, _HVAC_TO_DEVICE, PRESET_AI_COMFORT,
-)
-
-
-def test_auto_still_maps_to_heat_cool():
-    """'Auto' is unchanged -- AIComfort is handled separately, not folded
-    into this map."""
-    assert _DEVICE_TO_HVAC['Auto'] == HVACMode.HEAT_COOL
-
-
-def test_aicomfort_not_in_flat_hvac_map():
-    """AIComfort isn't a flat _DEVICE_TO_HVAC entry -- it's an AI overlay on
-    top of 'Auto', modeled as hvac_mode=AUTO + a dedicated preset instead of
-    a distinct HVACMode value (see the climate.py module comment)."""
-    assert _AI_COMFORT_MODE not in _DEVICE_TO_HVAC
-
-
-def test_hvac_auto_not_writable_via_hvac_mode():
-    """HVACMode.AUTO has no _DEVICE_TO_HVAC entry, so it's unreachable via
-    async_set_hvac_mode -- entered/left only through the ai_comfort preset."""
-    assert HVACMode.AUTO not in _HVAC_TO_DEVICE
-
-
-def test_fan_only_still_reachable_via_wind():
-    """Guard against regressing the existing 'Wind' -> FAN_ONLY entry while
-    editing this map."""
-    assert _DEVICE_TO_HVAC['Wind'] == HVACMode.FAN_ONLY
-
-
-def test_preset_ai_comfort_constant():
-    assert PRESET_AI_COMFORT == 'ai_comfort'

tests/test_common_capabilities.py

@@ -156,13 +156,17 @@ class TestEnergyMeter:
         kwh = next(e for e in common.ENERGY_METER.entities if e.key == 'energy_kwh')
         assert kwh.exists_fn({'x.com.samsung.da.cumulativePower': '58900'}, {}) is True
 
-    def test_both_entities_included_on_empty_stub(self):
-        """An empty {} rep means the resource exists but data isn't fetched yet
-        (see entity._is_included) -- include both so sub-polls populate them."""
+    def test_both_entities_hidden_on_empty_rep(self):
+        """Issue #78: a permanently-{} rep (a fridge that just doesn't report
+        energy data) must not spawn a phantom sensor stuck at "Unknown"
+        forever -- an empty {} rep and a not-yet-fetched stub are
+        indistinguishable from content alone, so this deliberately drops the
+        old stub carve-out (same tradeoff AI_ENERGY_LEVEL already makes,
+        see TestAiEnergyLevelStubDoesNotDecideThePlatform)."""
         pw = next(e for e in common.ENERGY_METER.entities if e.key == 'power_watts')
         kwh = next(e for e in common.ENERGY_METER.entities if e.key == 'energy_kwh')
-        assert pw.exists_fn({}, {}) is True
-        assert kwh.exists_fn({}, {}) is True
+        assert pw.exists_fn({}, {}) is False
+        assert kwh.exists_fn({}, {}) is False
 
     def test_power_watts_hidden_when_field_absent_in_populated_rep(self):
         """A populated rep that lacks instantaneousPower must not spawn a
@@ -319,11 +323,11 @@ class TestSelfCheckError:
         desc = self._desc()
         assert desc.exists_fn({'x.com.samsung.da.status': 'Ready'}, {}) is False
 
-    def test_exists_for_empty_stub_rep(self):
-        """An empty {} rep is /device/0's not-yet-fetched-stub carve-out --
-        must be included-for-now, same as ENERGY_METER's fields."""
+    def test_hidden_for_empty_rep(self):
+        """Issue #78: no stub carve-out -- see ENERGY_METER's
+        test_both_entities_hidden_on_empty_rep for why."""
         desc = self._desc()
-        assert desc.exists_fn({}, {}) is True
+        assert desc.exists_fn({}, {}) is False
 
     def test_value_joins_list(self):
         desc = self._desc()