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

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: python-tado
-Version: 0.18.5
+Version: 0.18.6
 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
@@ -743,6 +743,25 @@ cause discomfort and inconvenience to others.
     >>> t = Tado('my@username.com', 'mypassword')
     >>> climate = t.get_climate(zone=1)
 
+## Usage
+```python
+"""Example client for PyTado"""
+
+from PyTado.interface.interface import Tado
+
+
+def main() -> None:
+    """Retrieve all zones, once successfully logged in"""
+    tado = Tado(username="mail@email.com", password="password")  # nosec
+    zones = tado.get_zones()
+    print(zones)
+
+
+if __name__ == "__main__":
+    main()
+```
+Note: for developers, you can create an `example_dev.py` file in the root of the project to test your changes. This file will be ignored by the `.gitignore` file.
+
 ## Contributing
 
 We are very open to the community's contributions - be it a quick fix of a typo, or a completely new feature!

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

@@ -335,3 +335,15 @@ class TadoX(Tado):
         request.payload = {"temperatureOffset": offset}
 
         return self._http.request(request)
+
+    def set_child_lock(self, device_id, child_lock):
+        """ "
+        Set and toggle the child lock on the device.
+        """
+
+        request = TadoXRequest()
+        request.command = f"roomsAndDevices/devices/{device_id}"
+        request.action = Action.CHANGE
+        request.payload = {"childLockEnabled": child_lock}
+
+        self._http.request(request)

{python_tado-0.18.5 → python_tado-0.18.6}/PyTado/interface/api/my_tado.py

@@ -424,6 +424,20 @@ class Tado:
 
         self._http.request(request)
 
+    def set_child_lock(self, device_id, child_lock) -> None:
+        """
+        Sets the child lock on a device
+        """
+
+        request = TadoRequest()
+        request.command = "childLock"
+        request.action = Action.CHANGE
+        request.device = device_id
+        request.domain = Domain.DEVICES
+        request.payload = {"childLockEnabled": child_lock}
+
+        self._http.request(request)
+
     def set_auto(self) -> None:
         """
         Sets HomeState to AUTO

{python_tado-0.18.5 → python_tado-0.18.6}/PyTado/interface/interface.py

@@ -77,6 +77,11 @@ class Tado:
         """Gets zones information. (deprecated)"""
         return self.get_zones()
 
+    @deprecated("set_child_lock")
+    def setChildLock(self, device_id, enabled):
+        """Set the child lock for a device"""
+        return self.set_child_lock(device_id, enabled)
+
     @deprecated("get_zone_state")
     def getZoneState(self, zone):
         """Gets current state of Zone as a TadoZone object. (deprecated)"""

{python_tado-0.18.5 → python_tado-0.18.6}/README.md

@@ -33,6 +33,25 @@ cause discomfort and inconvenience to others.
     >>> t = Tado('my@username.com', 'mypassword')
     >>> climate = t.get_climate(zone=1)
 
+## Usage
+```python
+"""Example client for PyTado"""
+
+from PyTado.interface.interface import Tado
+
+
+def main() -> None:
+    """Retrieve all zones, once successfully logged in"""
+    tado = Tado(username="mail@email.com", password="password")  # nosec
+    zones = tado.get_zones()
+    print(zones)
+
+
+if __name__ == "__main__":
+    main()
+```
+Note: for developers, you can create an `example_dev.py` file in the root of the project to test your changes. This file will be ignored by the `.gitignore` file.
+
 ## Contributing
 
 We are very open to the community's contributions - be it a quick fix of a typo, or a completely new feature!

{python_tado-0.18.5 → python_tado-0.18.6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-tado"
-version = "0.18.5"
+version = "0.18.6"
 description = "PyTado from chrism0dwk, modfied by w.malgadey, diplix, michaelarnauts, LenhartStephan, splifter, syssi, andersonshatch, Yippy, p0thi, Coffee2CodeNL, chiefdragon, FilBr, nikilase, albertomontesg, Moritz-Schmidt, palazzem"
 authors = [
     { name = "Chris Jewell", email = "chrism0dwk@gmail.com" },

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

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: python-tado
-Version: 0.18.5
+Version: 0.18.6
 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
@@ -743,6 +743,25 @@ cause discomfort and inconvenience to others.
     >>> t = Tado('my@username.com', 'mypassword')
     >>> climate = t.get_climate(zone=1)
 
+## Usage
+```python
+"""Example client for PyTado"""
+
+from PyTado.interface.interface import Tado
+
+
+def main() -> None:
+    """Retrieve all zones, once successfully logged in"""
+    tado = Tado(username="mail@email.com", password="password")  # nosec
+    zones = tado.get_zones()
+    print(zones)
+
+
+if __name__ == "__main__":
+    main()
+```
+Note: for developers, you can create an `example_dev.py` file in the root of the project to test your changes. This file will be ignored by the `.gitignore` file.
+
 ## Contributing
 
 We are very open to the community's contributions - be it a quick fix of a typo, or a completely new feature!