pyg90alarm 2.5.1__tar.gz → 2.5.3__tar.gz

{pyg90alarm-2.5.1 → pyg90alarm-2.5.3}/PKG-INFO

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

{pyg90alarm-2.5.1 → pyg90alarm-2.5.3}/src/pyg90alarm/local/host_config.py

@@ -35,6 +35,7 @@ class G90SpeechLanguage(IntEnum):
     """
     Supported speech languages.
     """
+    NONE = 0  # Some panels send the value, exact meaning is unknown
     ENGLISH_FEMALE = 1
     ENGLISH_MALE = 2
     CHINESE_FEMALE = 3

{pyg90alarm-2.5.1 → pyg90alarm-2.5.3}/src/pyg90alarm/local/net_config.py

@@ -73,7 +73,7 @@ class G90NetConfig(DataclassLoadSave):
     # Access Point Name (APN) for GPRS connection, as provided by the cellular
     # operator
     apn_name: str = validated_string_field(
-        min_length=1, max_length=100, trust_initial_value=True
+        min_length=0, max_length=100, trust_initial_value=True
     )
     # User name for APN authentication, as provided by the cellular operator
     apn_user: str = validated_string_field(
@@ -132,8 +132,22 @@ class G90NetConfig(DataclassLoadSave):
     def apn_auth(self) -> G90APNAuth:
         """
         Returns the APN authentication method as an enum.
+
+        Some panels might send values outside of the defined enum range,
+        presumably when SIM card is absent. In such cases, returns
+        `G90APNAuth.NONE`.
+
+        No attempt is made to correct the invalid value in the underlying
+        data field, since the panel is trusted - unless the value is modified
+        and saved back to the device.
+
+        :return: APN authentication method, or G90APNAuth.NONE if the received
+         value is invalid.
         """
-        return G90APNAuth(self._apn_auth)
+        try:
+            return G90APNAuth(self._apn_auth)
+        except ValueError:
+            return G90APNAuth.NONE
 
     @apn_auth.setter
     def apn_auth(self, value: G90APNAuth) -> None:

{pyg90alarm-2.5.1 → pyg90alarm-2.5.3}/src/pyg90alarm.egg-info/PKG-INFO

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

{pyg90alarm-2.5.1 → pyg90alarm-2.5.3}/tests/test_host_config.py

@@ -164,3 +164,35 @@ async def test_host_config_constraints(
     # Test setting valid value
     setattr(cfg, field_name, valid_value)
     assert getattr(cfg, field_name) == valid_value
+
+
+@pytest.mark.g90device(sent_data=[
+    b'ISTART[106,'
+    b'[900,0,0,1,2,2,60,0,0,60,2]'
+    b']IEND\0',
+    b'ISTARTIEND\0'
+])
+async def test_host_config_speech_language_zero(
+    mock_device: DeviceMock
+) -> None:
+    """
+    Tests for handling host configuration with speech language set to zero.
+    """
+    g90 = G90Alarm(host=mock_device.host, port=mock_device.port)
+
+    # Retrieve configuration
+    cfg = await g90.host_config()
+    assert isinstance(cfg, G90HostConfig)
+
+    # Verify retrieved values
+    assert cfg.speech_language == G90SpeechLanguage.NONE
+
+    # Verify zero value is allowed to be sent back to the panel
+    await cfg.save()
+
+    assert await mock_device.recv_data == [
+        b'ISTART[106,106,""]IEND\0',
+        b'ISTART[107,107,[107,'
+        b'[900,0,0,1,2,2,60,0,0,60,2]'
+        b']]IEND\0'
+    ]

{pyg90alarm-2.5.1 → pyg90alarm-2.5.3}/tests/test_net_config.py

@@ -80,7 +80,7 @@ async def test_net_config(
 @pytest.mark.parametrize(
     'field_name,invalid_value_low,invalid_value_high,valid_value', [
         pytest.param(
-            'apn_name', '', 'a' * 101, 'valid.apn.net',
+            'apn_name', None, 'a' * 101, 'valid.apn.net',
             id='apn_name'
         ),
         pytest.param(
@@ -151,3 +151,97 @@ async def test_net_config_constraints(
     # Test setting valid value
     setattr(cfg, field_name, valid_value)
     assert getattr(cfg, field_name) == valid_value
+
+
+@pytest.mark.g90device(sent_data=[
+    b'ISTART[212,'
+    b'[0,"123456789",1,1,"","user","pwd",3,"54321"]'
+    b']IEND\0',
+    b'ISTARTIEND\0'
+])
+async def test_net_config_apn_name_empty(
+    mock_device: DeviceMock, caplog: pytest.LogCaptureFixture
+) -> None:
+    """
+    Tests for handling network configuration with empty APN name.
+    """
+    g90 = G90Alarm(host=mock_device.host, port=mock_device.port)
+
+    # Retrieve configuration
+    cfg = await g90.net_config()
+    assert isinstance(cfg, G90NetConfig)
+
+    # Verify retrieved values
+    assert cfg.apn_name == ''
+
+    # Ensure that no validation error was logged for empty APN name, the value
+    # of the field as received from the panel is trusted, so no exception will
+    # be raised only error logged
+    assert (
+        'apn_name: Validation failed during initialization for trusted value'
+    ) not in ''.join(caplog.messages)
+
+    # Verify empty APN name is allowed to be sent back to the panel
+    await cfg.save()
+
+    assert await mock_device.recv_data == [
+        b'ISTART[212,212,""]IEND\0',
+        b'ISTART[213,213,[213,'
+        b'[0,"123456789",1,1,"","user","pwd",3]'
+        b']]IEND\0'
+    ]
+
+
+@pytest.mark.parametrize('new_apn_auth_value,expected_recv_data', [
+    # Verify the invalid value is retained, since the panel is trusted, if no
+    # modifications to the value is made
+    pytest.param(
+        None, [
+            b'ISTART[212,212,""]IEND\0',
+            b'ISTART[213,213,[213,'
+            b'[0,"123456789",1,1,"","user","pwd",333]'
+            b']]IEND\0'
+        ], id='Device with invalid APN auth value unmodified'
+    ),
+    # Verify the invalid value is replaced with valid one when modified
+    pytest.param(
+        G90APNAuth.PAP, [
+            b'ISTART[212,212,""]IEND\0',
+            b'ISTART[213,213,[213,'
+            b'[0,"123456789",1,1,"","user","pwd",1]'
+            b']]IEND\0'
+        ], id='Device with invalid APN auth value modified to valid value'
+    ),
+])
+@pytest.mark.g90device(sent_data=[
+    b'ISTART[212,'
+    b'[0,"123456789",1,1,"","user","pwd",333,"54321"]'
+    b']IEND\0',
+    b'ISTARTIEND\0'
+])
+async def test_net_config_apn_auth_invalid(
+    new_apn_auth_value: Optional[G90APNAuth],
+    expected_recv_data: list[bytes],
+    mock_device: DeviceMock
+) -> None:
+    """
+    Tests for handling network configuration with invalid APN authentication
+    method value.
+    """
+    g90 = G90Alarm(host=mock_device.host, port=mock_device.port)
+
+    # Retrieve configuration
+    cfg = await g90.net_config()
+    assert isinstance(cfg, G90NetConfig)
+
+    # Verify retrieved value is mapped to NONE enum value
+    assert cfg.apn_auth == G90APNAuth.NONE
+
+    # Modify the value if requested
+    if new_apn_auth_value is not None:
+        cfg.apn_auth = new_apn_auth_value
+    # Save the configuration
+    await cfg.save()
+
+    # Verify data sent to the device
+    assert await mock_device.recv_data == expected_recv_data