qolsys-controller 0.0.4__tar.gz → 0.0.7__tar.gz

qolsys_controller-0.0.4/.github/workflows/python-app.yml → qolsys_controller-0.0.7/.github/workflows/build.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a single version of Python
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: Python application
+name: Build
 
 on:
   push:

{qolsys_controller-0.0.4 → qolsys_controller-0.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qolsys-controller
-Version: 0.0.4
+Version: 0.0.7
 Summary: A Python module that emulates a virtual IQ Remote device, enabling full local control of a Qolsys IQ Panel
 Project-URL: Homepage, https://github.com/EHylands/QolsysController
 Project-URL: Issues, https://github.com/EHylands/QolsysController/issues
@@ -14,7 +14,9 @@ Classifier: Topic :: Home Automation
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 
-# QolsysController
+# Qolsys Controller - qolsys-controller
+
+[![Build](https://github.com/EHylands/QolsysController/actions/workflows/build.yml/badge.svg)](https://github.com/EHylands/QolsysController/actions/workflows/build.yml)
 
 A Python module that emulates a virtual IQ Remote device, enabling full **local control** of a Qolsys IQ Panel over MQTT — no cloud access required.
 
@@ -62,7 +64,9 @@ A Python module that emulates a virtual IQ Remote device, enabling full **local
 
 ## ⚠️ Certificate Warning
 
-During pairing, the main panel issues **only one signed client certificate** per virtual IQ Remote. If any key files are lost or deleted, re-pairing may become impossible.
+During pairing, the main panel issues **only one signed client certificate** per virtual IQ Remote. If any key files are lost or deleted, re-pairing may become impossible. 
+
+A new PKI, including a new private key, can be recreated under specific circumstances, though the precise conditions remain unknown at this time.
 
 **Important:**  
 Immediately back up the following files from the `pki/` directory after initial pairing:

{qolsys_controller-0.0.4 → qolsys_controller-0.0.7}/README.md

@@ -1,4 +1,6 @@
-# QolsysController
+# Qolsys Controller - qolsys-controller
+
+[![Build](https://github.com/EHylands/QolsysController/actions/workflows/build.yml/badge.svg)](https://github.com/EHylands/QolsysController/actions/workflows/build.yml)
 
 A Python module that emulates a virtual IQ Remote device, enabling full **local control** of a Qolsys IQ Panel over MQTT — no cloud access required.
 
@@ -46,7 +48,9 @@ A Python module that emulates a virtual IQ Remote device, enabling full **local
 
 ## ⚠️ Certificate Warning
 
-During pairing, the main panel issues **only one signed client certificate** per virtual IQ Remote. If any key files are lost or deleted, re-pairing may become impossible.
+During pairing, the main panel issues **only one signed client certificate** per virtual IQ Remote. If any key files are lost or deleted, re-pairing may become impossible. 
+
+A new PKI, including a new private key, can be recreated under specific circumstances, though the precise conditions remain unknown at this time.
 
 **Important:**  
 Immediately back up the following files from the `pki/` directory after initial pairing:

{qolsys_controller-0.0.4 → qolsys_controller-0.0.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "qolsys-controller"
-version = "0.0.4"
+version = "0.0.7"
 authors = [
   { name="Eric Hylands", email="" },
 ]

{qolsys_controller-0.0.4 → qolsys_controller-0.0.7}/qolsys_controller/panel.py

@@ -93,22 +93,23 @@ class QolsysPanel(QolsysObservable):
         self._product_type = ""
 
     def read_users_file(self) -> bool:
-        # Loading user_code data from users.conf file
-        try:
-            path = self._settings.users_file_path
-            with path.open("r", encoding="utf-8") as file:
-                try:
-                    users = json.load(file)
-                    for user in users:
-                        self._users.append(user)
-
-                except json.JSONDecodeError:
-                    LOGGER.exception("users.conf file json error")
-                    return False
-
-        except FileNotFoundError:
-            LOGGER.exception("users.conf file not found")
-            return False
+        # Loading user_code data from users.conf file if exists
+        if self._settings.users_file_path.is_file():
+            try:
+                path = self._settings.users_file_path
+                with path.open("r", encoding="utf-8") as file:
+                    try:
+                        users = json.load(file)
+                        for user in users:
+                            self._users.append(user)
+
+                    except json.JSONDecodeError:
+                        LOGGER.exception("users.conf file json error")
+                        return False
+
+            except FileNotFoundError:
+                LOGGER.exception("users.conf file not found")
+                return False
 
         return True
 
@@ -817,6 +818,7 @@ class QolsysPanel(QolsysObservable):
         LOGGER.debug("Android Version: %s", self.ANDROID_VERSION)
         LOGGER.debug("Hardware Version: %s", self.HARDWARE_VERSION)
         LOGGER.debug("MAC Address: %s", self.MAC_ADDRESS)
+        LOGGER.debug("MQTT remoteClientID: %s", self._settings.mqtt_remote_client_id)
         LOGGER.debug("Unique ID: %s", self.unique_id)
         LOGGER.debug("Panel Tamper State: %s", self.PANEL_TAMPER_STATE)
         LOGGER.debug("AC Status: %s", self.AC_STATUS)

{qolsys_controller-0.0.4 → qolsys_controller-0.0.7}/qolsys_controller/plugin_remote.py

@@ -110,6 +110,9 @@ class QolsysPluginRemote(QolsysPlugin):
         else:
             self._pki.set_id(self.settings.random_mac)
 
+        # Set mqtt_remote_client_id
+        self.settings.mqtt_remote_client_id = "qolsys-controller-" + self._pki.formatted_id()
+
         # Check if plugin is paired
         if self.is_paired():
             LOGGER.debug("Panel is Paired")
@@ -133,6 +136,24 @@ class QolsysPluginRemote(QolsysPlugin):
     async def start_operation(self) -> None:
         await self._task_manager.run(self.mqtt_connect_task(reconnect=True), self._mqtt_task_connect_label)
 
+    async def stop_operation(self) -> None:
+        LOGGER.debug("Stopping Plugin Operation")
+
+        if self.certificate_exchange_server is not None:
+            self.certificate_exchange_server.close()
+
+        if self.aiomqtt is not None:
+            await self.aiomqtt.__aexit__(None, None, None)
+            self.aiomqtt = None
+
+        self._task_manager.cancel(self._mqtt_task_connect_label)
+        self._task_manager.cancel(self._mqtt_task_listen_label)
+        self._task_manager.cancel(self._mqtt_task_ping_label)
+        self._task_manager.cancel(self._mqtt_task_config_label)
+
+        self.connected = False
+        self.connected_observer.notify()
+
     async def mqtt_connect_task(self, reconnect: bool) -> None:
         # Configure TLS parameters for MQTT connection
         tls_params = aiomqtt.TLSParameters(
@@ -228,6 +249,7 @@ class QolsysPluginRemote(QolsysPlugin):
         while True:
             if self.aiomqtt is not None and self.connected:
                 await self.command_pingevent()
+
             await asyncio.sleep(self.settings.mqtt_ping)
 
     async def mqtt_listen_task(self) -> None:
@@ -434,7 +456,7 @@ class QolsysPluginRemote(QolsysPlugin):
         ipAddress = self.settings.plugin_ip
         eventName = "connect_v204"
         macAddress = self.settings.random_mac
-        remoteClientID = "QolsysController"
+        remoteClientID = self.settings.mqtt_remote_client_id
         softwareVersion = "4.4.1"
         producType = "tab07_rk68"
         bssid = ""
@@ -646,7 +668,7 @@ class QolsysPluginRemote(QolsysPlugin):
 
         topic = "mastermeid"
         eventName = "disconnect"
-        remoteClientID = "QolsysRemote"
+        remoteClientID = self.settings.mqtt_remote_client_id
         requestID = str(uuid.uuid4())
         remoteMacAddress = self.settings.random_mac
 

{qolsys_controller-0.0.4 → qolsys_controller-0.0.7}/qolsys_controller/settings.py

@@ -24,7 +24,8 @@ class QolsysSettings:
 
         # MQTT
         self._mqtt_timeout: int = 30
-        self._mqtt_ping: int = 600
+        self._mqtt_ping: int = 15
+        self._mqtt_remote_client_id = ""
 
     @property
     def random_mac(self) -> str:
@@ -89,6 +90,14 @@ class QolsysSettings:
     def mqtt_ping(self) -> int:
         return self._mqtt_ping
 
+    @property
+    def mqtt_remote_client_id(self) -> str:
+        return self._mqtt_remote_client_id
+
+    @mqtt_remote_client_id.setter
+    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)
@@ -123,4 +132,33 @@ class QolsysSettings:
                 return False
 
         LOGGER.debug("Using config_directory: %s", self.config_directory.resolve())
+
+        # Create pki directory if not found
+        if not self.pki_directory.is_dir():
+            LOGGER.debug("Creating pki_directory: %s", self.pki_directory.resolve())
+            try:
+                self.pki_directory.mkdir(parents=True)
+            except PermissionError:
+                LOGGER.exception("Permission denied: Unable to create: %s", self.pki_directory.resolve())
+                return False
+            except Exception:
+                LOGGER.exception("Error creating pki_directory: %s", self.pki_directory.resolve())
+                return False
+
+        LOGGER.debug("Using pki_directory: %s", self.pki_directory.resolve())
+
+        # Create media directory if not found
+        if not self._media_directory.is_dir():
+            LOGGER.debug("Creating media_directory: %s", self._media_directory.resolve())
+            try:
+                self._media_directory.mkdir(parents=True)
+            except PermissionError:
+                LOGGER.exception("Permission denied: Unable to create: %s", self._media_directory.resolve())
+                return False
+            except Exception:
+                LOGGER.exception("Error creating media_directory: %s", self._media_directory.resolve())
+                return False
+
+        LOGGER.debug("Using media_directory: %s", self._media_directory.resolve())
+
         return True