python-tado 0.17.6__tar.gz → 0.17.7__tar.gz

{python_tado-0.17.6 → python_tado-0.17.7}/AUTHORS

@@ -2,3 +2,4 @@ Author: Chris Jewell <chrism0dwk@gmail.com>
 Modified: Gareth Jeanne <contact@garethjeanne.co.uk>
           Wolfgang Malgadey <w.malgadey@gmail.com>
           Matt Clayton <matt.r.clayton@gmail.com>
+          Karl Beecken <karl@beecken.berlin>

{python_tado-0.17.6/python_tado.egg-info → python_tado-0.17.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-tado
-Version: 0.17.6
+Version: 0.17.7
 Summary: PyTado from chrism0dwk, modfied by w.malgadey, diplix, michaelarnauts, LenhartStephan, splifter, syssi, andersonshatch, Yippy, p0thi, Coffee2CodeNL, chiefdragon
 Home-page: https://github.com/wmalgadey/PyTado
 Author: chrism0dwk, w.malgadey

{python_tado-0.17.6 → python_tado-0.17.7}/PyTado/const.py

@@ -43,7 +43,7 @@ CONST_HORIZONTAL_SWING_RIGHT = "RIGHT"
 
 # When we change the temperature setting, we need an overlay mode
 CONST_OVERLAY_TADO_MODE = "NEXT_TIME_BLOCK"  # wait until tado changes the mode automatic
-CONST_OVERLAY_MANUAL = "MANUAL"  # the user has change the temperature or mode manually
+CONST_OVERLAY_MANUAL = "MANUAL"  # the user has changed the temperature or mode manually
 CONST_OVERLAY_TIMER = "TIMER"  # the temperature will be reset after a timespan
 
 # Heat always comes first since we get the

{python_tado-0.17.6 → python_tado-0.17.7}/PyTado/exceptions.py

@@ -8,6 +8,9 @@ class TadoException(Exception):
 class TadoNotSupportedException(TadoException):
     """Exception to indicate a requested action is not supported by Tado."""
 
+class TadoXNotSupportedException(TadoException):
+    """Exception to indicate a requested action is not supported by the Tado X API."""
+
 
 class TadoCredentialsException(TadoException):
     """Exception to indicate something with credentials"""

{python_tado-0.17.6 → python_tado-0.17.7}/PyTado/http/__init__.py

@@ -1 +1 @@
-from .http import Action, Domain, Endpoint, Http, Mode, TadoRequest
+from .http import Action, Domain, Endpoint, Http, Mode, TadoRequest, TadoXRequest

{python_tado-0.17.6 → python_tado-0.17.7}/PyTado/http/http.py

@@ -6,6 +6,7 @@ import json
 import logging
 import pprint
 from datetime import datetime, timedelta
+from typing import Union
 
 try:
     from enum import StrEnum, ReprEnum
@@ -26,6 +27,11 @@ class Endpoint(StrEnum):
     MOBILE = "https://my.tado.com/mobile/1.9/"
     EIQ = "https://energy-insights.tado.com/api/"
 
+class EndpointX(StrEnum):
+    """Endpoint URL Enum"""
+    API = "https://hops.tado.com/"
+    EIQ = "https://energy-insights.tado.com/api/"
+
 
 class Domain(StrEnum):
     """API Request Domain Enum"""
@@ -40,6 +46,7 @@ class Action(StrEnum):
     SET = "POST"
     RESET = "DELETE"
     CHANGE = "PUT"
+    UPDATE = "PATCH"
 
 
 class Mode(Enum):
@@ -58,6 +65,16 @@ class TadoRequest:
     device = None
     mode = Mode.OBJECT
 
+class TadoXRequest:
+    """Data Container"""
+    endpoint = EndpointX.API
+    command = None
+    action = Action.GET
+    payload = None
+    domain = Domain.HOME
+    device = None
+    mode = Mode.OBJECT
+
 
 class TadoResponse:
     """Unimplemented Response Container
@@ -83,6 +100,8 @@ class Http:
     # Id
     id = 0
 
+    isX = False
+
     __username = None
     __password = None
 
@@ -111,7 +130,7 @@ class Http:
             f"Response:\n\tStatusCode: {response_status}\n\tData: {response.json()}"
         )
 
-    def request(self, request: TadoRequest):
+    def request(self, request: Union[TadoRequest, TadoXRequest]):
         """Request something from the API with a TadoRequest"""
         self.__refresh_token()
 
@@ -250,6 +269,7 @@ class Http:
         if response.status_code == 200:
             self.__set_oauth_header(response.json())
             self.__get_id()
+            self.__check_x()
 
     def __get_id(self):
         if self.id == 0:
@@ -257,3 +277,14 @@ class Http:
             request.action = Action.GET
             request.domain = Domain.ME
             self.id = self.request(request)['homes'][0]['id']
+
+    def __check_x(self):
+        # get home info
+        request = TadoRequest()
+        request.action = Action.GET
+        request.domain = Domain.HOME
+        request.command = ""
+        home = self.request(request)
+        if 'generation' in home and home['generation'] == 'LINE_X':
+            self.isX = True
+            self.log.debug("Tado X API detected")

{python_tado-0.17.6 → python_tado-0.17.7}/PyTado/interface.py

@@ -7,10 +7,11 @@ import logging
 import warnings
 from enum import IntEnum
 
-from .exceptions import TadoNotSupportedException
-from PyTado.http import Action, Domain, Endpoint, Http, Mode, TadoRequest
+from .exceptions import TadoNotSupportedException, TadoXNotSupportedException
+from PyTado.http import Action, Domain, Endpoint, Http, Mode, TadoRequest, TadoXRequest
 from PyTado.logging import Logger
 from .zone import TadoZone
+from typing import Any
 
 
 class Tado:
@@ -77,10 +78,16 @@ class Tado:
         Gets device information.
         """
 
-        request = TadoRequest()
-        request.command = "devices"
-
-        return self.http.request(request)
+        if self.http.isX:
+            request = TadoXRequest()
+            request.command = "roomsAndDevices"
+            rooms: list[dict[str, Any]] = self.http.request(request)['rooms']
+            devices = [device for room in rooms for device in room['devices']]
+            return devices
+        else:
+            request = TadoRequest()
+            request.command = "devices"
+            return self.http.request(request)
 
     # <editor-fold desc="Deprecated">
     def getZones(self):
@@ -96,10 +103,15 @@ class Tado:
         Gets zones information.
         """
 
-        request = TadoRequest()
-        request.command = "zones"
+        if self.http.isX:
+            request = TadoXRequest()
+            request.command = "roomsAndDevices"
+            return self.http.request(request)['rooms']
+        else:
+            request = TadoRequest()
+            request.command = "zones"
+            return self.http.request(request)
 
-        return self.http.request(request)
 
     # <editor-fold desc="Deprecated">
     def getZoneState(self, zone):
@@ -114,8 +126,10 @@ class Tado:
         """
         Gets current state of Zone as a TadoZone object.
         """
-
-        return TadoZone(self.get_state(zone), zone)
+        if self.http.isX:
+            return TadoZone(self.get_state(zone), zone, isX=True)
+        else:
+            return TadoZone(self.get_state(zone), zone)
 
     # <editor-fold desc="Deprecated">
     def getZoneStates(self):
@@ -131,8 +145,12 @@ class Tado:
         Gets current states of all zones.
         """
 
-        request = TadoRequest()
-        request.command = "zoneStates"
+        if self.http.isX:
+            request = TadoXRequest()
+            request.command = "rooms"
+        else:
+            request = TadoRequest()
+            request.command = "zoneStates"
 
         return self.http.request(request)
 
@@ -149,10 +167,14 @@ class Tado:
         """
         Gets current state of Zone.
         """
-
-        request = TadoRequest()
-        request.command = f"zones/{zone}/state"
-        data = {**self.http.request(request), **self.get_zone_overlay_default(zone)}
+        if self.http.isX:
+            request = TadoXRequest()
+            request.command = f"rooms/{zone}"
+            data = self.http.request(request)
+        else:
+            request = TadoRequest()
+            request.command = f"zones/{zone}/state"
+            data = {**self.http.request(request), **self.get_zone_overlay_default(zone)}
 
         return data
 
@@ -236,7 +258,10 @@ class Tado:
     def get_capabilities(self, zone):
         """
         Gets current capabilities of zone.
+        TODO: This method is not currently supported by the Tado X API, check if it is needed
         """
+        if self.http.isX:
+            raise TadoXNotSupportedException("This method is not currently supported by the Tado X API")
 
         request = TadoRequest()
         request.command = f"zones/{zone:d}/capabilities"
@@ -258,7 +283,11 @@ class Tado:
         """
 
         data = self.get_state(zone)['sensorDataPoints']
-        return {'temperature': data['insideTemperature']['celsius'],
+        if self.http.isX:
+            return {'temperature': data['insideTemperature']['value'],
+                    'humidity': data['humidity']['percentage']}
+        else:
+            return {'temperature': data['insideTemperature']['celsius'],
                 'humidity': data['humidity']['percentage']}
 
     # <editor-fold desc="Deprecated">
@@ -275,15 +304,21 @@ class Tado:
         Get the Timetable type currently active
         """
 
-        request = TadoRequest()
-        request.command = f"zones/{zone:d}/schedule/activeTimetable"
-        request.mode = Mode.PLAIN
-        data = self.http.request(request)
+        if self.http.isX:
+            # Not currently supported by the Tado X API
+            raise TadoXNotSupportedException("This method is not currently supported by the Tado X API")
+        else:
+            request = TadoRequest()
+            request.command = f"zones/{zone:d}/schedule/activeTimetable"
+            request.mode = Mode.PLAIN
+            data = self.http.request(request)
+
+            if "id" in data:
+                return Tado.Timetable(data["id"])
+
+            raise Exception(f"Returned data did not contain \"id\" : {str(data)}")
 
-        if "id" in data:
-            return Tado.Timetable(data["id"])
 
-        raise Exception(f"Returned data did not contain \"id\" : {str(data)}")
 
     # <editor-fold desc="Deprecated">
     def getHistoric(self, zone, date):
@@ -328,6 +363,10 @@ class Tado:
         id = 3 : SEVEN_DAY (MONDAY, TUESDAY, WEDNESDAY ...)
         """
 
+        if self.http.isX:
+            # Not currently supported by the Tado X API
+            raise TadoXNotSupportedException("This method is not currently supported by the Tado X API")
+
         # Type checking
         if not isinstance(_id, Tado.Timetable):
             raise TypeError('id must be an instance of Tado.Timetable')
@@ -350,12 +389,19 @@ class Tado:
 
     # </editor-fold>
 
-    def get_schedule(self, zone, _id, day=None):
+    def get_schedule(self, zone, _id=None, day=None):
         """
         Get the JSON representation of the schedule for a zone.
         Zone has 3 different schedules, one for each timetable (see setTimetable)
         """
 
+        if self.http.isX:
+            request = TadoXRequest()
+            request.command = f'rooms/{zone}/schedule'
+            return self.http.request(request)
+
+        if not _id:
+            raise ValueError('id must be an instance of Tado.Timetable')
         # Type checking
         if not isinstance(_id, Tado.Timetable):
             raise TypeError('id must be an instance of Tado.Timetable')
@@ -377,14 +423,25 @@ class Tado:
 
     # </editor-fold>
 
-    def set_schedule(self, zone, _id, day, data):
+    def set_schedule(self, zone, data, _id=None, day=None):
         """
-        Set the schedule for a zone, day is required
+        Set the schedule for a zone, day is required for non-X API
         """
 
+        # TODO: sometimes gives back 400 error
+        if self.http.isX:
+            request = TadoXRequest()
+            request.action = Action.SET
+            request.command = f'rooms/{zone}/schedule'
+            request.payload = data
+            request.mode = Mode.OBJECT
+            return self.http.request(request)
+
         # Type checking
         if not isinstance(_id, Tado.Timetable):
             raise TypeError('id must be an instance of Tado.Timetable')
+        if not isinstance(day, int):
+            raise ValueError('day must be an integer')
 
         request = TadoRequest()
         request.command = f"zones/{zone:d}/schedule/timetables/{_id:d}/blocks/{day}"
@@ -427,7 +484,10 @@ class Tado:
         Gets air quality information
         """
 
-        request = TadoRequest()
+        if self.http.isX:
+            request = TadoXRequest()
+        else:
+            request = TadoRequest()
         request.command = "airComfort"
 
         return self.http.request(request)
@@ -461,6 +521,11 @@ class Tado:
         Gets getAppUsersRelativePositions data
         """
 
+        if self.http.isX:
+            # Not currently supported by the Tado X API
+            # TODO: reverse engineer mobile API
+            raise TadoXNotSupportedException("This method is not currently supported by the Tado X API")
+
         request = TadoRequest()
         request.command = "getAppUsersRelativePositions"
         request.endpoint = Endpoint.MOBILE
@@ -500,12 +565,19 @@ class Tado:
         Delete current overlay
         """
 
-        request = TadoRequest()
-        request.command = f"zones/{zone:d}/overlay"
-        request.action = Action.RESET
-        request.mode = Mode.PLAIN
+        if self.http.isX:
+            request = TadoXRequest()
+            request.command = f"rooms/{zone}/resumeSchedule"
+            request.action = Action.SET
 
-        return self.http.request(request)
+            return self.http.request(request)
+        else:
+            request = TadoRequest()
+            request.command = f"zones/{zone:d}/overlay"
+            request.action = Action.RESET
+            request.mode = Mode.PLAIN
+
+            return self.http.request(request)
 
     # <editor-fold desc="Deprecated">
     def setZoneOverlay(self, zone, overlayMode, setTemp=None, duration=None, deviceType='HEATING', power="ON",
@@ -540,9 +612,24 @@ class Tado:
 
         post_data = {
             "setting": {"type": device_type, "power": power},
-            "termination": {"typeSkillBasedApp": overlay_mode},
+            "termination": {"type": overlay_mode},
         }
 
+        if self.http.isX:
+            if set_temp is not None:
+                post_data["setting"]["temperature"] = {"value": set_temp, "valueRaw": set_temp, "precision": 0.1}
+
+            if duration is not None:
+                post_data["termination"]["durationInSeconds"] = duration
+
+            request = TadoXRequest()
+            request.command = f"rooms/{zone}/manualControl"
+            request.action = Action.SET
+            request.payload = post_data
+
+            return self.http.request(request)
+
+
         if set_temp is not None:
             post_data["setting"]["temperature"] = {"celsius": set_temp}
             if fan_speed is not None:
@@ -584,6 +671,10 @@ class Tado:
         Get current overlay default settings for zone.
         """
 
+        if self.http.isX:
+            # Not currently supported by the Tado X API
+            raise TadoXNotSupportedException("This method is not currently supported by the Tado X API")
+
         request = TadoRequest()
         request.command = f"zones/{zone:d}/defaultOverlay"
 
@@ -698,6 +789,12 @@ class Tado:
 
         data = self.get_state(zone)
 
+        if self.http.isX:
+            if 'activated'in data['openWindow']:
+                return {'openWindowDetected': True}
+            else:
+                return {'openWindowDetected': False}
+
         if "openWindowDetected" in data:
             return {'openWindowDetected': data['openWindowDetected']}
         else:
@@ -718,6 +815,10 @@ class Tado:
         Note: This can only be set if an open window was detected in this zone
         """
 
+        if self.http.isX:
+            # Not currently supported by the Tado X API
+            raise TadoXNotSupportedException("This method is not currently supported by the Tado X API")
+
         request = TadoRequest()
         request.command = f"zones/{zone:d}/state/openWindow/activate"
         request.action = Action.SET
@@ -739,6 +840,10 @@ class Tado:
         Sets the window in zone to closed
         """
 
+        if self.http.isX:
+            # TODO test with X
+            raise TadoXNotSupportedException("This method is not currently supported by the Tado X API")
+
         request = TadoRequest()
         request.command = f"zones/{zone:d}/state/openWindow"
         request.action = Action.RESET
@@ -761,6 +866,12 @@ class Tado:
         Gets information about devices
         with option to get specific info i.e. cmd='temperatureOffset'    
         """
+
+        if self.http.isX:
+            # Not currently supported by the Tado X API
+            # Is included in the roomsAndDevices endpoint
+            raise TadoXNotSupportedException("This method is not currently supported by the Tado X API")
+
         request = TadoRequest()
         request.command = cmd
         request.action = Action.GET
@@ -783,6 +894,15 @@ class Tado:
         Set the Temperature offset on the device.
         """
 
+        if self.http.isX:
+            request = TadoXRequest()
+            request.command = f"roomsAndDevices/devices/{device_id}"
+            request.action = Action.UPDATE
+            request.payload = {"temperatureOffset": offset}
+
+            return self.http.request(request)
+
+
         request = TadoRequest()
         request.command = "temperatureOffset"
         request.action = Action.CHANGE
@@ -914,6 +1034,7 @@ class Tado:
     def get_zone_control(self, zone):
         """
         Get zone control information
+        TODO: Test with X
         """
 
         request = TadoRequest()
@@ -924,6 +1045,7 @@ class Tado:
     def set_zone_heating_circuit(self, zone, heating_circuit):
         """
         Sets the heating circuit for a zone
+        TODO: Test with X
         """
 
         request = TadoRequest()

{python_tado-0.17.6 → python_tado-0.17.7}/PyTado/zone.py

@@ -9,6 +9,7 @@ from .const import (
     CONST_HVAC_IDLE,
     CONST_HVAC_OFF,
     CONST_LINK_OFFLINE,
+    CONST_MODE_HEAT,
     CONST_MODE_OFF,
     CONST_MODE_SMART_SCHEDULE,
     DEFAULT_TADO_PRECISION,
@@ -27,7 +28,7 @@ _LOGGER = logging.getLogger(__name__)
 class TadoZone:
     """Represent a tado zone."""
 
-    def __init__(self, data, zone_id):
+    def __init__(self, data, zone_id, isX: bool = False):
         """Create a tado zone."""
         self._data = data
         self._zone_id = zone_id
@@ -54,7 +55,6 @@ class TadoZone:
         self._heating_power = None
         self._heating_power_percentage = None
         self._tado_mode = None
-        self._overlay_active = None
         self._overlay_termination_type = None
         self._overlay_termination_timestamp = None
         self._preparation = None
@@ -64,6 +64,7 @@ class TadoZone:
         self._precision = DEFAULT_TADO_PRECISION
         self._default_overlay_termination_type = None
         self._default_overlay_termination_duration = None
+        self.isX = isX
         self.update_data(data)
 
     @property
@@ -238,11 +239,13 @@ class TadoZone:
             sensor_data = data["sensorDataPoints"]
 
             if "insideTemperature" in sensor_data:
-                temperature = float(sensor_data["insideTemperature"]["celsius"])
-                self._current_temp = temperature
-                self._current_temp_timestamp = sensor_data["insideTemperature"][
-                    "timestamp"
-                ]
+                if self.isX:
+                    self._current_temp = float(sensor_data["insideTemperature"]["value"])
+                    self._current_temp_timestamp = None
+                else:
+                    temperature = float(sensor_data["insideTemperature"]["celsius"])
+                    self._current_temp = temperature
+                    self._current_temp_timestamp = sensor_data["insideTemperature"]["timestamp"]
                 if "precision" in sensor_data["insideTemperature"]:
                     self._precision = sensor_data["insideTemperature"]["precision"][
                         "celsius"
@@ -251,7 +254,10 @@ class TadoZone:
             if "humidity" in sensor_data:
                 humidity = float(sensor_data["humidity"]["percentage"])
                 self._current_humidity = humidity
-                self._current_humidity_timestamp = sensor_data["humidity"]["timestamp"]
+                if self.isX:
+                    self._current_humidity_timestamp = None
+                else:
+                    self._current_humidity_timestamp = sensor_data["humidity"]["timestamp"]
 
         self._is_away = None
         self._tado_mode = None
@@ -259,9 +265,12 @@ class TadoZone:
             self._is_away = data["tadoMode"] == "AWAY"
             self._tado_mode = data["tadoMode"]
 
+
         self._link = None
         if "link" in data:
             self._link = data["link"]["state"]
+        if "connection" in data:
+            self._link = data["connection"]["state"]
 
         self._current_hvac_action = CONST_HVAC_OFF
 
@@ -271,8 +280,11 @@ class TadoZone:
                 "temperature" in data["setting"]
                 and data["setting"]["temperature"] is not None
             ):
-                setting = float(data["setting"]["temperature"]["celsius"])
-                self._target_temp = setting
+                if self.isX:
+                    self._target_temp = float(data["setting"]["temperature"]["value"])
+                else:
+                    setting = float(data["setting"]["temperature"]["celsius"])
+                    self._target_temp = setting
 
             setting = data["setting"]
 
@@ -378,5 +390,21 @@ class TadoZone:
         if "terminationCondition" in data:
             self._default_overlay_termination_type = data["terminationCondition"].get('type',None)
             self._default_overlay_termination_duration = data["terminationCondition"].get('durationInSeconds',None)
+        
+        if self.isX:
+            if self._power == "ON":
+                self._current_hvac_action = CONST_HVAC_IDLE if data["heatingPower"]["percentage"] == 0 else CONST_HVAC_HEAT
+                self._heating_power_percentage = data["heatingPower"]["percentage"]
+            else:
+                self._heating_power_percentage = 0
+                self._current_hvac_action = CONST_HVAC_OFF
             
-            
+            if "manualControlTermination" in data:
+                if data["manualControlTermination"]:
+                    self._current_hvac_mode = CONST_MODE_HEAT if self._power == "ON" else CONST_MODE_OFF
+                    self._overlay_termination_type = data["manualControlTermination"]["type"]
+                    self._overlay_termination_timestamp = data["manualControlTermination"]["projectedExpiry"]
+                else:
+                    self._overlay_termination_type = None
+                    self._overlay_termination_timestamp = None
+

{python_tado-0.17.6 → python_tado-0.17.7/python_tado.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-tado
-Version: 0.17.6
+Version: 0.17.7
 Summary: PyTado from chrism0dwk, modfied by w.malgadey, diplix, michaelarnauts, LenhartStephan, splifter, syssi, andersonshatch, Yippy, p0thi, Coffee2CodeNL, chiefdragon
 Home-page: https://github.com/wmalgadey/PyTado
 Author: chrism0dwk, w.malgadey

{python_tado-0.17.6 → python_tado-0.17.7}/setup.py

@@ -19,7 +19,7 @@ readme = open(here('README.md')).read()
 requirements = [x.strip() for x in open(here('requirements.txt')).readlines()]
 
 setup(name='python-tado',
-      version='0.17.6',
+      version='0.17.7',
       description='PyTado from chrism0dwk, modfied by w.malgadey, diplix, michaelarnauts, LenhartStephan, splifter, syssi, andersonshatch, Yippy, p0thi, Coffee2CodeNL, chiefdragon',
       long_description=readme,
       keywords='tado',