pyg90alarm 1.10.1__py3-none-any.whl → 1.12.0__py3-none-any.whl

pyg90alarm/history.py

@@ -22,35 +22,197 @@
 History protocol entity.
 """
 
-import time
+from datetime import datetime, timezone
 from collections import namedtuple
+from .const import (
+    G90AlertTypes,
+    G90AlertSources,
+    G90AlertStates,
+    G90AlertStateChangeTypes,
+    G90HistoryStates,
+)
+from .device_notifications import G90DeviceAlert
+
+
+# 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 = {
+    G90AlertStates.DOOR_CLOSE:
+        G90HistoryStates.DOOR_CLOSE,
+    G90AlertStates.DOOR_OPEN:
+        G90HistoryStates.DOOR_OPEN,
+    G90AlertStates.TAMPER:
+        G90HistoryStates.TAMPER,
+    G90AlertStates.LOW_BATTERY:
+        G90HistoryStates.LOW_BATTERY,
+    G90AlertStateChangeTypes.AC_POWER_FAILURE:
+        G90HistoryStates.AC_POWER_FAILURE,
+    G90AlertStateChangeTypes.AC_POWER_RECOVER:
+        G90HistoryStates.AC_POWER_RECOVER,
+    G90AlertStateChangeTypes.DISARM:
+        G90HistoryStates.DISARM,
+    G90AlertStateChangeTypes.ARM_AWAY:
+        G90HistoryStates.ARM_AWAY,
+    G90AlertStateChangeTypes.ARM_HOME:
+        G90HistoryStates.ARM_HOME,
+    G90AlertStateChangeTypes.LOW_BATTERY:
+        G90HistoryStates.LOW_BATTERY,
+    G90AlertStateChangeTypes.WIFI_CONNECTED:
+        G90HistoryStates.WIFI_CONNECTED,
+    G90AlertStateChangeTypes.WIFI_DISCONNECTED:
+        G90HistoryStates.WIFI_DISCONNECTED,
+}
 
 INCOMING_FIELDS = [
-    'log_type',  # (1 or 3 - alarm, 2 or 4 - notification)
-    'param1',    # (type 1: 1 - SOS, 2 - tamper alarm; type 3 - device ID; type
-                 #  2 - 5 stayarm, 3 - disarm, 4 - awayarm )
-    'param2',    # (type 3: device type)
-    'param3',
+    'type',
+    'event_id',
+    'source',
+    'state',
     'sensor_name',
     'unix_time',
-    'rest',
+    'other',
 ]
+# Class representing the data incoming from the device
+ProtocolData = namedtuple('ProtocolData', INCOMING_FIELDS)
 
 
-class G90History(namedtuple('G90History', INCOMING_FIELDS)):
+class G90History:
     """
     tbd
     """
+    def __init__(self, *args, **kwargs):
+        self._protocol_data = ProtocolData(*args, **kwargs)
 
     @property
     def datetime(self):
         """
-        tbd
+        Date/time of the history entry.
+
+        :rtype: :class:`datetime.datetime`
+        """
+        return datetime.fromtimestamp(
+            self._protocol_data.unix_time, tz=timezone.utc
+        )
+
+    @property
+    def type(self):
+        """
+        Type of the history entry.
+
+        :rtype: :class:`.G90AlertTypes`
+        """
+        return G90AlertTypes(self._protocol_data.type)
+
+    @property
+    def state(self):
+        """
+        State for the history entry.
+
+        :rtype: :class:`.G90HistoryStates`
+        """
+        # 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)]
+            )
+
+        # Device state change, mapped against `G90AlertStateChangeTypes` using
+        # `event_id` incoming field
+        if self.type == G90AlertTypes.STATE_CHANGE:
+            return G90HistoryStates(
+                states_mapping[
+                    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)
+            ]
+        )
+
+    @property
+    def source(self):
         """
-        return time.ctime(self.unix_time)
+        Source of the history entry.
+
+        :rtype: :class:`.G90AlertSources`
+        """
+        # 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)
+
+        # Alarm will have `SENSOR` as the source, since that is likely what
+        # triggered it
+        if self.type == G90AlertTypes.ALARM:
+            return G90AlertSources.SENSOR
+
+        # Other sources are assumed to be initiated by device itself
+        return G90AlertSources.DEVICE
+
+    @property
+    def sensor_name(self):
+        """
+        Name of the sensor related to the history entry, might be empty if none
+        associated.
+
+        :rtype: str|None
+        """
+        return self._protocol_data.sensor_name or None
+
+    @property
+    def sensor_idx(self):
+        """
+        ID of the sensor related to the history entry, might be empty if none
+        associated.
+
+        :rtype: str|None
+        """
+        # Sensor ID will only be available if entry source is a sensor
+        if self.source == G90AlertSources.SENSOR:
+            return self._protocol_data.event_id
+
+        return None
+
+    def as_device_alert(self):
+        """
+        Returns the history entry represented as device alert structure,
+        suitable for :meth:`G90DeviceNotifications._handle_alert`.
+
+        :rtype: :class:`.G90DeviceAlert`
+        """
+        return G90DeviceAlert(
+            type=self._protocol_data.type,
+            event_id=self._protocol_data.event_id,
+            source=self._protocol_data.source,
+            state=self._protocol_data.state,
+            zone_name=self._protocol_data.sensor_name,
+            device_id=None,
+            unix_time=self._protocol_data.unix_time,
+            resv4=None,
+            other=self._protocol_data.other
+        )
 
     def __repr__(self):
         """
-        tbd
+        Textural representation of the history entry.
+
+        :rtype: str
         """
-        return super().__repr__() + f'(datetime={str(self.datetime)})'
+        return f'type={repr(self.type)}' \
+            + f' source={repr(self.source)}' \
+            + f' state={repr(self.state)}' \
+            + f' sensor_name={self.sensor_name}' \
+            + f' sensor_idx={self.sensor_idx}' \
+            + f' datetime={repr(self.datetime)}'

pyg90alarm/targeted_discovery.py

@@ -55,29 +55,21 @@ class G90TargetedDiscoveryInfo(namedtuple('G90TargetedDiscoveryInfo',
     """
 
 
-class G90TargetedDiscoveryProtocol:
+class G90TargetedDiscovery(G90Discovery):
     """
     tbd
-
-    :meta private:
     """
-    def __init__(self, device_id, parent):
-        """
-        tbd
-        """
-        self._parent = parent
-        self._device_id = device_id
 
-    def connection_made(self, transport):
-        """
-        tbd
-        """
-
-    def connection_lost(self, exc):
+    # pylint: disable=too-few-public-methods
+    def __init__(self, device_id, **kwargs):
         """
         tbd
         """
+        super().__init__(**kwargs)
+        self._device_id = device_id
 
+    # Implementation of datagram protocol,
+    # https://docs.python.org/3/library/asyncio-protocol.html#datagram-protocols
     def datagram_received(self, data, addr):
         """
         tbd
@@ -95,39 +87,12 @@ class G90TargetedDiscoveryProtocol:
                    'port': addr[1]}
             res.update(host_info._asdict())
             _LOGGER.debug('Discovered device: %s', res)
-            self._parent.add_device(res)
+            self.add_device(res)
         except Exception as exc:  # pylint: disable=broad-except
             _LOGGER.warning('Got exception, ignoring: %s', exc)
 
-    def error_received(self, exc):
-        """
-        tbd
-        """
-
-
-class G90TargetedDiscovery(G90Discovery):
-    """
-    tbd
-    """
-
-    # pylint: disable=too-few-public-methods
-    def __init__(self, device_id, **kwargs):
-        """
-        tbd
-        """
-
-        super().__init__(**kwargs)
-        self._device_id = device_id
-
     def to_wire(self):
         """
         tbd
         """
         return bytes(f'IWTAC_PROBE_DEVICE,{self._device_id}\0', 'ascii')
-
-    def _proto_factory(self):
-        """
-        tbd
-        """
-        return G90TargetedDiscoveryProtocol(self._device_id,
-                                            self)

{pyg90alarm-1.10.1.dist-info → pyg90alarm-1.12.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyg90alarm
-Version: 1.10.1
+Version: 1.12.0
 Summary: G90 Alarm system protocol
 Home-page: https://github.com/hostcc/pyg90alarm
 Author: Ilia Sotnikov
@@ -24,13 +24,13 @@ Requires-Python: >=3.7, <4
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Provides-Extra: dev
-Requires-Dist: check-manifest ; extra == 'dev'
+Requires-Dist: check-manifest; extra == "dev"
 Provides-Extra: docs
-Requires-Dist: sphinx ; extra == 'docs'
-Requires-Dist: sphinx-rtd-theme ; 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'
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: asynctest; extra == "test"
 
 .. image::  https://github.com/hostcc/pyg90alarm/actions/workflows/main.yml/badge.svg?branch=master
    :target: https://github.com/hostcc/pyg90alarm/tree/master
@@ -158,6 +158,13 @@ set the IP address allocation up.
    status will not be reflected and those will always be reported as inactive,
    since there is no way to read their state in a polled manner.
 
+   To work that limitation around the package now supports simulating device
+   notifications from periodically polling the history it records - the
+   simulation works only for the alerts, not notifications (e.g. notifications
+   include low battery events and alike). This also requires the particular
+   alert to be enabled in the mobile application, otherwise it won't be
+   recorded in the history.
+
 Quick start
 ===========
 

pyg90alarm-1.12.0.dist-info/RECORD

@@ -0,0 +1,26 @@
+pyg90alarm/__init__.py,sha256=zidYApReScSFZCpC9Tk7pdsBNPMql6XiUtt-O7l3D5M,1381
+pyg90alarm/alarm.py,sha256=IsNpnPyBh90lTP9L03R1GJ608Ld6ZgUsJ7D5nS3WpCk,29157
+pyg90alarm/base_cmd.py,sha256=rjpjIzEgtI5mUvmurBasrt9psYKdbIEsivnx8QboivY,8561
+pyg90alarm/callback.py,sha256=zg698TCjjYhjAMk770J9CZp8-dDbX0Zj5wtoC6axq6w,4033
+pyg90alarm/config.py,sha256=FiYjiz_WrDH2OEqHyUJXZDDK7v1fLAUpZcQ3JRMmmX0,1974
+pyg90alarm/const.py,sha256=XP_x5w6quiKQceOJDpExXI86L5KbQLdTed4lbjlNth0,5760
+pyg90alarm/device_notifications.py,sha256=JLdOIIwyoxQdqvIjuLj6_5Rz_W6slYeM8HBPzPIa1ew,10628
+pyg90alarm/discovery.py,sha256=sPk2mRhc0IgpOIlC9kRlKCnlAfdXsT7TyWfHAc1bfqQ,3077
+pyg90alarm/exceptions.py,sha256=eiOcRe7D18EIPyPFDNU9DdFgbnkwPmkiLl8lGPOhBNw,1475
+pyg90alarm/history.py,sha256=Ln3-v8hvagIXTmj_2iURE3oOsVLeQb8OMczUy-SKSRs,7039
+pyg90alarm/host_info.py,sha256=fGGI2ZH6GVD0WhYT72rIELTbiIAmmPiT31eZkyVugwY,2571
+pyg90alarm/host_status.py,sha256=PEPgpkfGNkUzKUgRpfPKldz5qq3_9lqBwX86Ld613vk,1406
+pyg90alarm/paginated_cmd.py,sha256=7pXLAgFQHheByBpwRV-I1yEdZnm8hk6j2OMPZ_Wn-vE,3768
+pyg90alarm/paginated_result.py,sha256=xweFfPLn1a2yYm5h0AxGoDCyDIoy0JkUC_tI80vsrLc,5246
+pyg90alarm/targeted_discovery.py,sha256=DPxNvs8qJfyIOq6KLBYBpqkHPCpHbMW70_gfNyvNAoY,3221
+pyg90alarm/user_data_crc.py,sha256=RsQlbuXC4baD88hX4y0XdysmxEMtQkqkNVX_FhTLSmw,1467
+pyg90alarm/definitions/__init__.py,sha256=s0NZnkW_gMH718DJbgez28z9WA231CyszUf1O_ojUiI,68
+pyg90alarm/definitions/sensors.py,sha256=2Liap0stTT5qNmvsbP_7UscA21IYXQcSAKQLLm7YfHQ,19921
+pyg90alarm/entities/__init__.py,sha256=hHb6AOiC4Tz--rOWiiICMdLaZDs1Tf_xpWk_HeS_gO4,66
+pyg90alarm/entities/device.py,sha256=QbsQyIq2wFLjIH389zyD3d0CyME_rpG_ciD3srAdqXQ,2772
+pyg90alarm/entities/sensor.py,sha256=AkVj_qrK35K5SwSlAHXU9UXdBKVaJzV4TBcoeZUevn4,13942
+pyg90alarm-1.12.0.dist-info/LICENSE,sha256=f884inRbeNv-O-hbwz62Ro_1J8xiHRTnJ2cCx6A0WvU,1070
+pyg90alarm-1.12.0.dist-info/METADATA,sha256=8zrPZpzJVGK7UZ-It72WrJEpQst6S5BWVGjatOaLr_M,7611
+pyg90alarm-1.12.0.dist-info/WHEEL,sha256=HiCZjzuy6Dw0hdX5R3LCFPDmFS4BWl8H-8W39XfmgX4,91
+pyg90alarm-1.12.0.dist-info/top_level.txt,sha256=czHiGxYMyTk5QEDTDb0EpPiKqUMRa8zI4zx58Ii409M,11
+pyg90alarm-1.12.0.dist-info/RECORD,,

{pyg90alarm-1.10.1.dist-info → pyg90alarm-1.12.0.dist-info}/WHEEL

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

pyg90alarm-1.10.1.dist-info/RECORD

@@ -1,26 +0,0 @@
-pyg90alarm/__init__.py,sha256=zidYApReScSFZCpC9Tk7pdsBNPMql6XiUtt-O7l3D5M,1381
-pyg90alarm/alarm.py,sha256=0SMGPe9J1550j_Yq-KxoFlKPjzVIZ5Z-RhsjUusUS9U,23528
-pyg90alarm/base_cmd.py,sha256=xuW-jjuScag1kAVPKNa2GUmL99UYeyu2n-C9ppLmOMo,8768
-pyg90alarm/callback.py,sha256=zg698TCjjYhjAMk770J9CZp8-dDbX0Zj5wtoC6axq6w,4033
-pyg90alarm/config.py,sha256=FiYjiz_WrDH2OEqHyUJXZDDK7v1fLAUpZcQ3JRMmmX0,1974
-pyg90alarm/const.py,sha256=nhqrP9GqsU4VeEYHSW4NJTh6QO20L7uDea2reqDnqO4,5226
-pyg90alarm/device_notifications.py,sha256=wxDf0m_LOt6Sj_jG8cfTFZM3LNry2xrPwkFPa4lVscI,9315
-pyg90alarm/discovery.py,sha256=07TZIIGgPsRcW_iYpS-82lG18rotuykYqfGV-cE2eHc,3474
-pyg90alarm/exceptions.py,sha256=eiOcRe7D18EIPyPFDNU9DdFgbnkwPmkiLl8lGPOhBNw,1475
-pyg90alarm/history.py,sha256=E8c8ucy5cscPSawIz4nXxV4HKdyhsoJda4Akvvt3k6I,1836
-pyg90alarm/host_info.py,sha256=fGGI2ZH6GVD0WhYT72rIELTbiIAmmPiT31eZkyVugwY,2571
-pyg90alarm/host_status.py,sha256=PEPgpkfGNkUzKUgRpfPKldz5qq3_9lqBwX86Ld613vk,1406
-pyg90alarm/paginated_cmd.py,sha256=7pXLAgFQHheByBpwRV-I1yEdZnm8hk6j2OMPZ_Wn-vE,3768
-pyg90alarm/paginated_result.py,sha256=xweFfPLn1a2yYm5h0AxGoDCyDIoy0JkUC_tI80vsrLc,5246
-pyg90alarm/targeted_discovery.py,sha256=_SR_pBZxDkLNL5WA8LfGboQw2AH09G65ASn9EEtxlDs,3735
-pyg90alarm/user_data_crc.py,sha256=RsQlbuXC4baD88hX4y0XdysmxEMtQkqkNVX_FhTLSmw,1467
-pyg90alarm/definitions/__init__.py,sha256=s0NZnkW_gMH718DJbgez28z9WA231CyszUf1O_ojUiI,68
-pyg90alarm/definitions/sensors.py,sha256=htarrXk46u9RwFR_JLdsLJiZi0ilQSZdfWaCc5TydEQ,14697
-pyg90alarm/entities/__init__.py,sha256=hHb6AOiC4Tz--rOWiiICMdLaZDs1Tf_xpWk_HeS_gO4,66
-pyg90alarm/entities/device.py,sha256=QbsQyIq2wFLjIH389zyD3d0CyME_rpG_ciD3srAdqXQ,2772
-pyg90alarm/entities/sensor.py,sha256=2d_671Kefx7wM6mWRQR79XyScEkkp3bk7HsA1Qnx75I,13354
-pyg90alarm-1.10.1.dist-info/LICENSE,sha256=f884inRbeNv-O-hbwz62Ro_1J8xiHRTnJ2cCx6A0WvU,1070
-pyg90alarm-1.10.1.dist-info/METADATA,sha256=llXidozyi21SpryQm0IGdu42QjUNNQIKX5NTHF-qU_8,7211
-pyg90alarm-1.10.1.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-pyg90alarm-1.10.1.dist-info/top_level.txt,sha256=czHiGxYMyTk5QEDTDb0EpPiKqUMRa8zI4zx58Ii409M,11
-pyg90alarm-1.10.1.dist-info/RECORD,,