qolsys-controller 0.0.44__py3-none-any.whl → 0.0.87__py3-none-any.whl

qolsys_controller/scene.py

@@ -6,36 +6,46 @@ LOGGER = logging.getLogger(__name__)
 
 
 class QolsysScene(QolsysObservable):
-
-    def __init__(self, data: dict) -> None:
+    def __init__(self, data: dict[str, str]) -> None:
         super().__init__()
 
-        self._scene_id = data.get("scene_id", "")
-        self._name = data.get("name", "")
-        self._icon = data.get("icon", "")
-        self._color = data.get("color", "")
-
-    def update(self, data: dict) -> None:
+        self._scene_id: str = data.get("scene_id", "")
+        self._name: str = data.get("name", "")
+        self._icon: str = data.get("icon", "")
+        self._color: str = data.get("color", "")
 
+    def update(self, data: dict[str, str]) -> None:
         scene_id_update = data.get("scene_id", "")
         if scene_id_update != self._scene_id:
-            LOGGER.error("Updating Scene%s (%s) with Scene%s (different id)", self._scene_id, self.sensorname, scene_id_update)
+            LOGGER.error("Updating Scene%s (%s) with Scene%s (different id)", self._scene_id, self.name, scene_id_update)
             return
 
         self.start_batch_update()
 
         # Update name
         if "name" in data:
-            self.sensorname = data.get("name")
+            self.sensorname = data.get("name", "")
 
         if "color" in data:
-            self.color = data.get("color")
+            self.color = data.get("color", "")
 
         if "icon" in data:
-            self.icon = data.get("icon")
+            self.icon = data.get("icon", "")
 
         self.end_batch_update()
 
+    def to_dict(self) -> dict[str, str]:
+        return {
+            "scene_id": self.scene_id,
+            "name": self.name,
+            "color": self.color,
+            "icon": self.icon,
+        }
+
+    # -----------------------------
+    # properties + setters
+    # -----------------------------
+
     @property
     def scene_id(self) -> str:
         return self._scene_id
@@ -44,36 +54,28 @@ class QolsysScene(QolsysObservable):
     def name(self) -> str:
         return self._name
 
-    @property
-    def icon(self) -> str:
-        return self._icon
-
-    @property
-    def color(self) -> str:
-        return self._color
-
     @name.setter
     def name(self, value: str) -> None:
         if self._name != value:
             self._name = value
             self.notify()
 
+    @property
+    def icon(self) -> str:
+        return self._icon
+
     @icon.setter
     def icon(self, value: str) -> None:
         if self._icon != value:
             self._icon = value
             self.notify()
 
+    @property
+    def color(self) -> str:
+        return self._color
+
     @color.setter
     def color(self, value: str) -> None:
         if self._color != value:
             self._color = value
             self.notify()
-
-    def to_dict(self) -> dict:
-        return {
-            "scene_id": self.scene_id,
-            "name": self.name,
-            "color": self.color,
-            "icon": self.icon,
-        }

qolsys_controller/settings.py

@@ -1,18 +1,24 @@
+from __future__ import annotations
+
 import logging
 from pathlib import Path
+from typing import TYPE_CHECKING
 
 LOGGER = logging.getLogger(__name__)
 
+if TYPE_CHECKING:
+    from .controller import QolsysController
 
-class QolsysSettings:
 
-    def __init__(self) -> None:
+class QolsysSettings:
+    def __init__(self, controller: QolsysController) -> None:
+        self._controller = controller
 
         # Plugin
-        self._plugin_ip = ""
-        self._random_mac = ""
-        self._panel_mac = ""
-        self._panel_ip = ""
+        self._plugin_ip: str = ""
+        self._random_mac: str = ""
+        self._panel_mac: str = ""
+        self._panel_ip: str = ""
 
         # Path
         self._config_directory: Path = Path()
@@ -22,16 +28,40 @@ class QolsysSettings:
 
         # Pki
         self._key_size: int = 2048
+        self._auto_discover_pki: bool = True
 
         # MQTT
         self._mqtt_timeout: int = 30
         self._mqtt_ping: int = 600
-        self._mqtt_qos:int = 0
-        self._mqtt_remote_client_id = ""
+        self._mqtt_qos: int = 0
+        self._mqtt_remote_client_id: str = ""
+        self._log_mqtt_message: bool = False
 
         # Operation
-        self._motion_sensor_delay:bool = True
-        self._motion_sensor_delay_sec:int = 310
+        self._motion_sensor_delay: bool = True
+        self._motion_sensor_delay_sec: int = 310
+        self._check_user_code_on_arm: bool = False
+        self._check_user_code_on_disarm: bool = True
+
+    def check_panel_ip(self) -> bool:
+        if self._panel_ip == "":
+            LOGGER.debug("Invalid Panel IP:  %s", self._panel_ip)
+            return False
+
+        LOGGER.debug("Found Panel IP: %s", self._panel_ip)
+        return True
+
+    def check_plugin_ip(self) -> bool:
+        if self._plugin_ip == "":
+            LOGGER.debug("Invalid Plugin IP:  %s", self._plugin_ip)
+            return False
+
+        LOGGER.debug("Found Plugin IP: %s", self._plugin_ip)
+        return True
+
+    # -----------------------------
+    # properties + setters
+    # -----------------------------
 
     @property
     def random_mac(self) -> str:
@@ -45,6 +75,10 @@ class QolsysSettings:
     def plugin_ip(self) -> str:
         return self._plugin_ip
 
+    @plugin_ip.setter
+    def plugin_ip(self, plugin_ip: str) -> None:
+        self._plugin_ip = plugin_ip
+
     @property
     def panel_mac(self) -> str:
         return self._panel_mac
@@ -57,36 +91,76 @@ class QolsysSettings:
     def panel_ip(self) -> str:
         return self._panel_ip
 
+    @panel_ip.setter
+    def panel_ip(self, panel_ip: str) -> None:
+        self._panel_ip = panel_ip
+
+    @property
+    def log_mqtt_mesages(self) -> bool:
+        return self._log_mqtt_messages
+
+    @log_mqtt_mesages.setter
+    def log_mqtt_mesages(self, log_mqtt_mesages: bool) -> None:
+        self._log_mqtt_messages = log_mqtt_mesages
+
+    @property
+    def check_user_code_on_disarm(self) -> bool:
+        return self._check_user_code_on_disarm
+
+    @check_user_code_on_disarm.setter
+    def check_user_code_on_disarm(self, check_user_code_on_disarm: bool) -> None:
+        self._check_user_code_on_disarm = check_user_code_on_disarm
+
+    @property
+    def check_user_code_on_arm(self) -> bool:
+        return self._check_user_code_on_arm
+
+    @check_user_code_on_arm.setter
+    def check_user_code_on_arm(self, check_user_code_on_arm: bool) -> None:
+        self._check_user_code_on_arm = check_user_code_on_arm
+
+    @property
+    def auto_discover_pki(self) -> bool:
+        return self._auto_discover_pki
+
+    @auto_discover_pki.setter
+    def auto_discover_pki(self, value: bool) -> None:
+        self._auto_discover_pki = value
+
     @property
     def mqtt_timeout(self) -> int:
         return self._mqtt_timeout
 
+    @mqtt_timeout.setter
+    def mqtt_timeout(self, value: int) -> None:
+        self._mqtt_timeout = value
+
     @property
     def mqtt_ping(self) -> int:
         return self._mqtt_ping
 
+    @mqtt_ping.setter
+    def mqtt_ping(self, value: int) -> None:
+        self._mqtt_ping = value
+
     @property
     def motion_sensor_delay(self) -> bool:
         return self._motion_sensor_delay
 
-    @property
-    def motion_sensor_delay_sec(self) -> int:
-        return self._motion_sensor_delay_sec
-
     @motion_sensor_delay.setter
     def motion_sensor_delay(self, value: bool) -> None:
         self._motion_sensor_delay = value
 
-    @panel_ip.setter
-    def panel_ip(self, panel_ip: str) -> None:
-        self._panel_ip = panel_ip
+    @property
+    def motion_sensor_delay_sec(self) -> int:
+        return self._motion_sensor_delay_sec
 
-    @plugin_ip.setter
-    def plugin_ip(self, plugin_ip: str) -> None:
-        self._plugin_ip = plugin_ip
+    @motion_sensor_delay_sec.setter
+    def motion_sensor_delay_sec(self, value: int) -> None:
+        self._motion_sensor_delay_sec = value
 
     @property
-    def config_directory(self) -> str:
+    def config_directory(self) -> Path:
         return self._config_directory
 
     @config_directory.setter
@@ -108,18 +182,6 @@ class QolsysSettings:
     def key_size(self) -> int:
         return self._key_size
 
-    @mqtt_timeout.setter
-    def mqtt_timeout(self, value: int) -> None:
-        self._mqtt_timeout = value
-
-    @mqtt_ping.setter
-    def mqtt_ping(self, value: int) -> None:
-        self._mqtt_ping = value
-
-    @mqtt_ping.setter
-    def mqtt_ping(self, ping:int) -> None:
-        self._mqtt_ping = ping
-
     @property
     def mqtt_qos(self) -> int:
         return self._mqtt_qos
@@ -129,25 +191,9 @@ class QolsysSettings:
         return self._mqtt_remote_client_id
 
     @mqtt_remote_client_id.setter
-    def mqtt_remote_client_id(self,client_id:str) -> None:
+    def mqtt_remote_client_id(self, client_id: str) -> None:
         self._mqtt_remote_client_id = client_id
 
-    def check_panel_ip(self) -> bool:
-        if self._panel_ip == "":
-            LOGGER.debug("Invalid Panel IP:  %s", self._panel_ip)
-            return False
-
-        LOGGER.debug("Found Panel IP: %s", self._panel_ip)
-        return True
-
-    def check_plugin_ip(self) -> bool:
-        if self._plugin_ip == "":
-            LOGGER.debug("Invalid Plugin IP:  %s", self._plugin_ip)
-            return False
-
-        LOGGER.debug("Found Plugin IP: %s", self._plugin_ip)
-        return True
-
     def check_config_directory(self, create: bool = True) -> bool:  # noqa: PLR0911
         if not self.config_directory.is_dir():
             if not create: