weheat 2024.7.8__py3-none-any.whl

weheat/models/read_all_heat_pump_dto.py

@@ -0,0 +1,121 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from typing import Optional
+from pydantic import BaseModel, Field, StrictStr, constr
+from weheat.models.boiler_type import BoilerType
+from weheat.models.device_state import DeviceState
+from weheat.models.dhw_type import DhwType
+from weheat.models.heat_pump_model import HeatPumpModel
+from weheat.models.heat_pump_status_enum import HeatPumpStatusEnum
+from weheat.models.heat_pump_type import HeatPumpType
+
+class ReadAllHeatPumpDto(BaseModel):
+    """
+    Heat Pump dto used for the GetAll operation where the firmware version is needed  # noqa: E501
+    """
+    id: StrictStr = Field(..., description="Identifier of the heat pump")
+    control_board_id: StrictStr = Field(..., alias="controlBoardId", description="Identifier of the control board that is connected to the heat pump")
+    serial_number: constr(strict=True, min_length=1) = Field(..., alias="serialNumber", description="Serial Number of this heat pump")
+    part_number: Optional[StrictStr] = Field(None, alias="partNumber", description="Part Number of this heat pump")
+    state: DeviceState = Field(...)
+    name: Optional[StrictStr] = Field(None, description="Internal nickname of this heat pump")
+    model: Optional[HeatPumpModel] = None
+    dhw_type: Optional[DhwType] = Field(None, alias="dhwType")
+    boiler_type: Optional[BoilerType] = Field(None, alias="boilerType")
+    status: Optional[HeatPumpStatusEnum] = None
+    type: Optional[HeatPumpType] = None
+    commissioned_at: Optional[datetime] = Field(None, alias="commissionedAt", description="Date when the heat pump was last commissioned (decommissioning sets this to null)")
+    firmware_version: Optional[StrictStr] = Field(None, alias="firmwareVersion", description="Firmware version of control board connected to heat pump")
+    __properties = ["id", "controlBoardId", "serialNumber", "partNumber", "state", "name", "model", "dhwType", "boilerType", "status", "type", "commissionedAt", "firmwareVersion"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> ReadAllHeatPumpDto:
+        """Create an instance of ReadAllHeatPumpDto from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # set to None if part_number (nullable) is None
+        # and __fields_set__ contains the field
+        if self.part_number is None and "part_number" in self.__fields_set__:
+            _dict['partNumber'] = None
+
+        # set to None if name (nullable) is None
+        # and __fields_set__ contains the field
+        if self.name is None and "name" in self.__fields_set__:
+            _dict['name'] = None
+
+        # set to None if commissioned_at (nullable) is None
+        # and __fields_set__ contains the field
+        if self.commissioned_at is None and "commissioned_at" in self.__fields_set__:
+            _dict['commissionedAt'] = None
+
+        # set to None if firmware_version (nullable) is None
+        # and __fields_set__ contains the field
+        if self.firmware_version is None and "firmware_version" in self.__fields_set__:
+            _dict['firmwareVersion'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ReadAllHeatPumpDto:
+        """Create an instance of ReadAllHeatPumpDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ReadAllHeatPumpDto.parse_obj(obj)
+
+        _obj = ReadAllHeatPumpDto.parse_obj({
+            "id": obj.get("id"),
+            "control_board_id": obj.get("controlBoardId"),
+            "serial_number": obj.get("serialNumber"),
+            "part_number": obj.get("partNumber"),
+            "state": obj.get("state"),
+            "name": obj.get("name"),
+            "model": obj.get("model"),
+            "dhw_type": obj.get("dhwType"),
+            "boiler_type": obj.get("boilerType"),
+            "status": obj.get("status"),
+            "type": obj.get("type"),
+            "commissioned_at": obj.get("commissionedAt"),
+            "firmware_version": obj.get("firmwareVersion")
+        })
+        return _obj
+
+

weheat/models/read_heat_pump_dto.py

@@ -0,0 +1,114 @@
+# 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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from typing import Optional
+from pydantic import BaseModel, Field, StrictStr, constr
+from weheat.models.boiler_type import BoilerType
+from weheat.models.device_state import DeviceState
+from weheat.models.dhw_type import DhwType
+from weheat.models.heat_pump_model import HeatPumpModel
+from weheat.models.heat_pump_status_enum import HeatPumpStatusEnum
+from weheat.models.heat_pump_type import HeatPumpType
+
+class ReadHeatPumpDto(BaseModel):
+    """
+    ReadHeatPumpDto
+    """
+    id: StrictStr = Field(..., description="Identifier of the heat pump")
+    control_board_id: StrictStr = Field(..., alias="controlBoardId", description="Identifier of the control board that is connected to the heat pump")
+    serial_number: constr(strict=True, min_length=1) = Field(..., alias="serialNumber", description="Serial Number of this heat pump")
+    part_number: Optional[StrictStr] = Field(None, alias="partNumber", description="Part Number of this heat pump")
+    state: DeviceState = Field(...)
+    name: Optional[StrictStr] = Field(None, description="Internal nickname of this heat pump")
+    model: Optional[HeatPumpModel] = None
+    dhw_type: Optional[DhwType] = Field(None, alias="dhwType")
+    boiler_type: Optional[BoilerType] = Field(None, alias="boilerType")
+    status: Optional[HeatPumpStatusEnum] = None
+    type: Optional[HeatPumpType] = None
+    commissioned_at: Optional[datetime] = Field(None, alias="commissionedAt", description="Date when the heat pump was last commissioned (decommissioning sets this to null)")
+    __properties = ["id", "controlBoardId", "serialNumber", "partNumber", "state", "name", "model", "dhwType", "boilerType", "status", "type", "commissionedAt"]
+
+    class Config:
+        """Pydantic configuration"""
+        allow_population_by_field_name = True
+        validate_assignment = True
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.dict(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> ReadHeatPumpDto:
+        """Create an instance of ReadHeatPumpDto from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self):
+        """Returns the dictionary representation of the model using alias"""
+        _dict = self.dict(by_alias=True,
+                          exclude={
+                          },
+                          exclude_none=True)
+        # set to None if part_number (nullable) is None
+        # and __fields_set__ contains the field
+        if self.part_number is None and "part_number" in self.__fields_set__:
+            _dict['partNumber'] = None
+
+        # set to None if name (nullable) is None
+        # and __fields_set__ contains the field
+        if self.name is None and "name" in self.__fields_set__:
+            _dict['name'] = None
+
+        # set to None if commissioned_at (nullable) is None
+        # and __fields_set__ contains the field
+        if self.commissioned_at is None and "commissioned_at" in self.__fields_set__:
+            _dict['commissionedAt'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: dict) -> ReadHeatPumpDto:
+        """Create an instance of ReadHeatPumpDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return ReadHeatPumpDto.parse_obj(obj)
+
+        _obj = ReadHeatPumpDto.parse_obj({
+            "id": obj.get("id"),
+            "control_board_id": obj.get("controlBoardId"),
+            "serial_number": obj.get("serialNumber"),
+            "part_number": obj.get("partNumber"),
+            "state": obj.get("state"),
+            "name": obj.get("name"),
+            "model": obj.get("model"),
+            "dhw_type": obj.get("dhwType"),
+            "boiler_type": obj.get("boilerType"),
+            "status": obj.get("status"),
+            "type": obj.get("type"),
+            "commissioned_at": obj.get("commissionedAt")
+        })
+        return _obj
+
+

weheat/rest.py

@@ -0,0 +1,327 @@
+# 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 io
+import json
+import logging
+import re
+import ssl
+
+from urllib.parse import urlencode, quote_plus
+import urllib3
+
+from weheat.exceptions import ApiException, UnauthorizedException, ForbiddenException, NotFoundException, ServiceException, ApiValueError, BadRequestException
+
+
+logger = logging.getLogger(__name__)
+
+SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
+
+
+def is_socks_proxy_url(url):
+    if url is None:
+        return False
+    split_section = url.split("://")
+    if len(split_section) < 2:
+        return False
+    else:
+        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.urllib3_response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = resp.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.urllib3_response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.urllib3_response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration, pools_size=4, maxsize=None) -> None:
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # maxsize is the number of requests to host that are allowed in parallel  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        addition_pool_args = {}
+        if configuration.assert_hostname is not None:
+            addition_pool_args['assert_hostname'] = configuration.assert_hostname  # noqa: E501
+
+        if configuration.retries is not None:
+            addition_pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            addition_pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            addition_pool_args['socket_options'] = configuration.socket_options
+
+        if maxsize is None:
+            if configuration.connection_pool_maxsize is not None:
+                maxsize = configuration.connection_pool_maxsize
+            else:
+                maxsize = 4
+
+        # https pool manager
+        if configuration.proxy:
+            if is_socks_proxy_url(configuration.proxy):
+                from urllib3.contrib.socks import SOCKSProxyManager
+                self.pool_manager = SOCKSProxyManager(
+                        cert_reqs=cert_reqs,
+                        ca_certs=configuration.ssl_ca_cert,
+                        cert_file=configuration.cert_file,
+                        key_file=configuration.key_file,
+                        proxy_url=configuration.proxy,
+                        headers=configuration.proxy_headers,
+                        **addition_pool_args
+                    )
+            else:
+                self.pool_manager = urllib3.ProxyManager(
+                    num_pools=pools_size,
+                    maxsize=maxsize,
+                    cert_reqs=cert_reqs,
+                    ca_certs=configuration.ssl_ca_cert,
+                    cert_file=configuration.cert_file,
+                    key_file=configuration.key_file,
+                    proxy_url=configuration.proxy,
+                    proxy_headers=configuration.proxy_headers,
+                    **addition_pool_args
+                )
+        else:
+            self.pool_manager = urllib3.PoolManager(
+                num_pools=pools_size,
+                maxsize=maxsize,
+                cert_reqs=cert_reqs,
+                ca_certs=configuration.ssl_ca_cert,
+                cert_file=configuration.cert_file,
+                key_file=configuration.key_file,
+                **addition_pool_args
+            )
+
+    def request(self, method, url, query_params=None, headers=None,
+                body=None, post_params=None, _preload_content=True,
+                _request_timeout=None):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param query_params: query parameters in the url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :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.
+        """
+        method = method.upper()
+        assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT',
+                          'PATCH', 'OPTIONS']
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+        # url already contains the URL query string
+        # so reset query_params to empty dict
+        query_params = {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int,float)):  # noqa: E501,F821
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (isinstance(_request_timeout, tuple) and
+                  len(_request_timeout) == 2):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0], read=_request_timeout[1])
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+                # no content type provided or payload is json
+                if not headers.get('Content-Type') or re.search('json', headers['Content-Type'], re.IGNORECASE):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method, url,
+                        body=request_body,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                elif headers['Content-Type'] == 'application/x-www-form-urlencoded':  # noqa: E501
+                    r = self.pool_manager.request(
+                        method, url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                elif headers['Content-Type'] == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    r = self.pool_manager.request(
+                        method, url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                # Pass a `string` parameter directly in the body to support
+                # other content types than Json when `body` argument is
+                # provided in serialized form
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    request_body = body
+                    r = self.pool_manager.request(
+                        method, url,
+                        body=request_body,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(method, url,
+                                              fields={},
+                                              preload_content=_preload_content,
+                                              timeout=timeout,
+                                              headers=headers)
+        except urllib3.exceptions.SSLError as e:
+            msg = "{0}\n{1}".format(type(e).__name__, str(e))
+            raise ApiException(status=0, reason=msg)
+
+        if _preload_content:
+            r = RESTResponse(r)
+
+            # log response body
+            logger.debug("response body: %s", r.data)
+
+        if not 200 <= r.status <= 299:
+            if r.status == 400:
+                raise BadRequestException(http_resp=r)
+
+            if r.status == 401:
+                raise UnauthorizedException(http_resp=r)
+
+            if r.status == 403:
+                raise ForbiddenException(http_resp=r)
+
+            if r.status == 404:
+                raise NotFoundException(http_resp=r)
+
+            if 500 <= r.status <= 599:
+                raise ServiceException(http_resp=r)
+
+            raise ApiException(http_resp=r)
+
+        return r
+
+    def get_request(self, url, headers=None, query_params=None, _preload_content=True,
+            _request_timeout=None):
+        return self.request("GET", url,
+                            headers=headers,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            query_params=query_params)
+
+    def head_request(self, url, headers=None, query_params=None, _preload_content=True,
+             _request_timeout=None):
+        return self.request("HEAD", url,
+                            headers=headers,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            query_params=query_params)
+
+    def options_request(self, url, headers=None, query_params=None, post_params=None,
+                body=None, _preload_content=True, _request_timeout=None):
+        return self.request("OPTIONS", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def delete_request(self, url, headers=None, query_params=None, body=None,
+               _preload_content=True, _request_timeout=None):
+        return self.request("DELETE", url,
+                            headers=headers,
+                            query_params=query_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def post_request(self, url, headers=None, query_params=None, post_params=None,
+             body=None, _preload_content=True, _request_timeout=None):
+        return self.request("POST", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def put_request(self, url, headers=None, query_params=None, post_params=None,
+            body=None, _preload_content=True, _request_timeout=None):
+        return self.request("PUT", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def patch_request(self, url, headers=None, query_params=None, post_params=None,
+              body=None, _preload_content=True, _request_timeout=None):
+        return self.request("PATCH", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)

weheat-2024.7.8.dist-info/METADATA

@@ -0,0 +1,105 @@
+Metadata-Version: 2.1
+Name: weheat
+Version: 2024.7.8
+Summary: Weheat Backend client
+Home-page: https://github.com/wefabricate/wh-python
+Author: Jesper Raemaekers
+Author-email: jesper.raemaekers@wefabricate.com
+Keywords: OpenAPI,OpenAPI-Generator,Weheat Backend
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3 <2.1.0,>=1.25.3
+Requires-Dist: python-dateutil
+Requires-Dist: pydantic <2,>=1.10.5
+Requires-Dist: aenum
+
+# 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}')
+
+
+```
+
+
+