Merge pull request #4 from civ0/improve_value_parsing

Improve parsing of float values returned by API

Author: nigl

custom_components/eta/api.py

@@ -7,6 +7,28 @@ def __init__(self, session, host, port):
         self._host = host
         self._port = port
 
+        self._float_sensor_units = [
+            "%",
+            "A",
+            "Hz",
+            "Ohm",
+            "Pa",
+            "U/min",
+            "V",
+            "W",
+            "W/m²",
+            "bar",
+            "kW",
+            "kWh",
+            "kg",
+            "l",
+            "l/min",
+            "mV",
+            "m²",
+            "s",
+            "°C",
+        ]
+
     def build_uri(self, suffix):
         return "http://" + self._host + ":" + str(self._port) + suffix
 
@@ -30,11 +52,24 @@ async def does_endpoint_exists(self):
         resp = await self.get_request("/user/menu")
         return resp.status == 200
 
+    async def _parse_data(self, data):
+        unit = data["@unit"]
+        if unit in self._float_sensor_units:
+            scale_factor = int(data["@scaleFactor"])
+            decimal_places = int(data["@decPlaces"])
+            raw_value = float(data["#text"])
+            value = raw_value / scale_factor
+            value = round(value, decimal_places)
+        else:
+            # use default text string representation for values that cannot be parsed properly
+            value = data["@strValue"]
+        return value, unit
+
     async def get_data(self, uri):
         data = await self.get_request("/user/var/" + str(uri))
         text = await data.text()
-        data = xmltodict.parse(text)
-        return data["eta"]["value"]["@strValue"], data["eta"]["value"]["@unit"]
+        data = xmltodict.parse(text)["eta"]["value"]
+        return await self._parse_data(data)
 
     async def get_raw_sensor_dict(self):
         data = await self.get_request("/user/menu/")
@@ -54,8 +89,9 @@ async def get_float_sensors(self):
         float_dict = {}
         for key in sensor_dict:
             try:
-                raw_value, unit = await self.get_data(sensor_dict[key])
-                value = float(raw_value)
+                value, unit = await self.get_data(sensor_dict[key])
+                if unit not in self._float_sensor_units:
+                    continue
                 cleaned_key = key.lower().replace(" ", "_")
                 float_dict[cleaned_key] = (sensor_dict[key], value, unit)
             except:

custom_components/eta/sensor.py

@@ -78,10 +78,16 @@ def __init__(
         """
         _LOGGER.warning("ETA Integration - init sensor")
 
-        self._attr_state_class = state_class
         self._attr_device_class = self.determine_device_class(unit)
+
         if unit == "":
             unit = None
+
+        if self._attr_device_class == SensorDeviceClass.ENERGY:
+            self._attr_state_class = SensorStateClass.TOTAL_INCREASING
+        else:
+            self._attr_state_class = state_class
+
         self._attr_native_unit_of_measurement = unit
         self._attr_native_value = float
         id = name.lower().replace(" ", "_")
@@ -107,10 +113,20 @@ async def async_update(self):
 
     @staticmethod
     def determine_device_class(unit):
-        # TODO: Expand this function with more useable units
         unit_dict_eta = {
             "°C": SensorDeviceClass.TEMPERATURE,
             "W": SensorDeviceClass.POWER,
+            "A": SensorDeviceClass.CURRENT,
+            "Hz": SensorDeviceClass.FREQUENCY,
+            "Pa": SensorDeviceClass.PRESSURE,
+            "V": SensorDeviceClass.VOLTAGE,
+            "W/m²": SensorDeviceClass.IRRADIANCE,
+            "bar": SensorDeviceClass.PRESSURE,
+            "kW": SensorDeviceClass.POWER,
+            "kWh": SensorDeviceClass.ENERGY,
+            "kg": SensorDeviceClass.WEIGHT,
+            "mV": SensorDeviceClass.VOLTAGE,
+            "s": SensorDeviceClass.DURATION,
         }
 
         if unit in unit_dict_eta:

tests/test_api.py

@@ -66,7 +66,7 @@ async def test_get_data(monkeypatch):
     eta = EtaAPI("session", "host", "port")
 
     value, unit = await eta.get_data("blub")
-    assert value == "6539"
+    assert value == 6539
     assert unit == "kg"
 
 

tests/test_config_flow.py

@@ -47,6 +47,7 @@ def throw_error_test_url_fixture():
 # we want the config flow validation to succeed during the test.
 
 
+@pytest.mark.asyncio
 async def test_successful_config_flow(hass, bypass_test_url_fixture):
     """Test a successful config flow."""
     # Initialize a config flow
@@ -84,6 +85,7 @@ async def test_successful_config_flow(hass, bypass_test_url_fixture):
 
 
 # In this case, we want to simulate a failure during the config flow.
+@pytest.mark.asyncio
 async def test_failed_config_flow(hass, throw_error_test_url_fixture):
     """Test a failed config flow due to credential validation failure."""
     result = await hass.config_entries.flow.async_init(
@@ -101,6 +103,7 @@ async def test_failed_config_flow(hass, throw_error_test_url_fixture):
     assert result["errors"] == {"base": "url_broken"}
 
 
+@pytest.mark.asyncio
 async def test_options_flow_remove_sensor(bypass_test_url_fixture, hass):
     """Test config flow options."""
     m_instance = AsyncMock()
@@ -137,6 +140,7 @@ async def test_options_flow_remove_sensor(bypass_test_url_fixture, hass):
 
 
 
+@pytest.mark.asyncio
 async def test_options_flow_add_repo(bypass_test_url_fixture, hass):
     """Test config flow options."""
     m_instance = AsyncMock()