solarlog-cli 0.4.0__tar.gz → 0.6.0__tar.gz

{solarlog_cli-0.4.0 → solarlog_cli-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: solarlog_cli
-Version: 0.4.0
+Version: 0.6.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
@@ -8,12 +8,14 @@ Project-URL: Changelog, https://github.com/dontinelli/solarlog_cli/blob/master/C
 Project-URL: Solar-Log homepage, https://www.solar-log.com/
 Project-URL: API Documentation (inofficial), https://github.com/iobroker-community-adapters/ioBroker.solarlog/blob/master/docs/solarlog_dataobjects.md
 Author-email: dontinelli <73341522+dontinelli@users.noreply.github.com>
+License-File: LICENSE
 Keywords: IoT,hass,home assistant,sensor,smart home,solar
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.12
 Requires-Dist: aiohttp
+Requires-Dist: bcrypt>=4.3.0
 Requires-Dist: mashumaro>=3.13
 Description-Content-Type: text/markdown
 

{solarlog_cli-0.4.0 → solarlog_cli-0.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "solarlog_cli"
-version = "0.4.0"
+version = "0.6.0"
 authors = [
   { name="dontinelli", email="73341522+dontinelli@users.noreply.github.com" },
 ]
@@ -9,6 +9,7 @@ readme = "README.md"
 requires-python = ">=3.12"
 dependencies = [
   "aiohttp",
+  "bcrypt>=4.3.0",
   "mashumaro>=3.13",
 ]
 classifiers = [

{solarlog_cli-0.4.0 → solarlog_cli-0.6.0}/requirements.txt

@@ -1,5 +1,6 @@
 aiohttp>=3.9.5
 aioresponses == 0.7.6
+bcrypt >= 4.3.0
 mashumaro>=3.13
 pytest-aio==1.9.0
 pytest-cov==5.0.0

{solarlog_cli-0.4.0 → solarlog_cli-0.6.0}/src/solarlog_cli/solarlog_client.py

@@ -9,6 +9,7 @@ import logging
 from typing import Any
 
 from aiohttp import ClientResponse, ClientSession, ClientTimeout
+import bcrypt
 
 from .solarlog_exceptions import (
     SolarLogAuthenticationError,
@@ -70,13 +71,42 @@ class Client:
         response = await self.execute_http_request(payload,"login")
 
         text = await response.text()
-        if text.count("FAILED - Password was wrong"):
-            raise SolarLogAuthenticationError
+        _LOGGER.debug("Response: %s",text)
         if text.count("FAILED - User was wrong"):
             #Response means, that no password is required
             self.password = ""
             return False
 
+        if text.count("FAILED - Password was wrong"):
+            # For newer firmware, login with encrypted PWD is required.
+            # Therefore test with encrypted PWD and only raise authentication error,
+            # if login with encrypted PWD fails as well.
+
+            payload = '{ "550": None }'
+
+            response = await self.execute_http_request(payload)
+
+            text = await response.text()
+            _LOGGER.debug("Response to request for user salts: %s",text)
+            r_dict: dict[str, Any] = json.loads(text)
+
+            salt: str = r_dict.get('550',{}).get('104')
+            _LOGGER.debug("Salt to hash pwd: %s",salt)
+
+            try:
+                if salt != 'QUERY IMPOSSIBLE 000' and salt is not None:
+                    hashed_password = bcrypt.hashpw(self.password.encode(), salt.encode())
+                    payload = f"u=user&p={hashed_password.decode('utf-8')}"
+                    response = await self.execute_http_request(payload,"login")
+                    text = await response.text()
+                    _LOGGER.debug("Response of login with hashed pwd: %s",text)
+                    if text.count("FAILED - Password was wrong"):
+                        _LOGGER.debug("Wrong password (hashed)")
+                        raise SolarLogAuthenticationError
+                    self.password = hashed_password.decode('utf-8')
+            except Exception as exception:
+                raise SolarLogAuthenticationError from exception
+
         self.token = response.cookies["SolarLog"].value
 
         _LOGGER.debug("response: %s",text)
@@ -93,7 +123,7 @@ class Client:
 
         url = f"{self.host}/{path}"
 
-        header = {"Content-Type": "text/html"}
+        header = {"Content-Type": "text/html", "X-SL-CSRF-PROTECTION": "1"}
         if self.token != "":
             header |= {"Cookie": f"SolarLog={self.token}"}
             body = f"token={self.token}; " + body
@@ -135,7 +165,7 @@ class Client:
         if text.count('{"QUERY IMPOSSIBLE 000"}'):
             raise SolarLogUpdateError(f"Server response: {text}")
 
-        if text.count("ACCESS DENIED"):
+        if text.count("ACCESS DENIED") and not text.startswith('{"550":{'):
             raise SolarLogAuthenticationError(f"Server response: {text}")
 
         try:
@@ -179,6 +209,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.4.0 → solarlog_cli-0.6.0}/src/solarlog_cli/solarlog_connector.py

@@ -12,7 +12,7 @@ from .solarlog_exceptions import(
     SolarLogConnectionError,
     SolarLogUpdateError,
 )
-from .solarlog_models import SolarlogData, InverterData
+from .solarlog_models import BatteryData, InverterData, SolarlogData
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -63,8 +63,13 @@ class SolarLogConnector:
             return False
         except SolarLogAuthenticationError as err:
             #User has no unprotected access to extended API, try to log in
-            _LOGGER.debug("Authentication error: %s", err)
-            self.extended_data = await self.login()
+            #(login returns false, if no pwd is set)
+            _LOGGER.debug("Auth error during test for extended data: %s", err)
+            try:
+                self.extended_data = await self.login()
+            except SolarLogAuthenticationError as error:
+                _LOGGER.debug("Auth error during login in test for extended data: %s", err)
+                raise SolarLogAuthenticationError from error
             _LOGGER.debug("Login successful?: %s", self.extended_data)
         else:
             self.extended_data = True
@@ -95,6 +100,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)
@@ -112,6 +119,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.4.0 → solarlog_cli-0.6.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.4.0 → solarlog_cli-0.6.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.6.0/tests/fixtures/battery_data.json

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

solarlog_cli-0.6.0/tests/fixtures/battery_data_without_battery.json

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

solarlog_cli-0.6.0/tests/fixtures/user_salts.json

@@ -0,0 +1,16 @@
+{
+    "550": {
+        "100":"ACCESS DENIED",
+        "101":"ACCESS DENIED",
+        "102":"ACCESS DENIED",
+        "103":0,
+        "104":"$2b$08$yw.OTuzhjCHukKjYO0diL.",
+        "105":"ACCESS DENIED",
+        "106":1,
+        "107":"SALT2",
+        "108":"ACCESS DENIED",
+        "109":0,"110":"SALT3",
+        "111":"ACCESS DENIED",
+        "112":1
+    }
+}

{solarlog_cli-0.4.0 → solarlog_cli-0.6.0}/tests/test_solarlog_cli.py

@@ -58,7 +58,8 @@ async def test_existing_session(
         status=200,
     )
 
-    solarlog_connector = SolarLogConnector("localhost", session=ClientSession())
+    solarlog_connector = SolarLogConnector(
+        "localhost", session=ClientSession())
 
     assert await solarlog_connector.test_connection()
 
@@ -69,12 +70,14 @@ async def test_existing_session(
     await solarlog_connector.client.close()
     assert solarlog_connector.client.session.closed
 
+
 async def test_extended_data_available(
     responses: aioresponses,
 ) -> None:
     """Test extended data available."""
 
-    solarlog_connector = SolarLogConnector("http://solarlog.com", password="pwd")
+    solarlog_connector = SolarLogConnector(
+        "http://solarlog.com", password="pwd")
 
     responses.post(
         "http://solarlog.com/getjp",
@@ -99,6 +102,27 @@ async def test_extended_data_available(
     assert not await solarlog_connector.test_extended_data_available()
     assert solarlog_connector.password == ""
 
+    responses.post(
+        "http://solarlog.com/getjp",
+        body=load_fixture("device_list_access_denied.json"),
+    )
+    responses.post(
+        "http://solarlog.com/login",
+        body="FAILED - Password was wrong",
+    )
+    responses.post(
+        "http://solarlog.com/getjp",
+        body=load_fixture("user_salts.json"),
+    )
+    responses.post(
+        "http://solarlog.com/login",
+        exception=SolarLogAuthenticationError('test'),
+    )
+    solarlog_connector.client.password = "pwd"
+    # type: ignore [call-overload]
+    with pytest.raises(SolarLogAuthenticationError):
+        await solarlog_connector.test_extended_data_available()
+
     responses.post(
         "http://solarlog.com/getjp",
         body=load_fixture("device_list.json"),
@@ -108,6 +132,7 @@ async def test_extended_data_available(
     await solarlog_connector.client.close()
     assert solarlog_connector.client.session.closed
 
+
 async def test_login_and_data_retreival(responses: aioresponses) -> None:
     """Test login into Solar-Log."""
     responses.post(
@@ -115,7 +140,8 @@ async def test_login_and_data_retreival(responses: aioresponses) -> None:
         headers={"Set-Cookie": "SolarLog=token"},
         body="SUCCESS - Password was correct, you are now logged in",
     )
-    solarlog_connector = SolarLogConnector("http://solarlog.com", password="pwd")
+    solarlog_connector = SolarLogConnector(
+        "http://solarlog.com", password="pwd")
 
     assert await solarlog_connector.login()
     assert solarlog_connector.client.token == "token"
@@ -129,15 +155,52 @@ async def test_login_and_data_retreival(responses: aioresponses) -> None:
     await solarlog_connector.client.close()
     assert solarlog_connector.client.session.closed
 
+
+async def test_login_hashed_pwd(responses: aioresponses) -> None:
+    """Test login into Solar-Log."""
+
+    responses.post(
+        "http://solarlog.com/login",
+        body="FAILED - Password was wrong",
+    )
+    responses.post(
+        "http://solarlog.com/getjp",
+        body=load_fixture("user_salts.json"),
+    )
+    responses.post(
+        "http://solarlog.com/login",
+        headers={"Set-Cookie": "SolarLog=token"},
+        body="SUCCESS - Password was correct, you are now logged in",
+    )
+    solarlog_connector = SolarLogConnector(
+        "http://solarlog.com", password="pwd")
+
+    assert await solarlog_connector.login()
+    assert solarlog_connector.client.token == "token"
+
+    await solarlog_connector.client.close()
+    assert solarlog_connector.client.session.closed
+
+
 async def test_login_exceptions(responses: aioresponses) -> None:
     """Test exceptions at login into Solar-Log."""
-    solarlog_connector = SolarLogConnector("http://solarlog.com", password="pwd")
+    solarlog_connector = SolarLogConnector(
+        "http://solarlog.com", password="pwd")
 
     responses.post(
         "http://solarlog.com/login",
         body="FAILED - Password was wrong",
     )
-    with pytest.raises(SolarLogAuthenticationError):  # type: ignore [call-overload]
+    responses.post(
+        "http://solarlog.com/getjp",
+        body=load_fixture("user_salts.json"),
+    )
+    responses.post(
+        "http://solarlog.com/login",
+        body="FAILED - Password was wrong",
+    )
+    # type: ignore [call-overload]
+    with pytest.raises(SolarLogAuthenticationError):
         await solarlog_connector.client.login()
 
     responses.post(
@@ -155,6 +218,7 @@ async def test_login_exceptions(responses: aioresponses) -> None:
     await solarlog_connector.client.close()
     assert solarlog_connector.client.session.closed
 
+
 async def test_update_data(
     responses: aioresponses,
     snapshot: SnapshotAssertion
@@ -176,6 +240,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",
@@ -192,6 +260,46 @@ async def test_update_data(
     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"),
     [
@@ -322,11 +430,13 @@ async def test_enabled_devices(responses: aioresponses) -> None:
         body=load_fixture("device_list.json"),
     )
 
-    solarlog_connector = SolarLogConnector("http://solarlog.com",device_enabled={})
+    solarlog_connector = SolarLogConnector(
+        "http://solarlog.com", device_enabled={})
     assert solarlog_connector.device_enabled() == {}
     assert await solarlog_connector.update_device_list() == {}
 
-    solarlog_connector.set_enabled_devices({0: True, 1: False, 2: False, 3: True})
+    solarlog_connector.set_enabled_devices(
+        {0: True, 1: False, 2: False, 3: True})
 
     assert solarlog_connector.device_enabled(0)
     assert not solarlog_connector.device_enabled(1)