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

pyg90alarm/definitions/sensors.py

@@ -475,6 +475,16 @@ SENSOR_DEFINITIONS = [
         rwMode=SensorRwMode.READ,
         matchMode=SensorMatchMode.ONLY20BITS
     ),
+    # Door Sensor WRDS01
+    SensorDefinition(
+        type=1,
+        subtype=3,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
     # Door Sensor
     SensorDefinition(
         type=1,
@@ -485,6 +495,96 @@ SENSOR_DEFINITIONS = [
         rwMode=SensorRwMode.READ,
         matchMode=SensorMatchMode.ONLY16BITS
     ),
+    # Glass Break Sensor BLPS
+    SensorDefinition(
+        type=2,
+        subtype=0,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # Gas Detector WGD01
+    SensorDefinition(
+        type=3,
+        subtype=0,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # Smoke Detector WSD02
+    SensorDefinition(
+        type=4,
+        subtype=0,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # Smoke Detector WSD04
+    SensorDefinition(
+        type=4,
+        subtype=1,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # Panic Button WEB01
+    SensorDefinition(
+        type=5,
+        subtype=1,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # Panic Button WEB03
+    SensorDefinition(
+        type=5,
+        subtype=0,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # Shock Sensor WSS01
+    SensorDefinition(
+        type=6,
+        subtype=0,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # Water Detector LSTC02
+    SensorDefinition(
+        type=7,
+        subtype=1,
+        rx=0,
+        tx=0,
+        private_data='',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # Water Detector LSTC01
+    SensorDefinition(
+        type=7,
+        subtype=0,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
     # PIR motion sensor WMS08
     SensorDefinition(
         type=8,
@@ -505,6 +605,66 @@ SENSOR_DEFINITIONS = [
         rwMode=SensorRwMode.READ,
         matchMode=SensorMatchMode.ONLY20BITS
     ),
+    # PIR motion sensor ODPIR
+    SensorDefinition(
+        type=8,
+        subtype=0,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # PIR motion sensor N650
+    SensorDefinition(
+        type=8,
+        subtype=5,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # PIR motion sensor WPD02
+    SensorDefinition(
+        type=8,
+        subtype=6,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # PIR motion sensor WCMS02
+    SensorDefinition(
+        type=8,
+        subtype=8,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # PIR motion sensor CWMS01
+    SensorDefinition(
+        type=8,
+        subtype=9,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # PIR motion sensor WMS04
+    SensorDefinition(
+        type=8,
+        subtype=11,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
     # PIR motion sensor WMS07
     SensorDefinition(
         type=8,
@@ -515,6 +675,66 @@ SENSOR_DEFINITIONS = [
         rwMode=SensorRwMode.READ,
         matchMode=SensorMatchMode.ONLY20BITS
     ),
+    # PIR motion sensor ODPIR03
+    SensorDefinition(
+        type=8,
+        subtype=4,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # PIR motion sensor WPD01
+    SensorDefinition(
+        type=8,
+        subtype=7,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # PIR motion sensor PIR Ceiling
+    SensorDefinition(
+        type=8,
+        subtype=1,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # Beams ABT
+    SensorDefinition(
+        type=9,
+        subtype=0,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # Beams ABE
+    SensorDefinition(
+        type=9,
+        subtype=1,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # Beams ABH
+    SensorDefinition(
+        type=9,
+        subtype=2,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
     # Remote RMC08
     SensorDefinition(
         type=10,
@@ -565,6 +785,16 @@ SENSOR_DEFINITIONS = [
         rwMode=SensorRwMode.READ,
         matchMode=SensorMatchMode.ONLY20BITS
     ),
+    # Door Bell WDB
+    SensorDefinition(
+        type=12,
+        subtype=1,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
     # TouchID Detector
     SensorDefinition(
         type=13,
@@ -595,7 +825,17 @@ SENSOR_DEFINITIONS = [
         rwMode=SensorRwMode.READ,
         matchMode=SensorMatchMode.ONLY16BITS
     ),
-    # Gas Detector WGD02
+    # Sub Host SS08S
+    SensorDefinition(
+        type=16,
+        subtype=0,
+        rx=0,
+        tx=0,
+        private_data='00',
+        rwMode=SensorRwMode.READ,
+        matchMode=SensorMatchMode.ALL
+    ),
+    # Gas Valve Detector WGD02
     SensorDefinition(
         type=18,
         subtype=0,

pyg90alarm/device_notifications.py

@@ -21,7 +21,6 @@
 """
 Implements support for notifications/alerts sent by G90 alarm panel.
 """
-
 import json
 import logging
 from collections import namedtuple
@@ -34,6 +33,7 @@ from .const import (
     G90AlertStateChangeTypes,
     G90ArmDisarmTypes,
     G90AlertSources,
+    G90AlertStates,
 )
 
 
@@ -43,7 +43,7 @@ _LOGGER = logging.getLogger(__name__)
 class G90Message(namedtuple('G90Message',
                             ['code', 'data'])):
     """
-    tbd
+    Represents the message received from the device.
 
     :meta private:
     """
@@ -52,7 +52,7 @@ class G90Message(namedtuple('G90Message',
 class G90Notification(namedtuple('G90Notification',
                                  ['kind', 'data'])):
     """
-    tbd
+    Represents the notification received from the device.
 
     :meta private:
     """
@@ -61,7 +61,7 @@ class G90Notification(namedtuple('G90Notification',
 class G90ZoneInfo(namedtuple('G90ZoneInfo',
                              ['idx', 'name'])):
     """
-    tbd
+    Represents zone details received from the device.
 
     :meta private:
     """
@@ -70,7 +70,7 @@ class G90ZoneInfo(namedtuple('G90ZoneInfo',
 class G90ArmDisarmInfo(namedtuple('G90ArmDisarmInfo',
                                   ['state'])):
     """
-    tbd
+    Represents the arm/disarm state received from the device.
 
     :meta private:
     """
@@ -81,46 +81,31 @@ class G90DeviceAlert(namedtuple('G90DeviceAlert',
                                  'zone_name', 'device_id', 'unix_time',
                                  'resv4', 'other'])):
     """
-    tbd
+    Represents alert received from the device.
 
     :meta private:
     """
 
 
-class G90DeviceNotificationProtocol:
+class G90DeviceNotifications:
     """
     tbd
-
-    :meta private:
     """
-    def __init__(self, armdisarm_cb=None, sensor_cb=None,
-                 door_open_close_cb=None, alarm_cb=None):
-        """
-        tbd
-        """
-        self._armdisarm_cb = armdisarm_cb
-        self._sensor_cb = sensor_cb
-        self._door_open_close_cb = door_open_close_cb
-        self._alarm_cb = alarm_cb
-
-    def connection_made(self, transport):
-        """
-        tbd
-        """
-
-    def connection_lost(self, exc):
-        """
-        tbd
-        """
+    def __init__(self, port, host):
+        # pylint: disable=too-many-arguments
+        self._notification_transport = None
+        self._notifications_host = host
+        self._notifications_port = port
 
     def _handle_notification(self, addr, notification):
         # Sensor activity notification
         if notification.kind == G90NotificationTypes.SENSOR_ACTIVITY:
             g90_zone_info = G90ZoneInfo(*notification.data)
             _LOGGER.debug('Sensor notification: %s', g90_zone_info)
-            G90Callback.invoke(self._sensor_cb,
-                               g90_zone_info.idx,
-                               g90_zone_info.name)
+            G90Callback.invoke(
+                self.on_sensor_activity,
+                g90_zone_info.idx, g90_zone_info.name
+            )
             return
 
         # Arm/disarm notification
@@ -131,8 +116,7 @@ class G90DeviceNotificationProtocol:
             state = G90ArmDisarmTypes(g90_armdisarm_info.state)
             _LOGGER.debug('Arm/disarm notification: %s',
                           state)
-            G90Callback.invoke(self._armdisarm_cb,
-                               state)
+            G90Callback.invoke(self.on_armdisarm, state)
             return
 
         _LOGGER.warning('Unknown notification received from %s:%s:'
@@ -141,14 +125,30 @@ class G90DeviceNotificationProtocol:
 
     def _handle_alert(self, addr, alert):
         if alert.type == G90AlertTypes.DOOR_OPEN_CLOSE:
-            is_open = (
-                alert.source == G90AlertSources.SENSOR and alert.state == 1
-            ) or alert.source == G90AlertSources.DOORBELL
-            _LOGGER.debug('Door open_close alert: %s', alert)
-            G90Callback.invoke(self._door_open_close_cb,
-                               alert.event_id, alert.zone_name,
-                               is_open)
-            return
+            if alert.state in (
+                G90AlertStates.DOOR_OPEN, G90AlertStates.DOOR_CLOSE
+            ):
+                is_open = (
+                    alert.source == G90AlertSources.SENSOR
+                    and alert.state == G90AlertStates.DOOR_OPEN  # noqa: W503
+                ) or alert.source == G90AlertSources.DOORBELL
+                _LOGGER.debug('Door open_close alert: %s', alert)
+                G90Callback.invoke(
+                    self.on_door_open_close,
+                    alert.event_id, alert.zone_name, is_open
+                )
+                return
+
+            if (
+                alert.source == G90AlertSources.SENSOR
+                and alert.state == G90AlertStates.LOW_BATTERY  # noqa: W503
+            ):
+                _LOGGER.debug('Low battery alert: %s', alert)
+                G90Callback.invoke(
+                    self.on_low_battery,
+                    alert.event_id, alert.zone_name
+                )
+                return
 
         if alert.type == G90AlertTypes.STATE_CHANGE:
             # Define the mapping between device state received in the alert, to
@@ -168,21 +168,36 @@ class G90DeviceNotificationProtocol:
                 # We received the device state change related to arm/disarm,
                 # invoke the corresponding callback
                 _LOGGER.debug('Arm/disarm state change: %s', state)
-                G90Callback.invoke(self._armdisarm_cb, state)
+                G90Callback.invoke(self.on_armdisarm, state)
                 return
 
         if alert.type == G90AlertTypes.ALARM:
             _LOGGER.debug('Alarm: %s', alert.zone_name)
-            G90Callback.invoke(self._alarm_cb, alert.event_id, alert.zone_name)
+            G90Callback.invoke(
+                self.on_alarm,
+                alert.event_id, alert.zone_name
+            )
             return
 
         _LOGGER.warning('Unknown alert received from %s:%s:'
                         ' type %s, data %s',
                         addr[0], addr[1], alert.type, alert)
 
+    # Implementation of datagram protocol,
+    # https://docs.python.org/3/library/asyncio-protocol.html#datagram-protocols
+    def connection_made(self, transport):
+        """
+        Invoked when connection from the device is made.
+        """
+
+    def connection_lost(self, exc):
+        """
+        Same but when the connection is lost.
+        """
+
     def datagram_received(self, data, addr):  # pylint:disable=R0911
         """
-        tbd
+        Invoked from datagram is received from the device.
         """
         s_data = data.decode('utf-8')
         if not s_data.endswith('\0'):
@@ -228,37 +243,34 @@ class G90DeviceNotificationProtocol:
         _LOGGER.warning('Unknown message received from %s:%s: %s',
                         addr[0], addr[1], message)
 
+    async def on_armdisarm(self, state):
+        """
+        Invoked when device is armed or disarmed.
+        """
 
-class G90DeviceNotifications:
-    """
-    tbd
-    """
-    def __init__(self, port, host,
-                 armdisarm_cb=None, sensor_cb=None,
-                 door_open_close_cb=None, alarm_cb=None):
-        # pylint: disable=too-many-arguments
-        self._notification_transport = None
-        self._host = host
-        self._port = port
-        self._armdisarm_cb = armdisarm_cb
-        self._sensor_cb = sensor_cb
-        self._door_open_close_cb = door_open_close_cb
-        self._alarm_cb = alarm_cb
-
-    def proto_factory(self):
+    async def on_sensor_activity(self, idx, name):
         """
-        tbd
+        Invoked on sensor activity.
+        """
+
+    async def on_door_open_close(self, event_id, zone_name, is_open):
+        """
+        Invoked when door sensor reports it opened or closed.
+        """
+
+    async def on_low_battery(self, event_id, zone_name):
+        """
+        Invoked when a sensor reports it is low on battery.
+        """
+
+    async def on_alarm(self, event_id, zone_name):
+        """
+        Invoked when device triggers the alarm.
         """
-        return G90DeviceNotificationProtocol(
-            armdisarm_cb=self._armdisarm_cb,
-            sensor_cb=self._sensor_cb,
-            door_open_close_cb=self._door_open_close_cb,
-            alarm_cb=self._alarm_cb
-        )
 
     async def listen(self):
         """
-        tbd
+        Listens for notifications/alers from the device.
         """
         try:
             loop = asyncio.get_running_loop()
@@ -266,15 +278,29 @@ class G90DeviceNotifications:
             loop = asyncio.get_event_loop()
 
         _LOGGER.debug('Creating UDP endpoint for %s:%s',
-                      self._host, self._port)
+                      self._notifications_host,
+                      self._notifications_port)
         (self._notification_transport,
          _protocol) = await loop.create_datagram_endpoint(
-            self.proto_factory,
-            local_addr=(self._host, self._port))
+            lambda: self,
+            local_addr=(
+                self._notifications_host, self._notifications_port
+            ))
+
+    @property
+    def listener_started(self):
+        """
+        Indicates if the listener of the device notifications has been started.
+
+        :rtype: bool
+        """
+        return self._notification_transport is not None
 
     def close(self):
         """
-        tbd
+        Closes the listener.
         """
         if self._notification_transport:
+            _LOGGER.debug('No longer listening for device notifications')
             self._notification_transport.close()
+            self._notification_transport = None

pyg90alarm/discovery.py

@@ -32,34 +32,28 @@ from .const import G90Commands
 _LOGGER = logging.getLogger(__name__)
 
 
-class G90DiscoveryProtocol:
+class G90Discovery(G90BaseCommand):
     """
     tbd
-
-    :meta private:
     """
-    def __init__(self, parent):
-        """
-        tbd
-        """
-        self._parent = parent
-
-    def connection_made(self, transport):
-        """
-        tbd
-        """
-
-    def connection_lost(self, exc):
+    # pylint: disable=too-few-public-methods
+    def __init__(self, timeout=10, **kwargs):
         """
         tbd
         """
+        # pylint: disable=too-many-arguments
+        super().__init__(code=G90Commands.GETHOSTINFO, timeout=timeout,
+                         **kwargs)
+        self._discovered_devices = []
 
+    # Implementation of datagram protocol,
+    # https://docs.python.org/3/library/asyncio-protocol.html#datagram-protocols
     def datagram_received(self, data, addr):
         """
         tbd
         """
         try:
-            ret = self._parent.from_wire(data)
+            ret = self.from_wire(data)
             host_info = G90HostInfo(*ret)
             _LOGGER.debug('Received from %s:%s: %s', addr[0], addr[1], ret)
             res = {
@@ -69,31 +63,11 @@ class G90DiscoveryProtocol:
             }
             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 G90Discovery(G90BaseCommand):
-    """
-    tbd
-    """
-    # pylint: disable=too-few-public-methods
-    def __init__(self, timeout=10, **kwargs):
-        """
-        tbd
-        """
-        # pylint: disable=too-many-arguments
-        super().__init__(code=G90Commands.GETHOSTINFO, timeout=timeout,
-                         **kwargs)
-        self._discovered_devices = []
-
     async def process(self):
         """
         tbd
@@ -118,9 +92,3 @@ class G90Discovery(G90BaseCommand):
         tbd
         """
         self._discovered_devices.append(value)
-
-    def _proto_factory(self):
-        """
-        tbd
-        """
-        return G90DiscoveryProtocol(self)

pyg90alarm/entities/sensor.py

@@ -172,6 +172,7 @@ class G90Sensor:  # pylint:disable=too-many-instance-attributes
         self._subindex = subindex
         self._occupancy = False
         self._state_callback = None
+        self._low_battery_callback = None
         self._proto_idx = proto_idx
         self._extra_data = None
 
@@ -217,6 +218,25 @@ class G90Sensor:  # pylint:disable=too-many-instance-attributes
         """
         self._state_callback = value
 
+    @property
+    def low_battery_callback(self):
+        """
+        Returns callback the sensor might have set for low battery condition.
+
+        :return: Sensor's low battery callback
+        :rtype: object
+        """
+        return self._low_battery_callback
+
+    @low_battery_callback.setter
+    def low_battery_callback(self, value):
+        """
+        Sets callback for the low battery condition reported by the sensor.
+
+        :param object value: Sensor's low battery callback
+        """
+        self._low_battery_callback = value
+
     @property
     def occupancy(self):
         """