solarlog-cli 0.3.2__tar.gz → 0.5.0__tar.gz

{solarlog_cli-0.3.2 → solarlog_cli-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: solarlog_cli
-Version: 0.3.2
+Version: 0.5.0
 Summary: Python library to access the Solar-Log
 Project-URL: Repository, https://github.com/dontinelli/solarlog_cli.git
 Project-URL: Issues, https://github.com/dontinelli/solarlog_cli/issues

{solarlog_cli-0.3.2 → solarlog_cli-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "solarlog_cli"
-version = "0.3.2"
+version = "0.5.0"
 authors = [
   { name="dontinelli", email="73341522+dontinelli@users.noreply.github.com" },
 ]

{solarlog_cli-0.3.2 → solarlog_cli-0.5.0}/src/solarlog_cli/solarlog_client.py

@@ -26,15 +26,17 @@ class Client:
 
     # pylint: disable=too-many-positional-arguments
 
-    def __init__(self, host: str, password: str = "") -> None:
+    def __init__(self, host: str, session: ClientSession | None, password: str = "") -> None:
         self.host: str = host
         self.password: str = password
         self.token: str = ""
 
         self.request_timeout = 30
-        self.session = ClientSession(
-            timeout=ClientTimeout(total=self.request_timeout)
-        )
+
+        if not session:
+            self.session = ClientSession()
+        else:
+            self.session = session
 
         self._close_session: bool = True
 
@@ -42,14 +44,15 @@ class Client:
     async def test_connection(self) -> bool:
         """Test the connection to Solar-Log."""
         if self.session is None:
-            self.session = ClientSession(
-                timeout=ClientTimeout(total=self.request_timeout)
-            )
+            self.session = ClientSession()
             self._close_session = True
 
         url = f"{self.host}/getjp"
 
-        response = await self.session.post(url, json=SOLARLOG_REQUEST_PAYLOAD)
+        response = await self.session.post(
+            url, json=SOLARLOG_REQUEST_PAYLOAD,
+            timeout=ClientTimeout(total=self.request_timeout)
+        )
 
         if response.status == 200:
             return True
@@ -85,9 +88,7 @@ class Client:
     async def execute_http_request(self, body: str, path: str = "getjp") -> ClientResponse:
         """Helper function to process the HTTP Get call."""
         if self.session is None:
-            self.session = ClientSession(
-                timeout=ClientTimeout(total=self.request_timeout)
-            )
+            self.session = ClientSession()
             self._close_session = True
 
         url = f"{self.host}/{path}"
@@ -105,6 +106,7 @@ class Client:
                 url=url,
                 headers=header,
                 data=body,
+                timeout=ClientTimeout(total=self.request_timeout),
             )
         except asyncio.TimeoutError as exception:
             msg = f"Timeout occurred while connecting to Solar-Log at {self.host}"
@@ -177,6 +179,17 @@ class Client:
 
         return data
 
+    async def get_battery_data(self) -> list[float]:
+        """Get power data from Solar-Log"""
+
+        raw_data: dict = await self.parse_http_response(
+            await self.execute_http_request('{ "858": null }')
+        )
+
+        data: list[float] = raw_data["858"]
+
+        return data
+
     async def get_power_per_inverter(self) -> dict[int, float]:
         """Get power data from Solar-Log"""
 

{solarlog_cli-0.3.2 → solarlog_cli-0.5.0}/src/solarlog_cli/solarlog_connector.py

@@ -4,13 +4,15 @@ from datetime import timezone, tzinfo
 import logging
 from zoneinfo import ZoneInfo
 
+from aiohttp import ClientSession
+
 from .solarlog_client import Client
 from .solarlog_exceptions import(
     SolarLogAuthenticationError,
     SolarLogConnectionError,
     SolarLogUpdateError,
 )
-from .solarlog_models import SolarlogData, InverterData
+from .solarlog_models import BatteryData, InverterData, SolarlogData
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -28,8 +30,9 @@ class SolarLogConnector:
         tz: str = "",
         device_enabled: dict[int, bool] | None = None,
         password: str = "",
+        session: ClientSession | None = None,
     ):
-        self.client = Client(host, password)
+        self.client = Client(host, session, password)
         self.extended_data: bool = extended_data
 
         self._device_list: dict[int, InverterData] = {}
@@ -92,6 +95,8 @@ class SolarLogConnector:
             if self._device_list != {}:
                 data.inverter_data = await self.update_inverter_data()
 
+            data.battery_data = await self.update_battery_data()
+
             _LOGGER.debug("Extended data updated: %s",data)
 
         #calculated values (for downward compatibility)
@@ -109,6 +114,26 @@ class SolarLogConnector:
 
         return data
 
+
+    async def update_battery_data(self) -> BatteryData | None:
+        """Update device specific data."""
+
+        raw_data = await self.client.get_battery_data()
+
+        if raw_data == []:
+            return None
+
+        battery_data = BatteryData(
+                voltage=raw_data[0],
+                level=raw_data[1],
+                charge_power=raw_data[2],
+                discharge_power=raw_data[3],
+            )
+
+        _LOGGER.debug("Battery data updated: %s",battery_data)
+
+        return battery_data
+
     async def update_device_list(self) -> dict[int, InverterData]:
         """Update list of devices."""
         if not self.extended_data:

{solarlog_cli-0.3.2 → solarlog_cli-0.5.0}/src/solarlog_cli/solarlog_models.py

@@ -4,6 +4,16 @@ from datetime import datetime
 
 from mashumaro import DataClassDictMixin
 
+@dataclass
+class BatteryData():
+    """Battery Data model."""
+
+    charge_power: float = 0
+    discharge_power: float = 0
+    level: float = 0
+    voltage: float = 0
+
+
 @dataclass
 class InverterData():
     """Inverter Data model."""
@@ -46,6 +56,7 @@ class SolarlogData(DataClassDictMixin):
     usage: float | None = None
 
     #extended data
+    battery_data: BatteryData | None = None
     inverter_data: dict[int, InverterData] = field(default_factory=dict)
     production_year: float | None = None
     self_consumption_year: float | None = None

{solarlog_cli-0.3.2 → solarlog_cli-0.5.0}/tests/__snapshots__/test_solarlog_cli.ambr

@@ -2,6 +2,12 @@
 # name: test_update_data[asyncio]
   dict({
     'alternator_loss': 100,
+    'battery_data': dict({
+      'charge_power': 1074,
+      'discharge_power': 0,
+      'level': 79,
+      'voltage': 0,
+    }),
     'capacity': 27.901119402985074,
     'consumption_ac': 3110,
     'consumption_day': 47819,

solarlog_cli-0.5.0/tests/fixtures/battery_data.json

@@ -0,0 +1,3 @@
+{
+    "858": [0,79,1074,0]
+}

solarlog_cli-0.5.0/tests/fixtures/battery_data_without_battery.json

@@ -0,0 +1,3 @@
+{
+    "858": []
+}

{solarlog_cli-0.3.2 → solarlog_cli-0.5.0}/tests/test_solarlog_cli.py

@@ -1,6 +1,7 @@
 """Tests for solarlog_cli."""
 
 from aioresponses import aioresponses
+from aiohttp import ClientSession
 
 import pytest
 from syrupy.assertion import SnapshotAssertion
@@ -48,6 +49,26 @@ async def test_connection(
     assert solarlog_connector.client.session.closed
 
 
+async def test_existing_session(
+    responses: aioresponses,
+) -> None:
+    """Test connection."""
+    responses.post(
+        "localhost/getjp",
+        status=200,
+    )
+
+    solarlog_connector = SolarLogConnector("localhost", session=ClientSession())
+
+    assert await solarlog_connector.test_connection()
+
+    assert solarlog_connector.host == "localhost"
+
+    assert solarlog_connector.client.session is not None
+    assert not solarlog_connector.client.session.closed
+    await solarlog_connector.client.close()
+    assert solarlog_connector.client.session.closed
+
 async def test_extended_data_available(
     responses: aioresponses,
 ) -> None:
@@ -155,6 +176,10 @@ async def test_update_data(
         "http://solarlog.com/getjp",
         body=load_fixture("energy_per_inverter.json"),
     )
+    responses.post(
+        "http://solarlog.com/getjp",
+        body=load_fixture("battery_data.json"),
+    )
 
     solarlog_connector = SolarLogConnector(
         "http://solarlog.com",
@@ -170,6 +195,44 @@ async def test_update_data(
     await solarlog_connector.client.close()
     assert solarlog_connector.client.session.closed
 
+async def test_update_data_without_battery(
+    responses: aioresponses,
+) -> None:
+    """Test update data."""
+    responses.post(
+        "http://solarlog.com/getjp",
+        body=load_fixture("basic_data.json"),
+    )
+    responses.post(
+        "http://solarlog.com/getjp",
+        body=load_fixture("extended_data.json"),
+    )
+    responses.post(
+        "http://solarlog.com/getjp",
+        body=load_fixture("power_per_inverter.json"),
+    )
+    responses.post(
+        "http://solarlog.com/getjp",
+        body=load_fixture("energy_per_inverter.json"),
+    )
+    responses.post(
+        "http://solarlog.com/getjp",
+        body=load_fixture("battery_data_without_battery.json"),
+    )
+
+    solarlog_connector = SolarLogConnector(
+        "http://solarlog.com",
+        True,
+        "UTC",
+        {0: True, 1: True, 2: False, 3: True},
+    )
+
+    data = await solarlog_connector.update_data()
+
+    assert data.battery_data is None
+
+    await solarlog_connector.client.close()
+    assert solarlog_connector.client.session.closed
 
 @pytest.mark.parametrize(
     ("status", "request_timeout", "error"),