Merge pull request #37 from boralyl/feature/add-washer-device

Adding a washer device.

tests/test_washer.py

@@ -0,0 +1,62 @@
+import json
+import unittest
+
+from wideq.client import Client, DeviceInfo
+from wideq.washer import WasherDevice, WasherState, WasherStatus
+
+
+POLL_DATA = {
+    'APCourse': '10',
+    'DryLevel': '0',
+    'Error': '0',
+    'Initial_Time_H': '0',
+    'Initial_Time_M': '58',
+    'LoadLevel': '4',
+    'OPCourse': '0',
+    'Option1': '0',
+    'Option2': '0',
+    'Option3': '2',
+    'PreState': '23',
+    'Remain_Time_H': '0',
+    'Remain_Time_M': '13',
+    'Reserve_Time_H': '0',
+    'Reserve_Time_M': '0',
+    'RinseOption': '1',
+    'SmartCourse': '51',
+    'Soil': '0',
+    'SpinSpeed': '5',
+    'State': '30',
+    'TCLCount': '15',
+    'WaterTemp': '4',
+}
+
+
+class WasherStatusTest(unittest.TestCase):
+
+    def setUp(self):
+        super().setUp()
+        with open('./tests/fixtures/client.json') as fp:
+            state = json.load(fp)
+        self.client = Client.load(state)
+        self.device_info = DeviceInfo({
+            'alias': 'WASHER',
+            'deviceId': '33330ba80-107d-11e9-96c8-0051ede85d3f',
+            'deviceType': 201,
+            'modelJsonUrl': (
+                'https://aic.lgthinq.com:46030/api/webContents/modelJSON?'
+                'modelName=F3L2CYV5W_WIFI&countryCode=WW&contentsId='
+                'JS1217232703654216&authKey=thinq'),
+            'modelNm': 'F3L2CYV5W_WIFI',
+        })
+        self.washer = WasherDevice(self.client, self.device_info)
+
+    def test_properties(self):
+        status = WasherStatus(self.washer, POLL_DATA)
+        self.assertEqual(WasherState.RINSING, status.state)
+        self.assertEqual(WasherState.RUNNING, status.previous_state)
+        self.assertTrue(status.is_on)
+        self.assertEqual(13, status.remaining_time)
+        self.assertEqual(58, status.initial_time)
+        self.assertEqual('Towels', status.course)
+        self.assertEqual('SmallLoad', status.smart_course)
+        self.assertEqual('No Error', status.error)

wideq/client.py

@@ -372,6 +372,7 @@ class ModelInfo(object):
         reference = self.value(key).reference
         if value in reference:
             return reference[value]['_comment']
+        return None
 
     @property
     def binary_monitor_data(self):

wideq/dryer.py

@@ -2,6 +2,7 @@ import enum
 from typing import Optional
 
 from .client import Device, _UNKNOWN
+from .util import lookup_enum, lookup_reference
 
 
 class DryerState(enum.Enum):
@@ -123,38 +124,30 @@ class DryerStatus(object):
         else:
             return 'ON'
 
-    def _lookup_enum(self, attr: str) -> str:
-        """Looks up an enum value for the provided attr.
-
-        :param attr: The attribute to lookup in the enum.
-        :returns: The enum value.
-        """
-        return self.dryer.model.enum_name(attr, self.data[attr])
-
     @property
     def state(self) -> DryerState:
         """Get the state of the dryer."""
-        return DryerState(self._lookup_enum('State'))
+        return DryerState(lookup_enum('State', self.data, self.dryer))
 
     @property
     def previous_state(self) -> DryerState:
         """Get the previous state of the dryer."""
-        return DryerState(self._lookup_enum('PreState'))
+        return DryerState(lookup_enum('PreState', self.data, self.dryer))
 
     @property
     def dry_level(self) -> DryLevel:
         """Get the dry level."""
-        return DryLevel(self._lookup_enum('DryLevel'))
+        return DryLevel(lookup_enum('DryLevel', self.data, self.dryer))
 
     @property
     def temperature_control(self) -> TempControl:
         """Get the temperature control setting."""
-        return TempControl(self._lookup_enum('TempControl'))
+        return TempControl(lookup_enum('TempControl', self.data, self.dryer))
 
     @property
     def time_dry(self) -> TimeDry:
         """Get the time dry setting."""
-        return TimeDry(self._lookup_enum('TimeDry'))
+        return TimeDry(lookup_enum('TimeDry', self.data, self.dryer))
 
     @property
     def is_on(self) -> bool:
@@ -174,28 +167,17 @@ class DryerStatus(object):
             int(self.data['Initial_Time_H']) * 60 +
             int(self.data['Initial_Time_M']))
 
-    def _lookup_reference(self, attr: str) -> str:
-        """Look up a reference value for the provided attribute.
-
-        :param attr: The attribute to find the value for.
-        :returns: The looked up value.
-        """
-        value = self.dryer.model.reference_name(attr, self.data[attr])
-        if value is None:
-            return 'Off'
-        return value
-
     @property
     def course(self) -> str:
         """Get the current course."""
-        return self._lookup_reference('Course')
+        return lookup_reference('Course', self.data, self.dryer)
 
     @property
     def smart_course(self) -> str:
         """Get the current smart course."""
-        return self._lookup_reference('SmartCourse')
+        return lookup_reference('SmartCourse', self.data, self.dryer)
 
     @property
     def error(self) -> str:
         """Get the current error."""
-        return self._lookup_reference('Error')
+        return lookup_reference('Error', self.data, self.dryer)

wideq/util.py

@@ -0,0 +1,31 @@
+from typing import TypeVar
+
+from .client import Device
+
+
+T = TypeVar('T', bound=Device)
+
+
+def lookup_enum(attr: str, data: dict, device: T):
+    """Looks up an enum value for the provided attr.
+
+    :param attr: The attribute to lookup in the enum.
+    :param data: The JSON data from the API.
+    :param device: A sub-class instance of a Device.
+    :returns: The enum value.
+    """
+    return device.model.enum_name(attr, data[attr])
+
+
+def lookup_reference(attr: str, data: dict, device: T) -> str:
+    """Look up a reference value for the provided attribute.
+
+    :param attr: The attribute to find the value for.
+    :param data: The JSON data from the API.
+    :param device: A sub-class instance of a Device.
+    :returns: The looked up value.
+    """
+    value = device.model.reference_name(attr, data[attr])
+    if value is None:
+        return 'Off'
+    return value

wideq/washer.py

@@ -0,0 +1,122 @@
+import enum
+from typing import Optional
+
+from .client import Device
+from .util import lookup_enum, lookup_reference
+
+
+class WasherState(enum.Enum):
+    """The state of the washer device."""
+
+    ADD_DRAIN = '@WM_STATE_ADD_DRAIN_W'
+    COMPLETE = '@WM_STATE_COMPLETE_W'
+    DETECTING = '@WM_STATE_DETECTING_W'
+    DETERGENT_AMOUNT = '@WM_STATE_DETERGENT_AMOUNT_W'
+    DRYING = '@WM_STATE_DRYING_W'
+    END = '@WM_STATE_END_W'
+    ERROR_AUTO_OFF = '@WM_STATE_ERROR_AUTO_OFF_W'
+    FRESH_CARE = '@WM_STATE_FRESHCARE_W'
+    FROZEN_PREVENT_INITIAL = '@WM_STATE_FROZEN_PREVENT_INITIAL_W'
+    FROZEN_PREVENT_PAUSE = '@WM_STATE_FROZEN_PREVENT_PAUSE_W'
+    FROZEN_PREVENT_RUNNING = '@WM_STATE_FROZEN_PREVENT_RUNNING_W'
+    INITIAL = '@WM_STATE_INITIAL_W'
+    OFF = '@WM_STATE_POWER_OFF_W'
+    PAUSE = '@WM_STATE_PAUSE_W'
+    PRE_WASH = '@WM_STATE_PREWASH_W'
+    RESERVE = '@WM_STATE_RESERVE_W'
+    RINSING = '@WM_STATE_RINSING_W'
+    RINSE_HOLD = '@WM_STATE_RINSE_HOLD_W'
+    RUNNING = '@WM_STATE_RUNNING_W'
+    SMART_DIAGNOSIS = '@WM_STATE_SMART_DIAG_W'
+    SMART_DIAGNOSIS_DATA = '@WM_STATE_SMART_DIAGDATA_W'
+    SPINNING = '@WM_STATE_SPINNING_W'
+    TCL_ALARM_NORMAL = 'TCL_ALARM_NORMAL'
+    TUBCLEAN_COUNT_ALARM = '@WM_STATE_TUBCLEAN_COUNT_ALRAM_W'
+
+
+class WasherDevice(Device):
+    """A higher-level interface for a washer."""
+
+    def poll(self) -> Optional['WasherStatus']:
+        """Poll the device's current state.
+
+        Monitoring must be started first with `monitor_start`.
+
+        :returns: Either a `WasherStatus` instance or `None` if the status is
+            not yet available.
+        """
+        # Abort if monitoring has not started yet.
+        if not hasattr(self, 'mon'):
+            return None
+
+        res = self.mon.poll_json()
+        if res:
+            return WasherStatus(self, res)
+        else:
+            return None
+
+
+class WasherStatus(object):
+    """Higher-level information about a washer's current status.
+
+    :param washer: The WasherDevice instance.
+    :param data: JSON data from the API.
+    """
+
+    def __init__(self, washer: WasherDevice, data: dict):
+        self.washer = washer
+        self.data = data
+
+    @property
+    def state(self) -> WasherState:
+        """Get the state of the washer."""
+        return WasherState(lookup_enum('State', self.data, self.washer))
+
+    @property
+    def previous_state(self) -> WasherState:
+        """Get the previous state of the washer."""
+        return WasherState(lookup_enum('PreState', self.data, self.washer))
+
+    @property
+    def is_on(self) -> bool:
+        """Check if the washer is on or not."""
+        return self.state != WasherState.OFF
+
+    @property
+    def remaining_time(self) -> int:
+        """Get the remaining time in minutes."""
+        return (int(self.data['Remain_Time_H']) * 60 +
+                int(self.data['Remain_Time_M']))
+
+    @property
+    def initial_time(self) -> int:
+        """Get the initial time in minutes."""
+        return (
+            int(self.data['Initial_Time_H']) * 60 +
+            int(self.data['Initial_Time_M']))
+
+    def _lookup_reference(self, attr: str) -> str:
+        """Look up a reference value for the provided attribute.
+
+        :param attr: The attribute to find the value for.
+        :returns: The looked up value.
+        """
+        value = self.washer.model.reference_name(attr, self.data[attr])
+        if value is None:
+            return 'Off'
+        return value
+
+    @property
+    def course(self) -> str:
+        """Get the current course."""
+        return lookup_reference('APCourse', self.data, self.washer)
+
+    @property
+    def smart_course(self) -> str:
+        """Get the current smart course."""
+        return lookup_reference('SmartCourse', self.data, self.washer)
+
+    @property
+    def error(self) -> str:
+        """Get the current error."""
+        return lookup_reference('Error', self.data, self.washer)