python-tado 0.18.3__tar.gz → 0.18.5__tar.gz

{python_tado-0.18.3/python_tado.egg-info → python_tado-0.18.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-tado
-Version: 0.18.3
+Version: 0.18.5
 Summary: PyTado from chrism0dwk, modfied by w.malgadey, diplix, michaelarnauts, LenhartStephan, splifter, syssi, andersonshatch, Yippy, p0thi, Coffee2CodeNL, chiefdragon, FilBr, nikilase, albertomontesg, Moritz-Schmidt, palazzem
 Author-email: Chris Jewell <chrism0dwk@gmail.com>, "w.malgadey" <w.malgadey@gmail.com>, FilBr <filippo.barba@protonmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -696,43 +696,126 @@ License-File: AUTHORS
 Requires-Dist: requests
 Provides-Extra: dev
 Requires-Dist: black>=24.3; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pytype; extra == "dev"
 Requires-Dist: pylint; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
+Requires-Dist: requests; extra == "dev"
 Requires-Dist: responses; extra == "dev"
 Requires-Dist: coverage; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
+Provides-Extra: all
+Requires-Dist: python-tado[dev]; extra == "all"
 
-PyTado -- Pythonize your central heating
-========================================
+# PyTado -- Pythonize your central heating
 
-Author: Chris Jewell <chrism0dwk@gmail.com>  
-Modified: Wolfgang Malgadey <wolfgang@malgadey.de>
+[![Linting and testing](https://github.com/wmalgadey/PyTado/actions/workflows/lint-and-test-matrix.yml/badge.svg)](https://github.com/wmalgadey/PyTado/actions/workflows/lint-and-test-matrix.yml)
+[![Build and deploy to pypi](https://github.com/wmalgadey/PyTado/actions/workflows/publish-to-pypi.yml/badge.svg)](https://github.com/wmalgadey/PyTado/actions/workflows/publish-to-pypi.yml)
+[![PyPI version](https://badge.fury.io/py/python-tado.svg)](https://badge.fury.io/py/python-tado)
+
+PyTado is a Python module implementing an interface to the Tado web API. It allows a user to interact with their
+Tado heating system for the purposes of monitoring or controlling their heating system, beyond what Tado themselves
+currently offer.
+
+It is hoped that this module might be used by those who wish to tweak their Tado systems, and further optimise their
+heating setups.
+
+---
+
+Original author: Chris Jewell <chrism0dwk@gmail.com>  
 
 Licence: GPL v3
 
 Copyright: Chris Jewell 2016-2018
 
-PyTado is a Python module implementing an interface to the Tado web API.  It allows a user to interact with their Tado heating system for the purposes of monitoring or controlling their heating system, beyond what Tado themselves currently offer.
+## Disclaimer
 
-It is hoped that this module might be used by those who wish to tweak their Tado systems, and further optimise their heating setups.
+Besides owning a Tado system, I have no connection with the Tado company themselves. PyTado was created for my own use,
+and for others who may wish to experiment with personal Internet of Things systems. I receive no help (financial or
+otherwise) from Tado, and have no business interest with them. This software is provided without warranty, according to
+the GNU Public Licence version 3, and should therefore not be used where it may endanger life, financial stakes, or
+cause discomfort and inconvenience to others.
 
-Disclaimer
-----------
-Besides owning a Tado system, I have no connection with the Tado company themselves.  PyTado was created for my own use, and for others who may wish to experiment with personal Internet of Things systems.  I receive no help (financial or otherwise) from Tado, and have no business interest with them.  This software is provided without warranty, according to the GNU Public Licence version 3, and should therefore not be used where it may endanger life, financial stakes, or cause discomfort and inconvenience to others.
-
-Example basic usage
--------------------
+## Example basic usage
 
     >>> from PyTado.interface import Tado
     >>> t = Tado('my@username.com', 'mypassword')
     >>> climate = t.get_climate(zone=1)
 
-Development
------------
-This software is at a purely experimental stage.  If you're interested and can write Python, clone the Github repo, drop me a line, and get involved!
+## Contributing
+
+We are very open to the community's contributions - be it a quick fix of a typo, or a completely new feature!
+
+You don't need to be a Python expert to provide meaningful improvements. To learn how to get started, check out our
+[Contributor Guidelines](https://github.com/wmalgadey/econnect-python/blob/main/CONTRIBUTING.md) first, and ask for help
+in [GitHub Discussions](https://github.com/wmalgadey/PyTado/discussions) if you have questions.
+
+## Development
+
+We welcome external contributions, even though the project was initially intended for personal use. If you think some
+parts could be exposed with a more generic interface, please open a [GitHub issue](https://github.com/wmalgadey/PyTado/issues)
+to discuss your suggestion.
+
+### Dev Environment
+
+To contribute to this repository, you should first clone your fork and then setup your development environment. Clone
+your repository as follows (replace yourusername with your GitHub account name):
+
+```bash
+git clone https://github.com/yourusername/PyTado.git
+cd PyTado
+```
+
+Then, to create your development environment and install the project with its dependencies, execute the following
+commands in your terminal:
+
+```bash
+# Create and activate a new virtual environment
+python3 -m venv venv
+source venv/bin/activate
+
+# Upgrade pip and install all projects and their dependencies
+pip install --upgrade pip
+pip install -e '.[all]'
+
+# Install pre-commit hooks
+pre-commit install
+```
+
+### Coding Guidelines
+
+To maintain a consistent codebase, we utilize [black][1]. Consistency is crucial as it helps readability, reduces errors,
+and facilitates collaboration among developers.
+
+To ensure that every commit adheres to our coding standards, we've integrated [pre-commit hooks][2]. These hooks
+automatically run `black` before each commit, ensuring that all code changes are automatically checked and formatted.
+
+For details on how to set up your development environment to make use of these hooks, please refer to the
+[Development][3] section of our documentation.
+
+[1]: https://github.com/ambv/black
+[2]: https://pre-commit.com/
+[3]: https://github.com/wmalgadey/PyTado#development
+
+### Testing
+
+Ensuring the robustness and reliability of our code is paramount. Therefore, all contributions must include at least one
+test to verify the intended behavior.
+
+To run tests locally, execute the test suite using `pytest` with the following command:
+
+```bash
+pytest tests/ --cov --cov-branch -vv
+```
+
+---
 
-Best wishes and a warm winter to all!
+A message from the original author:
 
-Chris Jewell
+> This software is at a purely experimental stage. If you're interested and can write Python, clone the Github repo,
+> drop me a line, and get involved!
+>
+> Best wishes and a warm winter to all!
+>
+> Chris Jewell

{python_tado-0.18.3 → python_tado-0.18.5}/PyTado/const.py

@@ -21,6 +21,7 @@ CONST_MODE_DRY = "DRY"
 CONST_MODE_FAN = "FAN"
 
 CONST_LINK_OFFLINE = "OFFLINE"
+CONST_CONNECTION_OFFLINE = "OFFLINE"
 
 CONST_FAN_OFF = "OFF"
 CONST_FAN_AUTO = "AUTO"
@@ -99,6 +100,7 @@ TADO_MODES_WITH_NO_TEMP_SETTING = [
 ]
 
 DEFAULT_TADO_PRECISION = 0.1
+DEFAULT_TADOX_PRECISION = 0.01
 
 HOME_DOMAIN = "homes"
 DEVICE_DOMAIN = "devices"

{python_tado-0.18.3 → python_tado-0.18.5}/PyTado/http.py

@@ -8,6 +8,7 @@ import logging
 import pprint
 from datetime import datetime, timedelta
 from typing import Any
+from urllib.parse import urlencode
 
 import requests
 
@@ -25,6 +26,9 @@ class Endpoint(enum.StrEnum):
     HOPS_API = "https://hops.tado.com/"
     MOBILE = "https://my.tado.com/mobile/1.9/"
     EIQ = "https://energy-insights.tado.com/api/"
+    TARIFF = "https://tariff-experience.tado.com/api/"
+    GENIE = "https://genie.tado.com/api/v2/"
+    MINDER = "https://minder.tado.com/v1/"
 
 
 class Domain(enum.StrEnum):
@@ -63,6 +67,7 @@ class TadoRequest:
         domain: Domain = Domain.HOME,
         device: int | None = None,
         mode: Mode = Mode.OBJECT,
+        params: dict[str, Any] | None = None,
     ):
         self.endpoint = endpoint
         self.command = command
@@ -71,6 +76,7 @@ class TadoRequest:
         self.domain = domain
         self.device = device
         self.mode = mode
+        self.params = params
 
 
 class TadoXRequest(TadoRequest):
@@ -85,6 +91,7 @@ class TadoXRequest(TadoRequest):
         domain: Domain = Domain.HOME,
         device: int | None = None,
         mode: Mode = Mode.OBJECT,
+        params: dict[str, Any] | None = None,
     ):
         super().__init__(
             endpoint=endpoint,
@@ -94,6 +101,7 @@ class TadoXRequest(TadoRequest):
             domain=domain,
             device=device,
             mode=mode,
+            params=params,
         )
         self._action = action
 
@@ -212,6 +220,8 @@ class Http:
             url = f"{request.endpoint}{request.domain}/{request.device}/{request.command}"
         elif request.domain == Domain.ME:
             url = f"{request.endpoint}{request.domain}"
+        elif request.endpoint == Endpoint.MINDER:
+            url = f"{request.endpoint}{request.domain}/{self.id:d}/{request.command}?{urlencode(request.params)}"
         else:
             url = f"{request.endpoint}{request.domain}/{self._id:d}/{request.command}"
         return url

{python_tado-0.18.3 → python_tado-0.18.5}/PyTado/interface/api/hops_tado.py

@@ -12,6 +12,7 @@ from ...logger import Logger
 from ...exceptions import TadoNotSupportedException
 from ...http import (
     Action,
+    Domain,
     Http,
     Mode,
     TadoRequest,
@@ -28,7 +29,7 @@ class TadoX(Tado):
 
     Example usage: http = Http('me@somewhere.com', 'mypasswd')
                    t = TadoX(http)
-                   t.get_climate(1) # Get climate, zone 1.
+                   t.get_climate(1) # Get climate, room 1.
     """
 
     def __init__(
@@ -56,28 +57,36 @@ class TadoX(Tado):
         # set to None until explicitly set
         self._auto_geofencing_supported = None
 
-    def _create_x_request(self) -> TadoRequest:
-        return TadoXRequest()
-
     def get_devices(self):
         """
         Gets device information.
         """
 
-        request = self._create_x_request()
+        request = TadoXRequest()
         request.command = "roomsAndDevices"
 
-        rooms: list[dict[str, Any]] = self._http.request(request)["rooms"]
+        rooms_and_devices: list[dict[str, Any]] = self._http.request(request)
+        rooms = rooms_and_devices["rooms"]
+
         devices = [device for room in rooms for device in room["devices"]]
 
+        for device in devices:
+            request = TadoXRequest()
+            request.domain = Domain.DEVICES
+            request.device = device["serialNo"]
+            device.update(self._http.request(request))
+
+        if "otherDevices" in rooms_and_devices:
+            devices.append(rooms_and_devices["otherDevices"])
+
         return devices
 
     def get_zones(self):
         """
-        Gets zones information.
+        Gets zones (or rooms in Tado X API) information.
         """
 
-        request = self._create_x_request()
+        request = TadoXRequest()
         request.command = "roomsAndDevices"
 
         return self._http.request(request)["rooms"]
@@ -94,7 +103,7 @@ class TadoX(Tado):
         Gets current states of all zones.
         """
 
-        request = self._create_x_request()
+        request = TadoXRequest()
         request.command = "rooms"
 
         return self._http.request(request)
@@ -104,7 +113,7 @@ class TadoX(Tado):
         Gets current state of Zone.
         """
 
-        request = self._create_x_request()
+        request = TadoXRequest()
         request.command = f"rooms/{zone:d}"
         data = self._http.request(request)
 
@@ -139,7 +148,7 @@ class TadoX(Tado):
         """
 
         raise TadoNotSupportedException(
-            "This method is not currently supported by the Tado X API"
+            "Tado X API only support seven days timetable"
         )
 
     def get_schedule(
@@ -150,17 +159,54 @@ class TadoX(Tado):
         Zone has 3 different schedules, one for each timetable (see setTimetable)
         """
 
-        request = self._create_x_request()
+        request = TadoXRequest()
         request.command = f"rooms/{zone:d}/schedule"
 
         return self._http.request(request)
 
     def set_schedule(self, zone, timetable: Timetable, day, data):
         """
-        Set the schedule for a zone, day is required
+        Set the schedule for a zone, day is not required for Tado X API.
+
+        example data
+        [
+        {
+            "start": "00:00",
+            "end": "07:05",
+            "dayType": "MONDAY",
+            "setting": {
+            "power": "ON",
+            "temperature": {
+                "value": 18
+            }
+            }
+        },
+        {
+            "start": "07:05",
+            "end": "22:05",
+            "dayType": "MONDAY",
+            "setting": {
+            "power": "ON",
+            "temperature": {
+                "value": 22
+            }
+            }
+        },
+        {
+            "start": "22:05",
+            "end": "24:00",
+            "dayType": "MONDAY",
+            "setting": {
+            "power": "ON",
+            "temperature": {
+                "value": 18
+            }
+            }
+        }
+        ]
         """
 
-        request = self._create_x_request()
+        request = TadoXRequest()
         request.command = f"rooms/{zone:d}/schedule"
         request.action = Action.SET
         request.payload = data
@@ -173,7 +219,7 @@ class TadoX(Tado):
         Delete current overlay
         """
 
-        request = self._create_x_request()
+        request = TadoXRequest()
         request.command = f"rooms/{zone:d}/resumeSchedule"
         request.action = Action.SET
 
@@ -195,7 +241,7 @@ class TadoX(Tado):
         horizontal_swing=None,
     ):
         """
-        Set current overlay for a zone
+        Set current overlay for a zone, a room in Tado X API.
         """
 
         post_data = {
@@ -213,7 +259,7 @@ class TadoX(Tado):
         if duration is not None:
             post_data["termination"]["durationInSeconds"] = duration
 
-        request = self._create_x_request()
+        request = TadoXRequest()
         request.command = f"rooms/{zone:d}/manualControl"
         request.action = Action.SET
         request.payload = post_data
@@ -226,7 +272,7 @@ class TadoX(Tado):
         """
 
         raise TadoNotSupportedException(
-            "This method is not currently supported by the Tado X API"
+            "Concept of zones is not available by Tado X API, they use rooms"
         )
 
     def get_open_window_detected(self, zone):
@@ -266,16 +312,24 @@ class TadoX(Tado):
         with option to get specific info i.e. cmd='temperatureOffset'
         """
 
-        raise TadoNotSupportedException(
-            "This method is not currently supported by the Tado X API"
-        )
+        if cmd:
+            request = TadoRequest()
+            request.command = cmd
+        else:
+            request = TadoXRequest()
+
+        request.action = Action.GET
+        request.domain = Domain.DEVICES
+        request.device = device_id
+
+        return self._http.request(request)
 
     def set_temp_offset(self, device_id, offset=0, measure="celsius"):
         """
         Set the Temperature offset on the device.
         """
 
-        request = self._create_x_request()
+        request = TadoXRequest()
         request.command = f"roomsAndDevices/devices/{device_id}"
         request.action = Action.CHANGE
         request.payload = {"temperatureOffset": offset}