Marc Billow
b2c0517115
Some DA_WM_TP1/TP2-class boards populate /wm/editcourse/vs/0 without ever filling in editCourseList itself (issue #1), so the Cycle select never gets created even though the device clearly has one (confirmed via SmartThings app screenshots and a currently-selected course). /course/vs/0's own x.com.samsung.da.supportedOptions turns out to already carry the course list, just undocumented: a 1-hex-nibble header followed by one fixed-width record per course, self-indexed by a course-code first byte rather than positional like editCourseList. Confirmed against six independent real-world dumps pulled from open and closed GitHub issues. cycle_options() now falls back to deriving this when editCourseList is empty, gated on two checks: the derived codes must all be distinct, and must include whatever course is currently selected. Larger multiples of the true record width trivially re-pass both checks too (they're just a sparser sampling of the same table), so the smallest passing width wins rather than requiring one unambiguous match. Also fires on the washer_flexwash fixture, newly creating a Cycle select there -- unconfirmed against any ground truth for that device (a different, older board generation with no editCourseList and no screenshots to check against), flagged for follow-up discussion rather than silently accepted.
171 lines
7.8 KiB
Python
171 lines
7.8 KiB
Python
"""Tests for the shared laundry capabilities (washer/dryer/dishwasher)."""
|
|
from custom_components.localthings.registry.capabilities import laundry
|
|
|
|
|
|
class TestCourseHelpers:
|
|
def test_parses_edit_course_list(self):
|
|
raw = 'EditCourseList_1C1D211B1E29243328262722202325322F2E30662D8F96'
|
|
assert laundry.parse_edit_course_list(raw) == [
|
|
'1C', '1D', '21', '1B', '1E', '29', '24', '33', '28', '26', '27',
|
|
'22', '20', '23', '25', '32', '2F', '2E', '30', '66', '2D', '8F', '96',
|
|
]
|
|
|
|
def test_parse_edit_course_list_handles_missing_or_malformed(self):
|
|
assert laundry.parse_edit_course_list(None) == []
|
|
assert laundry.parse_edit_course_list('') == []
|
|
assert laundry.parse_edit_course_list('no underscore') == []
|
|
|
|
def test_cycle_options_reads_live_edit_course_list(self):
|
|
"""The device's own course list -- including a code ('65') never seen
|
|
on the primary dump -- is used as-is; there is no hardcoded table."""
|
|
resources = {
|
|
'/wm/editcourse/vs/0': {
|
|
'x.com.samsung.da.editCourseList': 'EditCourseList_651C',
|
|
},
|
|
}
|
|
assert laundry.cycle_options(resources) == ['65', '1C']
|
|
|
|
def test_cycle_options_empty_when_resource_absent_or_empty(self):
|
|
assert laundry.cycle_options({}) == []
|
|
assert laundry.cycle_options({'/wm/editcourse/vs/0': {}}) == []
|
|
|
|
def test_option_value(self):
|
|
opts = ['DeviceType_0167', 'Course_1C', 'GMT_04']
|
|
assert laundry.option_value(opts, 'Course') == '1C'
|
|
assert laundry.option_value(opts, 'Missing') is None
|
|
|
|
|
|
class TestCourseCodesFromSupportedOptions:
|
|
"""cycle_options()'s fallback for boards that populate
|
|
/wm/editcourse/vs/0 without ever filling in editCourseList itself
|
|
(issue #1) -- derives the course list from /course/vs/0's own
|
|
supportedOptions instead."""
|
|
|
|
# Real dump from issue #1 (DA_WM_TP1_21_COMMON, WW5000C): a 1-hex-nibble
|
|
# header followed by 14 self-indexed 7-byte-per-course records. '1C' (the
|
|
# first record) is confirmed as "Eco 40-60" both by this device's own
|
|
# currently-selected course matching the SmartThings app screenshot's
|
|
# checked item, and by six other independent devices' already-shipped
|
|
# translations agreeing on the same code -> name mapping.
|
|
_REAL_SUPPORTED_OPTIONS = (
|
|
'31C8410923FA67F1B847E923FA67F25843E933FA57F20857E943FA67F'
|
|
'088000913FA67F7485209204A5208780009000A00006841E930FA30F'
|
|
'7F841E920FA30F65841E943FA57F8F8102923FA57F96841E920FA37F'
|
|
'34841E923FA67FA0811E933FA33F'
|
|
)
|
|
|
|
def test_derives_codes_when_edit_course_list_is_empty(self):
|
|
resources = {
|
|
'/wm/editcourse/vs/0': {'x.com.samsung.da.editCourseList': ''},
|
|
'/course/vs/0': {
|
|
'x.com.samsung.da.options': ['Course_1C'],
|
|
'x.com.samsung.da.supportedOptions': [self._REAL_SUPPORTED_OPTIONS],
|
|
},
|
|
}
|
|
assert laundry.cycle_options(resources) == [
|
|
'1C', '1B', '25', '20', '08', '74', '87', '06',
|
|
'7F', '65', '8F', '96', '34', 'A0',
|
|
]
|
|
|
|
def test_edit_course_list_still_takes_priority(self):
|
|
"""A live editCourseList wins even with supportedOptions present --
|
|
no reason to prefer a derived list over the authoritative one."""
|
|
resources = {
|
|
'/wm/editcourse/vs/0': {'x.com.samsung.da.editCourseList': 'EditCourseList_651C'},
|
|
'/course/vs/0': {
|
|
'x.com.samsung.da.options': ['Course_1C'],
|
|
'x.com.samsung.da.supportedOptions': [self._REAL_SUPPORTED_OPTIONS],
|
|
},
|
|
}
|
|
assert laundry.cycle_options(resources) == ['65', '1C']
|
|
|
|
def test_rejects_a_table_missing_the_current_course(self):
|
|
"""The device's own currently-selected course must be a member of
|
|
its derived list -- a mismatch means the guess is wrong, not that
|
|
the device selected something outside its own supported set."""
|
|
resources = {
|
|
'/course/vs/0': {
|
|
'x.com.samsung.da.options': ['Course_FF'],
|
|
'x.com.samsung.da.supportedOptions': [self._REAL_SUPPORTED_OPTIONS],
|
|
},
|
|
}
|
|
assert laundry.cycle_options(resources) == []
|
|
|
|
def test_smallest_passing_split_wins_over_its_own_multiples(self):
|
|
"""K=2 and K=4 both trivially re-pass the same two checks here --
|
|
each is just a sparser sampling of the true, smaller K=1 table (its
|
|
first bytes are a subset of K=1's, so uniqueness and "contains the
|
|
current course" carry over for free) -- but K=1 is the real, most
|
|
specific table and must be the one returned."""
|
|
resources = {
|
|
'/course/vs/0': {
|
|
'x.com.samsung.da.options': ['Course_AA'],
|
|
'x.com.samsung.da.supportedOptions': ['0AABBCCDD'],
|
|
},
|
|
}
|
|
assert laundry.cycle_options(resources) == ['AA', 'BB', 'CC', 'DD']
|
|
|
|
def test_empty_without_supported_options_or_course_href(self):
|
|
assert laundry.cycle_options({}) == []
|
|
assert laundry.cycle_options({'/course/vs/0': {}}) == []
|
|
|
|
|
|
class TestCycleSelect:
|
|
def test_builds_labelled_cycle_select(self):
|
|
desc = laundry.cycle_select(translation_key='dryer_cycle', icon='mdi:tumble-dryer')
|
|
assert desc.key == 'cycle'
|
|
assert desc.translation_key == 'dryer_cycle'
|
|
assert desc.icon == 'mdi:tumble-dryer'
|
|
assert desc.options is laundry.cycle_options
|
|
|
|
def test_reads_raw_course_code_from_options(self):
|
|
desc = laundry.cycle_select(translation_key='dryer_cycle', icon='x')
|
|
rep = {'x.com.samsung.da.options': ['DeviceType_0167', 'Course_16', 'GMT_04']}
|
|
assert desc.rep_fn(rep) == '16'
|
|
assert desc.rep_fn({'x.com.samsung.da.options': ['GMT_04']}) is None
|
|
|
|
def test_exists_only_when_edit_course_list_is_live(self):
|
|
desc = laundry.cycle_select(translation_key='dryer_cycle', icon='x')
|
|
assert desc.exists_fn({}, {}) is False
|
|
assert desc.exists_fn({}, {'/wm/editcourse/vs/0': {}}) is False
|
|
live = {'/wm/editcourse/vs/0': {'x.com.samsung.da.editCourseList': 'EditCourseList_16'}}
|
|
assert desc.exists_fn({}, live) is True
|
|
|
|
def test_cycle_write_rmw_on_options(self):
|
|
desc = laundry.cycle_select(translation_key='dryer_cycle', icon='x')
|
|
rep = {'x.com.samsung.da.options': ['DeviceType_0167', 'Course_16', 'GMT_04']}
|
|
path, body = desc.write_fn('1D', rep)
|
|
assert path == ['course', 'vs', '0']
|
|
assert body == {
|
|
'x.com.samsung.da.options': ['DeviceType_0167', 'Course_1D', 'GMT_04'],
|
|
}
|
|
|
|
def test_cycle_write_noop_without_options(self):
|
|
desc = laundry.cycle_select(translation_key='dryer_cycle', icon='x')
|
|
assert desc.write_fn('1D', {}) is None
|
|
|
|
|
|
class TestBuzzerSound:
|
|
def test_href(self):
|
|
assert laundry.BUZZER_SOUND.href == '/buzzersound/vs/0'
|
|
|
|
def test_buzzer_sound_write(self):
|
|
desc = next(e for e in laundry.BUZZER_SOUND.entities if e.key == 'buzzer_sound')
|
|
assert desc.options_field == 'supportedBuzzerSound'
|
|
path, body = desc.write_fn('On', {})
|
|
assert path == ['buzzersound', 'vs', '0']
|
|
assert body == {'setBuzzerSound': 'On'}
|
|
|
|
def test_finish_sound_exists_only_when_supported(self):
|
|
desc = next(e for e in laundry.BUZZER_SOUND.entities if e.key == 'finish_sound')
|
|
assert desc.exists_fn({'setBuzzerSound': 'On'}, {}) is False
|
|
assert desc.exists_fn({'supportedFinishSound': ['FinishSound_1']}, {}) is True
|
|
|
|
|
|
class TestJobBeginningStatus:
|
|
def test_href_and_field(self):
|
|
assert laundry.JOB_BEGINNING_STATUS.href == '/wm/jobbeginingstatus/vs/0'
|
|
desc = laundry.JOB_BEGINNING_STATUS.entities[0]
|
|
assert desc.field == 'x.com.samsung.da.currentStatus'
|
|
assert desc.entity_category == 'diagnostic'
|