weheat 2024.7.8__py3-none-any.whl

weheat/__init__.py

@@ -0,0 +1,42 @@
+# 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
+
+# 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
+

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/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/abstractions/discovery.py

@@ -0,0 +1,47 @@
+from dataclasses import dataclass
+
+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
+    def discover(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:
+            # try:
+            response = HeatPumpApi(client).api_v1_heat_pumps_get_with_http_info()
+            if response.status_code == 200:
+                for pump in response.data:
+                    model_string = "BlackBird P80 heat pump"
+                    if pump.model == 1:
+                        model_string = "BlackBird P60 heat pump"
+                    elif pump.model == 2:
+                        model_string = "Sparrow P60 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

weheat/abstractions/heat_pump.py

@@ -0,0 +1,150 @@
+from enum import Enum, auto
+from weheat.configuration import Configuration
+from weheat.api_client import ApiClient
+from weheat.api.heat_pump_log_api import HeatPumpLogApi
+
+
+class HeatPump:
+    class State(Enum):
+        UNDEFINED = auto()
+        STANDBY = auto()
+        WATER_CHECK = auto()
+        HEATING = auto()
+        COOLING = auto()
+        DHW = auto()
+        LEGIONELLA_PREVENTION = auto()
+        DEFROSTING = auto()
+        SELF_TEST = auto()
+        MANUAL_CONTROL = auto()
+
+    def __init__(self, api_url: str, uuid: str) -> None:
+        self._api_url = api_url
+        self._uuid = uuid
+        self._last_log = None
+
+    def get_status(self, access_token: str):
+        try:
+            config = Configuration(host=self._api_url, access_token=access_token)
+
+            with ApiClient(configuration=config) as client:
+                response = HeatPumpLogApi(
+                    client
+                ).api_v1_heat_pumps_heat_pump_id_logs_latest_get_with_http_info(
+                    heat_pump_id=self._uuid
+                )
+                if response.status_code == 200:
+                    self._last_log = response.data
+        except Exception as e:
+            self._last_log = None
+            raise e
+
+    def _update_properties(self):
+        pass
+
+    def _if_available(self, key):
+        if self._last_log is not None and hasattr(self._last_log, key):
+            return getattr(self._last_log, key)
+        return None
+
+    def __str__(self):
+        return f"WeheatHeatPump(uuid={self._uuid}, last update={self._if_available('timestamp')})"
+
+    def __repr__(self):
+        return self.__str__()
+
+    @property
+    def water_inlet_temperature(self):
+        return self._if_available("t_water_in")
+
+    @property
+    def water_outlet_temperature(self):
+        return self._if_available("t_water_out")
+
+    @property
+    def water_house_in_temperature(self):
+        return self._if_available("t_water_house_in")
+
+    @property
+    def air_inlet_temperature(self):
+        return self._if_available("t_air_in")
+
+    @property
+    def air_outlet_temperature(self):
+        return self._if_available("t_air_out")
+
+    @property
+    def thermostat_water_setpoint(self):
+        return self._if_available("t_thermostat_setpoint")
+
+    @property
+    def thermostat_room_temperature(self):
+        return self._if_available("t_room")
+
+    @property
+    def thermostat_room_temperature_setpoint(self):
+        return self._if_available("t_room_target")
+
+    @property
+    def thermostat_on_off_state(self):
+        return self._if_available("on_off_thermostat_state")
+
+    @property
+    def power_input(self):
+        return self._if_available("cm_mass_power_in")
+
+    @property
+    def power_output(self):
+        return self._if_available("cm_mass_power_out")
+
+    @property
+    def cop(self):
+        """
+        Returns the coefficient of performance of the heat pump.
+        Note that this is calculated from a singular log entry and might not be accurate when the
+        heat pump is changing its output power or switching states
+        """
+        input = self.power_input
+        output = self.power_output
+        if input is not None and output is not None and input != 0:
+            return output / input
+
+    @property
+    def inside_unit_water_pump_state(self):
+        return self._if_available("control_bridge_status_decoded_water_pump")
+
+    @property
+    def inside_unit_auxilary_pump_state(self):
+        return self._if_available("control_bridge_status_decoded_water_pump2")
+
+    @property
+    def inside_unit_dhw_valve_or_pump_state(self):
+        return self._if_available("control_bridge_status_decoded_dhw_valve")
+
+    @property
+    def inside_unit_gas_boiler_state(self):
+        return self._if_available("control_bridge_status_decoded_gas_boiler")
+
+    @property
+    def heat_pump_state(self) -> State:
+        numeric_state = self._if_available("state")
+        if numeric_state is None:
+            return self.State.UNDEFINED
+
+        if numeric_state == 40:
+            return self.State.STANDBY
+        elif numeric_state == 70:
+            return self.State.HEATING
+        elif numeric_state == 130:
+            return self.State.COOLING
+        elif numeric_state == 150:
+            return self.State.DHW
+        elif numeric_state == 160:
+            return self.State.LEGIONELLA_PREVENTION
+        elif numeric_state == 170:
+            return self.State.SELF_TEST
+        elif numeric_state == 180:
+            return self.State.MANUAL_CONTROL
+        elif numeric_state == 200:
+            return self.State.DEFROSTING
+        else:
+            return self.State.UNDEFINED

weheat/api/__init__.py

@@ -0,0 +1,6 @@
+# flake8: noqa
+
+# import apis into api 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

weheat/api/energy_log_api.py

@@ -0,0 +1,228 @@
+# 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 re  # noqa: F401
+import io
+import warnings
+
+from pydantic import validate_arguments, ValidationError
+
+from typing_extensions import Annotated
+from datetime import datetime
+
+from pydantic import Field, StrictStr
+
+from typing import List, Optional
+
+from weheat.models.energy_view_dto import EnergyViewDto
+
+from weheat.api_client import ApiClient
+from weheat.api_response import ApiResponse
+from weheat.exceptions import (  # noqa: F401
+    ApiTypeError,
+    ApiValueError
+)
+
+
+class EnergyLogApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+    @validate_arguments
+    def api_v1_energy_logs_heat_pump_id_get(self, heat_pump_id : Annotated[StrictStr, Field(..., description="The id of the heat pump")], start_time : Annotated[Optional[datetime], Field(description="Start time of the interval as a DateTime object in UTC (format: yyyy-MM-dd HH:mm:ss)")] = None, end_time : Annotated[Optional[datetime], Field(description="End time of the interval as a DateTime object in UTC (format: yyyy-MM-dd HH:mm:ss)")] = None, interval : Annotated[Optional[StrictStr], Field(description="Interval granularity of the log data, allowed intervals: \"Hour\", \"Day\", \"Week\", \"Month\", \"Year\"")] = None, x_version : Annotated[Optional[StrictStr], Field(description="Optional version parameter for frontend applications to check if an update / refresh is needed")] = None, **kwargs) -> List[EnergyViewDto]:  # noqa: E501
+        """Gets the energy logs of the heat pump in a from start time to end time for a given interval  Correct Intervals include: Hour, Day, Week, Month, Year  Hour logs are rounded to 3 decimals, other logs to 2 decimals  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.api_v1_energy_logs_heat_pump_id_get(heat_pump_id, start_time, end_time, interval, x_version, async_req=True)
+        >>> result = thread.get()
+
+        :param heat_pump_id: The id of the heat pump (required)
+        :type heat_pump_id: str
+        :param start_time: Start time of the interval as a DateTime object in UTC (format: yyyy-MM-dd HH:mm:ss)
+        :type start_time: datetime
+        :param end_time: End time of the interval as a DateTime object in UTC (format: yyyy-MM-dd HH:mm:ss)
+        :type end_time: datetime
+        :param interval: Interval granularity of the log data, allowed intervals: \"Hour\", \"Day\", \"Week\", \"Month\", \"Year\"
+        :type interval: str
+        :param x_version: Optional version parameter for frontend applications to check if an update / refresh is needed
+        :type x_version: str
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _request_timeout: timeout setting for this request.
+               If one number provided, it will be total request
+               timeout. It can also be a pair (tuple) of
+               (connection, read) timeouts.
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: List[EnergyViewDto]
+        """
+        kwargs['_return_http_data_only'] = True
+        if '_preload_content' in kwargs:
+            message = "Error! Please call the api_v1_energy_logs_heat_pump_id_get_with_http_info method with `_preload_content` instead and obtain raw data from ApiResponse.raw_data"  # noqa: E501
+            raise ValueError(message)
+        return self.api_v1_energy_logs_heat_pump_id_get_with_http_info(heat_pump_id, start_time, end_time, interval, x_version, **kwargs)  # noqa: E501
+
+    @validate_arguments
+    def api_v1_energy_logs_heat_pump_id_get_with_http_info(self, heat_pump_id : Annotated[StrictStr, Field(..., description="The id of the heat pump")], start_time : Annotated[Optional[datetime], Field(description="Start time of the interval as a DateTime object in UTC (format: yyyy-MM-dd HH:mm:ss)")] = None, end_time : Annotated[Optional[datetime], Field(description="End time of the interval as a DateTime object in UTC (format: yyyy-MM-dd HH:mm:ss)")] = None, interval : Annotated[Optional[StrictStr], Field(description="Interval granularity of the log data, allowed intervals: \"Hour\", \"Day\", \"Week\", \"Month\", \"Year\"")] = None, x_version : Annotated[Optional[StrictStr], Field(description="Optional version parameter for frontend applications to check if an update / refresh is needed")] = None, **kwargs) -> ApiResponse:  # noqa: E501
+        """Gets the energy logs of the heat pump in a from start time to end time for a given interval  Correct Intervals include: Hour, Day, Week, Month, Year  Hour logs are rounded to 3 decimals, other logs to 2 decimals  # noqa: E501
+
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.api_v1_energy_logs_heat_pump_id_get_with_http_info(heat_pump_id, start_time, end_time, interval, x_version, async_req=True)
+        >>> result = thread.get()
+
+        :param heat_pump_id: The id of the heat pump (required)
+        :type heat_pump_id: str
+        :param start_time: Start time of the interval as a DateTime object in UTC (format: yyyy-MM-dd HH:mm:ss)
+        :type start_time: datetime
+        :param end_time: End time of the interval as a DateTime object in UTC (format: yyyy-MM-dd HH:mm:ss)
+        :type end_time: datetime
+        :param interval: Interval granularity of the log data, allowed intervals: \"Hour\", \"Day\", \"Week\", \"Month\", \"Year\"
+        :type interval: str
+        :param x_version: Optional version parameter for frontend applications to check if an update / refresh is needed
+        :type x_version: str
+        :param async_req: Whether to execute the request asynchronously.
+        :type async_req: bool, optional
+        :param _preload_content: if False, the ApiResponse.data will
+                                 be set to none and raw_data will store the
+                                 HTTP response body without reading/decoding.
+                                 Default is True.
+        :type _preload_content: bool, optional
+        :param _return_http_data_only: response data instead of ApiResponse
+                                       object with status code, headers, etc
+        :type _return_http_data_only: bool, optional
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the authentication
+                              in the spec for a single request.
+        :type _request_auth: dict, optional
+        :type _content_type: string, optional: force content-type for the request
+        :return: Returns the result object.
+                 If the method is called asynchronously,
+                 returns the request thread.
+        :rtype: tuple(List[EnergyViewDto], status_code(int), headers(HTTPHeaderDict))
+        """
+
+        _params = locals()
+
+        _all_params = [
+            'heat_pump_id',
+            'start_time',
+            'end_time',
+            'interval',
+            'x_version'
+        ]
+        _all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout',
+                '_request_auth',
+                '_content_type',
+                '_headers'
+            ]
+        )
+
+        # validate the arguments
+        for _key, _val in _params['kwargs'].items():
+            if _key not in _all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method api_v1_energy_logs_heat_pump_id_get" % _key
+                )
+            _params[_key] = _val
+        del _params['kwargs']
+
+        _collection_formats = {}
+
+        # process the path parameters
+        _path_params = {}
+        if _params['heat_pump_id'] is not None:
+            _path_params['heatPumpId'] = _params['heat_pump_id']
+
+
+        # process the query parameters
+        _query_params = []
+        if _params.get('start_time') is not None:  # noqa: E501
+            if isinstance(_params['start_time'], datetime):
+                _query_params.append(('startTime', _params['start_time'].strftime(self.api_client.configuration.datetime_format)))
+            else:
+                _query_params.append(('startTime', _params['start_time']))
+
+        if _params.get('end_time') is not None:  # noqa: E501
+            if isinstance(_params['end_time'], datetime):
+                _query_params.append(('endTime', _params['end_time'].strftime(self.api_client.configuration.datetime_format)))
+            else:
+                _query_params.append(('endTime', _params['end_time']))
+
+        if _params.get('interval') is not None:  # noqa: E501
+            _query_params.append(('interval', _params['interval']))
+
+        # process the header parameters
+        _header_params = dict(_params.get('_headers', {}))
+        if _params['x_version'] is not None:
+            _header_params['x-version'] = _params['x_version']
+
+        # process the form parameters
+        _form_params = []
+        _files = {}
+        # process the body parameter
+        _body_params = None
+        # set the HTTP header `Accept`
+        _header_params['Accept'] = self.api_client.select_header_accept(
+            ['text/plain', 'application/json', 'text/json'])  # noqa: E501
+
+        # authentication setting
+        _auth_settings = ['oauth2']  # noqa: E501
+
+        _response_types_map = {
+            '403': "str",
+            '505': None,
+            '200': "List[EnergyViewDto]",
+            '400': None,
+            '500': None,
+        }
+
+        return self.api_client.call_api(
+            '/api/v1/energy-logs/{heatPumpId}', 'GET',
+            _path_params,
+            _query_params,
+            _header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            response_types_map=_response_types_map,
+            auth_settings=_auth_settings,
+            async_req=_params.get('async_req'),
+            _return_http_data_only=_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=_params.get('_preload_content', True),
+            _request_timeout=_params.get('_request_timeout'),
+            collection_formats=_collection_formats,
+            _request_auth=_params.get('_request_auth'))