qolsys-controller 0.0.16__tar.gz → 0.0.18__tar.gz

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: qolsys-controller
-Version: 0.0.16
+Version: 0.0.18
 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
@@ -35,6 +35,7 @@ A Python module that emulates a virtual IQ Remote device, enabling full **local
 | **Partitions**       | Arming status                    | ✅ |
 |                      | Set Exit sounds                  | ✅            |
 |                      | Home Instant arming              | ✅            |
+|                      | Home Silent Disarm               | ✅            |
 |                      | Alarm state and type             | ✅            |
 |                      | Disarm pictures             | 🛠️ WIP            |
 |---|---|---|

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/README.md

@@ -19,6 +19,7 @@ A Python module that emulates a virtual IQ Remote device, enabling full **local
 | **Partitions**       | Arming status                    | ✅ |
 |                      | Set Exit sounds                  | ✅            |
 |                      | Home Instant arming              | ✅            |
+|                      | Home Silent Disarm               | ✅            |
 |                      | Alarm state and type             | ✅            |
 |                      | Disarm pictures             | 🛠️ WIP            |
 |---|---|---|

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/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 = True  # Enable for MQTT debug purposes
+    remote.plugin.log_mqtt_mesages = False  # Enable for MQTT debug purposes
     remote.plugin.auto_discover_pki = True
 
     # Configure remote plugin
@@ -70,12 +70,12 @@ 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-STAY",
-    #                               user_code="1111",
-    #                                exit_sounds=False,
-    #                                instant_arm=True)
+    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)
 
 
     # ARM_AWAY
@@ -87,8 +87,8 @@ async def main() -> None:  # noqa: D103
     #                               instant_arm=True)
 
     # DISARM
-    #await asyncio.sleep(10)
-    #await remote.plugin.command_disarm(partition_id="0", user_code="1111", silent_disarming=True)
+    await asyncio.sleep(5)
+    await remote.plugin.command_disarm(partition_id="0", user_code="1111", silent_disarming=True)
 
 
     # Use an asyncio.Event to keep the program running efficiently

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/pyproject.toml

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

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/qolsys_controller/database/db.py

@@ -132,7 +132,6 @@ class QolsysDB:
         # content://com.qolsys.qolsysprovider.ProvisionListContentProvider/provision_list
         # content://com.qolsys.qolsysprovider.PowerGSignalStrengthContentProvider/powerg_signal_strength
         # content://com.qolsys.qolsysprovider.ProximityTagContentProvider/proximity_tag
-        # content://com.qolsys.qolsysprovider.OutputRulesContentProvider/output_rules
         # content://com.qolsys.qolsysprovider.IQCameraContentProvider/iqcamera
         # content://com.qolsys.qolsysprovider.CorbusDeviceContentProvider/corbus_device
         # content://com.qolsys.qolsysprovider.AutomationRulesContentProvider/automation_rules
@@ -144,9 +143,7 @@ class QolsysDB:
         # content://com.qolsys.qolsysprovider.AxonSignalStrengthContentProvider/axon_signal_strength
         # content://com.qolsys.qolsysprovider.PanelInfoContentProvider/panel_info
         # content://com.qolsys.qolsysprovider.AxonRSSIContentProvider/axon_rssi_table
-        # content://com.qolsys.qolsysprovider.PowerGDeviceContentProvider/powerg_device
         # content://com.qolsys.qolsysprovider.PowerGRSSIContentProvider/powerg_rssi_table
-        # content://com.qolsys.qolsysprovider.PgmOutputsContentProvider/pgm_outputs
 
     @property
     def db(self) -> sqlite3.Connection:
@@ -156,6 +153,18 @@ class QolsysDB:
     def cursor(self) -> sqlite3.Cursor:
         return self._cursor
 
+    def get_scenes(self) -> list[dict]:
+        self.cursor.execute(f"SELECT * FROM {self.table_scene.table} ORDER BY scene_id")
+        self.db.commit()
+
+        scenes = []
+        columns = [description[0] for description in self.cursor.description]
+        for row in self.cursor.fetchall():
+            row_dict = dict(zip(columns, row, strict=True))
+            scenes.append(row_dict)
+
+        return scenes
+
     def get_partitions(self) -> list[dict]:
         self.cursor.execute(f"SELECT * FROM {self.table_partition.table} ORDER BY partition_id")
         self.db.commit()

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/qolsys_controller/database/table.py

@@ -15,6 +15,7 @@ class QolsysTable:
         self._table: str = ""
         self._columns: list[str] = []
         self._abort_on_error: bool = False
+        self._implemented:bool = False
 
     @property
     def uri(self) -> str:
@@ -66,22 +67,52 @@ class QolsysTable:
             if self._abort_on_error:
                 raise error from err
 
-    def update(self, selection: str, selection_argument: str, content_value: str) -> None:
-        # selection: 'zone_id=?, parition_id=?'
+    def insert(self, data: dict) -> None:
+        try:
+            if not self._implemented and data is not None:
+                LOGGER.warning("New Table format: %s", self.uri)
+                LOGGER.warning("Table: %s", self.table)
+                LOGGER.warning(data)
+                LOGGER.warning("Please Report")
+                return
+
+            full_data = {col: data.get(col, "") for col in self._columns}
+
+            new_columns = []
+            for key in data:
+                if key not in self._columns:
+                    new_columns.append(key)
+
+            # Warn if new column found in iq2meid database
+            if new_columns:
+                LOGGER.warning("New column found in iq2meid database")
+                LOGGER.warning("Table: %s", self.table)
+                LOGGER.warning("New Columns: %s", new_columns)
+                LOGGER.warning("Please Report")
+
+            col_str = ", ".join(full_data.keys())
+            placeholder_str = ", ".join([f":{key}" for key in full_data])
+            query = f"INSERT OR IGNORE INTO {self.table} ({col_str}) VALUES ({placeholder_str})"
+            self._cursor.execute(query, full_data)
+            self._db.commit()
 
-        # Firmware 4.4.1 is sending contentValues as string
-        # selection_argument: '[3,1]'
-        # Firmware 4.6.1: 
-        # selection_argument: ['cc:4b:73:86:5c:89']
+        except sqlite3.Error as err:
+            error = QolsysSqlError({
+                "table": self.table,
+                "query": query,
+                "columns": self._columns,
+            })
 
-        #  "contentValues":{"partition_id":"0","sensorgroup":"safetymotion","sensorstatus":"Idle"}"
+            if self._abort_on_error:
+                raise error from err
 
-        # Panel is sending query parameter for db update in text string
-        # Have not found a way to make it work with parametrized query yet
-        # Using f string concat for moment ...
+    def update(self, selection: str, selection_argument: str, content_value: str) -> None:
+        # selection: 'zone_id=?, parition_id=?'
+        # Firmware 4.4.1: selection_argument: '[3,1]'
+        # Firmware 4.6.1: selection_argument: ['3','1']
+        # contentValues:{"partition_id":"0","sensorgroup":"safetymotion","sensorstatus":"Idle"}"
 
         # New Values to update in table
-        # To change for parametrized
         db_value = ",".join([f"{key}='{value}'" for key, value in content_value.items()])
 
         # Selection Argument
@@ -109,15 +140,12 @@ class QolsysTable:
             if self._abort_on_error:
                 raise error from err
 
-    def insert(self) -> None:
-        pass
-
     def delete(self, selection: str, selection_argument: str) -> None:
         # selection: 'zone_id=?, parition_id=?'
-        # selection_argument: '[3,1]'
+        # Firmware 4.4.1: selection_argument: '[3,1]'
+        # Firmware 4.6.1: selection_argument: ['3','1']
 
         # Selection Argument
-        # Panel send selection_argument as list in Firmware 4.6.1
         if(type(selection_argument) is not list):
             #Firmware 4.4.1, seletion_argument is sent as a string
             selection_argument = selection_argument.strip("[]")

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/qolsys_controller/database/table_alarmedsensor.py

@@ -13,6 +13,8 @@ class QolsysTableAlarmedSensor(QolsysTable):
         self._uri = "content://com.qolsys.qolsysprovider.AlarmedSensorProvider/alarmedsensor"
         self._table = "alarmedsensor"
         self._abort_on_error = True
+        self._implemented = True
+
 
         self._columns = [
             "_id",
@@ -25,22 +27,7 @@ class QolsysTableAlarmedSensor(QolsysTable):
             "type",
             "priority",
             "aseb_type",
+            "alarm_time",
         ]
 
         self._create_table()
-
-    def insert(self, data: dict) -> None:
-        self._cursor.execute(f"""INSERT INTO {self.table} (_id,partition_id,silenced,zone_id,sgroup,action,timed_out,type,
-                             priority,aseb_type) VALUES (?,?,?,?,?,?,?,?,?,?)""", (
-            data.get("_id"),
-            data.get("partition_id", ""),
-            data.get("silenced", ""),
-            data.get("zone_id", ""),
-            data.get("sgroup", ""),
-            data.get("action", ""),
-            data.get("timed_out", ""),
-            data.get("type", ""),
-            data.get("priority", ""),
-            data.get("aseb_type", "")))
-
-        self._db.commit()

qolsys_controller-0.0.18/qolsys_controller/database/table_automation.py

@@ -0,0 +1,46 @@
+import logging  # noqa: INP001
+import sqlite3
+
+from .table import QolsysTable
+
+LOGGER = logging.getLogger(__name__)
+
+
+class QolsysTableAutomation(QolsysTable):
+
+    def __init__(self, db: sqlite3.Connection, cursor: sqlite3.Cursor) -> None:
+        super().__init__(db, cursor)
+        self._uri = "content://com.qolsys.qolsysprovider.AutomationDeviceContentProvider/automation"
+        self._table = "automation"
+        self._abort_on_error = False
+        self._implemented = True
+
+        self._columns = [
+            "_id",
+            "virtual_node_id",
+            "version",
+            "opr",
+            "partition_id",
+            "end_point",
+            "extras",
+            "is_autolocking_enabled",
+            "device_type",
+            "endpoint_secure_cmd_classes",
+            "automation_id",
+            "device_name",
+            "protocol",
+            "node_battery_level_value",
+            "state",
+            "last_updated_date",
+            "manufacturer_id",
+            "endpoint_cmd_classes",
+            "device_id",
+            "nodeid_cmd_classes",
+            "is_device_hidden",
+            "nodeid_secure_cmd_classes",
+            "created_date",
+            "status",
+            "smart_energy_optimizer",
+        ]
+
+        self._create_table()

qolsys_controller-0.0.18/qolsys_controller/database/table_country_locale.py

@@ -0,0 +1,37 @@
+import logging  # noqa: INP001
+import sqlite3
+
+from .table import QolsysTable
+
+LOGGER = logging.getLogger(__name__)
+
+
+class QolsysTableCountryLocale(QolsysTable):
+
+    def __init__(self, db: sqlite3.Connection, cursor: sqlite3.Cursor) -> None:
+        super().__init__(db, cursor)
+        self._uri = "content://com.qolsys.qolsysprovider.CountryLocaleContentProvider/country_locale"
+        self._table = "country_locale"
+        self._abort_on_error = False
+        self._implemented = True
+
+        self._columns = [
+            "_id",
+            "version",
+            "opr",
+            "partition_id",
+            "country",
+            "language",
+            "alpha2_code",
+            "language_code",
+            "date_format_enum",
+            "hour_format",
+            "temp_format",
+            "is_active",
+            "date_separator",
+            "zwave_region_frequency_code",
+            "zwave_region_frequency",
+            "zwave_region_prop_values",
+        ]
+
+        self._create_table()

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/qolsys_controller/database/table_dashboard_msgs.py

@@ -13,6 +13,8 @@ class QolsysTableDashboardMsgs(QolsysTable):
         self._uri = "content://com.qolsys.qolsysprovider.DashboardMessagesContentProvider/dashboard_msgs"
         self._table = "dashboard_msgs"
         self._abort_on_error = False
+        self._implemented = True
+
 
         self._columns = [
             "_id",
@@ -30,21 +32,3 @@ class QolsysTableDashboardMsgs(QolsysTable):
         ]
 
         self._create_table()
-
-    def insert(self, data: dict) -> None:
-        self._cursor.execute(f"""INSERT INTO {self.table} (_id,version,opr,partition_id,msg_id,title,description,
-                             received_time,start_time,end_time,read,mime_type) VALUES (?,?,?,?,?,?,?,?,?,?,?,?)""", (
-            data.get("_id"),
-            data.get("version"),
-            data.get("opr"),
-            data.get("partition_id"),
-            data.get("msg_id"),
-            data.get("title"),
-            data.get("description"),
-            data.get("received_time"),
-            data.get("start_time"),
-            data.get("end_time"),
-            data.get("read"),
-            data.get("mime_type")))
-
-        self._db.commit()

qolsys_controller-0.0.18/qolsys_controller/database/table_dimmerlight.py

@@ -0,0 +1,36 @@
+import logging  # noqa: INP001
+import sqlite3
+
+from .table import QolsysTable
+
+LOGGER = logging.getLogger(__name__)
+
+
+class QolsysTableDimmerLight(QolsysTable):
+
+    def __init__(self, db: sqlite3.Connection, cursor: sqlite3.Cursor) -> None:
+        super().__init__(db, cursor)
+        self._uri = "content://com.qolsys.qolsysprovider.DimmerLightsContentProvider/dimmerlight"
+        self._table = "dimmerlight"
+        self._abort_on_error = True
+        self._implemented = True
+
+        self._columns = [
+            "_id",
+            "version",
+            "opr",
+            "partition_id",
+            "dimmer_name",
+            "status",
+            "node_id",
+            "level",
+            "created_by",
+            "created_date",
+            "updated_by",
+            "last_updated_date",
+            "endpoint",
+            "power_details",
+            "paired_status",
+        ]
+
+        self._create_table()

qolsys_controller-0.0.18/qolsys_controller/database/table_doorlock.py

@@ -0,0 +1,37 @@
+import logging  # noqa: INP001
+import sqlite3
+
+from .table import QolsysTable
+
+LOGGER = logging.getLogger(__name__)
+
+
+class QolsysTableDoorLock(QolsysTable):
+
+    def __init__(self, db: sqlite3.Connection, cursor: sqlite3.Cursor) -> None:
+        super().__init__(db, cursor)
+        self._uri = "content://com.qolsys.qolsysprovider.DoorLocksContentProvider/doorlock"
+        self._table = "doorlock"
+        self._abort_on_error = True
+        self._implemented = True
+
+        self._columns = [
+            "_id",
+            "version",
+            "opr",
+            "partition_id",
+            "doorlock_name",
+            "status",
+            "node_id",
+            "created_by",
+            "created_date",
+            "updated_by",
+            "last_updated_date",
+            "remote_arming",
+            "keyfob_arming",
+            "panel_arming",
+            "endpoint",
+            "paired_status",
+        ]
+
+        self._create_table()

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/qolsys_controller/database/table_eu_event.py

@@ -13,6 +13,8 @@ class QolsysTableEuEvent(QolsysTable):
         self._uri = "content://com.qolsys.qolsysprovider.EUEventContentProvider/eu_event"
         self._table = "eu_event"
         self._abort_on_error = False
+        self._implemented = False
+
 
         self._columns = [
             "_id",
@@ -20,8 +22,3 @@ class QolsysTableEuEvent(QolsysTable):
 
         self._create_table()
 
-    def insert(self, data: dict) -> None:
-        if data is not None:
-            LOGGER.error("Please Report")
-            LOGGER.error("Loading Table Format: %s", self.uri)
-            LOGGER.error(data)

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/qolsys_controller/database/table_heat_map.py

@@ -13,6 +13,7 @@ class QolsysTableHeatMap(QolsysTable):
         self._uri = "content://com.qolsys.qolsysprovider.HeatMapContentProvider/heat_map"
         self._table = "heat_map"
         self._abort_on_error = False
+        self._implemented = True
 
         self._columns = [
             "_id",
@@ -28,17 +29,3 @@ class QolsysTableHeatMap(QolsysTable):
 
         self._create_table()
 
-    def insert(self, data: dict) -> None:
-        self._cursor.execute(f"""INSERT INTO {self.table} (_id,version,opr,partition_id,userid,fragment_id,element_id,
-                             count,time_stamp) VALUES (?,?,?,?,?,?,?,?,?)""", (
-            data.get("_id"),
-            data.get("version", ""),
-            data.get("opr", ""),
-            data.get("partition_id", ""),
-            data.get("userid", ""),
-            data.get("fragment_id", ""),
-            data.get("element_id", ""),
-            data.get("count", ""),
-            data.get("time_stamp", "")))
-
-        self._db.commit()

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/qolsys_controller/database/table_history.py

@@ -13,6 +13,7 @@ class QolsysTableHistory(QolsysTable):
         self._uri = "content://com.qolsys.qolsysprovider.HistoryContentProvider/history"
         self._table = "history"
         self._abort_on_error = False
+        self._implemented = True
 
         self._columns = [
             "_id",
@@ -25,24 +26,8 @@ class QolsysTableHistory(QolsysTable):
             "ack",
             "type",
             "feature1",
+            "feature2",
             "device_id",
         ]
 
         self._create_table()
-
-    def insert(self, data: dict) -> None:
-        self._cursor.execute(f"""INSERT INTO {self.table} (_id,version,opr,partition_id,device,events,time,ack,type,
-                             feature1,device_id) VALUES (?,?,?,?,?,?,?,?,?,?,?)""", (
-            data.get("_id"),
-            data.get("version", ""),
-            data.get("opr", ""),
-            data.get("partition_id", ""),
-            data.get("device", ""),
-            data.get("events", ""),
-            data.get("time", ""),
-            data.get("ack", ""),
-            data.get("type", ""),
-            data.get("feature1", ""),
-            data.get("device_id", "")))
-
-        self._db.commit()

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/qolsys_controller/database/table_iqremotesettings.py

@@ -13,6 +13,7 @@ class QolsysTableIqRemoteSettings(QolsysTable):
         self._uri = "content://com.qolsys.qolsysprovider.IQRemoteSettingsContentProvider/iqremotesettings"
         self._table = "iqremotesettings"
         self._abort_on_error = False
+        self._implemented = True
 
         self._columns = [
             "_id",
@@ -27,16 +28,3 @@ class QolsysTableIqRemoteSettings(QolsysTable):
 
         self._create_table()
 
-    def insert(self, data: dict) -> None:
-        self._cursor.execute(f"""INSERT INTO {self.table} (_id,version,opr,partition_id,zone_id,mac_address,name,value)
-                              VALUES (?,?,?,?,?,?,?,?)""", (
-            data.get("_id"),
-            data.get("version", ""),
-            data.get("opr", ""),
-            data.get("partition_id", ""),
-            data.get("zone_id", ""),
-            data.get("mac_address", ""),
-            data.get("name", ""),
-            data.get("value", "")))
-
-        self._db.commit()

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/qolsys_controller/database/table_iqrouter_network_config.py

@@ -13,15 +13,10 @@ class QolsysTableIqRouterNetworkConfig(QolsysTable):
         self._uri = "content://com.qolsys.qolsysprovider.IQRouterNetworkConfigContentProvider/iqrouter_network_config_table"
         self._table = "iqrouter_network_config_table"
         self._abort_on_error = False
+        self._implemented = False
 
         self._columns = [
             "_id",
         ]
 
         self._create_table()
-
-    def insert(self, data: dict) -> None:
-        if data is not None:
-            LOGGER.error("Please Report")
-            LOGGER.error("Loading Table Format: %s", self.uri)
-            LOGGER.error(data)

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/qolsys_controller/database/table_iqrouter_user_device.py

@@ -13,15 +13,11 @@ class QolsysTableIqRouterUserDevice(QolsysTable):
         self._uri = "content://com.qolsys.qolsysprovider.IQRouterUserDeviceContentProvider/iqrouter_user_device_table"
         self._table = "iqrouter_user_device_table"
         self._abort_on_error = False
+        self._implemented = False
+
 
         self._columns = [
             "_id",
         ]
 
         self._create_table()
-
-    def insert(self, data: dict) -> None:
-        if data is not None:
-            LOGGER.error("Please Report")
-            LOGGER.error("Loading Table Format: %s", self.uri)
-            LOGGER.error(data)

qolsys_controller-0.0.18/qolsys_controller/database/table_master_slave.py

@@ -0,0 +1,44 @@
+import logging  # noqa: INP001
+import sqlite3
+
+from .table import QolsysTable
+
+LOGGER = logging.getLogger(__name__)
+
+
+class QolsysTableMasterSlave(QolsysTable):
+
+    def __init__(self, db: sqlite3.Connection, cursor: sqlite3.Cursor) -> None:
+        super().__init__(db, cursor)
+        self._uri = "content://com.qolsys.qolsysprovider.MasterSlaveContentProvider/master_slave"
+        self._table = "master_slave"
+        self._abort_on_error = False
+        self._implemented = True
+
+        self._columns = [
+            "_id",
+            "version",
+            "opr",
+            "partition_id",
+            "zone_id",
+            "ip_address",
+            "mac_address",
+            "device_type",
+            "created_by",
+            "created_date",
+            "updated_by",
+            "last_updated_date",
+            "status",
+            "device_name",
+            "last_updated_iq_remote_checksum",
+            "software_version",
+            "upgrade_status",
+            "name",
+            "bssid",
+            "ssid",
+            "dhcpInfo",
+            "topology",
+            "reboot_reason",
+        ]
+
+        self._create_table()

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/qolsys_controller/database/table_nest_device.py

@@ -13,15 +13,10 @@ class QolsysTableNestDevice(QolsysTable):
         self._uri = "content://com.qolsys.qolsysprovider.NestDeviceContentProvider/nest_device"
         self._table = "nest_device"
         self._abort_on_error = False
+        self._implemented = False
 
         self._columns = [
             "_id",
         ]
 
         self._create_table()
-
-    def insert(self, data: dict) -> None:
-        if data is not None:
-            LOGGER.error("Please Report")
-            LOGGER.error("Loading Table Format: %s", self.uri)
-            LOGGER.error(data)

{qolsys_controller-0.0.16 → qolsys_controller-0.0.18}/qolsys_controller/database/table_output_rules.py

@@ -13,15 +13,10 @@ class QolsysTableOutputRules(QolsysTable):
         self._uri = "content://com.qolsys.qolsysprovider.OutputRulesContentProvider/output_rules"
         self._table = "output_rules"
         self._abort_on_error = False
+        self._implemented = False
 
         self._columns = [
             "_id",
         ]
 
         self._create_table()
-
-    def insert(self, data: dict) -> None:
-        if data is not None:
-            LOGGER.error("Please Report")
-            LOGGER.error("Loading Table Format: %s", self.uri)
-            LOGGER.error(data)