weheat 2025.1.14rc1__tar.gz

weheat-2025.1.14rc1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Weheat B.V.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

weheat-2025.1.14rc1/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.2
+Name: weheat
+Version: 2025.1.14rc1
+Summary: Weheat Backend client
+Home-page: https://github.com/wefabricate/wh-python
+Author: Jesper Raemaekers
+Author-email: jesper.raemaekers@wefabricate.com
+License: MIT
+Keywords: OpenAPI,OpenAPI-Generator,Weheat Backend
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: urllib3<2.1.0,>=1.25.3
+Requires-Dist: python-dateutil
+Requires-Dist: pydantic<3,>=1.10.5
+Requires-Dist: aenum
+Requires-Dist: aiohttp
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+# Weheat backend client
+
+This is a client for the Weheat backend. It is automatically generated from the OpenAPI specification.
+
+## Requirements.
+
+Python 3.7+
+
+## Installation & Usage
+
+You can install directly using:
+
+```sh
+pip install weheat
+```
+
+Then import the package:
+
+```python
+import weheat
+```
+
+
+
+## Getting Started
+
+After installation, you can now use the client to interact with the Weheat backend.
+
+```python
+import datetime
+from keycloak import KeycloakOpenID  # install with pip install python-keycloak
+from weheat import ApiClient, Configuration, HeatPumpApi, HeatPumpLogApi, EnergyLogApi
+
+# input your information here
+auth_url = 'https://auth.weheat.nl/auth/'
+api_url = 'https://api.weheat.nl'
+realm_name = 'Weheat'
+my_client_id = 'WeheatCommunityAPI'  # client ID and secret provided by Weheat
+my_client_secret = ''
+username = ''  # username and password used for the online portal
+password = ''
+my_heat_pump_id = ''  # your heat pump UUID
+
+# Get the access token from keycloak
+keycloak_open_id = KeycloakOpenID(server_url=auth_url,
+                                  client_id=my_client_id,
+                                  realm_name=realm_name,
+                                  client_secret_key=my_client_secret)
+
+token_response = keycloak_open_id.token(username, password)
+keycloak_open_id.logout(token_response['refresh_token'])
+
+# Create the cinfiguration object
+config = Configuration(host=api_url, access_token=token_response['access_token'])
+
+# with the client the APIs can be accessed
+with ApiClient(configuration=config) as client:
+    # Getting all heat pumps that the user has access to
+    response = HeatPumpApi(client).api_v1_heat_pumps_get_with_http_info()
+
+    if response.status_code == 200:
+        print(f'My heat pump: {response.data}')
+
+    # Getting the latest log of the heat pump
+    response = HeatPumpLogApi(client).api_v1_heat_pumps_heat_pump_id_logs_latest_get_with_http_info(
+        heat_pump_id=my_heat_pump_id)
+
+    if response.status_code == 200:
+        print(f'My heat pump logs: {response.data}')
+
+    # Getting the energy logs of the heat pump in a specific period
+    # interval can be  "Minute", "FiveMinute", "FifteenMinute", "Hour", "Day", "Week", "Month", "Year"
+    response = EnergyLogApi(client).api_v1_energy_logs_heat_pump_id_get_with_http_info(heat_pump_id=my_heat_pump_id,
+                                                                                       start_time=datetime.datetime(
+                                                                                           2024, 6,
+                                                                                           22, 0, 0,
+                                                                                           0),
+                                                                                       end_time=datetime.datetime(2024,
+                                                                                                                  6, 22,
+                                                                                                                  15, 0,
+                                                                                                                  0),
+                                                                                       interval='Hour')
+
+    if response.status_code == 200:
+        print(f'My energy logs: {response.data}')
+
+
+```
+
+
+

weheat-2025.1.14rc1/README.md

@@ -0,0 +1,91 @@
+# Weheat backend client
+
+This is a client for the Weheat backend. It is automatically generated from the OpenAPI specification.
+
+## Requirements.
+
+Python 3.7+
+
+## Installation & Usage
+
+You can install directly using:
+
+```sh
+pip install weheat
+```
+
+Then import the package:
+
+```python
+import weheat
+```
+
+
+
+## Getting Started
+
+After installation, you can now use the client to interact with the Weheat backend.
+
+```python
+import datetime
+from keycloak import KeycloakOpenID  # install with pip install python-keycloak
+from weheat import ApiClient, Configuration, HeatPumpApi, HeatPumpLogApi, EnergyLogApi
+
+# input your information here
+auth_url = 'https://auth.weheat.nl/auth/'
+api_url = 'https://api.weheat.nl'
+realm_name = 'Weheat'
+my_client_id = 'WeheatCommunityAPI'  # client ID and secret provided by Weheat
+my_client_secret = ''
+username = ''  # username and password used for the online portal
+password = ''
+my_heat_pump_id = ''  # your heat pump UUID
+
+# Get the access token from keycloak
+keycloak_open_id = KeycloakOpenID(server_url=auth_url,
+                                  client_id=my_client_id,
+                                  realm_name=realm_name,
+                                  client_secret_key=my_client_secret)
+
+token_response = keycloak_open_id.token(username, password)
+keycloak_open_id.logout(token_response['refresh_token'])
+
+# Create the cinfiguration object
+config = Configuration(host=api_url, access_token=token_response['access_token'])
+
+# with the client the APIs can be accessed
+with ApiClient(configuration=config) as client:
+    # Getting all heat pumps that the user has access to
+    response = HeatPumpApi(client).api_v1_heat_pumps_get_with_http_info()
+
+    if response.status_code == 200:
+        print(f'My heat pump: {response.data}')
+
+    # Getting the latest log of the heat pump
+    response = HeatPumpLogApi(client).api_v1_heat_pumps_heat_pump_id_logs_latest_get_with_http_info(
+        heat_pump_id=my_heat_pump_id)
+
+    if response.status_code == 200:
+        print(f'My heat pump logs: {response.data}')
+
+    # Getting the energy logs of the heat pump in a specific period
+    # interval can be  "Minute", "FiveMinute", "FifteenMinute", "Hour", "Day", "Week", "Month", "Year"
+    response = EnergyLogApi(client).api_v1_energy_logs_heat_pump_id_get_with_http_info(heat_pump_id=my_heat_pump_id,
+                                                                                       start_time=datetime.datetime(
+                                                                                           2024, 6,
+                                                                                           22, 0, 0,
+                                                                                           0),
+                                                                                       end_time=datetime.datetime(2024,
+                                                                                                                  6, 22,
+                                                                                                                  15, 0,
+                                                                                                                  0),
+                                                                                       interval='Hour')
+
+    if response.status_code == 200:
+        print(f'My energy logs: {response.data}')
+
+
+```
+
+
+

weheat-2025.1.14rc1/pyproject.toml

@@ -0,0 +1,30 @@
+[tool.poetry]
+name = "weheat"
+version = "2025.1.14rc1"
+description = "Weheat Backend"
+authors = ["Jesper Raemaekers <jesper.raemaekers@wefabricate.com>", "Kjell van Straaten <kjell.van.straaten@wefabricate.com>"]
+license = "MIT"
+readme = "README.md"
+repository = "https://github.com/wefabricate/wh-python"
+keywords = ["OpenAPI", "OpenAPI-Generator", "Weheat Backend"]
+include = ["weheat/py.typed"]
+
+[tool.poetry.dependencies]
+python = "^3.7"
+
+urllib3 = ">= 1.25.3"
+python-dateutil = ">=2.8.2"
+pydantic = ">=1.10.5, < 3"
+aenum = ">=3.1.11"
+
+[tool.poetry.dev-dependencies]
+pytest = ">=7.2.1"
+tox = ">=3.9.0"
+flake8 = ">=4.0.0"
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.pylint.'MESSAGES CONTROL']
+extension-pkg-whitelist = "pydantic"

weheat-2025.1.14rc1/setup.cfg

@@ -0,0 +1,10 @@
+[flake8]
+max-line-length = 99
+
+[metadata]
+license_files = LICENSE
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

weheat-2025.1.14rc1/setup.py

@@ -0,0 +1,50 @@
+# coding: utf-8
+
+"""
+    Weheat Backend
+
+    This is the backend for the Weheat project
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+import pathlib
+
+from setuptools import setup, find_packages  # noqa: H301
+
+# To install the library, run the following
+#
+# python setup.py install
+#
+# prerequisite: setuptools
+# http://pypi.python.org/pypi/setuptools
+NAME = "weheat"
+VERSION = "2025.1.14rc1"
+PYTHON_REQUIRES = ">=3.7"
+REQUIRES = [
+    "urllib3 >= 1.25.3, < 2.1.0",
+    "python-dateutil",
+    "pydantic >= 1.10.5, < 3",
+    "aenum",
+    "aiohttp"
+]
+
+setup(
+    name=NAME,
+    version=VERSION,
+    description="Weheat Backend client",
+    author="Jesper Raemaekers",
+    author_email="jesper.raemaekers@wefabricate.com",
+    url="https://github.com/wefabricate/wh-python",
+    keywords=["OpenAPI", "OpenAPI-Generator", "Weheat Backend"],
+    install_requires=REQUIRES,
+    packages=find_packages(exclude=["test", "tests"]),
+    include_package_data=True,
+    long_description_content_type='text/markdown',
+    long_description=pathlib.Path("README.md").read_text(),  # noqa: E501
+    package_data={"weheat": ["py.typed"]},
+    license="MIT",
+    license_files = ('LICENSE',),
+)

weheat-2025.1.14rc1/tests/test_ha_api.py

@@ -0,0 +1,97 @@
+import pytest
+from pydantic import ValidationError
+
+from weheat.abstractions.heat_pump import HeatPump
+
+from weheat.abstractions.discovery import HeatPumpDiscovery
+from weheat.abstractions.user import async_get_user_id_from_token
+from weheat.exceptions import UnauthorizedException, ForbiddenException
+
+
+uuid_list = [
+    '54ad613f-48e5-4583-b0e0-1a96d29131fa',
+    '306625f3-124a-42eb-8e31-952963c65932',
+    '573852f6-029f-4106-a019-2183b14a351f'
+]
+
+@pytest.mark.asyncio
+async def test_discovery(api_fixture):
+    discovery = await HeatPumpDiscovery.async_discover_active(api_url=api_fixture.api_url, access_token=api_fixture.access_token)
+
+    #The account is configured to find at least one Blackbird, one sparrow and one flint
+    assert len(discovery) >= 3
+
+    #check some information for each pump, find it by type in the list
+    blackbird = [hp for hp in discovery if 'blackbird' in hp.model.lower()]
+    sparrow = [hp for hp in discovery if 'sparrow' in hp.model.lower()]
+    flint = [hp for hp in discovery if 'flint' in hp.model.lower()]
+
+    # sanity check lengths
+    assert len(blackbird) >= 1
+    assert len(sparrow) >= 1
+    assert len(flint) >= 1
+
+    blackbird = blackbird[0]
+    sparrow = sparrow[0]
+    flint = flint[0]
+
+    # must have a UUID
+    assert len(blackbird.uuid) == 36
+    assert len(sparrow.uuid) == 36
+    assert len(flint.uuid) == 36
+
+    # must have a serial number
+    assert len(blackbird.sn) == 12
+    assert len(sparrow.sn) == 12
+    assert len(flint.sn) == 12
+
+@pytest.mark.asyncio
+async def test_user(api_fixture):
+    user = await async_get_user_id_from_token(api_fixture.api_url, api_fixture.access_token)
+
+    #check we got a UUID
+    assert len(user) == 36
+
+@pytest.mark.parametrize("uuid", uuid_list)
+@pytest.mark.asyncio
+async def test_hp_log(api_fixture, uuid):
+    heatpump = HeatPump(api_fixture.api_url, uuid)
+
+    # if the API is changed, this call will fail on a python validation error
+    try:
+        await heatpump.async_get_status(api_fixture.access_token)
+    except ValidationError as e:
+        print(f'Validation unsuccessful: {e}')
+        pytest.fail('Validation failed')
+
+    except UnauthorizedException as e:
+        pytest.fail('get_status call failed')
+    except ForbiddenException as e:
+        pytest.fail('get_status call failed')
+    except Exception as e:
+        pytest.fail('get_status call failed')
+
+    # check that all core values are present
+    assert heatpump.water_inlet_temperature >= 10
+    assert heatpump.water_outlet_temperature >= 10
+    assert heatpump.air_inlet_temperature >= -20
+    if heatpump.air_outlet_temperature is not None: # flint does not have an air out sensor
+        assert heatpump.air_outlet_temperature >= -20
+    if heatpump.water_house_in_temperature is not None: # indoor unit may be disconnected
+        assert heatpump.water_house_in_temperature >= -1
+    if heatpump.thermostat_room_temperature_setpoint is not None: #thermostat may be disconnected
+        assert heatpump.thermostat_room_temperature_setpoint >= -1
+    if heatpump.thermostat_room_temperature is not None:  #thermostat may be disconnected
+        assert heatpump.thermostat_room_temperature >= -1
+    assert heatpump.power_input >= 0
+    assert heatpump.power_output >= 0
+    assert heatpump.compressor_rpm >= 0
+    assert heatpump.heat_pump_state in HeatPump.State
+    assert heatpump.energy_total >= 0
+    assert heatpump.energy_output >= 0
+
+
+
+
+
+

weheat-2025.1.14rc1/weheat/__init__.py

@@ -0,0 +1,45 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Weheat Backend
+
+    This is the backend for the Weheat project
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "2024.07.08"
+
+# import apis into sdk package
+from weheat.api.energy_log_api import EnergyLogApi
+from weheat.api.heat_pump_api import HeatPumpApi
+from weheat.api.heat_pump_log_api import HeatPumpLogApi
+from weheat.api.user_api import UserApi
+
+# import ApiClient
+from weheat.api_response import ApiResponse
+from weheat.api_client import ApiClient
+from weheat.configuration import Configuration
+from weheat.exceptions import OpenApiException
+from weheat.exceptions import ApiTypeError
+from weheat.exceptions import ApiValueError
+from weheat.exceptions import ApiKeyError
+from weheat.exceptions import ApiAttributeError
+from weheat.exceptions import ApiException
+
+# import models into sdk package
+from weheat.models.device_state import DeviceState
+from weheat.models.energy_view_dto import EnergyViewDto
+from weheat.models.heat_pump_log_view_dto import HeatPumpLogViewDto
+from weheat.models.raw_heat_pump_log_dto import RawHeatPumpLogDto
+from weheat.models.read_all_heat_pump_dto import ReadAllHeatPumpDto
+from weheat.models.read_heat_pump_dto import ReadHeatPumpDto
+from weheat.models.read_user_dto import ReadUserDto
+from weheat.models.role import Role
+

weheat-2025.1.14rc1/weheat/abstractions/__init__.py

@@ -0,0 +1,3 @@
+from weheat.abstractions.auth import AbstractAuth
+from weheat.abstractions.discovery import HeatPumpDiscovery
+from weheat.abstractions.heat_pump import HeatPump

weheat-2025.1.14rc1/weheat/abstractions/auth.py

@@ -0,0 +1,34 @@
+from abc import ABC, abstractmethod
+from aiohttp import ClientSession, ClientResponse
+
+
+class AbstractAuth(ABC):
+    """Abstract class to make authenticated requests."""
+
+    def __init__(self, websession: ClientSession, host: str) -> None:
+        """Initialize the auth."""
+        self.websession = websession
+        self.host = host
+
+    @abstractmethod
+    async def async_get_access_token(self) -> str:
+        """Return a valid access token."""
+
+    async def request(self, method, url, **kwargs) -> ClientResponse:
+        """Make a request."""
+        headers = kwargs.get("headers")
+
+        if headers is None:
+            headers = {}
+        else:
+            headers = dict(headers)
+
+        access_token = await self.async_get_access_token()
+        headers["authorization"] = f"Bearer {access_token}"
+
+        return await self.websession.request(
+            method,
+            f"{self.host}/{url}",
+            **kwargs,
+            headers=headers,
+        )

weheat-2025.1.14rc1/weheat/abstractions/discovery.py

@@ -0,0 +1,62 @@
+import asyncio
+from dataclasses import dataclass
+
+from weheat import DeviceState
+from weheat.configuration import Configuration
+from weheat.api_client import ApiClient
+from weheat.api.heat_pump_api import HeatPumpApi
+
+
+class HeatPumpDiscovery:
+    @dataclass
+    class HeatPumpInfo:
+        uuid: str
+        name: str
+        model: str
+        sn : str
+        has_dhw: bool = False
+
+    @staticmethod
+    async def async_discover_active(api_url: str, access_token: str) -> list[HeatPumpInfo]:
+        discovered_pumps = []
+
+        config = Configuration(host=api_url, access_token=access_token)
+
+        with ApiClient(configuration=config) as client:
+
+            response = HeatPumpApi(client).api_v1_heat_pumps_get_with_http_info('', 1, 1000, DeviceState.NUMBER_3 ,async_req=True)
+
+            response = await asyncio.to_thread(response.get)
+
+            if response.status_code == 200:
+                for pump in response.data:
+                    # Model of the heat pump
+                    # - BlackBirdP80: BlackBird P80 heat pump (0)
+                    # - BlackBirdP60: BlackBird P60 heat pump (1)
+                    # - SparrowP60Brown: Sparrow P60 heat pump, colour brown (default) (2)
+                    # - SparrowP60Green: Sparrow P60 heat pump, colour green (3)
+                    # - SparrowP60Grey: Sparrow P60 heat pump, colour grey (4)
+                    # - FlintP40: Flint P40 heat pump (5)
+                    model_string = "Blackbird P80 heat pump"
+                    if pump.model == 1:
+                        model_string = "Blackbird P60 heat pump"
+                    elif 2 <= pump.model <= 4:
+                        model_string = "Sparrow P60 heat pump"
+                    elif pump.model == 5:
+                        model_string = "Flint P40 heat pump"
+
+
+                    dhw = False
+                    if pump.dhw_type is not None and pump.dhw_type == 1:
+                        dhw = True
+
+                    discovered_pumps.append(
+                        HeatPumpDiscovery.HeatPumpInfo(
+                            uuid=pump.id,
+                            name=pump.name,
+                            model=model_string,
+                            sn=pump.serial_number,
+                            has_dhw=dhw,
+                        )
+                    )
+        return discovered_pumps