Add consumption report based daily energy consumption

Author: Vilppu Vuorinen

CHANGELOG.md

@@ -5,6 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Added
+- Add report based daily energy consumption for all devices.
+
 ### Changed
 - Guard against zero Ata device energy meter reading. Latest firmware returns occasional zeroes breaking energy consumption integrations.
 - Round temperatures being set to the nearest temperature_increment using round half up.

README.md

@@ -45,6 +45,9 @@ Available properties:
 * `temp_unit`
 * `last_seen`
 * `power`
+* `daily_energy_consumed`
+* `wifi_signal`
+
 
 Other properties are available through `_` prefixed state objects if
 one has the time to go through the source.

pymelcloud/client.py

@@ -196,6 +196,27 @@ async def fetch_device_state(self, device) -> Optional[Dict[Any, Any]]:
         ) as resp:
             return await resp.json()
 
+    async def fetch_energy_report(self, device) -> Optional[Dict[Any, Any]]:
+        """Fetch energy report for the current day.
+
+        The energy report rolls over at midnight MELCloud time.
+        """
+        device_id = device.device_id
+        today_str = datetime.today().strftime("%Y-%m-%d")
+        tomorrow_str = (datetime.today() + timedelta(days=1)).strftime("%Y-%m-%d")
+        async with self._session.post(
+            f"{BASE_URL}/EnergyCost/Report",
+            headers=_headers(self._token),
+            json={
+                "DeviceId": device_id,
+                "UseCurrency": False,
+                "FromDate": f"{today_str}T00:00:00",
+                "ToDate": f"{tomorrow_str}T00:00:00"
+            },
+            raise_for_status=True,
+        ) as resp:
+            return await resp.json()
+
     async def set_device_state(self, device):
         """Update device state.
 

pymelcloud/device.py

@@ -93,6 +93,7 @@ async def update(self):
             and c.get("BuildingID") == self.building_id
         )
         self._state = await self._client.fetch_device_state(self)
+        self._energy_report = await self._client.fetch_energy_report(self)
 
         if self._device_units is None and self.access_level != ACCESS_LEVEL.get(
             "GUEST"
@@ -194,6 +195,21 @@ def power(self) -> Optional[bool]:
             return None
         return self._state.get("Power")
 
+    @property
+    def daily_energy_consumed(self) -> Optional[float]:
+        """Return daily energy consumption for the current day in kWh.
+
+        The value resets at midnight MELCloud time.
+        """
+        if self._energy_report is None:
+            return None
+        return (self._energy_report.get("TotalHeatingConsumed", 0.0)
+                + self._energy_report.get("TotalCoolingConsumed", 0.0)
+                + self._energy_report.get("TotalAutoConsumed", 0.0)
+                + self._energy_report.get("TotalDryConsumed", 0.0)
+                + self._energy_report.get("TotalFanConsumed", 0.0)
+                + self._energy_report.get("TotalOtherConsumed", 0.0))
+
     @property
     def wifi_signal(self) -> Optional[int]:
         """Return wifi signal in dBm (negative value)."""

tests/test_ata_properties.py

@@ -47,6 +47,7 @@ def _build_device(device_conf_name: str, device_state_name: str) -> AtaDevice:
         _client.device_confs.__iter__ = Mock(return_value=[device_conf].__iter__())
         _client.fetch_device_units = CoroutineMock(return_value=[])
         _client.fetch_device_state = CoroutineMock(return_value=device_state)
+        _client.fetch_energy_report = CoroutineMock(return_value=None)
         client = _client
 
     return AtaDevice(device_conf, client)

tests/test_device.py

@@ -1,12 +1,13 @@
 """Device tests."""
+from typing import Any, Dict, Optional
 
 import pytest
 from pymelcloud.ata_device import AtaDevice
 from .util import build_device
 
 
-def _build_device(device_conf_name: str, device_state_name: str) -> AtaDevice:
-    device_conf, client = build_device(device_conf_name, device_state_name)
+def _build_device(device_conf_name: str, device_state_name: str, energy_report: Optional[Dict[Any, Any]]=None) -> AtaDevice:
+    device_conf, client = build_device(device_conf_name, device_state_name, energy_report)
     return AtaDevice(device_conf, client)
 
 
@@ -39,3 +40,29 @@ async def test_round_temperature():
     assert device.round_temperature(25.49999) == 25.0
     assert device.round_temperature(25.5) == 26.0
 
+@pytest.mark.asyncio
+async def test_energy_report_none_if_no_report():
+    device = _build_device("ata_listdevice.json", "ata_get.json")
+
+    await device.update()
+
+    assert device.daily_energy_consumed == None
+
+@pytest.mark.asyncio
+async def test_round_temperature():
+    device = _build_device(
+        "ata_listdevice.json",
+        "ata_get.json",
+        {
+            "TotalHeatingConsumed": 1.0,
+            "TotalCoolingConsumed": 0.0,
+            "TotalAutoConsumed": 2.0,
+            "TotalDryConsumed": 0.0,
+            "TotalFanConsumed": 3.0,
+        },
+    )
+
+    await device.update()
+
+    assert device.daily_energy_consumed == 6.0
+

tests/test_erv_properties.py

@@ -1,78 +1,79 @@
-"""ERV tests."""
-import json
-import os
-
-import pytest
-from asynctest import CoroutineMock, Mock, patch
-from pymelcloud import DEVICE_TYPE_ERV
-from pymelcloud.erv_device import (
-    VENTILATION_MODE_AUTO,
-    VENTILATION_MODE_BYPASS,
-    VENTILATION_MODE_RECOVERY,
-    ErvDevice,
-)
-
-
-def _build_device(device_conf_name: str, device_state_name: str) -> ErvDevice:
-    test_dir = os.path.join(os.path.dirname(__file__), "samples")
-    with open(os.path.join(test_dir, device_conf_name), "r") as json_file:
-        device_conf = json.load(json_file)
-
-    with open(os.path.join(test_dir, device_state_name), "r") as json_file:
-        device_state = json.load(json_file)
-
-    with patch("pymelcloud.client.Client") as _client:
-        _client.update_confs = CoroutineMock()
-        _client.device_confs.__iter__ = Mock(return_value=[device_conf].__iter__())
-        _client.fetch_device_units = CoroutineMock(return_value=[])
-        _client.fetch_device_state = CoroutineMock(return_value=device_state)
-        client = _client
-
-    return ErvDevice(device_conf, client)
-
-@pytest.mark.asyncio
-async def test_erv():
-    device = _build_device("erv_listdevice.json", "erv_get.json")
-
-    assert device.name == ""
-    assert device.device_type == DEVICE_TYPE_ERV
-    assert device.temperature_increment == 1.0
-    assert device.has_energy_consumed_meter is True
-    assert device.total_energy_consumed == 0.1
-    assert device.room_temperature is None
-    assert device.outside_temperature is None
-    assert device.room_co2_level is None
-
-    assert device.ventilation_mode is None
-    assert device.ventilation_modes == [
-        VENTILATION_MODE_RECOVERY,
-        VENTILATION_MODE_BYPASS,
-        VENTILATION_MODE_AUTO,
-    ]
-    assert device.actual_ventilation_mode is None
-    assert device.fan_speed is None
-    assert device.fan_speeds is None
-    assert device.actual_supply_fan_speed is None
-    assert device.actual_exhaust_fan_speed is None
-    assert device.core_maintenance_required is False
-    assert device.filter_maintenance_required is False
-    assert device.night_purge_mode is False
-
-    await device.update()
-
-    assert device.room_temperature == 29.0
-    assert device.outside_temperature == 28.0
+"""ERV tests."""
+import json
+import os
+
+import pytest
+from asynctest import CoroutineMock, Mock, patch
+from pymelcloud import DEVICE_TYPE_ERV
+from pymelcloud.erv_device import (
+    VENTILATION_MODE_AUTO,
+    VENTILATION_MODE_BYPASS,
+    VENTILATION_MODE_RECOVERY,
+    ErvDevice,
+)
+
+
+def _build_device(device_conf_name: str, device_state_name: str) -> ErvDevice:
+    test_dir = os.path.join(os.path.dirname(__file__), "samples")
+    with open(os.path.join(test_dir, device_conf_name), "r") as json_file:
+        device_conf = json.load(json_file)
+
+    with open(os.path.join(test_dir, device_state_name), "r") as json_file:
+        device_state = json.load(json_file)
+
+    with patch("pymelcloud.client.Client") as _client:
+        _client.update_confs = CoroutineMock()
+        _client.device_confs.__iter__ = Mock(return_value=[device_conf].__iter__())
+        _client.fetch_device_units = CoroutineMock(return_value=[])
+        _client.fetch_device_state = CoroutineMock(return_value=device_state)
+        _client.fetch_energy_report = CoroutineMock(return_value=None)
+        client = _client
+
+    return ErvDevice(device_conf, client)
+
+@pytest.mark.asyncio
+async def test_erv():
+    device = _build_device("erv_listdevice.json", "erv_get.json")
+
+    assert device.name == ""
+    assert device.device_type == DEVICE_TYPE_ERV
+    assert device.temperature_increment == 1.0
+    assert device.has_energy_consumed_meter is True
+    assert device.total_energy_consumed == 0.1
+    assert device.room_temperature is None
+    assert device.outside_temperature is None
+    assert device.room_co2_level is None
+
+    assert device.ventilation_mode is None
+    assert device.ventilation_modes == [
+        VENTILATION_MODE_RECOVERY,
+        VENTILATION_MODE_BYPASS,
+        VENTILATION_MODE_AUTO,
+    ]
+    assert device.actual_ventilation_mode is None
+    assert device.fan_speed is None
+    assert device.fan_speeds is None
+    assert device.actual_supply_fan_speed is None
+    assert device.actual_exhaust_fan_speed is None
+    assert device.core_maintenance_required is False
+    assert device.filter_maintenance_required is False
+    assert device.night_purge_mode is False
+
+    await device.update()
+
+    assert device.room_temperature == 29.0
+    assert device.outside_temperature == 28.0
     assert device.room_co2_level is None
-
-    assert device.ventilation_mode == VENTILATION_MODE_RECOVERY
-    assert device.actual_ventilation_mode == VENTILATION_MODE_RECOVERY
-    assert device.fan_speed == "3"
-    assert device.fan_speeds == ["1", "2", "3", "4"]
-    assert device.actual_supply_fan_speed == "3"
-    assert device.actual_exhaust_fan_speed == "3"
-    assert device.core_maintenance_required is False
-    assert device.filter_maintenance_required is False
-    assert device.night_purge_mode is False
+
+    assert device.ventilation_mode == VENTILATION_MODE_RECOVERY
+    assert device.actual_ventilation_mode == VENTILATION_MODE_RECOVERY
+    assert device.fan_speed == "3"
+    assert device.fan_speeds == ["1", "2", "3", "4"]
+    assert device.actual_supply_fan_speed == "3"
+    assert device.actual_exhaust_fan_speed == "3"
+    assert device.core_maintenance_required is False
+    assert device.filter_maintenance_required is False
+    assert device.night_purge_mode is False
 
     assert device.wifi_signal == -65
     assert device.has_error is False

tests/util.py

@@ -1,9 +1,10 @@
 import json
 import os
+from typing import Any, Dict, Optional
 
 from asynctest import CoroutineMock, Mock, patch
 
-def build_device(device_conf_name: str, device_state_name: str):
+def build_device(device_conf_name: str, device_state_name: str, energy_report: Optional[Dict[Any, Any]]=None):
     test_dir = os.path.join(os.path.dirname(__file__), "samples")
     with open(os.path.join(test_dir, device_conf_name), "r") as json_file:
         device_conf = json.load(json_file)
@@ -16,6 +17,7 @@ def build_device(device_conf_name: str, device_state_name: str):
         _client.device_confs.__iter__ = Mock(return_value=[device_conf].__iter__())
         _client.fetch_device_units = CoroutineMock(return_value=[])
         _client.fetch_device_state = CoroutineMock(return_value=device_state)
+        _client.fetch_energy_report = CoroutineMock(return_value=energy_report)
         client = _client
 
     return device_conf, client

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist=py36,py37,py38,flake8,typing
+envlist=py36,py37,py38,py39,flake8,typing
 
 [testenv]
 deps=