feat: add more energy sensors properties (#208)

* feat: add more energy sensors properties

* formatting

* update tests

* formatting

* update tests

Author: firstof9

openevsehttp/__main__.py

@@ -719,6 +719,8 @@ def current_capacity(self) -> int:
     def usage_total(self) -> float:
         """Return the total energy usage in Wh."""
         assert self._status is not None
+        if "total_energy" in self._status:
+            return self._status["total_energy"]
         return self._status["watthour"]
 
     @property
@@ -781,8 +783,50 @@ def usage_session(self) -> float:
         Return the energy usage in Wh.
         """
         assert self._status is not None
+        if "session_energy" in self._status:
+            return self._status["session_energy"]
         return float(round(self._status["wattsec"] / 3600, 2))
 
+    @property
+    def total_day(self) -> float | None:
+        """Get the total day energy usage."""
+        assert self._status is not None
+        if "total_day" in self._status:
+            return self._status["total_day"]
+        return None
+
+    @property
+    def total_week(self) -> float | None:
+        """Get the total week energy usage."""
+        assert self._status is not None
+        if "total_week" in self._status:
+            return self._status["total_week"]
+        return None
+
+    @property
+    def total_month(self) -> float | None:
+        """Get the total week energy usage."""
+        assert self._status is not None
+        if "total_month" in self._status:
+            return self._status["total_month"]
+        return None
+
+    @property
+    def total_year(self) -> float | None:
+        """Get the total year energy usage."""
+        assert self._status is not None
+        if "total_year" in self._status:
+            return self._status["total_year"]
+        return None
+
+    @property
+    def has_limit(self) -> bool | None:
+        """Return if a limit has been set."""
+        assert self._status is not None
+        if "has_limit" in self._status:
+            return self._status["has_limit"]
+        return None
+
     @property
     def protocol_version(self) -> str | None:
         """Return the protocol version."""

tests/conftest.py

@@ -81,7 +81,7 @@ def test_charger_new(mock_aioclient):
     mock_aioclient.get(
         TEST_URL_STATUS,
         status=200,
-        body=load_fixture("v4_json/status.json"),
+        body=load_fixture("v4_json/status-new.json"),
     )
     mock_aioclient.get(
         TEST_URL_CONFIG,

tests/fixtures/v4_json/status-new.json

@@ -0,0 +1,59 @@
+{
+    "mode": "STA",
+    "wifi_client_connected": 1,
+    "eth_connected": 0,
+    "net_connected": 1,
+    "ipaddress": "192.168.21.10",
+    "emoncms_connected": 0,
+    "packets_sent": 0,
+    "packets_success": 0,
+    "mqtt_connected": 1,
+    "ohm_hour": "NotConnected",
+    "free_heap": 223464,
+    "comm_sent": 345660,
+    "comm_success": 332432,
+    "rapi_connected": 1,
+    "evse_connected": 1,
+    "amp": 32.2,
+    "voltage": 240,
+    "pilot": 48,
+    "wh": 64582,
+    "temp": 503,
+    "temp1": false,
+    "temp2": 503,
+    "temp3": false,
+    "temp4": 560,
+    "state": 254,
+    "vehicle": 1,
+    "colour": 6,
+    "freeram": 223464,
+    "divertmode": 0,
+    "srssi": -61,
+    "elapsed": 246,
+    "wattsec": 992549,
+    "watthour": 64582,
+    "gfcicount": 1,
+    "nogndcount": 0,
+    "stuckcount": 0,
+    "solar": 0,
+    "grid_ie": 2891,
+    "charge_rate": 0,
+    "divert_update": 11,
+    "ota_update": 0,
+    "time": "2021-08-10T23:00:11Z",
+    "offset": "-0700",
+    "shaper": 1,
+    "shaper_live_pwr": 2299, 
+    "shaper_max_pwr": 4000, 
+    "shaper_cur": 21,
+    "vehicle_soc": 75,
+    "vehicle_range": 468,
+    "vehicle_eta": 18000,
+    "session_energy": 7004,
+    "has_limit": false,
+    "total_day": 1234,
+    "total_week": 12345,
+    "total_month": 123456,
+    "total_year": 1234567,
+    "total_energy": 12345678
+  }

tests/test_main.py

@@ -360,7 +360,12 @@ async def test_get_current_capacity(fixture, expected, request):
 
 
 @pytest.mark.parametrize(
-    "fixture, expected", [("test_charger", 64582), ("test_charger_v2", 1585443)]
+    "fixture, expected",
+    [
+        ("test_charger", 64582),
+        ("test_charger_v2", 1585443),
+        ("test_charger_new", 12345678),
+    ],
 )
 async def test_get_usage_total(fixture, expected, request):
     """Test v4 Status reply."""
@@ -427,7 +432,12 @@ async def test_get_time(fixture, expected, request):
 
 
 @pytest.mark.parametrize(
-    "fixture, expected", [("test_charger", 275.71), ("test_charger_v2", 7003.41)]
+    "fixture, expected",
+    [
+        ("test_charger", 275.71),
+        ("test_charger_v2", 7003.41),
+        ("test_charger_new", 7004),
+    ],
 )
 async def test_get_usage_session(fixture, expected, request):
     """Test v4 Status reply."""
@@ -1319,3 +1329,63 @@ async def test_set_service_level(test_charger, mock_aioclient, caplog):
     )
     with pytest.raises(ValueError):
         await test_charger.set_service_level("A")
+
+
+@pytest.mark.parametrize(
+    "fixture, expected",
+    [("test_charger", None), ("test_charger_v2", None), ("test_charger_new", False)],
+)
+async def test_get_has_limit(fixture, expected, request):
+    """Test has_limit reply."""
+    charger = request.getfixturevalue(fixture)
+    await charger.update()
+    status = charger.has_limit
+    assert status == expected
+
+
+@pytest.mark.parametrize(
+    "fixture, expected",
+    [("test_charger", None), ("test_charger_v2", None), ("test_charger_new", 1234)],
+)
+async def test_get_total_day(fixture, expected, request):
+    """Test total_day reply."""
+    charger = request.getfixturevalue(fixture)
+    await charger.update()
+    status = charger.total_day
+    assert status == expected
+
+
+@pytest.mark.parametrize(
+    "fixture, expected",
+    [("test_charger", None), ("test_charger_v2", None), ("test_charger_new", 12345)],
+)
+async def test_get_total_week(fixture, expected, request):
+    """Test total_week reply."""
+    charger = request.getfixturevalue(fixture)
+    await charger.update()
+    status = charger.total_week
+    assert status == expected
+
+
+@pytest.mark.parametrize(
+    "fixture, expected",
+    [("test_charger", None), ("test_charger_v2", None), ("test_charger_new", 123456)],
+)
+async def test_get_total_month(fixture, expected, request):
+    """Test total_month reply."""
+    charger = request.getfixturevalue(fixture)
+    await charger.update()
+    status = charger.total_month
+    assert status == expected
+
+
+@pytest.mark.parametrize(
+    "fixture, expected",
+    [("test_charger", None), ("test_charger_v2", None), ("test_charger_new", 1234567)],
+)
+async def test_get_total_year(fixture, expected, request):
+    """Test total_year reply."""
+    charger = request.getfixturevalue(fixture)
+    await charger.update()
+    status = charger.total_year
+    assert status == expected