Merge pull request #28 from postlund/sensor

Add generic sensor platform

custom_components/localtuya/const.py

@@ -19,7 +19,10 @@ CONF_OPEN_CMD = 'open_cmd'
 CONF_CLOSE_CMD = 'close_cmd'
 CONF_STOP_CMD = 'stop_cmd'
 
+# sensor
+CONF_SCALING = "scaling"
+
 DOMAIN = "localtuya"
 
 # Platforms in this list must support config flows
-PLATFORMS = ["cover", "fan", "light", "switch"]
+PLATFORMS = ["cover", "fan", "light", "sensor", "switch"]

custom_components/localtuya/sensor.py

@@ -0,0 +1,185 @@
+"""
+Platform to prsent any Tuya DP as a sensor.
+
+Sample config yaml
+
+sensor:
+  - platform: localtuya
+    host: 192.168.0.1
+    local_key: 1234567891234567
+    device_id: 12345678912345671234
+    friendly_name: Current
+    protocol_version: 3.3
+    id: 18
+    unit_of_measurement: mA
+    device_class: current
+"""
+import logging
+from time import time, sleep
+from threading import Lock
+
+import voluptuous as vol
+
+from homeassistant.components.sensor import DOMAIN, PLATFORM_SCHEMA, DEVICE_CLASSES
+from homeassistant.const import (
+    CONF_ID,
+    CONF_DEVICE_CLASS,
+    CONF_FRIENDLY_NAME,
+    CONF_UNIT_OF_MEASUREMENT,
+    STATE_UNKNOWN,
+)
+
+from . import (
+    BASE_PLATFORM_SCHEMA,
+    LocalTuyaEntity,
+    prepare_setup_entities,
+    import_from_yaml,
+)
+from .const import CONF_SCALING
+
+_LOGGER = logging.getLogger(__name__)
+
+DEFAULT_SCALING = 1.0
+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(BASE_PLATFORM_SCHEMA)
+
+
+def flow_schema(dps):
+    """Return schema used in config flow."""
+    return {
+        vol.Optional(CONF_UNIT_OF_MEASUREMENT): str,
+        vol.Optional(CONF_DEVICE_CLASS): vol.In(DEVICE_CLASSES),
+        vol.Optional(CONF_SCALING, default=DEFAULT_SCALING): vol.All(
+            vol.Coerce(float), vol.Range(min=-1000000.0, max=1000000.0)
+        ),
+    }
+
+
+async def async_setup_entry(hass, config_entry, async_add_entities):
+    """Setup a Tuya sensor based on a config entry."""
+    device, entities_to_setup = prepare_setup_entities(config_entry, DOMAIN)
+    if not entities_to_setup:
+        return
+
+    sensors = []
+    for device_config in entities_to_setup:
+        sensors.append(
+            LocaltuyaSensor(
+                TuyaCache(device, config_entry.data[CONF_FRIENDLY_NAME]),
+                config_entry,
+                device_config[CONF_ID],
+            )
+        )
+
+    async_add_entities(sensors, True)
+
+
+def setup_platform(hass, config, add_devices, discovery_info=None):
+    """Set up of the Tuya sensor."""
+    return import_from_yaml(hass, config, DOMAIN)
+
+
+class TuyaCache:
+    """Cache wrapper for pytuya.TuyaDevice"""
+
+    def __init__(self, device, friendly_name):
+        """Initialize the cache."""
+        self._cached_status = ""
+        self._cached_status_time = 0
+        self._device = device
+        self._friendly_name = friendly_name
+        self._lock = Lock()
+
+    @property
+    def unique_id(self):
+        """Return unique device identifier."""
+        return self._device.id
+
+    def __get_status(self):
+        for i in range(5):
+            try:
+                status = self._device.status()
+                return status
+            except Exception:
+                print(
+                    "Failed to update status of device [{}]".format(
+                        self._device.address
+                    )
+                )
+                sleep(1.0)
+                if i + 1 == 3:
+                    _LOGGER.error(
+                        "Failed to update status of device %s", self._device.address
+                    )
+                    #                    return None
+                    raise ConnectionError("Failed to update status .")
+
+    def set_dps(self, state, dps_index):
+        """Change the Tuya sensor status and clear the cache."""
+        self._cached_status = ""
+        self._cached_status_time = 0
+        for i in range(5):
+            try:
+                return self._device.set_dps(state, dps_index)
+            except Exception:
+                print(
+                    "Failed to set status of device [{}]".format(self._device.address)
+                )
+                if i + 1 == 3:
+                    _LOGGER.error(
+                        "Failed to set status of device %s", self._device.address
+                    )
+                    return
+
+        #                    raise ConnectionError("Failed to set status.")
+        self.update()
+
+    def status(self):
+        """Get state of Tuya sensor and cache the results."""
+        self._lock.acquire()
+        try:
+            now = time()
+            if not self._cached_status or now - self._cached_status_time > 15:
+                sleep(0.5)
+                self._cached_status = self.__get_status()
+                self._cached_status_time = time()
+            return self._cached_status
+        finally:
+            self._lock.release()
+
+
+class LocaltuyaSensor(LocalTuyaEntity):
+    """Representation of a Tuya sensor."""
+
+    def __init__(
+        self,
+        device,
+        config_entry,
+        sensorid,
+        **kwargs,
+    ):
+        """Initialize the Tuya sensor."""
+        super().__init__(device, config_entry, sensorid, **kwargs)
+        self._state = STATE_UNKNOWN
+
+    @property
+    def state(self):
+        """Return sensor state."""
+        scale_factor = self._config.get(CONF_SCALING)
+        if scale_factor is not None:
+            return self._state * scale_factor
+        return self._state
+
+    @property
+    def device_class(self):
+        """Return the class of this device."""
+        return self._config.get(CONF_DEVICE_CLASS)
+
+    @property
+    def unit_of_measurement(self):
+        """Return the unit of measurement of this entity, if any."""
+        return self._config.get(CONF_UNIT_OF_MEASUREMENT)
+
+    def status_updated(self):
+        """Device status was updated."""
+        self._state = self.dps(self._dps_id)

custom_components/localtuya/translations/en.json

@@ -48,7 +48,10 @@
                     "voltage": "Voltage",
                     "open_cmd": "Open Command",
                     "close_cmd": "Close Command",
-                    "stop_cmd": "Stop Command"
+                    "stop_cmd": "Stop Command",
+                    "unit_of_measurement": "Unit of Measurement",
+                    "device_class": "Device Class",
+                    "scaling": "Scaling Factor"
                 }
             }
         }
@@ -76,7 +79,10 @@
                     "voltage": "Voltage",
                     "open_cmd": "Open Command",
                     "close_cmd": "Close Command",
-                    "stop_cmd": "Stop Command"
+                    "stop_cmd": "Stop Command",
+                    "unit_of_measurement": "Unit of Measurement",
+                    "device_class": "Device Class",
+                    "scaling": "Scaling Factor"
                 }
             },
             "yaml_import": {