ics_2000_python 0.1.2__tar.gz → 0.1.4__tar.gz

{ics_2000_python-0.1.2 → ics_2000_python-0.1.4}/PKG-INFO

@@ -1,14 +1,14 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: ics_2000_python
-Version: 0.1.2
+Version: 0.1.4
 Summary: 
-Home-page: https://github.com/zefanjajobse/ics_2000_python
 Keywords: ics_2000,ics-2000,klikaanklikuit
 Author: iiTzArcur
 Author-email: zefanjaj@gmail.com
 Requires-Python: >=3.12,<4.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: pycryptodome (>=3.21.0,<4.0.0)
 Requires-Dist: requests (>=2.32.3,<3.0.0)
 Project-URL: Repository, https://github.com/zefanjajobse/ics_2000_python
@@ -24,7 +24,9 @@ from ics_2000.entities.switch_device import SwitchDevice
 from ics_2000.hub import Hub
 
 hub = Hub("example@email.com", "password")
-hub.login() # Authenticate
+homes = hub.login()  # Authenticate
+print(homes) # returns a dictionary of homes, ex: {"0": "test home}
+hub.select_home("132829") # Select the right home by id
 hub.get_devices() # request devices
 for device in hub.devices:
     if type(device) is SwitchDevice or type(device) is DimDevice:

{ics_2000_python-0.1.2 → ics_2000_python-0.1.4}/README.md

@@ -8,7 +8,9 @@ from ics_2000.entities.switch_device import SwitchDevice
 from ics_2000.hub import Hub
 
 hub = Hub("example@email.com", "password")
-hub.login() # Authenticate
+homes = hub.login()  # Authenticate
+print(homes) # returns a dictionary of homes, ex: {"0": "test home}
+hub.select_home("132829") # Select the right home by id
 hub.get_devices() # request devices
 for device in hub.devices:
     if type(device) is SwitchDevice or type(device) is DimDevice:

{ics_2000_python-0.1.2 → ics_2000_python-0.1.4}/ics_2000/config.py

@@ -1,3 +1,4 @@
+
 from .model.device_config import DeviceConfig
 
 
@@ -94,8 +95,10 @@ device_configs: dict[int, DeviceConfig] = {
         model_name="AWMT Buil-in wall switch",
     ),
     23: DeviceConfig(
-        disabled=True,
         model_name="Somfy Actuator",
+        index_open=0,
+        index_my=1,
+        index_close=2,
     ),
     24: DeviceConfig(
         model_name="KAKU dimmable lightbulb",

ics_2000_python-0.1.4/ics_2000/entities/blind_device.py

@@ -0,0 +1,74 @@
+from ..model import device_data
+from ..model.device_config import DeviceConfig
+from .device import Device
+
+
+class BlindDevice(Device):
+    def __init__(self, hub, device_data: device_data.DeviceData, device_config: DeviceConfig):
+        super().__init__(hub, device_data, device_config)
+
+        if device_config.index_open is None:
+            raise ValueError(
+                f"index_open not defined for '{self.device_data.name}'"
+            )
+        if device_config.index_close is None:
+            raise ValueError(
+                f"index_close not defined for '{self.device_data.name}'"
+            )
+        if device_config.index_my is None:
+            raise ValueError(
+                f"index_my not defined for '{self.device_data.name}'"
+            )
+
+    def open(self, send_local: bool = False) -> None:
+        """Turn off the device.
+
+        Args:
+          send_local: Use the ip_address set on the hub to talk to the device
+          send_local set to false, because it triggers a time out.
+        """
+        if self.device_config.index_open is None:
+            return
+
+        self.get_hub().change_status(
+            self.entity_id,
+            self.device_config.index_open,
+            0,
+            self.is_group,
+            send_local,
+        )
+
+    def close(self, send_local: bool = False) -> None:
+        """Turn off the device.
+
+        Args:
+          send_local: Use the ip_address set on the hub to talk to the device
+          send_local set to false, because it triggers a timeout.
+        """
+        if self.device_config.index_close is None:
+            return
+
+        self.get_hub().change_status(
+            self.entity_id,
+            self.device_config.index_close,
+            0,
+            self.is_group,
+            send_local,
+        )
+    def stop(self, send_local: bool = False) -> None:
+        """Turn off the device.
+
+        Args:
+          send_local: Use the ip_address set on the hub to talk to the device
+          send_local set to false, because it triggers a timeout.
+        """
+        if self.device_config.index_my is None:
+            return
+
+        self.get_hub().change_status(
+            self.entity_id,
+            self.device_config.index_my,
+            0,
+            self.is_group,
+            send_local,
+        )

ics_2000_python-0.1.4/ics_2000/exceptions.py

@@ -0,0 +1,12 @@
+
+class InvalidAuthException(Exception):
+    """When the authentication failed"""
+    
+class InvalidHomeException(Exception):
+    """When selected home does not exist as a option"""
+
+class InvalidMacOrAuthException(Exception):
+    """When the auth or mac address is not set"""
+
+class NoHomeSelectedException(Exception):
+    """When no home is selected"""

{ics_2000_python-0.1.2 → ics_2000_python-0.1.4}/ics_2000/hub.py

@@ -1,9 +1,12 @@
 from datetime import datetime
 import json
 import requests
+
+from ics_2000.exceptions import InvalidAuthException, InvalidHomeException, InvalidMacOrAuthException, NoHomeSelectedException
 from .command import Command
 from .encryption import decrypt
 from .config import API_URL, device_configs
+from .entities.blind_device import BlindDevice
 from .entities.color_temperature_device import ColorTemperatureDevice
 from .entities.device import Device
 from .entities.dim_device import DimDevice
@@ -23,8 +26,9 @@ class Hub:
     """
 
     def __init__(self, email: str, password: str):
+        self.homes = []
         self.devices: list[
-            Device | DimDevice | SwitchDevice | ColorTemperatureDevice
+            Device | DimDevice | SwitchDevice | ColorTemperatureDevice | BlindDevice
         ] = []
         """List of available devices within the authenticated home"""
         self.aes_key: str | None = None
@@ -46,9 +50,10 @@ class Hub:
         self.update_date = datetime.min
         """When the device statuses were last updated"""
 
-    def login(self) -> None:
+    def login(self) -> dict[str, str]:
         """Logs in to the account given"""
-        test = requests.post(
+        self.homes = []
+        response = requests.post(
             f"{API_URL}/account.php",
             {
                 "action": "login",
@@ -60,24 +65,28 @@ class Hub:
             },
         )
 
-        if test.status_code != 200:
-            if test.status_code == 401:
-                raise Exception("Incorrect username or password")
-            raise Exception(test.content)
-
-        response = test.json()
-        if len(response.get("homes", [])) > 0:
-            home: dict = response["homes"][0]
-            self.aes_key = home.get("aes_key", "")
-            self.mac = home.get("mac", "")
-            self.home_id = home.get("home_id")
-            self.home_name = home.get("home_name")
-        else:
-            raise Exception("No homes")
+        if response.status_code != 200:
+            if response.status_code == 401:
+                raise InvalidAuthException("Incorrect username or password")
+            raise InvalidAuthException(response.content)
+
+        data = response.json()
+        if data is not None:
+            self.homes = data.get("homes", [])
+        return dict([(home.get("home_id"), home.get("home_name"))for home in self.homes])
+
+    def select_home(self, home_id: str) -> None:
+        home = next(home for home in self.homes if home.get("home_id") == home_id)
+        if home is None:
+            raise InvalidHomeException()
+        self.aes_key = home.get("aes_key", "")
+        self.mac = home.get("mac", "")
+        self.home_id = home.get("home_id")
+        self.home_name = home.get("home_name")
 
     def get_raw_devices_data(self, decrypt_data, decrypt_status) -> list:
         if self.aes_key is None or self.mac is None:
-            raise Exception("no mac or auth key")
+            raise InvalidMacOrAuthException()
 
         device_info = requests.post(
             f"{API_URL}/gateway.php",
@@ -112,10 +121,10 @@ class Hub:
 
     def get_devices(
         self,
-    ) -> list[Device | DimDevice | SwitchDevice | ColorTemperatureDevice]:
+    ) -> list[Device | DimDevice | SwitchDevice | ColorTemperatureDevice | BlindDevice]:
         """Gets all devices connected to the hub"""
         if self.home_id is None:
-            raise Exception("no home")
+            raise NoHomeSelectedException()
 
         entities = self.get_raw_devices_data(True, False)
         for device in entities:
@@ -149,6 +158,8 @@ class Hub:
 
             elif device_config.on_off_function is not None:
                 self.devices.append(SwitchDevice(self, device_data, device_config))
+            elif device_config.index_open is not None and device_config.index_close is not None and device_config.index_my is not None:
+                self.devices.append(BlindDevice(self, device_data, device_config))
             else:
                 self.devices.append(Device(self, device_data, device_config))
         return self.devices
@@ -161,7 +172,7 @@ class Hub:
         entity_type: Entity_Type,
     ) -> Command:
         if self.aes_key is None or self.mac is None:
-            raise Exception("no mac or auth key")
+            raise InvalidMacOrAuthException()
 
         device_functions: list[int | float] = []
 
@@ -264,7 +275,7 @@ class Hub:
         self, data: dict, decrypt_data: bool, decrypt_status: bool
     ) -> dict:
         if self.aes_key is None or self.mac is None:
-            raise Exception("no mac or auth key")
+            raise InvalidMacOrAuthException()
 
         if decrypt_data:
             data["data"] = json.loads(decrypt(data.get("data", ""), self.aes_key))

{ics_2000_python-0.1.2 → ics_2000_python-0.1.4}/ics_2000/model/device_config.py

@@ -11,6 +11,9 @@ class DeviceConfig:
         color_temperature_function: Optional[int] = None,
         max_brightness: Optional[int] = None,
         max_color_temperature: Optional[int] = None,
+        index_open: Optional[int] = None,
+        index_close: Optional[int] = None,
+        index_my: Optional[int] = None,
     ):
         self.disabled = disabled
         self.model_name = model_name
@@ -19,3 +22,6 @@ class DeviceConfig:
         self.color_temperature_function = color_temperature_function
         self.max_brightness = max_brightness
         self.max_color_temperature = max_color_temperature
+        self.index_open = index_open
+        self.index_close = index_close
+        self.index_my = index_my

{ics_2000_python-0.1.2 → ics_2000_python-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ics_2000_python"
-version = "0.1.2"
+version = "0.1.4"
 description = ""
 authors = ["iiTzArcur <zefanjaj@gmail.com>"]
 readme = "README.md"