Merge pull request #31 from rlippmann/1.1.0

1.1.0

Author: rlippmann

.gitignore

@@ -9,4 +9,4 @@ build
 __pycache__
 .mypy_cache
 *.swp
-
+.vscode/settings.json

.pre-commit-config.yaml

@@ -14,12 +14,12 @@ repos:
     hooks:
     -   id: pycln
         args: [--config=pyproject.toml]
-#-   repo: https://github.com/pycqa/isort
-#    rev: 5.12.0
-#    hooks:
-#    -   id: isort
-#        files: "\\.(py)$"
-#        args: [--settings-path=pyproject.toml]
+-   repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+    -   id: isort
+        files: "\\.(py)$"
+        args: [--settings-path=pyproject.toml]
 -   repo: https://github.com/dosisod/refurb
     rev: v1.15.0
     hooks:

.vscode/launch.json

@@ -19,8 +19,8 @@
             "module": "example-client",
             "justMyCode": true,
             "args": [
-                "/home/rlippmann/pulse.json"
+                "~/pulse.json"
             ]
         }
     ]
-}
+}

.vscode/settings.json

@@ -1,3 +1,4 @@
 {
-    "python.analysis.typeCheckingMode": "basic"
-}
+    "python.analysis.typeCheckingMode": "basic",
+    "python.terminal.activateEnvironment": true
+}

CHANGELOG.md

@@ -1,3 +1,15 @@
+## 1.1 (2023-09-20)
+
+* bug fixes
+* relogin support
+* device dataclasses
+
+## 1.0 (2023-03-28)
+
+* async support
+* background refresh
+* bug fixes
+
 ## 0.1.0 (2019-12-16)
 
 * added ability to override the ADT API host (example: Canada endpoint portal-ca.adtpulse.com)

README.md

@@ -78,6 +78,18 @@ for site in adt.sites:
     await site.async_arm_away(force=True)
 ```
 
+The pyadtpulse object runs background tasks and refreshes its data automatically.
+
+Certain parameters can be set to control how often certain actions are run.
+
+Namely:
+
+```python
+adt.poll_interval = 0.75  # check for updates every 0.75 seconds
+adt.relogin_interval = 60 # relogin every 60 minutes
+adt.keepalive_interval = 10 # run keepalive (prevent logout) every 10 minutes
+```
+
 See [example-client.py](example-client.py) for a working example.
 
 ## Browser Fingerprinting

example-client.json

@@ -6,5 +6,9 @@
   "debug_locks": false,
   "adtpulse_user": "me@myisp.com",
   "adtpulse_password": "supersecretpassword",
-  "adtpulse_fingerprint": "areallyreallyreallyreallyreallylongstring"
+  "adtpulse_fingerprint": "areallyreallyreallyreallyreallylongstring",
+  "service_host": "https://portal.adtpulse.com",
+  "relogin_interval": 60,
+  "keepalive_interval": 10,
+  "poll_interval": 0.9
 }