pyg90alarm 1.14.0__tar.gz → 1.15.1__tar.gz

{pyg90alarm-1.14.0 → pyg90alarm-1.15.1}/MANIFEST.in

@@ -10,3 +10,5 @@ include LICENSE
 include setup.py
 
 recursive-include src py.typed
+
+exclude requirements_dev.txt

{pyg90alarm-1.14.0 → pyg90alarm-1.15.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyg90alarm
-Version: 1.14.0
+Version: 1.15.1
 Summary: G90 Alarm system protocol
 Home-page: https://github.com/hostcc/pyg90alarm
 Author: Ilia Sotnikov

{pyg90alarm-1.14.0 → pyg90alarm-1.15.1}/pyproject.toml

@@ -11,6 +11,7 @@ local_scheme = "no-local-version"
 log_cli = 1
 log_cli_level = "error"
 asyncio_mode = "auto"
+pythonpath = "src/"
 
 [tool.coverage.run]
 relative_files = true

{pyg90alarm-1.14.0 → pyg90alarm-1.15.1}/src/pyg90alarm/alarm.py

@@ -56,9 +56,6 @@ from typing import (
     TYPE_CHECKING, Any, List, Optional, AsyncGenerator,
     Callable, Coroutine, Union
 )
-from typing_extensions import (
-    TypeAlias
-)
 from .const import (
     G90Commands, REMOTE_PORT,
     REMOTE_TARGETED_DISCOVERY_PORT,
@@ -91,7 +88,7 @@ if TYPE_CHECKING:
     # Type alias for the callback functions available to the user, should be
     # compatible with `G90Callback.Callback` type, since `G90Callback.invoke`
     # is used to invoke them
-    AlarmCallback: TypeAlias = Union[
+    AlarmCallback = Union[
         Callable[[int, str, Any], None],
         Callable[[int, str, Any], Coroutine[None, None, None]]
     ]
@@ -103,22 +100,25 @@ if TYPE_CHECKING:
         Callable[[int, str, bool], None],
         Callable[[int, str, bool], Coroutine[None, None, None]]
     ]
-    SensorStateCallback = Union[
-        Callable[[bool], None],
-        Callable[[bool], Coroutine[None, None, None]]
-    ]
     LowBatteryCallback = Union[
         Callable[[int, str], None],
         Callable[[int, str], Coroutine[None, None, None]]
     ]
-    SensorLowBatteryCallback = Union[
-        Callable[[bool], None],
-        Callable[[bool], Coroutine[None, None, None]]
-    ]
     ArmDisarmCallback = Union[
         Callable[[G90ArmDisarmTypes], None],
         Callable[[G90ArmDisarmTypes], Coroutine[None, None, None]]
     ]
+    # Sensor-related callbacks for `G90Sensor` class - despite that class
+    # stores them, the invication is done by the `G90Alarm` class hence these
+    # are defined here
+    SensorStateCallback = Union[
+        Callable[[bool], None],
+        Callable[[bool], Coroutine[None, None, None]]
+    ]
+    SensorLowBatteryCallback = Union[
+        Callable[[], None],
+        Callable[[], Coroutine[None, None, None]]
+    ]
 
 
 # pylint: disable=too-many-public-methods
@@ -470,16 +470,19 @@ class G90Alarm(G90DeviceNotifications):
         _LOGGER.debug('on_sensor_activity: %s %s %s', idx, name, occupancy)
         sensor = await self.find_sensor(idx, name)
         if sensor:
-            _LOGGER.debug('Setting occupancy to %s (previously %s)',
-                          occupancy, sensor.occupancy)
-            sensor.occupancy = occupancy
+            # Reset the low battery flag since the sensor reports activity,
+            # implying it has sufficient battery power
+            # pylint: disable=protected-access
+            sensor._set_low_battery(False)
+            # Set the sensor occupancy
+            # pylint: disable=protected-access
+            sensor._set_occupancy(occupancy)
 
             # Emulate turning off the occupancy - most of sensors will not
             # notify the device of that, nor the device would emit such
             # notification itself
             def reset_sensor_occupancy(sensor: G90Sensor) -> None:
-                _LOGGER.debug('Resetting occupancy for sensor %s', sensor)
-                sensor.occupancy = False
+                sensor._set_occupancy(False)
                 G90Callback.invoke(sensor.state_callback, sensor.occupancy)
 
             # Determine if door close notifications are available for the given
@@ -639,8 +642,12 @@ class G90Alarm(G90DeviceNotifications):
         :param event_id: Index of the sensor triggered alarm
         :param zone_name: Sensor name
         """
+        _LOGGER.debug('on_low_battery: %s %s', event_id, zone_name)
         sensor = await self.find_sensor(event_id, zone_name)
         if sensor:
+            # Set the low battery flag on the sensor
+            # pylint: disable=protected-access
+            sensor._set_low_battery(True)
             # Invoke per-sensor callback if provided
             G90Callback.invoke(sensor.low_battery_callback)
 

{pyg90alarm-1.14.0 → pyg90alarm-1.15.1}/src/pyg90alarm/entities/sensor.py

@@ -185,6 +185,7 @@ class G90Sensor:  # pylint:disable=too-many-instance-attributes
         self._occupancy = False
         self._state_callback: Optional[SensorStateCallback] = None
         self._low_battery_callback: Optional[SensorLowBatteryCallback] = None
+        self._low_battery = False
         self._proto_idx = proto_idx
         self._extra_data: Any = None
 
@@ -247,8 +248,19 @@ class G90Sensor:  # pylint:disable=too-many-instance-attributes
         """
         return self._occupancy
 
-    @occupancy.setter
-    def occupancy(self, value: bool) -> None:
+    def _set_occupancy(self, value: bool) -> None:
+        """
+        Sets occupancy state of the sensor.
+        Intentionally private, as occupancy state is derived from
+        notifications/alerts.
+
+        :param value: Occupancy state
+        """
+        _LOGGER.debug(
+            "Setting occupancy for sensor index=%s: '%s' %s"
+            " (previous value: %s)",
+            self.index, self.name, value, self._occupancy
+        )
         self._occupancy = value
 
     @property
@@ -342,6 +354,35 @@ class G90Sensor:  # pylint:disable=too-many-instance-attributes
         """
         return self._definition is not None
 
+    @property
+    def is_wireless(self) -> bool:
+        """
+        Indicates if the sensor is wireless.
+        """
+        return self.protocol not in (G90SensorProtocols.CORD,)
+
+    @property
+    def is_low_battery(self) -> bool:
+        """
+        Indicates if the sensor is reporting low battery.
+        """
+        return self._low_battery
+
+    def _set_low_battery(self, value: bool) -> None:
+        """
+        Sets low battery state of the sensor.
+        Intentionally private, as low battery state is derived from
+        notifications/alerts.
+
+        :param value: Low battery state
+        """
+        _LOGGER.debug(
+            "Setting low battery for sensor index=%s '%s': %s"
+            " (previous value: %s)",
+            self.index, self.name, value, self._low_battery
+        )
+        self._low_battery = value
+
     @property
     def enabled(self) -> bool:
         """
@@ -485,6 +526,8 @@ class G90Sensor:  # pylint:disable=too-many-instance-attributes
             'extra_data': self.extra_data,
             'enabled': self.enabled,
             'supports_enable_disable': self.supports_enable_disable,
+            'is_wireless': self.is_wireless,
+            'is_low_battery': self.is_low_battery,
         }
 
     def __repr__(self) -> str:
@@ -493,11 +536,4 @@ class G90Sensor:  # pylint:disable=too-many-instance-attributes
 
         :return: String representation
         """
-        return super().__repr__() + f"(name='{str(self.name)}'" \
-            f' type={str(self.type)}' \
-            f' subtype={str(self.subtype)}' \
-            f' protocol={str(self.protocol)}' \
-            f' occupancy={self.occupancy}' \
-            f' user flag={str(self.user_flag)}' \
-            f' reserved={str(self.reserved)}' \
-            f" extra_data={str(self.extra_data)})"
+        return super().__repr__() + f'({repr(self._asdict())})'

{pyg90alarm-1.14.0 → pyg90alarm-1.15.1}/src/pyg90alarm/history.py

@@ -211,9 +211,4 @@ class G90History:
         """
         Textural representation of the history entry.
         """
-        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)}'
+        return super().__repr__() + f'({repr(self._asdict())})'

{pyg90alarm-1.14.0 → pyg90alarm-1.15.1}/src/pyg90alarm.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyg90alarm
-Version: 1.14.0
+Version: 1.15.1
 Summary: G90 Alarm system protocol
 Home-page: https://github.com/hostcc/pyg90alarm
 Author: Ilia Sotnikov

{pyg90alarm-1.14.0 → pyg90alarm-1.15.1}/tests/test_alarm.py

@@ -211,8 +211,10 @@ async def test_single_sensor(mock_device: DeviceMock) -> None:
 
 @pytest.mark.g90device(sent_data=[
     b'ISTART[102,'
-    b'[[2,1,2],["Remote 1",10,0,10,1,0,32,0,0,16,1,0,""],'
-    b'["Remote 2",11,0,10,1,0,32,0,0,16,1,0,""]]]IEND\0',
+    b'[[3,1,3],["Remote 1",10,0,10,1,0,32,0,0,16,1,0,""],'
+    b'["Remote 2",11,0,10,1,0,32,0,0,16,1,0,""],'
+    b'["Cord 1",12,0,126,1,0,32,0,5,16,1,0,""]'
+    b']]IEND\0',
 ])
 async def test_multiple_sensors_shorter_than_page(
     mock_device: DeviceMock
@@ -230,14 +232,20 @@ async def test_multiple_sensors_shorter_than_page(
     assert mock_device.recv_data == [
         b'ISTART[102,102,[102,[1,10]]]IEND\0',
     ]
-    assert len(sensors) == 2
+    assert len(sensors) == 3
     assert isinstance(sensors, list)
     assert isinstance(sensors[0], G90Sensor)
     assert sensors[0].name == 'Remote 1'
     assert sensors[0].index == 10
+    assert sensors[0].is_wireless is True
     assert isinstance(sensors[1], G90Sensor)
     assert sensors[1].name == 'Remote 2'
     assert sensors[1].index == 11
+    assert sensors[1].is_wireless is True
+    assert isinstance(sensors[2], G90Sensor)
+    assert sensors[2].name == 'Cord 1'
+    assert sensors[2].index == 12
+    assert sensors[2].is_wireless is False
 
 
 @pytest.mark.g90device(sent_data=[
@@ -334,7 +342,9 @@ async def test_sensor_event(mock_device: DeviceMock) -> None:
         b'ISTART[117,[256]]IEND\0',
     ],
     notification_data=[
-        b'[208,[4,26,1,4,"Remote","DUMMYGUID",1719223959,0,[""]]]\0'
+        b'[208,[4,26,1,4,"Remote","DUMMYGUID",1719223959,0,[""]]]\0',
+        # Simulate sensor activity, which should reset low battery state for it
+        b'[170,[5,[26,"Remote"]]]\0',
     ]
 )
 async def test_sensor_low_battery_event(mock_device: DeviceMock) -> None:
@@ -360,9 +370,22 @@ async def test_sensor_low_battery_event(mock_device: DeviceMock) -> None:
     await g90.listen_device_notifications()
     await mock_device.send_next_notification()
     await asyncio.wait([future], timeout=0.1)
-    g90.close_device_notifications()
+
     low_battery_sensor_cb.assert_called_once_with()
     low_battery_cb.assert_called_once_with(26, 'Remote')
+    # Verify the low battery state is set upon receiving the notification
+    assert sensor[0].is_low_battery is True
+
+    # Signal the second notification is ready, the future has to be re-created
+    # as the corresponding callback will be fired again
+    future = asyncio.get_running_loop().create_future()
+    await mock_device.send_next_notification()
+    await asyncio.wait([future], timeout=0.1)
+
+    # Verify the low battery state is reset upon sensor activity
+    assert sensor[0].is_low_battery is False
+
+    g90.close_device_notifications()
 
 
 @pytest.mark.g90device(

{pyg90alarm-1.14.0 → pyg90alarm-1.15.1}/tox.ini

@@ -14,22 +14,8 @@ isolated_build = true
 
 [testenv]
 deps =
-    check-manifest == 0.49
-    flake8 == 7.1.1
-    pytest == 8.3.2
-    pytest-asyncio == 0.23.8
-    pytest-cov == 5.0.0
-    pylint == 3.2.6
-    mypy[reports] == 1.11.2
+    -r requirements_dev.txt
 
-setenv =
-	# Ensure the module under test will be found under `src/` directory, in
-	# case of any test command below will attempt importing it. In particular,
-	# it helps `coverage` to recognize test traces from the module under `src/`
-	# directory and report correct (aligned with repository layout) paths, not
-	# from the module installed by `tox` in the virtual environment (the traces
-	# will be referencing `tox` specific paths, not aligned with repository)
-    PYTHONPATH = src
 allowlist_externals =
 	cat
 commands =