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

qolsys_controller/enum_zwave.py

@@ -1,49 +1,178 @@
 from enum import Enum, IntEnum
 
 
+class MeterType(IntEnum):
+    UNKNOWN = 0x00
+    ELECTRIC_METER = 0x01
+    GAZ_METER = 0x02
+    WATER_METER = 0x03
+    HEATING = 0x04
+    COOLING = 0x05
+    RESERVED = 0x6
+
+
+class MeterRateType(IntEnum):
+    UNSPECIFIED = 0x00
+    IMPORT = 0x01
+    EXPORT = 0x02
+    RESERVED = 0x03
+
+
+class ZWaveMultilevelSensorScale(Enum):
+    TEMPERATURE_CELSIUS = "temperature_celsius"
+    TEMPERATURE_FAHRENHEIT = "temperature_fahrenheit"
+    RELATIVE_HUMIDITY = "relative_humidity"
+    WIND_DIRECTION = "wind_direction"
+    BAROMETRIC_PRESSURE = "barometric_pressure"
+    DEW_POINT = "dew_point"
+    RAIN_RATE = "rain_rate"
+    TIDE_LEVEL = "tide_level"
+    WEIGHT = "weight"
+    VOLTS = "volts"
+    AMPS = "amps"
+    WATTS = "watts"
+    DISTANCE = "distance"
+    ANGLE_POSITION = "angle_position"
+    ROTATION = "rotation"
+    WATER_TEMPERATURE_CELSIUS = "water_temperature_celsius"
+    WATER_TEMPERATURE_FAHRENHEIT = "water_temperature_fahrenheit"
+    LUMINOSITY_LUX = "luminosity_lux"
+    UNKNOWN = "unknown"
+
+
+class ZWaveUnknownMeterScale(IntEnum):
+    UNKNOWN = 0
+
+
+class ZWaveElectricMeterScale(IntEnum):
+    KWH = 0
+    KVAH = 1
+    WATTS = 2
+    PULSE_COUNT = 3
+    VOLTS = 4
+    AMPS = 5
+    POWER_FACTOR = 6
+    KVAR = 7
+    KVARH = 8
+
+
+class ZWaveGasMeterScale(IntEnum):
+    CUBIC_METERS = 0
+    CUBIC_FEET = 1
+    PULSE_COUNT = 3
+
+
+class ZWaveWaterMeterScale(IntEnum):
+    CUBIC_METERS = 0
+    CUBIC_FEET = 1
+    US_GALLONS = 2
+    PULSE_COUNT = 3
+
+
+class ZWaveThermalMeterScale(IntEnum):
+    KWH = 0
+    PULSE_COUNT = 3
+
+
 class ThermostatMode(IntEnum):
-    OFF = 0x0001
-    HEAT = 0x0002
-    COOL = 0x0004
-    AUTO = 0x0008
-    AUX_HEAT = 0x0010
-    RESUME = 0x0020
-    FAN_ONLY = 0x0040
-    FURNACE = 0x0080
-    DRY_AIR = 0x0100
-    MOIST_AIR = 0x0200
-    AUTO_CHANGEOVER = 0x0400
-    ENERGY_SAVE_HEAT = 0x0800
-    ENERGY_SAVE_COOL = 0x1000
-    AWAY = 0x2000
-    FULL_POWER = 0x4000
-    MANUFACTURER_SPECEFIC = 0x8000
+    OFF = 0x00
+    HEAT = 0x01
+    COOL = 0x02
+    AUTO = 0x03
+    AUX_HEAT = 0x04
+    RESUME = 0x05
+    FAN_ONLY = 0x06
+    FURNACE = 0x07
+    DRY_AIR = 0x08
+    MOIST_AIR = 0x09
+    AUTO_CHANGEOVER = 0x0A
+    ENERGY_SAVE_HEAT = 0x0B
+    ENERGY_SAVE_COOL = 0x0C
+    AWAY = 0x0F
+
+
+BITMASK_SUPPORTED_THERMOSTAT_MODE = {
+    0: ThermostatMode.OFF,
+    1: ThermostatMode.HEAT,
+    2: ThermostatMode.COOL,
+    3: ThermostatMode.AUTO,
+    4: ThermostatMode.AUX_HEAT,
+    5: ThermostatMode.RESUME,
+    6: ThermostatMode.FAN_ONLY,
+    7: ThermostatMode.FURNACE,
+}
+
+
+class ThermostatSetpointMode(IntEnum):
+    HEATING = 0x01
+    COOLING = 0x02
+    FURNACE = 0x03
+    DRY_AIR = 0x04
+    MOIST_AIR = 0x05
+    AUTO_CHANGEOVER = 0x06
+    ECO_HEATING = 0x07
+    ECO_COOLING = 0x08
+    AWAY_HEATING = 0x09
+    AWAY_COOLING = 0x10
+
+
+BITMASK_SUPPORTED_THERMOSTAT_SETPOINT_MODE = {
+    0: ThermostatSetpointMode.HEATING,
+    1: ThermostatSetpointMode.COOLING,
+    2: ThermostatSetpointMode.FURNACE,
+    3: ThermostatSetpointMode.DRY_AIR,
+    4: ThermostatSetpointMode.MOIST_AIR,
+    5: ThermostatSetpointMode.AUTO_CHANGEOVER,
+    6: ThermostatSetpointMode.ECO_HEATING,
+    7: ThermostatSetpointMode.ECO_COOLING,
+    8: ThermostatSetpointMode.AWAY_HEATING,
+    9: ThermostatSetpointMode.AWAY_COOLING,
+}
 
 
 class ThermostatFanMode(IntEnum):
-    AUTO_LOW = 0x0001
-    LOW = 0x0002
-    AUTO_HIGH = 0x0004
-    HIGH = 0x0008
-    AUTO_MEDIUM = 0x0010
-    MEDIUM = 0x0020
-    CIRCULATION = 0x4000
-    HUMIDITY_CIRCULATION = 0x0080
-    LEFT_RIGHT = 0x0100
-    UP_DOWN = 0x0200
-    QUIET = 0x0400
+    AUTO_LOW = 0x00
+    LOW = 0x01
+    AUTO_HIGH = 0x02
+    HIGH = 0x03
+    AUTO_MEDIUM = 0x04
+    MEDIUM = 0x05
+    CIRCULATION = 0x06
+    HUMIDITY_CIRCULATION = 0x07
+    LEFT_RIGHT = 0x08
+    UP_DOWN = 0x09
+    QUIET = 0x0A
     EXTERNAL_CIRCULATION = 0x0800
-    MANUFACTURER_SPECEFIC = 0x1000
 
 
-class ZwaveCommand(IntEnum):
+BITMASK_SUPPORTED_THERMOSTAT_FAN_MODE = {
+    0: ThermostatFanMode.AUTO_LOW,
+    1: ThermostatFanMode.LOW,
+    2: ThermostatFanMode.AUTO_HIGH,
+    3: ThermostatFanMode.HIGH,
+    4: ThermostatFanMode.AUTO_MEDIUM,
+    5: ThermostatFanMode.MEDIUM,
+    6: ThermostatFanMode.CIRCULATION,
+    7: ThermostatFanMode.HUMIDITY_CIRCULATION,
+}
+
+
+class ZwaveCommandClass(IntEnum):
     SwitchBinary = 0x25
     SwitchMultilevel = 0x26
+    SensorMultiLevel = 0x31
+    Meter = 0x32
     ThermostatMode = 0x40
     ThermostatSetPoint = 0x43
     ThermostatFanMode = 0x44
     ThermostatFanState = 0x45
     DoorLock = 0x62
+    Alarm = 0x71
+
+
+class ZwaveCommand(IntEnum):
+    SET = 0x01
+    GET = 0x02
 
 
 class ZwaveDeviceClass(Enum):

qolsys_controller/errors.py

@@ -9,6 +9,11 @@ class QolsysError(Exception):
         super().__init__(*args, **kwargs)
 
 
+class QolsysUserCodeError(QolsysError):
+    def __init__(self) -> None:
+        super().__init__("QolsysUserCodeError")
+
+
 class QolsysSslError(QolsysError):
     def __init__(self) -> None:
         super().__init__("QolsysSslError")

qolsys_controller/mqtt_command.py

@@ -91,26 +91,32 @@ class MQTTCommand_ZWave(MQTTCommand_IpcCall):
 
         ipc_request: list[dict[str, Any]] = [
             {
+                # Node ID
                 "dataType": "int",
                 "dataValue": int(node_id),
             },
             {
+                # End Point
                 "dataType": "int",
                 "dataValue": 0,
             },
             {
+                # Z-Wave Payload
                 "dataType": "byteArray",
                 "dataValue": zwave_command,
             },
             {
+                # Transmit option ?
                 "dataType": "int",
                 "dataValue": 0,
             },
             {
+                # Priority
                 "dataType": "int",
                 "dataValue": 106,
             },
             {
+                # Callback ?
                 "dataType": "byteArray",
                 "dataValue": [0],
             },

qolsys_controller/panel.py

@@ -1,9 +1,14 @@
 from __future__ import annotations
 
+import base64
 import json
 import logging
 from typing import TYPE_CHECKING, Any
 
+from qolsys_controller.adc_device import QolsysAdcDevice
+from qolsys_controller.zwave_energy_clamp import QolsysEnergyClamp
+from qolsys_controller.zwave_thermometer import QolsysThermometer
+
 from .database.db import QolsysDB
 from .enum import (
     PartitionAlarmState,
@@ -386,9 +391,54 @@ class QolsysPanel(QolsysObservable):
         self._controller.state.sync_partitions_data(self.get_partitions_from_db())
         self._controller.state.sync_zones_data(self.get_zones_from_db())
         self._controller.state.sync_zwave_devices_data(self.get_zwave_devices_from_db())
+        self._controller.state.sync_adc_devices_data(self.get_adc_devices_from_db())
         self._controller.state.sync_scenes_data(self.get_scenes_from_db())
         self._controller.state.sync_weather_data(self.get_weather_from_db())
 
+        # Validate all local user match a Qolsys Panel user
+        qolsys_users = self.db.get_users()
+        qolsys_user_list = []
+        for qolsys_user in qolsys_users:
+            try:
+                userid = int(qolsys_user.get("userid", ""))
+            except ValueError:
+                LOGGER.error("Invalid userid in panel database: %s", qolsys_user.get("userid", ""))
+                userid = -1
+
+            qolsys_user_list.append(userid)
+
+        for local_user in self._users:
+            if local_user.id not in qolsys_user_list:
+                LOGGER.error("ID %s from users.conf file not found in panel database", local_user.id)
+
+        # Check associated zone_id in iqremotesettins table
+        LOGGER.debug("Checking iqremotesettings table for zone_id matching panel MAC address")
+        iqremote_settings_list = self.db.get_iqremote_settings()
+        for iqremote in iqremote_settings_list:
+            if (
+                self._controller.settings.random_mac.replace(":", "").lower()
+                == iqremote.get("mac_address", "").replace(":", "").lower()
+            ):
+                self._controller._zone_id = iqremote.get("zone_id", "")
+                LOGGER.debug("Found matching zone_id: %s", self._controller._zone_id)
+                break
+
+    # Parse Z-Wave message
+    def parse_zwave_message(self, data: dict[str, Any]) -> None:
+        zwave = data.get("ZWAVE_RESPONSE", "")
+        payload = base64.b64decode(zwave.get("ZWAVE_PAYLOAD", "")).hex()
+        # LOGGER.debug(
+        #    "Z-Wave Response: Node(%s) - Status(%s) - Payload(%s)",
+        #    zwave.get("NODE_ID", ""),
+        #    zwave.get("ZWAVE_COMMAND_STATUS", ""),
+        #    payload,
+        # )
+
+        node_id: str = str(zwave.get("NODE_ID", 0))
+        node = self._controller.state.zwave_device(node_id)
+        if node is not None:
+            node.update_raw(bytes.fromhex(payload))
+
     # Parse panel update to database
     def parse_iq2meid_message(self, data: dict[str, Any]) -> None:  # noqa: C901, PLR0912, PLR0915
         eventName = data.get("eventName")
@@ -564,6 +614,22 @@ class QolsysPanel(QolsysObservable):
                             case self.db.table_zwave_association_goup.uri:
                                 self.db.table_zwave_association_goup.update(selection, selection_argument, content_values)
 
+                            # Update Zwave Other
+                            case self.db.table_zwave_other.uri:
+                                self.db.table_zwave_other.update(selection, selection_argument, content_values)
+
+                            # Country Locale
+                            case self.db.table_country_locale.uri:
+                                self.db.table_country_locale.update(selection, selection_argument, content_values)
+
+                            # Virtual device
+                            case self.db.table_virtual_device.uri:
+                                self.db.table_virtual_device.update(selection, selection_argument, content_values)
+                                adc_id = content_values.get("device_id", "")
+                                adc_device = self._controller.state.adc_device(adc_id)
+                                if adc_device is not None:
+                                    adc_device.update_adc_device(content_values)
+
                             case _:
                                 LOGGER.debug("iq2meid updating unknow uri:%s", uri)
                                 LOGGER.debug(data)
@@ -641,6 +707,13 @@ class QolsysPanel(QolsysObservable):
                             case self.db.table_zwave_association_goup.uri:
                                 self.db.table_zwave_association_goup.delete(selection, selection_argument)
 
+                            case self.db.table_virtual_device.uri:
+                                self.db.table_virtual_device.delete(selection, selection_argument)
+                                self._controller.state.sync_adc_devices_data(self.get_adc_devices_from_db())
+
+                            case self.db.table_zwave_other.uri:
+                                self.db.table_zwave_other.delete(selection, selection_argument)
+
                             case _:
                                 LOGGER.debug("iq2meid deleting unknown uri:%s", uri)
                                 LOGGER.debug(data)
@@ -771,9 +844,21 @@ class QolsysPanel(QolsysObservable):
                                 self.db.table_weather.insert(data=content_values)
                                 self._controller.state.sync_weather_data(self.get_weather_from_db())
 
+                            # ZWave Association Group
                             case self.db.table_zwave_association_goup.uri:
                                 self.db.table_zwave_association_goup.insert(data=content_values)
 
+                            # Zwave Other
+                            case self.db.table_zwave_other.uri:
+                                self.db.table_zwave_other.insert(data=content_values)
+                                LOGGER.debug("New Z-Wave Other information")
+                                LOGGER.debug(content_values)
+
+                            # Virtual Device
+                            case self.db.table_virtual_device.uri:
+                                self.db.table_virtual_device.insert(data=content_values)
+                                self._controller.state.sync_adc_devices_data(self.get_adc_devices_from_db())
+
                             case _:
                                 LOGGER.debug("iq2meid inserting unknow uri:%s", uri)
                                 LOGGER.debug(data)
@@ -793,6 +878,15 @@ class QolsysPanel(QolsysObservable):
         # No valid user code found
         return -1
 
+    def get_adc_devices_from_db(self) -> list[QolsysAdcDevice]:
+        adc_devices: list[QolsysAdcDevice] = []
+        devices_list = self.db.get_adc_devices()
+
+        for device in devices_list:
+            adc_devices.append(QolsysAdcDevice(device))
+
+        return adc_devices
+
     def get_zwave_devices_from_db(self) -> list[QolsysZWaveDevice]:
         devices: list[QolsysZWaveDevice] = []
         devices_list = self.db.get_zwave_devices()
@@ -802,8 +896,21 @@ class QolsysPanel(QolsysObservable):
 
         for device in devices_list:
             device_added = False
-
             zwave_node_id = device.get("node_id", "")
+
+            # Check if z-wave device is an Energy Clamp
+            if device.get("node_type", "") == "Energy Clamp":
+                LOGGER.debug(device)
+                qolsys_meter_device = QolsysEnergyClamp(device)
+                devices.append(qolsys_meter_device)
+                device_added = True
+
+            # Check if z-wave device is a thermometer
+            if device.get("node_type", "") == "Thermometer":
+                qolsys_thermometer = QolsysThermometer(device)
+                devices.append(qolsys_thermometer)
+                device_added = True
+
             # Check if z-wave device is a Dimmer
             for d in dimmers_list:
                 dimmer_node_id = d.get("node_id", "")
@@ -907,10 +1014,7 @@ class QolsysPanel(QolsysObservable):
 
             alarm_type = []
             for alarm in self.db.get_alarm_type(partition_id):
-                if alarm == "":
-                    alarm_type.append(PartitionAlarmType("Police Emergency"))
-                else:
-                    alarm_type.append(PartitionAlarmType(alarm))
+                alarm_type.append(PartitionAlarmType(alarm))
 
             alarm_state = PartitionAlarmState(self.db.get_state_partition("ALARM_STATE", partition_id) or "UNKNOWN")
 

qolsys_controller/partition.py

@@ -38,7 +38,8 @@ class QolsysPartition(QolsysObservable):
         self._alarm_state: PartitionAlarmState = alarm_state
 
         # Alarm Type (alarmedsensor table)
-        self._alarm_type_array: list[PartitionAlarmType] = alarm_type_array
+        self._alarm_type_array: list[PartitionAlarmType] = []
+        self.append_alarm_type(alarm_type_array)
 
         # Other
         self._command_exit_sounds: bool = True
@@ -72,7 +73,7 @@ class QolsysPartition(QolsysObservable):
 
         # Update system_status
         if "SYSTEM_STATUS" in data:
-            self.system_status = PartitionSystemStatus[data.get("SYSTEM_STATUS", "")]
+            self.system_status = PartitionSystemStatus(data.get("SYSTEM_STATUS", ""))
 
         # Update system_status_changed_time
         if "SYSTEM_STATUS_CHANGED_TIME" in data:
@@ -250,6 +251,25 @@ class QolsysPartition(QolsysObservable):
         data_changed = False
 
         for new_alarm_type in new_alarm_type_array:
+            # Map values to Police Emergency if needed
+            if new_alarm_type in {
+                PartitionAlarmType.GLASS_BREAK,
+                PartitionAlarmType.GLASS_BREAK_AWAY_ONLY,
+                PartitionAlarmType.ENTRY_EXIT_LONG_DELAY,
+                PartitionAlarmType.ENTRY_EXIT_NORMAL_DELAY,
+                PartitionAlarmType.INSTANT_PERIMETER_DW,
+                PartitionAlarmType.INSTANT_INTERIOR_DOOR,
+                PartitionAlarmType.AWAY_DELAY_MOTION,
+                PartitionAlarmType.AWAY_INSTANT_MOTION,
+                PartitionAlarmType.REPORTING_SAFETY_SENSOR,
+                PartitionAlarmType.DELAYED_REPORTING_SAFETY_SENSOR,
+                PartitionAlarmType.AWAY_INSTANT_FOLLOWER_DELAY,
+                PartitionAlarmType.STAY_INSTANT_MOTION,
+                PartitionAlarmType.STAY_DELAY_MOTION,
+                PartitionAlarmType.EMPTY,
+            }:
+                new_alarm_type = PartitionAlarmType.POLICE_EMERGENCY
+
             # Value already in array
             if new_alarm_type in self._alarm_type_array:
                 continue