pyg90alarm 2.3.0__py3-none-any.whl → 2.4.0__py3-none-any.whl

pyg90alarm/local/host_config.py

@@ -0,0 +1,167 @@
+# Copyright (c) 2026 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.
+"""
+Protocol entity for G90 alarm panel config.
+"""
+from __future__ import annotations
+from typing import Dict, Any
+from dataclasses import dataclass
+from enum import IntEnum
+from .dataclass_load_save import DataclassLoadSave
+from ..const import G90Commands
+
+
+class G90SpeechLanguage(IntEnum):
+    """
+    Supported speech languages.
+    """
+    ENGLISH_FEMALE = 1
+    ENGLISH_MALE = 2
+    CHINESE_FEMALE = 3
+    CHINESE_MALE = 4
+    GERMAN_FEMALE = 5
+    GERMAN_MALE = 6
+    SPANISH_FEMALE = 7
+    SPANISH_MALE = 8
+    DUTCH_FEMALE = 9
+    DUTCH_MALE = 10
+    SWEDISH_FEMALE = 11
+    SWEDISH_MALE = 12
+    FRENCH_FEMALE = 13
+    FRENCH_MALE = 14
+    TURKISH_FEMALE = 15
+    TURKISH_MALE = 16
+    RUSSIAN_FEMALE = 17
+    RUSSIAN_MALE = 18
+
+
+class G90VolumeLevel(IntEnum):
+    """
+    Supported volume levels.
+    """
+    MUTE = 0
+    LOW = 1
+    HIGH = 2
+
+
+@dataclass
+class G90HostConfig(DataclassLoadSave):
+    """
+    Interprets data fields of GETHOSTCONFIG/SETHOSTCONFIG commands.
+    """
+    # pylint: disable=too-many-instance-attributes
+    LOAD_COMMAND = G90Commands.GETHOSTCONFIG
+    SAVE_COMMAND = G90Commands.SETHOSTCONFIG
+
+    # Duration of the alarm siren when triggered, in seconds
+    alarm_siren_duration: int
+    # Delay before arming the panel, in seconds
+    arm_delay: int
+    # Delay before the alarm is triggered, in seconds
+    alarm_delay: int
+    # Duration of the backlight, in seconds
+    backlight_duration: int
+    # Alarm volume level, applies to panel's built-in speaker
+    _alarm_volume_level: int
+    # Speech volume level
+    _speech_volume_level: int
+    # Duration of the ring for the incoming call, in seconds
+    ring_duration: int
+    # Speech language
+    _speech_language: int
+    # Key tone volume level
+    _key_tone_volume_level: int
+    # Timezone offset, in minutes
+    timezone_offset_m: int
+    # Ring volume level for incoming calls
+    _ring_volume_level: int
+
+    @property
+    def speech_language(self) -> G90SpeechLanguage:
+        """
+        Returns the speech language as an enum.
+        """
+        return G90SpeechLanguage(self._speech_language)
+
+    @speech_language.setter
+    def speech_language(self, value: G90SpeechLanguage) -> None:
+        self._speech_language = value.value
+
+    @property
+    def alarm_volume_level(self) -> G90VolumeLevel:
+        """
+        Returns the alarm volume level as an enum.
+        """
+        return G90VolumeLevel(self._alarm_volume_level)
+
+    @alarm_volume_level.setter
+    def alarm_volume_level(self, value: G90VolumeLevel) -> None:
+        self._alarm_volume_level = value.value
+
+    @property
+    def speech_volume_level(self) -> G90VolumeLevel:
+        """
+        Returns the speech volume level as an enum.
+        """
+        return G90VolumeLevel(self._speech_volume_level)
+
+    @speech_volume_level.setter
+    def speech_volume_level(self, value: G90VolumeLevel) -> None:
+        self._speech_volume_level = value.value
+
+    @property
+    def key_tone_volume_level(self) -> G90VolumeLevel:
+        """
+        Returns the key tone volume level as an enum.
+        """
+        return G90VolumeLevel(self._key_tone_volume_level)
+
+    @key_tone_volume_level.setter
+    def key_tone_volume_level(self, value: G90VolumeLevel) -> None:
+        self._key_tone_volume_level = value.value
+
+    @property
+    def ring_volume_level(self) -> G90VolumeLevel:
+        """
+        Returns the ring volume level as an enum.
+        """
+        return G90VolumeLevel(self._ring_volume_level)
+
+    @ring_volume_level.setter
+    def ring_volume_level(self, value: G90VolumeLevel) -> None:
+        self._ring_volume_level = value.value
+
+    def _asdict(self) -> Dict[str, Any]:
+        """
+        Returns the dataclass fields as a dictionary.
+        """
+        return {
+            'alarm_siren_duration': self.alarm_siren_duration,
+            'arm_delay': self.arm_delay,
+            'alarm_delay': self.alarm_delay,
+            'backlight_duration': self.backlight_duration,
+            'alarm_volume_level': self.alarm_volume_level.name,
+            'speech_volume_level': self.speech_volume_level.name,
+            'ring_duration': self.ring_duration,
+            'speech_language': self.speech_language.name,
+            'key_tone_volume_level': self.key_tone_volume_level.name,
+            'timezone_offset_m': self.timezone_offset_m,
+            'ring_volume_level': self.ring_volume_level.name,
+        }

pyg90alarm/local/net_config.py

@@ -0,0 +1,127 @@
+# Copyright (c) 2026 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.
+"""
+Interprets network configuration data fields of GETAPINFO/SETAPINFO commands.
+"""
+from __future__ import annotations
+from enum import IntEnum
+from dataclasses import dataclass
+from typing import Any, Dict
+from ..const import G90Commands
+from .dataclass_load_save import DataclassLoadSave
+
+
+class G90APNAuth(IntEnum):
+    """
+    Supported APN authentication methods.
+    """
+    NONE = 0
+    PAP = 1
+    CHAP = 2
+    PAP_OR_CHAP = 3
+
+
+@dataclass
+class G90NetConfig(DataclassLoadSave):
+    """
+    Interprets data fields of GETAPINFO/SETAPINFO commands.
+    """
+    # pylint: disable=too-many-instance-attributes
+    LOAD_COMMAND = G90Commands.GETAPINFO
+    SAVE_COMMAND = G90Commands.SETAPINFO
+
+    # Whether the access point is enabled, so that the device can be accessed
+    # via WiFi
+    _ap_enabled: int
+    # Access point password
+    ap_password: str
+    # Whether WiFi is enabled, so that the device can connect to WiFi network
+    _wifi_enabled: int
+    # Whether GPRS is enabled, so that the device can connect via cellular
+    # network
+    _gprs_enabled: int
+    # Access Point Name (APN) for GPRS connection, as provided by the cellular
+    # operator
+    apn_name: str
+    # User name for APN authentication, as provided by the cellular operator
+    apn_user: str
+    # Password for APN authentication, as provided by the cellular operator
+    apn_password: str
+    # APN authentication method, as provided by the cellular operator
+    _apn_auth: int
+    # GSM operator code
+    gsm_operator: str
+
+    @property
+    def ap_enabled(self) -> bool:
+        """
+        Returns whether the access point is enabled.
+        """
+        return bool(self._ap_enabled)
+
+    @ap_enabled.setter
+    def ap_enabled(self, value: bool) -> None:
+        self._ap_enabled = int(value)
+
+    @property
+    def wifi_enabled(self) -> bool:
+        """
+        Returns whether WiFi is enabled.
+        """
+        return bool(self._wifi_enabled)
+
+    @wifi_enabled.setter
+    def wifi_enabled(self, value: bool) -> None:
+        self._wifi_enabled = int(value)
+
+    @property
+    def gprs_enabled(self) -> bool:
+        """
+        Returns whether GPRS is enabled.
+        """
+        return bool(self._gprs_enabled)
+
+    @gprs_enabled.setter
+    def gprs_enabled(self, value: bool) -> None:
+        self._gprs_enabled = int(value)
+
+    @property
+    def apn_auth(self) -> G90APNAuth:
+        """
+        Returns the APN authentication method as an enum.
+        """
+        return G90APNAuth(self._apn_auth)
+
+    @apn_auth.setter
+    def apn_auth(self, value: G90APNAuth) -> None:
+        self._apn_auth = value.value
+
+    def _asdict(self) -> Dict[str, Any]:
+        return {
+            'ap_enabled': self.ap_enabled,
+            'ap_password': '********',
+            'wifi_enabled': self.wifi_enabled,
+            'gprs_enabled': self.gprs_enabled,
+            'apn_name': self.apn_name,
+            'apn_user': self.apn_user,
+            'apn_password': '********',
+            'apn_auth': self.apn_auth,
+            'gsm_operator': self.gsm_operator
+        }

pyg90alarm/notifications/base.py

@@ -40,7 +40,9 @@ from ..const import (
     G90AlertSources,
     G90AlertStates,
     G90RemoteButtonStates,
+    G90RFIDKeypadStates,
 )
+from ..event_mapping import map_alert_state
 from .protocol import G90NotificationProtocol
 
 _LOGGER = logging.getLogger(__name__)
@@ -218,6 +220,17 @@ class G90NotificationsBase:
 
             return True
 
+        if alert.source == G90AlertSources.RFID:
+            _LOGGER.debug('RFID keypad alert: %s', alert)
+            # Invoke the callback specific to RFID keypad events
+            G90Callback.invoke(
+                self._protocol.on_rfid_keypad,
+                alert.event_id, alert.zone_name,
+                G90RFIDKeypadStates(alert.state)
+            )
+
+            return True
+
         if alert.state in (
             G90AlertStates.DOOR_OPEN, G90AlertStates.DOOR_CLOSE
         ):
@@ -308,7 +321,11 @@ class G90NotificationsBase:
                 )
             # Regular alarm
             else:
-                is_tampered = alert.state == G90AlertStates.TAMPER
+                # Determine the state depending on alert source
+                alert_state = map_alert_state(
+                    G90AlertSources(alert.source), alert.state
+                )
+                is_tampered = alert_state == G90AlertStates.TAMPER
                 _LOGGER.debug(
                     'Alarm: %s, is tampered: %s', alert.zone_name, is_tampered
                 )

pyg90alarm/notifications/protocol.py

@@ -25,6 +25,7 @@ Defines notification protocol for `NotificationBase` class.
 from ..const import (
     G90ArmDisarmTypes,
     G90RemoteButtonStates,
+    G90RFIDKeypadStates,
 )
 
 
@@ -125,3 +126,14 @@ class G90NotificationProtocol:
         :param sensor_name: Name of the sensor.
         :param added: True if the sensor was added.
         """
+
+    async def on_rfid_keypad(
+        self, event_id: int, zone_name: str, state: G90RFIDKeypadStates
+    ) -> None:
+        """
+        Invoked when an RFID keypad event occurs.
+
+        :param event_id: Index of the RFID keypad.
+        :param zone_name: Name of the RFID keypad.
+        :param state: State of the RFID keypad.
+        """

{pyg90alarm-2.3.0.dist-info → pyg90alarm-2.4.0.dist-info}/METADATA

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

{pyg90alarm-2.3.0.dist-info → pyg90alarm-2.4.0.dist-info}/RECORD

@@ -1,7 +1,8 @@
-pyg90alarm/__init__.py,sha256=9RyHo4m46owUxAdPMFOkrr0VSd1lXK9QWyXMQlia7tM,3018
-pyg90alarm/alarm.py,sha256=Y80AsrC5-s4xfsCnFcVpNPKbIWBZ8yDo_bTCsthL4iM,47033
+pyg90alarm/__init__.py,sha256=_tJhV_LpED_ei4n4pKdu5tTcUCuaj5vPPO1nwuUHY-k,3024
+pyg90alarm/alarm.py,sha256=BDBVQ8qRa2Bx2-786uytShTw8znlFEWakxweCGvgxME,50130
 pyg90alarm/callback.py,sha256=9PVtjRs2MLn80AgiM-UJNL8ZJF4_PxcopJIpxMmB3vc,4707
-pyg90alarm/const.py,sha256=w2BzsVRDxfdwOb9590zsntGMlVWEH80zbQ4djojft9U,6851
+pyg90alarm/const.py,sha256=XBmtojOV0OrjqwL7x_wixqnt4Vcs9xOGlz-wHY4uO_Q,7948
+pyg90alarm/event_mapping.py,sha256=hSmRWkkuA5hlauGvYakdOrw8QFt0TMNfUuDQ4J3vHpQ,3438
 pyg90alarm/exceptions.py,sha256=9LleQC2SkJXjv80FlWMeaHs9ZjXxCvZx9UtYdrvejyY,1951
 pyg90alarm/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pyg90alarm/cloud/__init__.py,sha256=u7ZzrIwCsdgmBmgtpCe6c_Kipdo8nG8PEOEcaAHXCxI,1407
@@ -15,28 +16,33 @@ pyg90alarm/definitions/devices.py,sha256=K0DQnyE-1hlhIGwRfZojKJYMSmlJzmyWcZ_98ur
 pyg90alarm/definitions/sensors.py,sha256=bDecBGyUo7wFVNuD5Fu1JNZQHcMDv-234BuNKioaQQs,27426
 pyg90alarm/entities/__init__.py,sha256=hHb6AOiC4Tz--rOWiiICMdLaZDs1Tf_xpWk_HeS_gO4,66
 pyg90alarm/entities/base_entity.py,sha256=hNhhuuwNuir54uVMZzPbjE0N6WL8wKvoW_KZa4R8L8U,2680
-pyg90alarm/entities/base_list.py,sha256=Ot4kd44CUheSvYETjEQBQNT_HaOTWZhKa-4L5pr8LMI,9276
+pyg90alarm/entities/base_list.py,sha256=vNP0T8qg7lgrES0IBs4zOggQM6Uxyfarfds46bbAnH0,9482
 pyg90alarm/entities/device.py,sha256=eWE_N83hiDs5I-TT5F_W0Vb8sVugLldrDc9Lj9sgVLo,3700
 pyg90alarm/entities/device_list.py,sha256=PKnHEazeT3iUEaz70bW1OaWh0wq-7WOY-7dpV4FVCTc,5984
 pyg90alarm/entities/sensor.py,sha256=hunu-X-RhC8Wp52VMeanfqQg8rBSP8TG0qacJiFZEhg,27653
 pyg90alarm/entities/sensor_list.py,sha256=0S88bhTn91O45WgbIIMQ0iXaNjlUWmMBOOFwj2Hg73U,6993
 pyg90alarm/local/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyg90alarm/local/alarm_phones.py,sha256=OKH7t8jBziHOSJth1bnYKYVKFiX1o83JzA-6ijCYBDc,3149
+pyg90alarm/local/alert_config.py,sha256=n2dycEf6TH0MKefQXMcRsCFJyYvUMV55LRsy4FARtDI,6027
 pyg90alarm/local/base_cmd.py,sha256=f0PozHJjErIg08vn0sAacHbigJSFor8q5jdxfXiM27c,10491
-pyg90alarm/local/config.py,sha256=AYDswfeM1aZImoAr6ZB-4fVIvMuTiNgkF_bLIROVckI,4922
+pyg90alarm/local/config.py,sha256=QYetAc6QLrAN8T-37D4Esifvao52w_uJ01nHciLbGME,1390
+pyg90alarm/local/dataclass_load_save.py,sha256=wmHT5834_rOlgPMe0ryZW0SbdFNTLC6-4NjJlSt6mhY,4738
 pyg90alarm/local/discovery.py,sha256=8YVIXuNe57lhas0VSRf7QXZH83pEDGNj9oehNY4Kh2U,3576
-pyg90alarm/local/history.py,sha256=v_deRl62tHeysydyeLRvyHJwcBMnKonsEbXXSXb8XP8,9138
+pyg90alarm/local/history.py,sha256=sL6_Z1BNYkuUwAZUi78d4p5hhcCfsXKw29i4Qu1O60M,10811
+pyg90alarm/local/host_config.py,sha256=ycGx8WdSQ_azuBWpK366gvldZcxfVGnYBa_frbI9-TM,5502
 pyg90alarm/local/host_info.py,sha256=4lFIaFEpYd3EvgNrDJmKijTrzX9i29nFISLLlXGnkmE,2759
 pyg90alarm/local/host_status.py,sha256=WHGtw-A0wHILqVWP4DnZhXj8DPRGyS26AV0bL1isTz4,1863
+pyg90alarm/local/net_config.py,sha256=wjJMzL6tcHAfYF-OtregRpCoNEviOlkHHr5SpDaTmNs,4157
 pyg90alarm/local/notifications.py,sha256=Vs6NQJciYqDALV-WwzH6wIcTGdX_UD4XBuHWjSOpCDY,4591
 pyg90alarm/local/paginated_cmd.py,sha256=5pPVP8f4ydjgu8Yq6MwqINJAUt52fFlD17wO4AI88Pc,4467
 pyg90alarm/local/paginated_result.py,sha256=2tW3kMYkfCoNIhXi0N8acoIAhGhZYIbWdc347CH-Pjg,5474
 pyg90alarm/local/targeted_discovery.py,sha256=Ik2C2VBtVLurf3-RKko4O2R3B6MrmFdOskd457uyASU,5516
 pyg90alarm/local/user_data_crc.py,sha256=JQBOPY3RlOgVtvR55R-rM8OuKjYW-BPXQ0W4pi6CEH0,1689
 pyg90alarm/notifications/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pyg90alarm/notifications/base.py,sha256=_YX0kL9bqMAOdKBRZ5M-SIrwR4xotnZwgxqWoyEgxAk,16032
-pyg90alarm/notifications/protocol.py,sha256=mvn6hVNopOUgwQy4nWHKp7ydt5r84lsDWCCaWYJjL9Q,4422
-pyg90alarm-2.3.0.dist-info/licenses/LICENSE,sha256=f884inRbeNv-O-hbwz62Ro_1J8xiHRTnJ2cCx6A0WvU,1070
-pyg90alarm-2.3.0.dist-info/METADATA,sha256=bPvzjRYbZ8Cq_pO0pCbD4ensWw0m_HICuo0x4FbeORQ,12568
-pyg90alarm-2.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pyg90alarm-2.3.0.dist-info/top_level.txt,sha256=czHiGxYMyTk5QEDTDb0EpPiKqUMRa8zI4zx58Ii409M,11
-pyg90alarm-2.3.0.dist-info/RECORD,,
+pyg90alarm/notifications/base.py,sha256=d3N_zNPa_jcTX4QpA78jdgMHDhmrgwqyM3HdvuO14Jk,16682
+pyg90alarm/notifications/protocol.py,sha256=TlZQ3P8-N-E2X5bzkGefz432x4lBYyIBF9VriwYn9ds,4790
+pyg90alarm-2.4.0.dist-info/licenses/LICENSE,sha256=f884inRbeNv-O-hbwz62Ro_1J8xiHRTnJ2cCx6A0WvU,1070
+pyg90alarm-2.4.0.dist-info/METADATA,sha256=F4oEK7YEmXUXUXtwVhRxn-qPM0MSvOjdmNlmHfUbYxo,12568
+pyg90alarm-2.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pyg90alarm-2.4.0.dist-info/top_level.txt,sha256=czHiGxYMyTk5QEDTDb0EpPiKqUMRa8zI4zx58Ii409M,11
+pyg90alarm-2.4.0.dist-info/RECORD,,