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

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/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/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.dist-info → pyg90alarm-1.15.1.dist-info}/METADATA

@@ -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.dist-info → pyg90alarm-1.15.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
 pyg90alarm/__init__.py,sha256=5AITRm5jZSzuQaL7PS8fZZMZb4-IuGRhSqyAdfTt0Cs,2236
-pyg90alarm/alarm.py,sha256=N2TTK1F1ZVmj_fCxrx1zNvdMO6HsPOz4yIVcoWnyd2I,31777
+pyg90alarm/alarm.py,sha256=9SqJHGK6wawFUZSaRo6-GkLBz_SxONNgCwGeD38MsSU,32211
 pyg90alarm/base_cmd.py,sha256=wu2v_RKpcPHxUW4HBDLWcUFMzPsGooY4o2Rc0LgcanU,9754
 pyg90alarm/callback.py,sha256=3JsD_JChmZD24OyjaCP-PxxuBDBX7myGYhkM4RN7bk4,3742
 pyg90alarm/config.py,sha256=2YtIgdT7clQXmYvkdn_fhIdS05CY8E1Yc90R8_tAmRI,1961
@@ -7,7 +7,7 @@ pyg90alarm/const.py,sha256=4eJyEZpUE5XZkNL1sePKnuPloIvcjKIAJJ4g2e1cXVA,6054
 pyg90alarm/device_notifications.py,sha256=I5K8IsyYTe0XDJT8XiQoC8a2xY1XLjaGx4QFrEsaixg,11135
 pyg90alarm/discovery.py,sha256=fwyBHDCKGej06OwhpbVCHYTRU9WWkeYysAFgv3FiwqI,3575
 pyg90alarm/exceptions.py,sha256=eiOcRe7D18EIPyPFDNU9DdFgbnkwPmkiLl8lGPOhBNw,1475
-pyg90alarm/history.py,sha256=st9RWfrBbn4LLjfz3MguocPSnaTIATzIiBq2hLNeVTY,7380
+pyg90alarm/history.py,sha256=GnCVRsQNV2x9g6KngBBvvIUnTAIyXKX2nVKF_aFA0oM,7160
 pyg90alarm/host_info.py,sha256=4lFIaFEpYd3EvgNrDJmKijTrzX9i29nFISLLlXGnkmE,2759
 pyg90alarm/host_status.py,sha256=4XhuilBzB8XsXkpeWj3PAVpmDPcTnBBOYunO21Flabo,1862
 pyg90alarm/paginated_cmd.py,sha256=vJ8slMS7aNLpkAxnIe25EHstusYy1bYTl1j306ps-MQ,4439
@@ -19,9 +19,9 @@ pyg90alarm/definitions/__init__.py,sha256=s0NZnkW_gMH718DJbgez28z9WA231CyszUf1O_
 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=qg08Myz_P4aTd29R37Js0feSfuJ-u2U6F-6FZiS76D0,15124
-pyg90alarm-1.14.0.dist-info/LICENSE,sha256=f884inRbeNv-O-hbwz62Ro_1J8xiHRTnJ2cCx6A0WvU,1070
-pyg90alarm-1.14.0.dist-info/METADATA,sha256=Km8Q2Kl5fdxdypLxpA201_A8kfujIpzu5hiSozidmR4,7663
-pyg90alarm-1.14.0.dist-info/WHEEL,sha256=UvcQYKBHoFqaQd6LKyqHw9fxEolWLQnlzP0h_LgJAfI,91
-pyg90alarm-1.14.0.dist-info/top_level.txt,sha256=czHiGxYMyTk5QEDTDb0EpPiKqUMRa8zI4zx58Ii409M,11
-pyg90alarm-1.14.0.dist-info/RECORD,,
+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,,