pyg90alarm 2.1.1__py3-none-any.whl → 2.2.0__py3-none-any.whl

pyg90alarm/cloud/messages.py

@@ -40,7 +40,7 @@ from ..const import (
     G90AlertStateChangeTypes, REMOTE_CLOUD_HOST, REMOTE_CLOUD_PORT,
     G90AlertTypes, G90AlertSources, G90AlertStates,
 )
-from ..entities.sensor import G90SensorTypes
+from ..definitions.base import G90PeripheralTypes
 from ..notifications.base import G90DeviceAlert
 
 
@@ -369,19 +369,19 @@ class G90CloudStatusChangeSensorReqMessage(G90CloudStatusChangeReqMessageBase):
 
     type: int
     sensor_id: int
-    _sensor_type: G90SensorTypes
+    _sensor_type: G90PeripheralTypes
     _sensor_state: int
     _sensor: bytes
     _timestamp: int  # Unix timestamp
 
     @property
-    def sensor_type(self) -> G90SensorTypes:
+    def sensor_type(self) -> G90PeripheralTypes:
         """
         Get the sensor type.
 
         :return: The type of the sensor that triggered the event
         """
-        return G90SensorTypes(self._sensor_type)
+        return G90PeripheralTypes(self._sensor_type)
 
     @property
     def sensor_state(self) -> G90AlertStates:
@@ -453,7 +453,7 @@ class G90CloudStatusChangeAlarmReqMessage(G90CloudStatusChangeReqMessageBase):
 
     type: int
     sensor_id: int
-    _sensor_type: G90SensorTypes
+    _sensor_type: G90PeripheralTypes
     _sensor_state: int
     _sensor: bytes
     _timestamp: int  # Unix timestamp
@@ -478,13 +478,13 @@ class G90CloudStatusChangeAlarmReqMessage(G90CloudStatusChangeReqMessageBase):
         return self._sensor.decode().rstrip('\x00')
 
     @property
-    def sensor_type(self) -> G90SensorTypes:
+    def sensor_type(self) -> G90PeripheralTypes:
         """
         Get the sensor type for the alarm event.
 
         :return: The type of sensor that triggered the alarm
         """
-        return G90SensorTypes(self._sensor_type)
+        return G90PeripheralTypes(self._sensor_type)
 
     @property
     def as_device_alert(self) -> G90DeviceAlert:

pyg90alarm/const.py

@@ -34,6 +34,8 @@ CLOUD_NOTIFICATIONS_HOST = '0.0.0.0'
 CLOUD_NOTIFICATIONS_PORT = 5678
 REMOTE_CLOUD_HOST = '47.88.7.61'
 REMOTE_CLOUD_PORT = 5678
+DEVICE_REGISTRATION_TIMEOUT = 30
+ROOM_ID = 0
 
 CMD_PAGE_SIZE = 10
 
@@ -92,6 +94,7 @@ class G90Commands(IntEnum):
     """)
     GETSINGLEDEVICE = 139
     SETSINGLEDEVICE = 140
+    SENDREGDEVICERESULT = 162
     DELALLDEVICES = 203
     # Host config
     GETHOSTCONFIG = 106
@@ -170,7 +173,7 @@ class G90NotificationTypes(IntEnum):
     Defines types of notifications sent by the alarm panel.
     """
     ARM_DISARM = 1
-    SENSOR_ADDED = 4
+    SENSOR_CHANGE = 4
     SENSOR_ACTIVITY = 5
     DOOR_OPEN_WHEN_ARMING = 6
     FIRMWARE_UPDATING = 8

pyg90alarm/definitions/base.py

@@ -0,0 +1,247 @@
+# Copyright (c) 2025 Ilia Sotnikov
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""
+Base entities for peripheral definitions.
+"""
+from __future__ import annotations
+from dataclasses import dataclass
+from itertools import groupby
+from enum import IntEnum
+from abc import ABC, abstractmethod
+import logging
+from ..exceptions import G90PeripheralDefinitionNotFound, G90Error
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class G90PeripheralProtocols(IntEnum):
+    """
+    Protocol types for the peripherals.
+    """
+    RF_1527 = 0
+    RF_2262 = 1
+    RF_PRIVATE = 2
+    RF_SLIDER = 3
+    CORD = 5
+    WIFI = 4
+    USB = 6
+
+
+class G90PeripheralTypes(IntEnum):
+    """
+    Peripheral types.
+    """
+    DOOR = 1
+    GLASS = 2
+    GAS = 3
+    SMOKE = 4
+    SOS = 5
+    VIB = 6
+    WATER = 7
+    INFRARED = 8
+    IN_BEAM = 9
+    REMOTE = 10
+    RFID = 11
+    DOORBELL = 12
+    BUTTONID = 13
+    WATCH = 14
+    FINGER_LOCK = 15
+    SUBHOST = 16
+    REMOTE_2_4G = 17
+    GAS_VALVE = 18
+    CORD_SENSOR = 126
+    SOCKET = 128
+    SIREN = 129
+    CURTAIN = 130
+    SLIDINGWIN = 131
+    AIRCON = 133
+    TV = 135
+    TV_BOX = 136
+    SMART_SWITCH = 137
+    NIGHTLIGHT = 138
+    SOCKET_2_4G = 140
+    SIREN_2_4G = 141
+    SWITCH_2_4G = 142
+    TOUCH_SWITCH_2_4G = 143
+    CURTAIN_2_4G = 144
+    IR_2_4G = 145
+    CORD_DEV = 254
+    UNKNOWN = 255
+
+
+class G90PeripheralMatchModes(IntEnum):
+    """
+    Defines compare (match) mode for the peripheral.
+    """
+    ALL = 0
+    ONLY20BITS = 1
+    ONLY16BITS = 2
+
+
+class G90PeripheralRwModes(IntEnum):
+    """
+    Defines read/write mode for the peripheral.
+    """
+    READ = 0
+    WRITE = 1
+    READ_WRITE = 2
+
+
+@dataclass(frozen=True)
+class G90PeripheralDefinition:
+    # pylint: disable=too-many-instance-attributes
+    """
+    Holds peripheral definition data.
+    """
+    type: G90PeripheralTypes
+    subtype: int
+    rx: int
+    tx: int
+    private_data: str
+    rw_mode: G90PeripheralRwModes
+    match_mode: G90PeripheralMatchModes
+    name: str
+    protocol: G90PeripheralProtocols
+    timeout: int
+    baudrate: int
+    node_count: int
+
+    @property
+    def reserved_data(self) -> int:
+        """
+        Peripheral's 'reserved_data' field to be written, combined of match
+        and RW mode values bitwise.
+        """
+        return self.match_mode.value << 4 | self.rw_mode.value
+
+
+def unique_definitions(
+    obj: type[G90PeripheralDefinitionsBase]
+) -> type[G90PeripheralDefinitionsBase]:
+    """
+    Decorator to ensure that peripheral definitions are unique by name
+    and type/subtype/protocol.
+
+    :param obj: Class to decorate.
+    :return: Decorated class with unique definitions.
+    :raises G90Error: If definitions are not unique.
+    """
+    names = groupby(
+        sorted(obj.definitions(), key=lambda x: x.name),
+        lambda x: x.name
+    )
+    type_subtype = groupby(
+        sorted(
+            obj.definitions(),
+            key=lambda x: (x.type, x.subtype, x.protocol)
+        ),
+        lambda x: (x.type, x.subtype, x.protocol)
+    )
+    non_unique_names = [
+        k for _, group in names if len(k := list(group)) > 1
+    ]
+    non_unique_types = [
+        k for _, group in type_subtype if len(k := list(group)) > 1
+    ]
+
+    msgs = []
+    if non_unique_names:
+        msgs.append(
+            f"{obj}: Peripheral definitions have non-unique names: \n"
+            f"{non_unique_names}"
+        )
+    if non_unique_types:
+        msgs.append(
+            f"{obj}: Peripheral definitions have non-unique types: \n"
+            f"{non_unique_types}"
+        )
+
+    if msgs:
+        raise G90Error('.\n'.join(msgs))
+
+    return obj
+
+
+class G90PeripheralDefinitionsBase(ABC):
+    """
+    Base class for peripheral definitions.
+    """
+    @classmethod
+    @abstractmethod
+    def definitions(cls) -> list[G90PeripheralDefinition]:
+        """
+        Get all peripheral definitions.
+
+        :return: List of peripheral definitions.
+        """
+
+    @classmethod
+    def get_by_id(
+        cls, id_type: G90PeripheralTypes, id_subtype: int,
+        protocol: G90PeripheralProtocols
+    ) -> G90PeripheralDefinition:
+        """
+        Gets peripheral definition by type, subtype and protocol.
+
+        :param id_type: Peripheral type.
+        :param id_subtype: Peripheral subtype.
+        :param protocol: Peripheral protocol.
+        :raises G90PeripheralDefinitionNotFound: If definition not found.
+        """
+        for definition in cls.definitions():
+            if (
+                definition.type == id_type
+                and definition.subtype == id_subtype
+                and definition.protocol == protocol
+            ):
+                _LOGGER.debug(
+                    "Found peripheral definition by"
+                    " type %d, subtype %d and protocol %d: %s",
+                    id_type, id_subtype, protocol, definition
+                )
+                return definition
+
+        raise G90PeripheralDefinitionNotFound(
+            "Peripheral definition not found"
+            f" by type={id_type}, subtype={id_subtype}"
+            f" and protocol={protocol}",
+        )
+
+    @classmethod
+    def get_by_name(
+        cls, name: str
+    ) -> G90PeripheralDefinition:
+        """
+        Gets peripheral definition by name.
+
+        :param name: Peripheral name.
+        :raises G90PeripheralDefinitionNotFound: If definition not found.
+        """
+        for definition in cls.definitions():
+            if definition.name == name:
+                _LOGGER.debug(
+                    "Found peripheral definition by name '%s': %s",
+                    name, definition
+                )
+                return definition
+
+        raise G90PeripheralDefinitionNotFound(
+            f"Peripheral definition not found by name='{name}'"
+        )

pyg90alarm/definitions/devices.py

@@ -0,0 +1,366 @@
+# Copyright (c) 2025 Ilia Sotnikov
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""
+Device (relays, sockets) definitions for G90 alarm panel.
+"""
+from __future__ import annotations
+import logging
+from .base import (
+    G90PeripheralDefinition,
+    G90PeripheralDefinitionsBase,
+    G90PeripheralTypes,
+    G90PeripheralProtocols,
+    G90PeripheralRwModes,
+    G90PeripheralMatchModes,
+    unique_definitions,
+)
+
+_LOGGER = logging.getLogger(__name__)
+
+
+@unique_definitions
+class G90DeviceDefinitions(G90PeripheralDefinitionsBase):
+    """
+    Device definitions, required when modifying them since
+    writing a device to the panel requires values not present on read.
+    """
+    DEVICE_DEFINITIONS = [
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.CORD_DEV,
+            subtype=0,
+            rx=0,
+            tx=0,
+            private_data='00',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY20BITS,
+            name="Wired",
+            protocol=G90PeripheralProtocols.CORD,
+            timeout=0,
+            baudrate=1480,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.SOCKET,
+            subtype=3,
+            rx=0,
+            tx=2,
+            private_data='060A0600',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY20BITS,
+            name="Socket: S07",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=1190,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.SOCKET,
+            subtype=0,
+            rx=0,
+            tx=2,
+            private_data='0707070B0B0D0D0E0E00',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY20BITS,
+            name="Socket: JDQ",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=1480,
+            node_count=4
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.SOCKET,
+            subtype=1,
+            rx=0,
+            tx=2,
+            private_data='07070700',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY20BITS,
+            name="Socket: Single channel",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=1480,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.SOCKET,
+            subtype=4,
+            rx=0,
+            tx=2,
+            private_data='050D0500',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY20BITS,
+            name="Socket Switch",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=840,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.SOCKET,
+            subtype=5,
+            rx=0,
+            tx=2,
+            private_data='070A0E080D060B00',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY20BITS,
+            name="Socket: 3 channel",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=960,
+            node_count=3
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.SOCKET,
+            subtype=6,
+            rx=0,
+            tx=2,
+            private_data='0B0D0E0B0C090A070800',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY20BITS,
+            name="Socket: 4 channel",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=960,
+            node_count=4
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.CURTAIN,
+            subtype=0,
+            rx=0,
+            tx=7,
+            private_data='070B0E0D0C09030100',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY20BITS,
+            name="Curtain: Rolling",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=960,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.CURTAIN,
+            subtype=1,
+            rx=0,
+            tx=7,
+            private_data='0804010200',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY16BITS,
+            name="Curtain",
+            protocol=G90PeripheralProtocols.RF_SLIDER,
+            timeout=0,
+            baudrate=500,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.CURTAIN,
+            subtype=1,
+            rx=0,
+            tx=7,
+            private_data='0E0B0E0D0C09030100',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY20BITS,
+            name="Curtain: Sliding",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=960,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.CURTAIN,
+            subtype=2,
+            rx=0,
+            tx=7,
+            private_data='070B0E0D0C09030100',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY20BITS,
+            name="Curtain: Push",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=960,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.AIRCON,
+            subtype=0,
+            rx=0,
+            tx=0,
+            private_data='00',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY20BITS,
+            name="Air Conditioner",
+            protocol=G90PeripheralProtocols.RF_PRIVATE,
+            timeout=0,
+            baudrate=800,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.TV,
+            subtype=0,
+            rx=0,
+            tx=0,
+            private_data='00',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY20BITS,
+            name="TV",
+            protocol=G90PeripheralProtocols.RF_PRIVATE,
+            timeout=0,
+            baudrate=800,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.SIREN,
+            subtype=0,
+            rx=0,
+            tx=2,
+            private_data='FEFEF600',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY16BITS,
+            name="Siren: SS08",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=1480,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.SIREN,
+            subtype=4,
+            rx=0,
+            tx=2,
+            private_data='FEFEF600',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY16BITS,
+            name="Siren: SS07A",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=1480,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.SIREN,
+            subtype=5,
+            rx=0,
+            tx=2,
+            private_data='FCFCCF00',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY16BITS,
+            name="Siren: SS04",
+            protocol=G90PeripheralProtocols.RF_2262,
+            timeout=0,
+            baudrate=1480,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.SIREN,
+            subtype=1,
+            rx=0,
+            tx=2,
+            private_data='FCFCCF00',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY16BITS,
+            name="Siren: SS02B",
+            protocol=G90PeripheralProtocols.RF_2262,
+            timeout=0,
+            baudrate=1480,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.SIREN,
+            subtype=2,
+            rx=0,
+            tx=2,
+            private_data='FEFEFD00',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY16BITS,
+            name="Siren: Solar",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=2200,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.NIGHTLIGHT,
+            subtype=0,
+            rx=0,
+            tx=2,
+            private_data='060A0600',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY20BITS,
+            name="Night Light",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=1190,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.SOCKET_2_4G,
+            subtype=1,
+            rx=0,
+            tx=0,
+            private_data='00',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY20BITS,
+            name="Socket: 2.4G",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=960,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.SIREN_2_4G,
+            subtype=1,
+            rx=0,
+            tx=0,
+            private_data='00',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY16BITS,
+            name="Siren: 2.4G",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=2200,
+            node_count=1
+        ),
+        G90PeripheralDefinition(
+            type=G90PeripheralTypes.CURTAIN_2_4G,
+            subtype=1,
+            rx=0,
+            tx=0,
+            private_data='00',
+            rw_mode=G90PeripheralRwModes.WRITE,
+            match_mode=G90PeripheralMatchModes.ONLY20BITS,
+            name="Curtain: 2.4G",
+            protocol=G90PeripheralProtocols.RF_1527,
+            timeout=0,
+            baudrate=960,
+            node_count=1
+        ),
+    ]
+
+    @classmethod
+    def definitions(cls) -> list[G90PeripheralDefinition]:
+        """
+        Gets all device definitions.
+
+        :return: List of device definitions.
+        """
+        _LOGGER.debug(
+            "Number of sensor definitions: %d", len(cls.DEVICE_DEFINITIONS)
+        )
+        return cls.DEVICE_DEFINITIONS