Marc Billow
c181a8b447
Samsung 2-in-1 air conditioners put more than one logical indoor unit behind a single IP and a single DTLS session. Only the unit the config entry was set up against was ever discovered; the second one -- a whole physical appliance the user can see in SmartThings -- had no entities at all. Two reporters turned out to have two different mechanisms: ARTIK051_DONGLE_FAC_18K -- indexed siblings. /oic/res registers the whole tree discoverable and lists three complete parallel resource sets whose trailing path segment is the index (/mode/vs/0, /mode/vs/1, ...), on OCF-standard and vendor hrefs alike. /device/0's batch carries only the index-0 hrefs, so a sibling is reachable only through its own /device/<n> collection. TP2X_FAC_BORA_21K -- UUID-prefixed tree. /oic/res hides the appliance tree entirely (which is why a direct /device/1 probe returns nothing on this board). /subdevices/vs/0 carries subdeviceIdList instead, and that UUID appears as a literal href prefix; /<uuid>/information/vs/0 was confirmed live to return the wall unit's own model and serial (TP2X_FAC_BORA_RAC_21K) against the master's TP2X_FAC_BORA_21K. The detection signals don't overlap on either board, so no disambiguation is needed -- enumeration checks both and takes what answers. Both patterns are the same thing underneath: a logical unit is a seed collection path to poll plus an href transform between the canonical href the registry knows and the actual on-the-wire href. That is the whole abstraction (SubUnit), applied at four boundaries -- discovery, the coordinator, the adapter, and the platforms. Capabilities, the registry and the climate composite stay written against canonical hrefs and are untouched. Uniqueness comes from a key_prefix inside the flattened state key, so the master unit's keys are byte-identical to every release before this and every existing golden file is an unchanged regression guard. Each sub-unit gets its own device-registry entry linked by via_device and named from its own /information/vs/<n>, so it lands in its own room rather than crowding the master's device page. A sub-unit materializes only when it yields at least one primary (non-diagnostic) entity with a populated value. That gate is not decoration: the reporter's /device/2 is an unused slot that SmartThings shows disabled, yet it answers with a full 14-href batch, and it flattens to exactly one non-None value -- a diagnostic alarm_code derived from an empty /alarms/vs/2. Without the entity-category filter it becomes a phantom third climate card. The rule is deliberately domain-agnostic rather than a list of HVAC hrefs, so a multi-drum washer (#19) gets the same treatment with no new curation. Units that answer but fail the gate are logged and reported in diagnostics, so a genuinely missing unit stays diagnosable from a dump. Enumeration fetches things that must not then be treated as appliance state. A rejected candidate's seed has to be read to evaluate the gate, but only units that pass are polled again, and StateCache has no eviction -- so discovery runs before the first cache apply and those reps are held aside for diagnostics rather than frozen into the cache forever. /multidevice/vs/0 is probed on every device regardless of family, so merging it into the resources dict would have reached discovery on any board whose registry doesn't ignore that href -- only the air conditioner one does -- raising a spurious coverage-gap repair for a washer or fridge whose firmware answers it. It is corroborating metadata (numofsubdevice, confirmed read-only) and now lives beside the resources rather than in them. Diagnostics reports each unit separately: top-level `resources` is this unit's own and only its own, which is what the module docstring and the adding-device-support skill have always claimed it was, and each sibling or rejected candidate carries its own reps canonicalized so a block reads exactly like the master's instead of needing to be de-indexed by hand. Fixtures are real captures. The ARTIK051_DONGLE_FAC_18K one is entirely verbatim, both sibling seeds and the hand-read /multidevice/vs/0 included. The TP2X_FAC_BORA one has a real device0, oic_res and sub-unit /information/vs/0, with the remainder of that unit's tree constructed and documented as such in seeds_note; /<uuid>/device/0 is the one part of that pattern still inferred rather than observed, and can't be tested through the debug panel because a Collection returns a list.
109 lines
4.2 KiB
Python
109 lines
4.2 KiB
Python
"""Tests for LocalThingsSelect's option-list resolution
|
|
(custom_components/localthings/select.py) -- the static tuple, options_field,
|
|
and callable forms of SelectDesc.options.
|
|
"""
|
|
from custom_components.localthings.registry.capability import Capability
|
|
from custom_components.localthings.registry.discovery import BoundEntity
|
|
from custom_components.localthings.registry.entities import SelectDesc
|
|
from custom_components.localthings.select import LocalThingsSelect
|
|
|
|
|
|
class _FakeCoordinator:
|
|
device_serial = 'TEST-SERIAL'
|
|
|
|
def __init__(self, last_resources):
|
|
self.last_resources = last_resources
|
|
|
|
def canonical_resources(self, sub_unit):
|
|
# Every entity built by _make_select uses the default MAIN
|
|
# sub-unit, so the canonical view is just the raw snapshot
|
|
# (issue #177 -- see LocalThingsEntity._resources).
|
|
return self.last_resources
|
|
|
|
|
|
def _make_select(desc, href, last_resources):
|
|
capability = Capability(href=href, entities=(desc,))
|
|
bound = BoundEntity(href=href, capability=capability, desc=desc)
|
|
return LocalThingsSelect(_FakeCoordinator(last_resources), bound)
|
|
|
|
|
|
def test_static_options_unaffected():
|
|
desc = SelectDesc(key='x', options=('A', 'B'))
|
|
entity = _make_select(desc, '/x/vs/0', {})
|
|
assert entity.options == ['A', 'B']
|
|
|
|
|
|
def test_options_field_unaffected():
|
|
desc = SelectDesc(key='x', options_field='supported')
|
|
entity = _make_select(desc, '/x/vs/0', {'/x/vs/0': {'supported': ['Lo', 'Hi']}})
|
|
assert entity.options == ['Lo', 'Hi']
|
|
|
|
|
|
def test_callable_options_receives_full_resource_snapshot():
|
|
"""A callable options is handed the coordinator's full href->rep
|
|
snapshot, not just this entity's own href's rep -- needed for course
|
|
lists decoded from a sibling resource (see laundry.cycle_options)."""
|
|
calls = []
|
|
|
|
def _options_fn(resources):
|
|
calls.append(resources)
|
|
return list(resources.get('/other/vs/0', {}).get('codes', []))
|
|
|
|
desc = SelectDesc(key='cycle', translation_key='fake_cycle', options=_options_fn)
|
|
resources = {
|
|
'/x/vs/0': {},
|
|
'/other/vs/0': {'codes': ['1C', '1D']},
|
|
}
|
|
entity = _make_select(desc, '/x/vs/0', resources)
|
|
assert entity.options == ['1C', '1D']
|
|
assert calls == [resources]
|
|
|
|
|
|
def test_callable_options_empty_result():
|
|
desc = SelectDesc(key='cycle', options=lambda resources: [])
|
|
entity = _make_select(desc, '/x/vs/0', {})
|
|
assert entity.options == []
|
|
|
|
|
|
def test_callable_translation_key_reresolves_live_not_once_at_construction():
|
|
"""A callable translation_key (laundry.cycle_select's table-id-gated
|
|
resolver) must be re-evaluated against current coordinator data on
|
|
every access, not baked in once at __init__ -- discovery can run while
|
|
a sibling resource (e.g. /st/washercourse/vs/0) is still an empty stub
|
|
(see entity.py's _is_included docstring), and a one-time resolution
|
|
would permanently show untranslated codes even after a later poll
|
|
populates the real value."""
|
|
desc = SelectDesc(key='cycle', translation_key=lambda resources: resources.get('key'))
|
|
resources = {'key': None}
|
|
entity = _make_select(desc, '/x/vs/0', resources)
|
|
assert entity.translation_key is None
|
|
|
|
resources['key'] = 'washer_cycle_table_02'
|
|
assert entity.translation_key == 'washer_cycle_table_02'
|
|
|
|
|
|
async def test_unknown_vendor_option_round_trips_to_exact_raw_value():
|
|
"""Readable fallback labels must still write the exact Samsung token."""
|
|
class _WritableCoordinator(_FakeCoordinator):
|
|
data = {'mode': 'FutureVendorMode'}
|
|
|
|
def __init__(self, last_resources):
|
|
super().__init__(last_resources)
|
|
self.writes = []
|
|
|
|
async def async_send_command(self, bound, value):
|
|
self.writes.append(value)
|
|
|
|
desc = SelectDesc(
|
|
key='mode', translation_key='door_alert',
|
|
options=('Known', 'FutureVendorMode'), write_fn=lambda *args: None,
|
|
)
|
|
capability = Capability(href='/x/vs/0', entities=(desc,))
|
|
bound = BoundEntity(href='/x/vs/0', capability=capability, desc=desc)
|
|
coordinator = _WritableCoordinator({})
|
|
entity = LocalThingsSelect(coordinator, bound)
|
|
|
|
assert entity.options[-1] == 'Future Vendor Mode'
|
|
await entity.async_select_option('Future Vendor Mode')
|
|
assert coordinator.writes == ['FutureVendorMode']
|