bwt-api 0.5.1__tar.gz → 0.6.1__tar.gz

bwt_api-0.6.1/.devcontainer/devcontainer.json

@@ -0,0 +1,7 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+	"name": "Python 3",
+	"image": "mcr.microsoft.com/devcontainers/python:1-3.13-bullseye",
+	"postCreateCommand": "pip install --upgrade pip && pip install .[testing]"
+}

{bwt_api-0.5.1/src/bwt_api.egg-info → bwt_api-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bwt_api
-Version: 0.5.1
+Version: 0.6.1
 Summary: Python API to access the local BWT Perla API.
 Home-page: https://github.com/dkarv/bwt_api
 Author: dkarv
@@ -22,6 +22,7 @@ Requires-Dist: flake8; extra == "testing"
 Requires-Dist: setuptools; extra == "testing"
 Requires-Dist: pytest; extra == "testing"
 Requires-Dist: pytest-cov; extra == "testing"
+Requires-Dist: pytest-asyncio; extra == "testing"
 Requires-Dist: aioresponses; extra == "testing"
 Dynamic: license-file
 

{bwt_api-0.5.1 → bwt_api-0.6.1}/pyproject.toml

@@ -7,3 +7,7 @@ build-backend = "setuptools.build_meta"
 # For smarter version schemes and other configuration options,
 # check out https://github.com/pypa/setuptools_scm
 version_scheme = "no-guess-dev"
+
+[tool.pytest.ini_options]
+pythonpath = ["src",]
+asyncio_mode = "auto"

{bwt_api-0.5.1 → bwt_api-0.6.1}/setup.cfg

@@ -39,6 +39,7 @@ testing =
 	setuptools
 	pytest
 	pytest-cov
+	pytest-asyncio
 	aioresponses
 
 [options.entry_points]

{bwt_api-0.5.1 → bwt_api-0.6.1}/src/bwt_api/api.py

@@ -6,7 +6,6 @@ import aiohttp
 import base64
 import logging
 from datetime import datetime
-from zoneinfo import ZoneInfo
 
 from bwt_api.error import BwtError
 from bwt_api.exception import ApiException, ConnectException, WrongCodeException
@@ -67,6 +66,8 @@ class BwtApi:
         _logger.debug(f"Fetching current data from {self._host}")
         raw = await self.__get_data("GetCurrentData")
         errors = [BwtError(int(error)) for error in raw["ActiveErrorIDs"].split(",") if error]
+        if BwtError.UNKNOWN in errors:
+            _logger.warning(f"Unknown error in current data response {raw['ActiveErrorIDs']}")
         perla_one = raw["CapacityColumn2_ml_dH"] == -1
         
         in_hardness = Hardness(
@@ -135,6 +136,42 @@ class BwtApi:
         keys = [f"Month{month:02}_l" for month in range(1, 13)]
         return YearlyResponse(list(map(lambda k: raw[k], keys)))
 
+
+class BwtSilkApi:
+    """BWT Silk Api."""
+    _session: aiohttp.ClientSession
+    _host: str
+
+    def __init__(self, host):
+        self._host = host
+        self._session = aiohttp.ClientSession()
+    
+    async def __aenter__(self):
+        return self
+
+    async def __aexit__(self, *err):
+        await self.close()
+
+    async def close(self):
+        await self._session.close()
+
+    async def get_registers(self) -> list[int]:
+        """Internal method to fetch json from the endpoint and handle general errors."""
+        try:
+            async with self._session.get(f"http://{self._host}:80/silk/registers") as response:
+                _logger.debug(f"Response status: {response.status}, content-type: {response.headers['content-type']}")
+                if (response.status == 200):
+                    json = await response.json(content_type=None)
+                    _logger.debug(f"Raw response: {json}")
+                    return json["params"]
+                else:
+                    text = await response.text()
+                    _logger.warning(f"Unknown response with status {response.status}: {text}")
+                    raise ApiException(f"Unknown response: {text}")
+        except aiohttp.ClientConnectorError as e:
+            raise ConnectException from e
+
+
 def treated_to_blended(treated: int, hardness_in: int, hardness_out: int) -> float:
     if (hardness_in == 0 | hardness_in == hardness_out):
         return treated

bwt_api-0.6.1/src/bwt_api/bwt.py

@@ -0,0 +1,44 @@
+"""The BWT model check."""
+
+
+from enum import Enum
+import aiohttp
+import logging
+
+from bwt_api.exception import ConnectException
+
+_logger = logging.getLogger(__name__)
+
+class BwtModel(Enum):
+    """Enum for BWT models."""
+    PERLA_LOCAL_API = 1
+    PERLA_SILK = 2
+
+async def determine_bwt_model(host: str) -> BwtModel:
+    """Determine the BWT model based on the api response."""
+
+    _logger.debug(f"Determining BWT model for host {host}")
+    timeout = aiohttp.ClientTimeout(total=3)
+    # Try :8080/api/GetCurrentData
+    try:
+        async with aiohttp.ClientSession() as session:
+            async with session.get(f"http://{host}:8080/api", timeout=timeout) as response:
+                res = await response.text()
+                _logger.debug(f"Response from {host}:8080/api: {response.status} - {res}")
+                if response.status == 404 and res == "Not Found":
+                    return BwtModel.PERLA_LOCAL_API
+    except Exception:
+        pass
+
+    # Try :80/status
+    try:
+        async with aiohttp.ClientSession() as session:
+            async with session.get(f"http://{host}:80/silk/registers", timeout=timeout) as response:
+                res = await response.text()
+                _logger.debug(f"Response from {host}:80/silk/registers: {response.status} - {res}")
+                if response.status == 200 and res.startswith("""{"params":["""):
+                    return BwtModel.PERLA_SILK
+    except Exception:
+        pass
+
+    raise ConnectException(f"Could not determine BWT model for host {host}. Please check the connection or the host address.")

{bwt_api-0.5.1 → bwt_api-0.6.1}/src/bwt_api/error.py

@@ -5,6 +5,7 @@ import enum
 
 
 class BwtError(enum.Enum):
+    UNKNOWN = -1 # Fallback for unknown errors
     OFFLINE_MOTOR_1 = 1
     OFFLINE_MOTOR_2 = 2
     OFFLINE_MOTOR_BLEND = 3
@@ -49,6 +50,17 @@ class BwtError(enum.Enum):
     BRINE_UNSATURATED = 75
     DOSING_FAULT = 88
 
+    def __new__(cls, value):
+        obj = object.__new__(cls)
+        obj._value_ = value
+        return obj
+
+    @classmethod
+    def _missing_(cls, value):
+        obj = cls.UNKNOWN
+        obj._value_ = value
+        return obj
+
     def is_fatal(self) -> bool:
         return self not in WARNING_CODES
 

{bwt_api-0.5.1 → bwt_api-0.6.1}/src/bwt_api/skeleton.py

@@ -5,7 +5,6 @@ import asyncio
 
 
 from bwt_api import __version__
-import bwt_api
 from bwt_api.exception import BwtException, WrongCodeException, ConnectException
 from .api import BwtApi
 

{bwt_api-0.5.1 → bwt_api-0.6.1/src/bwt_api.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bwt_api
-Version: 0.5.1
+Version: 0.6.1
 Summary: Python API to access the local BWT Perla API.
 Home-page: https://github.com/dkarv/bwt_api
 Author: dkarv
@@ -22,6 +22,7 @@ Requires-Dist: flake8; extra == "testing"
 Requires-Dist: setuptools; extra == "testing"
 Requires-Dist: pytest; extra == "testing"
 Requires-Dist: pytest-cov; extra == "testing"
+Requires-Dist: pytest-asyncio; extra == "testing"
 Requires-Dist: aioresponses; extra == "testing"
 Dynamic: license-file
 

{bwt_api-0.5.1 → bwt_api-0.6.1}/src/bwt_api.egg-info/SOURCES.txt

@@ -9,10 +9,12 @@ pyproject.toml
 setup.cfg
 setup.py
 tox.ini
+.devcontainer/devcontainer.json
 .github/workflows/python-package.yml
 .github/workflows/python-publish.yml
 src/bwt_api/__init__.py
 src/bwt_api/api.py
+src/bwt_api/bwt.py
 src/bwt_api/data.py
 src/bwt_api/error.py
 src/bwt_api/exception.py
@@ -25,5 +27,5 @@ src/bwt_api.egg-info/not-zip-safe
 src/bwt_api.egg-info/requires.txt
 src/bwt_api.egg-info/top_level.txt
 tests/conftest.py
-tests/pytest.ini
-tests/test_api.py
+tests/test_api.py
+tests/test_distinguish.py

{bwt_api-0.5.1 → bwt_api-0.6.1}/src/bwt_api.egg-info/requires.txt

@@ -5,4 +5,5 @@ flake8
 setuptools
 pytest
 pytest-cov
+pytest-asyncio
 aioresponses

{bwt_api-0.5.1 → bwt_api-0.6.1}/tests/test_api.py

@@ -17,7 +17,7 @@ __license__ = "MIT"
 
 current_json = """
 {
-   "ActiveErrorIDs" : "5,32,34",
+   "ActiveErrorIDs" : "5,32,34,29",
    "BlendedWaterSinceSetup_l" : 318383,
    "CapacityColumn1_ml_dH" : 5485275,
    "CapacityColumn2_ml_dH" : 3833994,
@@ -158,6 +158,7 @@ async def test_current_data():
                     BwtError.REGENERATIV_20,
                     BwtError.MAINTENANCE_CUSTOMER,
                     BwtError.MAINTENANCE_SERVICE,
+                    BwtError.UNKNOWN,
                 ],
                 blended_total=318383,
                 capacity_1=5485275,

bwt_api-0.6.1/tests/test_distinguish.py

@@ -0,0 +1,64 @@
+from datetime import datetime
+from zoneinfo import ZoneInfo
+import pytest
+
+from bwt_api.api import BwtApi, treated_to_blended
+from bwt_api.bwt import BwtModel, determine_bwt_model
+from bwt_api.error import BwtError
+from bwt_api.data import CurrentResponse, Hardness, BwtStatus
+
+from aioresponses import aioresponses
+
+from bwt_api.exception import ApiException, ConnectException, WrongCodeException
+
+new_json = """
+{
+   "ActiveErrorIDs" : "5,32,34",
+   "BlendedWaterSinceSetup_l" : 318383,
+   "CapacityColumn1_ml_dH" : 5485275,
+   "CapacityColumn2_ml_dH" : 3833994,
+   "CurrentFlowrate_l_h" : 0,
+   "DosingSinceSetup_ml" : 0,
+   "FirmwareVersion" : "2.0207",
+   "HardnessIN_CaCO3" : 374,
+   "HardnessIN_dH" : 21,
+   "HardnessIN_fH" : 37,
+   "HardnessIN_mmol_l" : 4,
+   "HardnessOUT_CaCO3" : 71,
+   "HardnessOUT_dH" : 4,
+   "HardnessOUT_fH" : 7,
+   "HardnessOUT_mmol_l" : 1,
+   "HolidayModeStartTime" : 0,
+   "LastRegenerationColumn1" : "2023-11-16 04:42:15",
+   "LastRegenerationColumn2" : "2023-11-15 04:41:48",
+   "LastServiceCustomer" : "2023-05-18 10:51:07",
+   "LastServiceTechnican" : "2021-01-25 13:14:06",
+   "OutOfService" : 0,
+   "RegenerationCountSinceSetup" : 1505,
+   "RegenerationCounterColumn1" : 754,
+   "RegenerationCounterColumn2" : 751,
+   "RegenerativLevel" : 20,
+   "RegenerativRemainingDays" : 26,
+   "RegenerativSinceSetup_g" : 245846,
+   "ShowError" : 2,
+   "WaterSinceSetup_l" : 261633,
+   "WaterTreatedCurrentDay_l" : 181,
+   "WaterTreatedCurrentMonth_l" : 3137,
+   "WaterTreatedCurrentYear_l" : 80700
+}
+"""
+
+silk_json = """{"params":[0,-1,18,23,285,29,16,2,0,9,8,1,8,4,296,158,0,52,2138,9,40,0,100,2275,11,20,50,1,1,0,160,141,20,0,678,1,-1,-1,6,1,1,15,355,-1,-1,-1,-1,0]}"""
+
+async def test_local_api():
+    with aioresponses() as mocked:
+        mocked.get("http://host:8080/api", status=404, body="Not Found")
+        result = await determine_bwt_model("host")
+        assert result == BwtModel.PERLA_LOCAL_API
+
+async def test_silk():
+    with aioresponses() as mocked:
+        mocked.get("http://host:8080/api", status=404, body="Some other webservice")
+        mocked.get("http://host:80/silk/registers", status=200, body=silk_json)
+        result = await determine_bwt_model("host")
+        assert result == BwtModel.PERLA_SILK

bwt_api-0.5.1/tests/pytest.ini

@@ -1,2 +0,0 @@
-[pytest]
-asyncio_mode=auto