pyg90alarm 1.15.1__py3-none-any.whl → 1.16.1__py3-none-any.whl

pyg90alarm/alarm.py

@@ -60,7 +60,8 @@ from .const import (
     G90Commands, REMOTE_PORT,
     REMOTE_TARGETED_DISCOVERY_PORT,
     LOCAL_TARGETED_DISCOVERY_PORT,
-    NOTIFICATIONS_PORT,
+    LOCAL_NOTIFICATIONS_HOST,
+    LOCAL_NOTIFICATIONS_PORT,
     G90ArmDisarmTypes,
 )
 from .base_cmd import (G90BaseCommand, G90BaseCommandData)
@@ -140,11 +141,14 @@ class G90Alarm(G90DeviceNotifications):
     # pylint: disable=too-many-instance-attributes,too-many-arguments
     def __init__(self, host: str, port: int = REMOTE_PORT,
                  reset_occupancy_interval: float = 3.0,
-                 notifications_host: str = '0.0.0.0',
-                 notifications_port: int = NOTIFICATIONS_PORT):
-        super().__init__(host=notifications_host, port=notifications_port)
-        self._host = host
-        self._port = port
+                 notifications_local_host: str = LOCAL_NOTIFICATIONS_HOST,
+                 notifications_local_port: int = LOCAL_NOTIFICATIONS_PORT):
+        super().__init__(
+            local_host=notifications_local_host,
+            local_port=notifications_local_port
+        )
+        self._host: str = host
+        self._port: int = port
         self._sensors: List[G90Sensor] = []
         self._devices: List[G90Device] = []
         self._notifications: Optional[G90DeviceNotifications] = None
@@ -336,7 +340,9 @@ class G90Alarm(G90DeviceNotifications):
         :return: Device information
         """
         res = await self.command(G90Commands.GETHOSTINFO)
-        return G90HostInfo(*res)
+        info = G90HostInfo(*res)
+        self.device_id = info.host_guid
+        return info
 
     @property
     async def host_status(self) -> G90HostStatus:
@@ -813,7 +819,7 @@ class G90Alarm(G90DeviceNotifications):
                         # code as alert, as if it came from the device and its
                         # notifications port
                         self._handle_alert(
-                            (self._host, self._notifications_port),
+                            (self._host, self._notifications_local_port),
                             item.as_device_alert()
                         )
 

pyg90alarm/base_cmd.py

@@ -154,7 +154,12 @@ class G90BaseCommand(DatagramProtocol):
         Parses the response from the alarm panel.
         """
         _LOGGER.debug('To be decoded from wire format %s', data)
-        self._parse(data.decode('utf-8', errors='ignore'))
+        try:
+            self._parse(data.decode('utf-8'))
+        except UnicodeDecodeError as exc:
+            raise G90Error(
+                'Unable to decode response from UTF-8'
+            ) from exc
         return self._resp.data or []
 
     def _parse(self, data: str) -> None:

pyg90alarm/const.py

@@ -28,7 +28,8 @@ from typing import Optional
 REMOTE_PORT = 12368
 REMOTE_TARGETED_DISCOVERY_PORT = 12900
 LOCAL_TARGETED_DISCOVERY_PORT = 12901
-NOTIFICATIONS_PORT = 12901
+LOCAL_NOTIFICATIONS_HOST = '0.0.0.0'
+LOCAL_NOTIFICATIONS_PORT = 12901
 
 CMD_PAGE_SIZE = 10
 
@@ -165,7 +166,10 @@ class G90NotificationTypes(IntEnum):
     Defines types of notifications sent by the alarm panel.
     """
     ARM_DISARM = 1
+    SENSOR_ADDED = 4
     SENSOR_ACTIVITY = 5
+    DOOR_OPEN_WHEN_ARMING = 6
+    FIRMWARE_UPDATING = 8
 
 
 class G90ArmDisarmTypes(IntEnum):
@@ -194,7 +198,10 @@ class G90AlertSources(IntEnum):
     """
     DEVICE = 0
     SENSOR = 1
+    REMOTE = 10
+    RFID = 11
     DOORBELL = 12
+    FINGERPRINT = 15
 
 
 class G90AlertStates(IntEnum):
@@ -203,6 +210,7 @@ class G90AlertStates(IntEnum):
     """
     DOOR_CLOSE = 0
     DOOR_OPEN = 1
+    SOS = 2
     TAMPER = 3
     LOW_BATTERY = 4
 

pyg90alarm/device_notifications.py

@@ -41,7 +41,6 @@ from .const import (
     G90AlertStates,
 )
 
-
 _LOGGER = logging.getLogger(__name__)
 
 
@@ -107,12 +106,29 @@ class G90DeviceAlert:  # pylint: disable=too-many-instance-attributes
 class G90DeviceNotifications(DatagramProtocol):
     """
     Implements support for notifications/alerts sent by alarm panel.
+
+    There is a basic check to ensure only notifications/alerts from the correct
+    device are processed - the check uses the host and port of the device, and
+    the device ID (GUID) that is set by the ancestor class that implements the
+    commands (e.g. :class:`G90Alarm`). The latter to work correctly needs a
+    command to be performed first, one that fetches device GUID and then stores
+    it using :attr:`.device_id` (e.g. :meth:`G90Alarm.get_host_info`).
     """
-    def __init__(self, port: int, host: str):
+    def __init__(self, local_port: int, local_host: str):
         # pylint: disable=too-many-arguments
         self._notification_transport: Optional[BaseTransport] = None
-        self._notifications_host = host
-        self._notifications_port = port
+        self._notifications_local_host = local_host
+        self._notifications_local_port = local_port
+        # Host/port of the device is configured to communicating via commands.
+        # Inteded to validate if notifications/alert are received from the
+        # correct device.
+        self._host: Optional[str] = None
+        self._port: Optional[int] = None
+        # Same but for device ID (GUID) - the notifications logic uses it to
+        # perform validation, but doesn't set it from messages received (it
+        # will diminish the purpose of the validation, should be done by an
+        # ancestor class).
+        self._device_id: Optional[str] = None
 
     def _handle_notification(
         self, addr: Tuple[str, int], notification: G90Notification
@@ -145,6 +161,15 @@ class G90DeviceNotifications(DatagramProtocol):
     def _handle_alert(
         self, addr: Tuple[str, int], alert: G90DeviceAlert
     ) -> None:
+        # Stop processing when alert is received from the device with different
+        # GUID
+        if self.device_id and alert.device_id != self.device_id:
+            _LOGGER.error(
+                "Received alert from wrong device: expected '%s', got '%s'",
+                self.device_id, alert.device_id
+            )
+            return
+
         if alert.type == G90AlertTypes.DOOR_OPEN_CLOSE:
             if alert.state in (
                 G90AlertStates.DOOR_OPEN, G90AlertStates.DOOR_CLOSE
@@ -219,11 +244,23 @@ class G90DeviceNotifications(DatagramProtocol):
     def datagram_received(  # pylint:disable=R0911
         self, data: bytes, addr: Tuple[str, int]
     ) -> None:
-
         """
-        Invoked from datagram is received from the device.
+        Invoked when datagram is received from the device.
         """
-        s_data = data.decode('utf-8')
+        if self._host and self._host != addr[0]:
+            _LOGGER.error(
+                "Received notification/alert from wrong host '%s',"
+                " expected from '%s'",
+                addr[0], self._host
+            )
+            return
+
+        try:
+            s_data = data.decode('utf-8')
+        except UnicodeDecodeError:
+            _LOGGER.error('Unable to decode device message from UTF-8')
+            return
+
         if not s_data.endswith('\0'):
             _LOGGER.error('Missing end marker in data')
             return
@@ -304,13 +341,13 @@ class G90DeviceNotifications(DatagramProtocol):
             loop = asyncio.get_event_loop()
 
         _LOGGER.debug('Creating UDP endpoint for %s:%s',
-                      self._notifications_host,
-                      self._notifications_port)
+                      self._notifications_local_host,
+                      self._notifications_local_port)
         (self._notification_transport,
          _protocol) = await loop.create_datagram_endpoint(
             lambda: self,
             local_addr=(
-                self._notifications_host, self._notifications_port
+                self._notifications_local_host, self._notifications_local_port
             ))
 
     @property
@@ -328,3 +365,17 @@ class G90DeviceNotifications(DatagramProtocol):
             _LOGGER.debug('No longer listening for device notifications')
             self._notification_transport.close()
             self._notification_transport = None
+
+    @property
+    def device_id(self) -> Optional[str]:
+        """
+        The ID (GUID) of the panel being communicated with thru commands.
+
+        Available when any panel command receives it from the device
+        (:meth:`G90Alarm.get_host_info` currently).
+        """
+        return self._device_id
+
+    @device_id.setter
+    def device_id(self, device_id: str) -> None:
+        self._device_id = device_id

pyg90alarm/history.py

@@ -21,6 +21,8 @@
 """
 History protocol entity.
 """
+import logging
+
 from typing import Any, Optional, Dict
 from dataclasses import dataclass
 from datetime import datetime, timezone
@@ -33,12 +35,13 @@ from .const import (
 )
 from .device_notifications import G90DeviceAlert
 
+_LOGGER = logging.getLogger(__name__)
+
 
 # The state of the incoming history entries are mixed of `G90AlertStates` and
-# `G90AlertStateChangeTypes`, depending on entry type - the mapping
-# consilidates them into unified `G90HistoryStates`. The latter enum can't be
-# just an union of former two, since those have conflicting values
-states_mapping = {
+# `G90AlertStateChangeTypes`, depending on entry type - hence two separate
+# dictionaries, since enums used for keys have conflicting values
+states_mapping_alerts = {
     G90AlertStates.DOOR_CLOSE:
         G90HistoryStates.DOOR_CLOSE,
     G90AlertStates.DOOR_OPEN:
@@ -47,6 +50,9 @@ states_mapping = {
         G90HistoryStates.TAMPER,
     G90AlertStates.LOW_BATTERY:
         G90HistoryStates.LOW_BATTERY,
+}
+
+states_mapping_state_changes = {
     G90AlertStateChangeTypes.AC_POWER_FAILURE:
         G90HistoryStates.AC_POWER_FAILURE,
     G90AlertStateChangeTypes.AC_POWER_RECOVER:
@@ -87,6 +93,7 @@ class G90History:
     Represents a history entry from the alarm panel.
     """
     def __init__(self, *args: Any, **kwargs: Any):
+        self._raw_data = args
         self._protocol_data = ProtocolData(*args, **kwargs)
 
     @property
@@ -99,55 +106,79 @@ class G90History:
         )
 
     @property
-    def type(self) -> G90AlertTypes:
+    def type(self) -> Optional[G90AlertTypes]:
         """
         Type of the history entry.
         """
-        return G90AlertTypes(self._protocol_data.type)
+        try:
+            return G90AlertTypes(self._protocol_data.type)
+        except ValueError:
+            _LOGGER.warning(
+                "Can't interpret '%s' as alert type (decoded protocol"
+                " data '%s', raw data '%s')",
+                self._protocol_data.type, self._protocol_data, self._raw_data
+            )
+            return None
 
     @property
-    def state(self) -> G90HistoryStates:
+    def state(self) -> Optional[G90HistoryStates]:
         """
         State for the history entry.
         """
-        # Door open/close type, mapped against `G90AlertStates` using `state`
-        # incoming field
-        if self.type == G90AlertTypes.DOOR_OPEN_CLOSE:
-            return G90HistoryStates(
-                states_mapping[G90AlertStates(self._protocol_data.state)]
+        try:
+            # Door open/close or alert types, mapped against `G90AlertStates`
+            # using `state` incoming field
+            if self.type in [
+                G90AlertTypes.DOOR_OPEN_CLOSE, G90AlertTypes.ALARM
+            ]:
+                return G90HistoryStates(
+                    states_mapping_alerts[
+                        G90AlertStates(self._protocol_data.state)
+                    ]
+                )
+        except ValueError:
+            _LOGGER.warning(
+                "Can't interpret '%s' as alert state (decoded protocol"
+                " data '%s', raw data '%s')",
+                self._protocol_data.state, self._protocol_data, self._raw_data
             )
+            return None
 
-        # Device state change, mapped against `G90AlertStateChangeTypes` using
-        # `event_id` incoming field
-        if self.type == G90AlertTypes.STATE_CHANGE:
+        try:
+            # Other types are mapped against `G90AlertStateChangeTypes`
             return G90HistoryStates(
-                states_mapping[
+                states_mapping_state_changes[
                     G90AlertStateChangeTypes(self._protocol_data.event_id)
                 ]
             )
-
-        # Alarm gets mapped to its counterpart in `G90HistoryStates`
-        if self.type == G90AlertTypes.ALARM:
-            return G90HistoryStates.ALARM
-
-        # Other types are mapped against `G90AlertStateChangeTypes`
-        return G90HistoryStates(
-            states_mapping[
-                G90AlertStateChangeTypes(self._protocol_data.event_id)
-            ]
-        )
+        except ValueError:
+            _LOGGER.warning(
+                "Can't interpret '%s' as state change (decoded protocol"
+                " data '%s', raw data '%s')",
+                self._protocol_data.event_id, self._protocol_data,
+                self._raw_data
+            )
+            return None
 
     @property
-    def source(self) -> G90AlertSources:
+    def source(self) -> Optional[G90AlertSources]:
         """
         Source of the history entry.
         """
-        # Device state changes or open/close events are mapped against
-        # `G90AlertSources` using `source` incoming field
-        if self.type in [
-            G90AlertTypes.STATE_CHANGE, G90AlertTypes.DOOR_OPEN_CLOSE
-        ]:
-            return G90AlertSources(self._protocol_data.source)
+        try:
+            # Device state changes or open/close events are mapped against
+            # `G90AlertSources` using `source` incoming field
+            if self.type in [
+                G90AlertTypes.STATE_CHANGE, G90AlertTypes.DOOR_OPEN_CLOSE
+            ]:
+                return G90AlertSources(self._protocol_data.source)
+        except ValueError:
+            _LOGGER.warning(
+                "Can't interpret '%s' as alert source (decoded protocol"
+                " data '%s', raw data '%s')",
+                self._protocol_data.source, self._protocol_data, self._raw_data
+            )
+            return None
 
         # Alarm will have `SENSOR` as the source, since that is likely what
         # triggered it
@@ -182,6 +213,7 @@ class G90History:
         Returns the history entry represented as device alert structure,
         suitable for :meth:`G90DeviceNotifications._handle_alert`.
         """
+
         return G90DeviceAlert(
             type=self._protocol_data.type,
             event_id=self._protocol_data.event_id,

pyg90alarm/targeted_discovery.py

@@ -103,7 +103,12 @@ class G90TargetedDiscovery(G90BaseCommand):
         """
         try:
             _LOGGER.debug('Received from %s:%s: %s', addr[0], addr[1], data)
-            decoded = data.decode('utf-8', errors='ignore')
+            try:
+                decoded = data.decode('utf-8')
+            except UnicodeDecodeError as exc:
+                raise G90Error(
+                    'Unable to decode discovery response from UTF-8'
+                ) from exc
             if not decoded.endswith('\0'):
                 raise G90Error('Invalid discovery response')
             host_info = G90TargetedDiscoveryInfo(*decoded[:-1].split(','))

{pyg90alarm-1.15.1.dist-info → pyg90alarm-1.16.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyg90alarm
-Version: 1.15.1
+Version: 1.16.1
 Summary: G90 Alarm system protocol
 Home-page: https://github.com/hostcc/pyg90alarm
 Author: Ilia Sotnikov
@@ -20,18 +20,19 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.8, <4
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Provides-Extra: dev
 Requires-Dist: check-manifest; extra == "dev"
-Provides-Extra: docs
-Requires-Dist: sphinx; extra == "docs"
-Requires-Dist: sphinx-rtd-theme; extra == "docs"
 Provides-Extra: test
 Requires-Dist: coverage; extra == "test"
 Requires-Dist: asynctest; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
 
 .. image::  https://github.com/hostcc/pyg90alarm/actions/workflows/main.yml/badge.svg?branch=master
    :target: https://github.com/hostcc/pyg90alarm/tree/master

{pyg90alarm-1.15.1.dist-info → pyg90alarm-1.16.1.dist-info}/RECORD

@@ -1,27 +1,27 @@
 pyg90alarm/__init__.py,sha256=5AITRm5jZSzuQaL7PS8fZZMZb4-IuGRhSqyAdfTt0Cs,2236
-pyg90alarm/alarm.py,sha256=9SqJHGK6wawFUZSaRo6-GkLBz_SxONNgCwGeD38MsSU,32211
-pyg90alarm/base_cmd.py,sha256=wu2v_RKpcPHxUW4HBDLWcUFMzPsGooY4o2Rc0LgcanU,9754
+pyg90alarm/alarm.py,sha256=VssyGxYXb-r-fb8TdN2NfLaIPr1Zq8ogdGUV521bjsQ,32414
+pyg90alarm/base_cmd.py,sha256=Bz7yoZ0RpkcjWARya664DKAPo3goD6BeaKtuW-hA804,9902
 pyg90alarm/callback.py,sha256=3JsD_JChmZD24OyjaCP-PxxuBDBX7myGYhkM4RN7bk4,3742
 pyg90alarm/config.py,sha256=2YtIgdT7clQXmYvkdn_fhIdS05CY8E1Yc90R8_tAmRI,1961
-pyg90alarm/const.py,sha256=4eJyEZpUE5XZkNL1sePKnuPloIvcjKIAJJ4g2e1cXVA,6054
-pyg90alarm/device_notifications.py,sha256=I5K8IsyYTe0XDJT8XiQoC8a2xY1XLjaGx4QFrEsaixg,11135
+pyg90alarm/const.py,sha256=uq4-vQvbhCkddQKO8C38tQzkjHm-l-TacxNlLdhQZyg,6237
+pyg90alarm/device_notifications.py,sha256=QFs4FiaPkSKoQ_geU3Pngj9iPMHMHwi9Mjpzs8asDrM,13382
 pyg90alarm/discovery.py,sha256=fwyBHDCKGej06OwhpbVCHYTRU9WWkeYysAFgv3FiwqI,3575
 pyg90alarm/exceptions.py,sha256=eiOcRe7D18EIPyPFDNU9DdFgbnkwPmkiLl8lGPOhBNw,1475
-pyg90alarm/history.py,sha256=GnCVRsQNV2x9g6KngBBvvIUnTAIyXKX2nVKF_aFA0oM,7160
+pyg90alarm/history.py,sha256=M70BCl7ykX3FFPY1htZofreYWUCviePRB2CIKVgL-ZI,8188
 pyg90alarm/host_info.py,sha256=4lFIaFEpYd3EvgNrDJmKijTrzX9i29nFISLLlXGnkmE,2759
 pyg90alarm/host_status.py,sha256=4XhuilBzB8XsXkpeWj3PAVpmDPcTnBBOYunO21Flabo,1862
 pyg90alarm/paginated_cmd.py,sha256=vJ8slMS7aNLpkAxnIe25EHstusYy1bYTl1j306ps-MQ,4439
 pyg90alarm/paginated_result.py,sha256=Zs_yB9UW6VlHRBPIzOwHy8ZJ0FqCUPMB-rmfPG2BdnU,5447
 pyg90alarm/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pyg90alarm/targeted_discovery.py,sha256=zD-oW8u75H39sBanKX_Cjwz3_z_n__TC20doSctmy-g,5336
+pyg90alarm/targeted_discovery.py,sha256=h0SijMpPQ12iBZtfh4xsaP_HIbiQRNBnXsd0-K9rjHA,5514
 pyg90alarm/user_data_crc.py,sha256=JQBOPY3RlOgVtvR55R-rM8OuKjYW-BPXQ0W4pi6CEH0,1689
 pyg90alarm/definitions/__init__.py,sha256=s0NZnkW_gMH718DJbgez28z9WA231CyszUf1O_ojUiI,68
 pyg90alarm/definitions/sensors.py,sha256=rKOu21ZpI44xk6aMh_vBjniFqnsNTc1CKwAvnv4PYLQ,19904
 pyg90alarm/entities/__init__.py,sha256=hHb6AOiC4Tz--rOWiiICMdLaZDs1Tf_xpWk_HeS_gO4,66
 pyg90alarm/entities/device.py,sha256=f_LHvKCAqTEebZ4mrRh3CpPUI7o-OvpvOfyTRCbftJs,2818
 pyg90alarm/entities/sensor.py,sha256=4r8ouAYTZB8ih8I4ncWdQOaifYsRxaC-ukY9jvnrRvk,16139
-pyg90alarm-1.15.1.dist-info/LICENSE,sha256=f884inRbeNv-O-hbwz62Ro_1J8xiHRTnJ2cCx6A0WvU,1070
-pyg90alarm-1.15.1.dist-info/METADATA,sha256=csITqi1utrvJOAqm0PtFGz9UIeDZzTX7JBWJRBjjIzY,7663
-pyg90alarm-1.15.1.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
-pyg90alarm-1.15.1.dist-info/top_level.txt,sha256=czHiGxYMyTk5QEDTDb0EpPiKqUMRa8zI4zx58Ii409M,11
-pyg90alarm-1.15.1.dist-info/RECORD,,
+pyg90alarm-1.16.1.dist-info/LICENSE,sha256=f884inRbeNv-O-hbwz62Ro_1J8xiHRTnJ2cCx6A0WvU,1070
+pyg90alarm-1.16.1.dist-info/METADATA,sha256=iOhBwSXDDvBDAGAWHJvwygQBm2GiWUQ5sfzNzwx4x_g,7714
+pyg90alarm-1.16.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+pyg90alarm-1.16.1.dist-info/top_level.txt,sha256=czHiGxYMyTk5QEDTDb0EpPiKqUMRa8zI4zx58Ii409M,11
+pyg90alarm-1.16.1.dist-info/RECORD,,

{pyg90alarm-1.15.1.dist-info → pyg90alarm-1.16.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (74.0.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: true
 Tag: py3-none-any