pyg90alarm 2.5.2__tar.gz → 2.6.0__tar.gz

pyg90alarm-2.6.0/.github/workflows/release.yaml

@@ -0,0 +1,45 @@
+---
+name: Release
+
+on:  # yamllint disable rule:truthy
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+      - main
+
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+
+jobs:
+  release:
+    name: Release with semantic-release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code (SSH)
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          ssh-key: ${{ secrets.DEPLOY_KEY }}
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: '24'
+          cache: 'npm'
+          cache-dependency-path: '**/.github/workflows/*.yaml'
+
+      - name: Run semantic-release
+        env:
+          GIT_AUTHOR_NAME: "github-actions[bot]"
+          GIT_AUTHOR_EMAIL: "github-actions[bot]@users.noreply.github.com"
+          GIT_COMMITTER_NAME: "github-actions[bot]"
+          GIT_COMMITTER_EMAIL: "github-actions[bot]@users.noreply.github.com"
+          GITHUB_TOKEN: ${{ github.token }}
+        run: |
+          npx -y \
+            -p semantic-release@25.0.2 \
+            -p conventional-changelog-conventionalcommits@9.1.0 \
+            semantic-release

{pyg90alarm-2.5.2 → pyg90alarm-2.6.0}/MANIFEST.in

@@ -12,3 +12,4 @@ include setup.py
 recursive-include src *.py py.typed
 
 exclude requirements_dev.txt
+exclude .releaserc.yaml

{pyg90alarm-2.5.2 → pyg90alarm-2.6.0}/PKG-INFO

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

{pyg90alarm-2.5.2 → pyg90alarm-2.6.0}/src/pyg90alarm/__init__.py

@@ -33,7 +33,8 @@ from .entities.sensor import (
 )
 from .entities.device import G90Device
 from .local.host_info import (
-    G90HostInfo, G90HostInfoWifiStatus, G90HostInfoGsmStatus
+    G90HostInfo, G90HostInfoWifiStatus, G90HostInfoGsmStatus,
+    G90HostInfoWifiSetupProgress,
 )
 from .definitions.sensors import (
     G90SensorDefinitions
@@ -81,7 +82,7 @@ __all__ = [
     'G90Device',
     # Panel information and status
     'G90HostInfo', 'G90HostInfoWifiStatus', 'G90HostInfoGsmStatus',
-    'G90HostStatus',
+    'G90HostStatus', 'G90HostInfoWifiSetupProgress',
     # Types for alerts and notifications
     'G90MessageTypes', 'G90NotificationTypes', 'G90ArmDisarmTypes',
     'G90AlertTypes', 'G90AlertSources', 'G90AlertStates',

{pyg90alarm-2.5.2 → pyg90alarm-2.6.0}/src/pyg90alarm/local/host_info.py

@@ -43,10 +43,23 @@ class G90HostInfoWifiStatus(IntEnum):
     """
     POWERED_OFF = 0
     NOT_CONNECTED = 1
-    NO_SIGNAL = 2
+    SERVER_NOT_CONNECTED = 2
     OPERATIONAL = 3
 
 
+class G90HostInfoWifiSetupProgress(IntEnum):
+    """
+    Defines possible values of Wifi connection progress.
+    """
+    IDLE = 0
+    CONNECTING = 1
+    OK = 2
+    WRONG_SSID = 3
+    WRONG_PASSWORD = 4
+    CONNECTION_ERROR = 5
+    WIFI_ERROR = 6
+
+
 @dataclass
 class G90HostInfo:  # pylint: disable=too-many-instance-attributes
     """
@@ -60,11 +73,11 @@ class G90HostInfo:  # pylint: disable=too-many-instance-attributes
     wifi_hw_version: str
     gsm_status_data: int
     wifi_status_data: int
-    reserved1: int
-    reserved2: int
-    band_frequency: str
-    gsm_signal_level: int
-    wifi_signal_level: int
+    gprs_3g_active_data: int
+    wifi_setup_progress_data: int
+    battery_voltage: str  # in mV
+    gsm_signal_level: int  # percentage 0-100
+    wifi_signal_level: int  # percentage 0-100
 
     @property
     def gsm_status(self) -> G90HostInfoGsmStatus:
@@ -82,6 +95,21 @@ class G90HostInfo:  # pylint: disable=too-many-instance-attributes
         """
         return G90HostInfoWifiStatus(self.wifi_status_data)
 
+    @property
+    def wifi_setup_progress(self) -> G90HostInfoWifiSetupProgress:
+        """
+        Translates the Wifi connection progress received from the device into
+        corresponding enum.
+        """
+        return G90HostInfoWifiSetupProgress(self.wifi_setup_progress_data)
+
+    @property
+    def gprs_3g_active(self) -> bool:
+        """
+        Indicates whether GPRS/3G is enabled.
+        """
+        return bool(self.gprs_3g_active_data)
+
     def _asdict(self) -> Dict[str, Any]:
         """
         Returns the host information as dictionary.

{pyg90alarm-2.5.2 → pyg90alarm-2.6.0}/src/pyg90alarm/local/net_config.py

@@ -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.2 → pyg90alarm-2.6.0}/src/pyg90alarm.egg-info/PKG-INFO

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

{pyg90alarm-2.5.2 → pyg90alarm-2.6.0}/src/pyg90alarm.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ tox.ini
 .github/CODEOWNERS
 .github/dependabot.yml
 .github/workflows/main.yml
+.github/workflows/release.yaml
 docs/.DS_Store
 docs/.gitignore
 docs/api-docs.rst

{pyg90alarm-2.5.2 → pyg90alarm-2.6.0}/tests/test_alarm.py

@@ -11,6 +11,7 @@ from pyg90alarm.alarm import (
 )
 from pyg90alarm.local.host_info import (
     G90HostInfo, G90HostInfoGsmStatus, G90HostInfoWifiStatus,
+    G90HostInfoWifiSetupProgress,
 )
 from pyg90alarm.local.host_status import (
     G90HostStatus,
@@ -63,6 +64,12 @@ async def test_host_info(mock_device: DeviceMock) -> None:
     assert res.product_name == 'DUMMYPRODUCT'
     assert res.gsm_status == G90HostInfoGsmStatus.OPERATIONAL
     assert res.wifi_status == G90HostInfoWifiStatus.OPERATIONAL
+    assert res.wifi_setup_progress == G90HostInfoWifiSetupProgress.OK
+    assert res.gprs_3g_active is False
+    assert res.battery_voltage == '4242'
+    assert res.gsm_signal_level == 50
+    assert res.wifi_signal_level == 100
+
     assert isinstance(res._asdict(), dict)
 
 

{pyg90alarm-2.5.2 → pyg90alarm-2.6.0}/tests/test_net_config.py

@@ -190,3 +190,58 @@ async def test_net_config_apn_name_empty(
         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