pyg90alarm 1.10.0__tar.gz → 1.11.0__tar.gz

{pyg90alarm-1.10.0 → pyg90alarm-1.11.0}/.github/workflows/main.yml

@@ -28,6 +28,9 @@ jobs:
           - os: ubuntu-latest
             python: '3.10'
             toxenv: py
+          - os: ubuntu-latest
+            python: '3.11'
+            toxenv: py
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout the code
@@ -45,8 +48,6 @@ jobs:
           python -m pip install --upgrade setuptools pip tox virtualenv coverage
       - name: Run the tests
         run: tox -e ${{ matrix.toxenv }}
-      - name: Combine Coverage reports
-        run: coverage combine
       - name: Generage Coverage combined XML report
         run: coverage xml
       - name: Determine package version

{pyg90alarm-1.10.0 → pyg90alarm-1.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyg90alarm
-Version: 1.10.0
+Version: 1.11.0
 Summary: G90 Alarm system protocol
 Home-page: https://github.com/hostcc/pyg90alarm
 Author: Ilia Sotnikov
@@ -22,10 +22,15 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.7, <4
 Description-Content-Type: text/x-rst
+License-File: LICENSE
 Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"
 Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: asynctest; extra == "test"
 Provides-Extra: docs
-License-File: LICENSE
+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.11.0/docs/requirements.txt

@@ -0,0 +1,10 @@
+sphinx-rtd-theme
+enum-tools[sphinx]
+pygments>=2.15.0 # not directly required, pinned by Snyk to avoid a vulnerability
+sphinx>=3.3.0 # not directly required, pinned by Snyk to avoid a vulnerability
+setuptools>=65.5.1 # not directly required, pinned by Snyk to avoid a vulnerability
+certifi>=2023.7.22 # not directly required, pinned by Snyk to avoid a vulnerability
+requests>=2.32.0 # not directly required, pinned by Snyk to avoid a vulnerability
+jinja2>=3.1.4 # not directly required, pinned by Snyk to avoid a vulnerability
+requests>=2.31.0 # not directly required, pinned by Snyk to avoid a vulnerability
+idna>=3.7 # not directly required, pinned by Snyk to avoid a vulnerability

{pyg90alarm-1.10.0 → pyg90alarm-1.11.0}/pyproject.toml

@@ -6,3 +6,8 @@ build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
 local_scheme = "no-local-version"
+
+[tool.pytest.ini_options]
+log_cli = 1
+log_cli_level = "error"
+asyncio_mode = "auto"

{pyg90alarm-1.10.0 → pyg90alarm-1.11.0}/src/pyg90alarm/alarm.py

@@ -54,6 +54,7 @@ from .const import (
     G90Commands, REMOTE_PORT,
     REMOTE_TARGETED_DISCOVERY_PORT,
     LOCAL_TARGETED_DISCOVERY_PORT,
+    NOTIFICATIONS_PORT,
     G90ArmDisarmTypes,
 )
 from .base_cmd import G90BaseCommand
@@ -87,23 +88,18 @@ class G90Alarm:  # pylint: disable=too-many-public-methods
      protocol commands on WiFi interface, currently the devices don't allow it
      to be customized
     :type port: int, optional
-    :param sock: The existing socket to operate on, instead of
-     creating one internally. Primarily used by the tests to mock the network
-     traffic
-    :type sock: socket.socket or None, optional
     :param reset_occupancy_interval: The interval upon that the sensors are
      simulated to go into inactive state.
     :type reset_occupancy_interval: int, optional
     """
     # pylint: disable=too-many-instance-attributes
-    def __init__(self, host, port=REMOTE_PORT, sock=None,
+    def __init__(self, host, port=REMOTE_PORT,
                  reset_occupancy_interval=3):
         self._host = host
         self._port = port
         self._sensors = []
         self._devices = []
         self._notifications = None
-        self._sock = sock
         self._sensor_cb = None
         self._armdisarm_cb = None
         self._door_open_close_cb = None
@@ -124,7 +120,7 @@ class G90Alarm:  # pylint: disable=too-many-public-methods
          command invocation
         """
         cmd = await G90BaseCommand(
-            self._host, self._port, code, data, sock=self._sock).process()
+            self._host, self._port, code, data).process()
         return cmd.result
 
     def paginated_result(self, code, start=1, end=None):
@@ -141,7 +137,7 @@ class G90Alarm:  # pylint: disable=too-many-public-methods
           yields :class:`.G90PaginatedResponse` instance
         """
         return G90PaginatedResult(
-            self._host, self._port, code, start, end, sock=self._sock
+            self._host, self._port, code, start, end
         ).process()
 
     @classmethod
@@ -585,19 +581,19 @@ class G90Alarm:  # pylint: disable=too-many-public-methods
     def alarm_callback(self, value):
         self._alarm_cb = value
 
-    async def listen_device_notifications(self, sock=None):
+    async def listen_device_notifications(
+        self, host='0.0.0.0', port=NOTIFICATIONS_PORT
+    ):
         """
         Starts internal listener for device notifications/alerts.
 
-        :param sock: socket instance to listen on, mostly used by tests
-        :type: socket.socket
         """
         self._notifications = G90DeviceNotifications(
+            host=host, port=port,
             sensor_cb=self._internal_sensor_cb,
             door_open_close_cb=self._internal_door_open_close_cb,
             armdisarm_cb=self._internal_armdisarm_cb,
-            alarm_cb=self._internal_alarm_cb,
-            sock=sock)
+            alarm_cb=self._internal_alarm_cb)
         await self._notifications.listen()
 
     def close_device_notifications(self):

{pyg90alarm-1.10.0 → pyg90alarm-1.11.0}/src/pyg90alarm/base_cmd.py

@@ -110,7 +110,7 @@ class G90BaseCommand:
 
     def __init__(self, host, port, code,
                  data=None, local_port=None,
-                 timeout=3.0, retries=3, sock=None):
+                 timeout=3.0, retries=3):
         """
         tbd
         """
@@ -130,9 +130,8 @@ class G90BaseCommand:
                                     # No whitespace around entities
                                     separators=(',', ':'))
         self._resp = G90Header()
-        self._sock = sock
 
-    def _proto_factory(self):  # pylint: disable=no-self-use
+    def _proto_factory(self):
         """
         tbd
         """
@@ -147,23 +146,17 @@ class G90BaseCommand:
         except AttributeError:
             loop = asyncio.get_event_loop()
 
-        if self._sock:
-            _LOGGER.debug('Using provided socket %s', self._sock)
-            transport, protocol = await loop.create_datagram_endpoint(
-                self._proto_factory,
-                sock=self._sock)
-        else:
-            _LOGGER.debug('Creating UDP endpoint for %s:%s',
-                          self.host, self.port)
-            extra_kwargs = {}
-            if self._local_port:
-                extra_kwargs['local_addr'] = ('0.0.0.0', self._local_port)
-
-            transport, protocol = await loop.create_datagram_endpoint(
-                self._proto_factory,
-                remote_addr=(self.host, self.port),
-                **extra_kwargs,
-                allow_broadcast=True)
+        _LOGGER.debug('Creating UDP endpoint for %s:%s',
+                      self.host, self.port)
+        extra_kwargs = {}
+        if self._local_port:
+            extra_kwargs['local_addr'] = ('0.0.0.0', self._local_port)
+
+        transport, protocol = await loop.create_datagram_endpoint(
+            self._proto_factory,
+            remote_addr=(self.host, self.port),
+            **extra_kwargs,
+            allow_broadcast=True)
 
         return transport, protocol
 

{pyg90alarm-1.10.0 → pyg90alarm-1.11.0}/src/pyg90alarm/const.py

@@ -27,6 +27,7 @@ from enum import IntEnum
 REMOTE_PORT = 12368
 REMOTE_TARGETED_DISCOVERY_PORT = 12900
 LOCAL_TARGETED_DISCOVERY_PORT = 12901
+NOTIFICATIONS_PORT = 12901
 
 CMD_PAGE_SIZE = 10
 

{pyg90alarm-1.10.0 → pyg90alarm-1.11.0}/src/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-1.10.0 → pyg90alarm-1.11.0}/src/pyg90alarm/device_notifications.py

@@ -36,6 +36,7 @@ from .const import (
     G90AlertSources,
 )
 
+
 _LOGGER = logging.getLogger(__name__)
 
 
@@ -232,16 +233,17 @@ class G90DeviceNotifications:
     """
     tbd
     """
-    def __init__(self, port=12901, armdisarm_cb=None, sensor_cb=None,
-                 door_open_close_cb=None, alarm_cb=None, sock=None):
+    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
-        self._sock = sock
 
     def proto_factory(self):
         """
@@ -263,19 +265,12 @@ class G90DeviceNotifications:
         except AttributeError:
             loop = asyncio.get_event_loop()
 
-        if self._sock:
-            _LOGGER.debug('Using provided socket %s', self._sock)
-            (self._notification_transport,
-             _protocol) = await loop.create_datagram_endpoint(
-                self.proto_factory,
-                sock=self._sock)
-        else:
-            _LOGGER.debug('Creating UDP endpoint for 0.0.0.0:%s',
-                          self._port)
-            (self._notification_transport,
-             _protocol) = await loop.create_datagram_endpoint(
-                self.proto_factory,
-                local_addr=('0.0.0.0', self._port))
+        _LOGGER.debug('Creating UDP endpoint for %s:%s',
+                      self._host, self._port)
+        (self._notification_transport,
+         _protocol) = await loop.create_datagram_endpoint(
+            self.proto_factory,
+            local_addr=(self._host, self._port))
 
     def close(self):
         """

{pyg90alarm-1.10.0 → pyg90alarm-1.11.0}/src/pyg90alarm/targeted_discovery.py

@@ -119,7 +119,7 @@ class G90TargetedDiscovery(G90Discovery):
         super().__init__(**kwargs)
         self._device_id = device_id
 
-    def to_wire(self):  # pylint: disable=no-self-use
+    def to_wire(self):
         """
         tbd
         """

{pyg90alarm-1.10.0 → pyg90alarm-1.11.0}/src/pyg90alarm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyg90alarm
-Version: 1.10.0
+Version: 1.11.0
 Summary: G90 Alarm system protocol
 Home-page: https://github.com/hostcc/pyg90alarm
 Author: Ilia Sotnikov
@@ -22,10 +22,15 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.7, <4
 Description-Content-Type: text/x-rst
+License-File: LICENSE
 Provides-Extra: dev
+Requires-Dist: check-manifest; extra == "dev"
 Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: asynctest; extra == "test"
 Provides-Extra: docs
-License-File: LICENSE
+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.10.0 → pyg90alarm-1.11.0}/src/pyg90alarm.egg-info/SOURCES.txt

@@ -44,8 +44,8 @@ src/pyg90alarm/definitions/sensors.py
 src/pyg90alarm/entities/__init__.py
 src/pyg90alarm/entities/device.py
 src/pyg90alarm/entities/sensor.py
-tests/__init__.py
-tests/fixtures.py
+tests/conftest.py
+tests/device_mock.py
 tests/test_alarm.py
 tests/test_base_commands.py
 tests/test_callback.py

pyg90alarm-1.11.0/tests/conftest.py

@@ -0,0 +1,66 @@
+# Copyright (c) 2023 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.
+
+"""
+Performs runtime configuration and exposes custom fixtures for Pytest.
+"""
+import pytest
+from device_mock import DeviceMock
+
+
+def pytest_configure(config):
+    """
+    Configures `pytest`.
+    """
+    config.addinivalue_line("markers", "g90device")
+
+
+@pytest.fixture
+async def mock_device(request, unused_udp_port_factory):
+    """
+    Fixture to instantiate a simulated G90 device allocating random unused
+    ports for network exchanges.
+
+    The fixture should be customized with `g90device` mark containing
+    `sent_data` and `notification_data` lists of bytes to simulate the messages
+    the device sends back to client and notification messages sent to client,
+    respectively.
+    """
+    marker = getattr(
+        request.node
+        .get_closest_marker('g90device'),
+        'kwargs', {}
+    )
+    data = marker.get('sent_data', [])
+    notification_data = marker.get('notification_data', [])
+
+    # Allocate unused ports to listen for client requests on, and to send
+    # notification messages to, respectively
+
+    # Note the `unised_udp_port_factory` comes from `pytest-asyncio` package
+    device_port = unused_udp_port_factory()
+    notification_port = unused_udp_port_factory()
+    device = DeviceMock(
+        data, notification_data,
+        device_port=device_port, notification_port=notification_port
+    )
+    await device.start()
+    yield device
+    device.stop()