Merge pull request #32 from rlippmann:master

pyadtpulse 1.1.1

Author: rlippmann

.pre-commit-config.yaml

@@ -5,12 +5,12 @@ repos:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
 -   repo: https://github.com/psf/black
-    rev: 23.3.0
+    rev: 23.9.1
     hooks:
     -   id: black
         args: [--config=pyproject.toml]
 -   repo: https://github.com/hadialqattan/pycln
-    rev: v2.1.3
+    rev: v2.2.2
     hooks:
     -   id: pycln
         args: [--config=pyproject.toml]
@@ -21,10 +21,10 @@ repos:
         files: "\\.(py)$"
         args: [--settings-path=pyproject.toml]
 -   repo: https://github.com/dosisod/refurb
-    rev: v1.15.0
+    rev: v1.21.0
     hooks:
       - id: refurb
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v3.3.1
+    rev: v3.13.0
     hooks:
     -   id: pyupgrade

CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.1.1 (2023-10-02)
+
+* pylint fixes
+* set min relogin interval
+* set max keepalive interval
+* remove poll_interval from pyADTPulse constructor
+* expose public methods in ADTPulseConnection object
+
 ## 1.1 (2023-09-20)
 
 * bug fixes

example-client.py

@@ -200,7 +200,7 @@ def load_parameters_from_json(json_file: str) -> Optional[Dict]:
                         or None if there was an error.
     """
     try:
-        with open(json_file) as file:
+        with open(json_file, encoding="utf-8") as file:
             parameters = json.load(file)
             invalid_keys = []
             for key, value in parameters.items():
@@ -253,7 +253,7 @@ def print_site(site: ADTPulseSite) -> None:
     pprint(site.gateway, compact=True)
 
 
-def check_updates(site: ADTPulseSite, adt: PyADTPulse, test_alarm: bool) -> bool:
+def check_updates(site: ADTPulseSite, adt: PyADTPulse, run_alarm_test: bool) -> bool:
     """Check a site for updates and print details.
 
     We don't really need to do this anymore, as the data will be
@@ -266,7 +266,7 @@ def check_updates(site: ADTPulseSite, adt: PyADTPulse, test_alarm: bool) -> bool
 
         Returns: bool: True if update successful
     """
-    if test_alarm:
+    if run_alarm_test:
         while (
             site.alarm_control_panel.is_arming or site.alarm_control_panel.is_disarming
         ):
@@ -283,7 +283,7 @@ def check_updates(site: ADTPulseSite, adt: PyADTPulse, test_alarm: bool) -> bool
     return False
 
 
-def test_alarm(site: ADTPulseSite, adt: PyADTPulse, sleep_interval: int) -> None:
+def test_alarm(site: ADTPulseSite, adt: PyADTPulse) -> None:
     """Test alarm functions.
 
     Args:
@@ -363,7 +363,6 @@ def sync_example(
         run_alarm_test (bool): True if alarm test to be run
         sleep_interval (int): how long in seconds to sleep between update checks
         debug_locks: bool: True to enable thread lock debugging
-        poll_interval (float): polling interval in seconds
         keepalive_interval (int): keepalive interval in minutes
         relogin_interval (int): relogin interval in minutes
     """
@@ -373,7 +372,6 @@ def sync_example(
             password,
             fingerprint,
             debug_locks=debug_locks,
-            poll_interval=poll_interval,
             keepalive_interval=keepalive_interval,
             relogin_interval=relogin_interval,
         )
@@ -401,11 +399,11 @@ def sync_example(
         adt.site.site_lock.release()
         adt.logout()
         return
-
+    adt.site.gateway.poll_interval = poll_interval
     pprint(adt.site.zones, compact=True)
     adt.site.site_lock.release()
     if run_alarm_test:
-        test_alarm(adt.site, adt, sleep_interval)
+        test_alarm(adt.site, adt)
 
     done = False
     while not done:
@@ -526,7 +524,6 @@ async def async_example(
         fingerprint,
         do_login=False,
         debug_locks=debug_locks,
-        poll_interval=poll_interval,
         keepalive_interval=keepalive_interval,
         relogin_interval=relogin_interval,
     )
@@ -549,7 +546,7 @@ async def async_example(
         print("Error: no zones exist")
         await adt.async_logout()
         return
-
+    adt.site.gateway.poll_interval = poll_interval
     pprint(adt.site.zones, compact=True)
     if run_alarm_test:
         await async_test_alarm(adt)