Merge pull request #703 from mintsoft/master

Adding heated towel radiator element, AFD02

Author: jasonacox

tinytuya/Contrib/README.md

@@ -228,7 +228,7 @@ In addition to the built-in `OutletDevice`, `BulbDevice` and `CoverDevice` devic
 * WiFiDualMeterDevice - A community-contributed Python module to add support for Tuya WiFi Dual Meter device
 * Author: [Guillaume Gardet](https://github.com/ggardet)
 
-```
+```python
 from tinytuya.Contrib import WiFiDualMeterDevice
 
 wdm = WiFiDualMeterDevice.WiFiDualMeterDevice(
@@ -243,8 +243,35 @@ wdm.print_all()
 # Only print Voltage and frequency
 print(wdm.get_freq())
 print(wdm.get_voltage())
+```
+
+### TowelRailHeaterDevice
+
+* TowelRailHeaterDevice - A community-contributed Python module to add support for Tuya WiFi Towel Rail Heater
+* Author: [Rob Emery](https://github.com/mintsoft)
+
+The mode is mapped as follows:
+* "auto" is the scheduler, I could not find a way to set or configure the schedule through Tuya, only physically on the device
+* "hot" is the user configured temperature (`set_target_temperature`)
+* "cold" is the hard-coded 50 degrees C
+* "eco"  is the heat for a defined duration and then switches back off.
+
+```python
+from tinytuya.Contrib import TowelRailHeaterDevice
+
+device = TowelRailHeaterDevice.TowelRailHeaterDevice(
+      dev_id='YOUR_DEV_ID',
+      address='192.168.XX.YY',      # Or set to 'Auto' to auto-discover IP address
+      local_key='LOCAL_KEY',
+      version=3.4)
 
+# Print all known values
+print(device.status_json())
+
+print(device.get_operating_mode())
+print(device.get_current_temperature())
 
+```
 ## Submit Your Device
 
 * We welcome new device modules!

tinytuya/Contrib/TowelRailHeaterDevice.py

@@ -0,0 +1,137 @@
+from tinytuya.core import Device
+
+"""
+ Python module to interface with Tuya Heated Towel Rail devices
+
+ Local Control Classes
+    TowelRailHeaterDevice(..., version=3.4)
+        This class uses a default version of 3.4
+        See OutletDevice() for the other constructor arguments
+
+ Functions
+    TowelRailHeaterDevice:
+        status_json()
+        get_current_temperature()
+        get_target_temperature()
+        set_target_temperature()
+        get_operating_mode()
+        set_operating_mode()
+        get_current_state()
+        get_timer()                        # returns number of minutes
+        set_timer()                        # expects number of minutes
+    Inherited
+        json = status()                    # returns json payload
+        set_version(version)               # protocol version (defaults to 3.4 for this device)
+        set_socketPersistent(False/True)   # False [default] or True
+        set_socketNODELAY(False/True)      # False or True [default]
+        set_socketRetryLimit(integer)      # retry count limit [default 5]
+        set_socketTimeout(timeout)         # set connection timeout in seconds [default 5]
+        set_dpsUsed(dps_to_request)        # add data points (DPS) to request
+        add_dps_to_request(index)          # add data point (DPS) index set to None
+        set_retry(retry=True)              # retry if response payload is truncated
+        set_status(on, switch=1, nowait)   # Set status of device to 'on' or 'off' (bool)
+        set_value(index, value, nowait)    # Set int value of any index.
+        heartbeat(nowait)                  # Send heartbeat to device
+        updatedps(index=[1], nowait)       # Send updatedps command to device
+        turn_on(switch=1, nowait)          # Turn on device
+        turn_off(switch=1, nowait)         # Turn off
+        set_timer(num_secs, nowait)        # Set timer for num_secs
+        set_debug(toggle, color)           # Activate verbose debugging output
+        set_sendWait(num_secs)             # Time to wait after sending commands before pulling response
+        detect_available_dps()             # Return list of DPS available from device
+        generate_payload(command, data)    # Generate TuyaMessage payload for command with data
+        send(payload)                      # Send payload to device (do not wait for response)
+        receive()
+"""
+
+
+class TowelRailHeaterDevice(Device):
+    """
+    Represents a Tuya based Towel Rail Heating Element
+    """
+
+    DPS_POWER = "1"
+    DPS_SET_TEMP = "16"
+    DPS_CUR_TEMP = "24"
+    DPS_MODE = "2"
+    DPS_TIMER = "111"
+
+    def __init__(self, *args, **kwargs):
+        # set the default version to 3.4 as that is what my device uses
+        if "version" not in kwargs or not kwargs["version"]:
+            kwargs["version"] = 3.4
+        super(TowelRailHeaterDevice, self).__init__(*args, **kwargs)
+
+    def status_json(self):
+        """Wrapper around status() that replaces DPS indices with human readable labels."""
+        status = self.status()["dps"]
+        return {
+            "Power On": status[self.DPS_POWER],
+            "Set temperature": self.tuya_temperature_to_celsius(status[self.DPS_SET_TEMP]),
+            "Current temperature": self.tuya_temperature_to_celsius(status[self.DPS_CUR_TEMP]),
+            "Operating mode": status[self.DPS_MODE],
+            "Timer": self.tuya_duration_to_minutes(status[self.DPS_TIMER]),
+        }
+
+    def tuya_temperature_to_celsius(self, temperature):
+        return round(float(temperature) / 10, 1)
+
+    def celsius_to_tuya_temperature(self, temperature):
+        return int(round(float(temperature) * 10))
+
+    def get_current_temperature(self):
+        status = self.status()["dps"]
+        return self.tuya_temperature_to_celsius(status[self.DPS_CUR_TEMP])
+
+    def get_target_temperature(self):
+        status = self.status()["dps"]
+        return self.tuya_temperature_to_celsius(status[self.DPS_SET_TEMP])
+
+    def set_target_temperature(self, t):
+        def is_float(f):
+            try:
+                float(f)
+                return True
+            except ValueError:
+                return False
+
+        # non numeric values can confuse the unit
+        if not is_float(t):
+            return
+
+        target = float(t)
+        self.set_value(self.DPS_SET_TEMP, self.celsius_to_tuya_temperature(target))
+
+    def get_operating_mode(self):
+        status = self.status()["dps"]
+        return status[self.DPS_MODE]
+
+    def set_operating_mode(self, mode):
+        if mode not in ("cold", "hot", "eco", "auto"):
+            return
+        self.set_value(self.DPS_MODE, mode)
+
+    def get_current_state(self):
+        status = self.status()["dps"]
+        return "On" if status[self.DPS_POWER] else "Off"
+
+    def tuya_duration_to_minutes(self, duration):
+        # The devices returns 10 for 1 hour, 15 for 1 hour 30, 20 for 2 hours
+        # but it seems more intuitive to use minutes as our interface
+        return duration * 6
+
+    def minutes_to_tuya_duration(self, duration):
+        # The device expects 10 for 1 hour, 15 for 1 hour 30, 20 for 2 hours
+        # so we need to convert from minutes into this format
+        return int(duration / 6)
+
+    def get_timer(self):
+        status = self.status()["dps"]
+        return self.tuya_duration_to_minutes(status[self.DPS_TIMER])
+
+    def set_timer(self, delay):
+        if delay < 30 or delay > 8 * 60:  # 8 hours maximum
+            return
+        if delay % 30 != 0:
+            return
+        self.set_value(self.DPS_TIMER, self.minutes_to_tuya_duration(delay))