Prompted by issue #138's fix, which extended oven._OVEN_MODES with newly confirmed modes instead of reading them from the device's own supportedModes field via options_field -- the pattern laundry.py already uses for buzzer/finish sound. Document that preference so future device-support work reaches for options_field/a callable first and treats a static tuple as a last resort, not the default.
12 KiB
name, description
| name | description |
|---|---|
| adding-device-support | Add or extend support for a Samsung OCF appliance in localthings from a /device/0 diagnostics dump. Use when a device-support issue lands, a device raises the "incomplete capability coverage" repair, a diagnostics JSON needs triaging, or you're mapping OCF resources to HA entities. Covers reading dumps, OCF-standard vs vendor hrefs, the diagnostic/config/normal entity taxonomy, preferring dynamic (device-reported) select options over hardcoded lists, ensuring every href is bound or ignored, and locking it in with a fixture + golden + test. |
Adding device support
localthings maps a Samsung appliance's OCF resources (/device/0 dump) to Home
Assistant entities. Each resource href is handled by a Capability that
declares the entities it produces. This skill is the workflow for turning a new
dump into coverage.
1. Get the dump and see the gaps
A user's diagnostics download (config_entry-localthings-*.json) has, under
data:
resources:{href: rep}— the parsed/device/0snapshot. This is the source of truth, not code comments.unbound_hrefs: resources that bound to no capability. The "incomplete capability coverage" repair fires whenever this is non-empty or the device type is unrecognized (coordinator._update_coverage_gap_issue).
Goal: make unbound_hrefs empty by binding the useful resources and
ignoring the noise — and surface every genuinely useful sensor/select/switch
along the way.
2. Compute coverage without Home Assistant
The registry/ package is HA-free, so you can drive discovery directly (HA
isn't importable standalone because localthings/__init__.py pulls it in — stub
the package to skip that):
import sys, types, json, importlib
cc = types.ModuleType('custom_components'); cc.__path__=['custom_components']; sys.modules['custom_components']=cc
lt = types.ModuleType('custom_components.localthings'); lt.__path__=['custom_components/localthings']; sys.modules['custom_components.localthings']=lt
by_type = importlib.import_module('custom_components.localthings.registry.by_type')
discovery = importlib.import_module('custom_components.localthings.registry.discovery')
adapter = importlib.import_module('custom_components.localthings.registry.adapter')
resources = json.load(open('dump.json'))['data']['resources']
info = resources['/information/vs/0']
reg = by_type.for_device_by_model(info['x.com.samsung.da.modelNum'], info['x.com.samsung.da.description'])
# or: by_type.for_device(one_ui_version) when /otninformation has swVersionInfo.oneUiVersion
unbound = []
bound = discovery.discover(resources, reg.capabilities, reg.pattern_capabilities, log=unbound.append)
state = adapter.flatten(bound, resources) # {entity_key: value}
print('registry:', reg.name, 'unbound:', sorted(unbound))
print('state_keys:', sorted(state))
discover() binds caps (applies rt_filter/match_fn); flatten() applies
exists_fn and produces the final entity values. Use the same routine to
regenerate a golden.
3. OCF-standard vs vendor hrefs (/x/0 vs /x/vs/0)
Samsung appliances run RT-OCF and often expose the same state twice:
/x/vs/0— vendor resource,x.com.samsung.da.*fields./x/0— standard OCF resource type (oic.r.*) with OCF's fixed field names. Confirmable against the OCF spec:/power/0{value: bool}isoic.r.switch.binary;/operational/state/0isoic.r.operational.state.
Newer firmware advertises both as Samsung migrates onto the OCF standard. There is no single "always prefer vs / always prefer non-vs" rule — decide per resource from the populated dump:
- Both populated, same state (power, kids-lock, remote): prefer the
OCF-standard
/x/0; fall back to/x/vs/0when/x/0is absent. Encode with amatch_fnpresence check — seecommon.POWER_GENERIC/POWER_VS_FALLBACK. - Only vendor populated (
/energy/consumption/0is often empty{}): use/x/vs/0. - Vendor is a superset (
/operational/state/vs/0adds fields the OCF one lacks): build on the vendor resource, ignore the OCF subset.
Course/cycle is not an OCF question — there's no standard course resource, so
/course/vs/0 (and the /st/*course/vs/0 re-encoding) are both vendor.
4. Entity taxonomy — the judgement call
For each field worth exposing, decide the entity kind and category
(entity_category on the descriptor):
- Normal / primary (no
entity_category): the things a user acts on or watches — power switch, machine state, the cycle select, energy sensors. config: user-tunable settings — sound mode, door LED, wash temperature, buzzer. Shown under the device's Configuration section.diagnostic: read-only status/troubleshooting — alarms, diagnosis, job beginning status, last-operation source.
Also set poll_tier (hot/warm/cold) on the capability for how often it's
sub-polled between summary polls. Pick descriptor types from entities.py
(SensorDesc, SelectDesc, SwitchDesc, NumberDesc, BinarySensorDesc,
TimeDesc, ButtonDesc) — the class selects the HA platform.
Don't guess. If a field's meaning or write contract is unclear from the dump
(opaque encoded blobs, no supported-values list), leave it unbound so it surfaces
as a gap for a human, or ignore it with a documented reason — never invent an
entity on a hunch (ignored.py's rule).
5. Select options: read them from the device, don't hardcode
A SelectDesc's options should come from the device's own advertised list
whenever the resource carries one, not from a Python tuple typed in from a
single dump. Two dynamic forms already exist in the repo and should be
reached for first:
options_field='x.com.samsung.da.supportedModes'(or whatever the resource's own supported-values field is called) — reads the live rep on the capability's own href. Seelaundry.py'sbuzzer_sound/finish_sound(options_field='supportedBuzzerSound'/'supportedFinishSound').options=<callable>— for option lists that live on a different resource than the select's own href (e.g. a course table keyed off a sibling href). Seelaundry.cycle_select'soptions=cycle_options.
A static options=(...) tuple is a coverage gap waiting to happen: the next
dump from a different board generation will report modes/values the tuple
doesn't have, and both the HA options list and write_fn's validation (if
it checks the same tuple) will silently reject values the device itself
advertises as supported. That's exactly what happened with oven._OVEN_MODES
in issue #138 — a hardcoded list rejected AirFryer/Dehydrate/
SelfClean/etc. even though the device's own supportedModes field listed
them. Reach for a static tuple only when the dump genuinely has no
supported-values field to read (e.g. the NV7000BS-class oven dump
_OVEN_MODES was inferred before any live oven dump existed — see that
module's docstring), and treat it as an interim best-guess rather than a
permanent design choice: migrate it to options_field/a callable the moment
a dump with a real supported-values list surfaces, instead of just adding
the new values to the static tuple.
6. Names and enum labels live in translations, never in Python
Descriptors have no name field. Every entity is named from the shipped
catalog, keyed by translation_key — which defaults to the descriptor's own
key. So adding SensorDesc(key='filter_status', ...) obliges you to add:
"entity": { "sensor": { "filter_status": { "name": "Filter status" } } }
to translations/en.json. Skip it and the entity ships nameless;
tests/test_translations.py fails the build instead.
- Sentence case ("Filter status", not "Filter Status"), per HA's style guide — capitalize only proper nouns and Samsung feature names ("AI Energy Mode", "Storm Wash+").
- Set
translation_keyexplicitly only to share one catalog entry across descriptors, or to point at a differently-named one. Two descriptors on the same platform with the samekeyalready share an entry — intended forcommon.py's OCF/vendor fallback pairs, a silent mislabel otherwise. - Prefer HA's own vocabulary where it fits: a
device_classgives you translated states for free (binary_sensordoor/running,sensortimestamp/enum), so don't restate them.
Selects whose options are raw device codes (course/cycle, code-valued settings) additionally need those codes labelled:
options/options_fieldsupply the raw codes; the catalog maps them.- Add labels under
entity.select.<translation_key>.state.<code>, code lowercased (e.g."16": "Cotton").select.pyderives which values it normalizes from the catalog itself, so there is no Python list to keep in sync — a code with no entry simply renders as the raw code, which is the cue to identify and name it.
translations/en.json is the only place any of this lives: there is no
strings.json (Home Assistant doesn't read one from a custom integration) and
no [%key:...%] resolution (that's Core build tooling). Every other language
must mirror en.json key for key — also enforced by
tests/test_translations.py.
7. Coverage discipline: bound or ignored
Every href in the dump must resolve, or the repair fires. If a resource isn't
worth an entity, add it to capabilities/ignored.py (a no-entity Capability)
with a one-line reason. Add there only when it's irrelevant plumbing
(network/OTA/account housekeeping) or a duplicate of state exposed via a
friendlier href.
- Global vs per-registry ignore:
ignored.IGNOREDis folded into every registry. A global ignore collides (via_build) with any real capability that binds the same href in some family — e.g./course/vs/0can't be globally ignored because washers bind it. When only one family should ignore an href that another binds, scope the ignore to that family's registry.
8. Reuse before writing new code
Check common.py (generic OCF: power, energy, alarms, water) and laundry.py
(shared washer/dryer/dishwasher: buzzer, job status, cycle_select + course
machinery) before adding a capability. Cross-family reuse is normal — the dryer
registry uses fridge.FIRMWARE_UPDATE; all three laundry families share
laundry.cycle_select. If two families hand-roll the same helper, hoist it to a
shared module rather than copying.
9. Lock it in
- Add a scrubbed fixture
tests/fixtures/<type>_device.json({"device0": [ {devcol rep}, {href, rep}, ... ]}) — replace serials, MACs, and other PII with placeholders. - Generate
tests/fixtures/golden/<type>.json({"state_keys": [...]}) with the harness in §2. - Add the type to
test_golden_regression.pyand write atest_<type>_capabilities.pyasserting zero unbound hrefs and that the expected entities exist (and any misleading ones are gated). - Run
pytest tests/ -q— and re-run the golden tests for other device types after any change tocommon.py/laundry.py, since they share those.
Key files
registry/discovery.py—discover(), unbound reporting, pattern caps.registry/capability.py,registry/entities.py— theCapabilityand descriptor shapes (rt_filter,match_fn,exists_fn,rep_fn,write_fn).registry/capabilities/{common,laundry,fridge,...}.py— capability defs.registry/capabilities/ignored.py— the ignore list + its philosophy.registry/by_type/*.py— per-device-type registries (what to include).registry/registry.py— the global unknown-device fallback + collision check.tests/test_golden_regression.py,tests/fixtures/— regression harness.