qolsys-controller 0.0.13__tar.gz → 0.0.15__tar.gz

{qolsys_controller-0.0.13 → qolsys_controller-0.0.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qolsys-controller
-Version: 0.0.13
+Version: 0.0.15
 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

{qolsys_controller-0.0.13 → qolsys_controller-0.0.15}/example.py

@@ -26,7 +26,7 @@ async def main() -> None:  # noqa: D103
 
     # Additionnal remote plugin config
     remote.plugin.check_user_code_on_disarm = False  # Check user code in user.conf file
-    remote.plugin.log_mqtt_mesages = False  # Enable for MQTT debug purposes
+    remote.plugin.log_mqtt_mesages = True  # Enable for MQTT debug purposes
     remote.plugin.auto_discover_pki = True
 
     # Configure remote plugin
@@ -52,6 +52,12 @@ async def main() -> None:  # noqa: D103
 
     LOGGER.debug("Qolsys Panel Ready for operation")
 
+    #await asyncio.sleep(5)
+
+    #await remote.plugin.stop_operation()
+
+    LOGGER.debug("Qolsys Panel - Stopped")
+
     # Change Z-Wave dimmer
     # node_id: z-wane device id
     # level: 0-99, -1 to switch from off to previous on dimmer level
@@ -64,25 +70,26 @@ async def main() -> None:  # noqa: D103
     #                                   user_code="1111")
 
     # ARM_STAY
-    await asyncio.sleep(3)
-    await remote.plugin.command_arm(partition_id="0",
-                                    arming_type="ARM-NIGHT",
-                                    user_code="1111",
-                                    exit_sounds=False,
-                                    instant_arm=False)
+    #await asyncio.sleep(3)
+    #await remote.plugin.command_arm(partition_id="0",
+    #                                arming_type="ARM-STAY",
+    #                               user_code="1111",
+    #                                exit_sounds=False,
+    #                                instant_arm=True)
 
-    # DISARM
-    await asyncio.sleep(3)
-    await remote.plugin.command_disarm(partition_id="0",
-                                       user_code="1111")
 
     # ARM_AWAY
-    # await asyncio.sleep(3)
-    # await remote.plugin.command_arm(partition_id=0,
-    #                               arming_type='ARM-AWAY',
-    #                               user_code='1111',
-    #                                exit_sounds=True,
-    #                               instant_arm=False)
+    #await asyncio.sleep(3)
+    #await remote.plugin.command_arm(partition_id='0',
+    #                               arming_type="ARM-STAY",
+    #                               user_code="1111",
+    #                                exit_sounds=False,
+    #                               instant_arm=True)
+
+    # DISARM
+    #await asyncio.sleep(10)
+    #await remote.plugin.command_disarm(partition_id="0", user_code="1111", silent_disarming=True)
+
 
     # Use an asyncio.Event to keep the program running efficiently
     stop_event = asyncio.Event()

{qolsys_controller-0.0.13 → qolsys_controller-0.0.15}/pyproject.toml

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

{qolsys_controller-0.0.13 → qolsys_controller-0.0.15}/qolsys_controller/partition.py

@@ -39,6 +39,7 @@ class QolsysPartition(QolsysObservable):
 
         # Other
         self._command_exit_sounds = True
+        self._command_silent_disarming = False
         self._command_arm_stay_instant = True
 
     @property
@@ -81,6 +82,14 @@ class QolsysPartition(QolsysObservable):
     def command_arm_stay_instant(self) -> bool:
         return self._command_arm_stay_instant
 
+    @property
+    def command_silent_disarming(self) -> bool:
+        return self._command_silent_disarming
+
+    @command_silent_disarming.setter
+    def command_silent_disarming(self, value: bool) -> None:
+        self._command_silent_disarming = value
+
     @system_status.setter
     def system_status(self, new_value: PartitionSystemStatus) -> None:
         if self._system_status != new_value:

{qolsys_controller-0.0.13 → qolsys_controller-0.0.15}/qolsys_controller/plugin_remote.py

@@ -34,6 +34,7 @@ class QolsysPluginRemote(QolsysPlugin):
 
         # Plugin
         self.certificate_exchange_server = None
+        self._check_user_code_on_arm = False
         self._check_user_code_on_disarm = True
         self._log_mqtt_messages = False
         self._task_manager = QolsysTaskManager()
@@ -62,6 +63,14 @@ class QolsysPluginRemote(QolsysPlugin):
     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
@@ -196,7 +205,7 @@ class QolsysPluginRemote(QolsysPlugin):
                     await self.aiomqtt.subscribe("mastermeid", qos=0)
 
                     # Subscribe to all topics
-                    await self.aiomqtt.subscribe("#", qos=0)
+                    #await self.aiomqtt.subscribe("#", qos=0)
 
                 # Start mqtt_listent_task and mqtt_ping_task
                 self._task_manager.cancel(self._mqtt_task_listen_label)
@@ -733,7 +742,7 @@ class QolsysPluginRemote(QolsysPlugin):
         LOGGER.debug("MQTT: Receiving pairing_request command")
         return response
 
-    async def command_ui_delay(self, partition_id: str) -> None:
+    async def command_ui_delay(self, partition_id: str,silent_disarming:bool = False) -> None:
         LOGGER.debug("MQTT: Sending ui_delay command")
 
         # partition state needs to be sent for ui_delay to work
@@ -744,6 +753,7 @@ class QolsysPluginRemote(QolsysPlugin):
             "panel_status": partition.system_status,
             "userID": 0,
             "partitionID": partition_id,  # STR EXPECTED
+            "silentDisarming":silent_disarming,
             "operation_source": 1,
             "macAddress": self.settings.random_mac,
         }
@@ -774,7 +784,7 @@ class QolsysPluginRemote(QolsysPlugin):
         await self.send_command(topic, payload, requestID)
         LOGGER.debug("MQTT: Receiving ui_delay command")
 
-    async def command_disarm(self, partition_id: str, user_code: str = "", exit_sounds: bool = True) -> bool:
+    async def command_disarm(self, partition_id: str, user_code: str = "", silent_disarming: bool = False) -> bool:
         partition = self.state.partition(partition_id)
         if not partition:
             LOGGER.debug("MQTT: disarm command error - Unknow Partition")
@@ -788,7 +798,7 @@ class QolsysPluginRemote(QolsysPlugin):
                 LOGGER.debug("MQTT: disarm command error - user_code error")
                 return False
 
-        async def get_mqtt_disarm_command() -> str:
+        async def get_mqtt_disarm_command(silent_disarming:bool) -> str:
             if partition.alarm_state == PartitionAlarmState.ALARM:
                 return "disarm_from_emergency"
             if partition.system_status in {PartitionSystemStatus.ARM_AWAY_EXIT_DELAY,
@@ -798,12 +808,12 @@ class QolsysPluginRemote(QolsysPlugin):
             if partition.system_status in {PartitionSystemStatus.ARM_AWAY,
                                            PartitionSystemStatus.ARM_STAY,
                                            PartitionSystemStatus.ARM_NIGHT}:
-                await self.command_ui_delay(partition_id)
+                await self.command_ui_delay(partition_id,silent_disarming)
                 return "disarm_the_panel_from_entry_delay"
 
             return "disarm_from_openlearn_sensor"
 
-        mqtt_disarm_command = await get_mqtt_disarm_command()
+        mqtt_disarm_command = await get_mqtt_disarm_command(silent_disarming)
         LOGGER.debug("MQTT: Sending disarm command - check_user_code:%s", self.check_user_code_on_disarm)
 
 
@@ -812,7 +822,6 @@ class QolsysPluginRemote(QolsysPlugin):
             "userID": user_id,
             "partitionID": int(partition_id),  # INT EXPECTED
             "operation_source": 1,
-            "disarm_exit_sounds": exit_sounds,
             "macAddress": self.settings.random_mac,
         }
 
@@ -903,7 +912,7 @@ class QolsysPluginRemote(QolsysPlugin):
             LOGGER.debug("MQTT: arm command error - Unknow Partition")
             return False
 
-        if self.panel.SECURE_ARMING == "true":
+        if self.panel.SECURE_ARMING == "true" and self.check_user_code_on_arm:
             # Do local user code verification to arm if secure arming is enabled
             user_id = self.panel.check_user(user_code)
             if user_id == -1: