loqedAPI 2.1.14__tar.gz → 2.1.16__tar.gz

{loqedapi-2.1.14 → loqedapi-2.1.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: loqedAPI
-Version: 2.1.14
+Version: 2.1.16
 Summary: Python package to use the Loqed Smart Door Lock APIs in a local network. To be used by Home Assistant.
 Author-email: Casper Polhout <cpolhout@gmail.com>, Mike Woudenberg <mwoudenberg@xebia.com>
 License: BSD 2-Clause License
@@ -39,13 +39,14 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp<3.14,>=3.8
+Requires-Dist: aiohttp>=3.8
 Requires-Dist: async-timeout
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-asyncio; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: aioresponses; extra == "dev"
+Requires-Dist: aiohttp<3.14; extra == "dev"
 Dynamic: license-file
 
 # Loqed Touch Smart Lock — Python client
@@ -111,6 +112,12 @@ Notes:
 - The library is async-first and uses `aiohttp` for HTTP calls.
 - `APIClient` accepts `base_url` and an optional `token` (for authorization) or you can provide your own `aiohttp.ClientSession`.
 
+### Online status
+
+`Lock.online` is `True` when the lock is connected to the bridge. It is read from `lock_online` in the `/status` response (refreshed by `Lock.update()`) and kept current by `trigger_online_status` webhooks (bit 8, enabled by the default `registerWebhook` flags), which carry `ble_strength` (`-1` means not connected) and `wifi_strength`.
+
+While the lock is offline the bridge reports `battery_percentage` as `-1`, so check `lock.online` before using the battery value.
+
 ## Testing
 
 Run the test suite with pytest (the project uses `pytest-asyncio` and `aioresponses`).

{loqedapi-2.1.14 → loqedapi-2.1.16}/README.md

@@ -61,6 +61,12 @@ Notes:
 - The library is async-first and uses `aiohttp` for HTTP calls.
 - `APIClient` accepts `base_url` and an optional `token` (for authorization) or you can provide your own `aiohttp.ClientSession`.
 
+### Online status
+
+`Lock.online` is `True` when the lock is connected to the bridge. It is read from `lock_online` in the `/status` response (refreshed by `Lock.update()`) and kept current by `trigger_online_status` webhooks (bit 8, enabled by the default `registerWebhook` flags), which carry `ble_strength` (`-1` means not connected) and `wifi_strength`.
+
+While the lock is offline the bridge reports `battery_percentage` as `-1`, so check `lock.online` before using the battery value.
+
 ## Testing
 
 Run the test suite with pytest (the project uses `pytest-asyncio` and `aioresponses`).

{loqedapi-2.1.14 → loqedapi-2.1.16}/pyproject.toml

@@ -14,9 +14,7 @@ authors = [
 ]
 requires-python = ">=3.9"
 dependencies = [
-    # aioresponses 0.7.9 (latest) doesn't yet support aiohttp's ClientResponse
-    # signature change in 3.14.0 (new required `stream_writer` kwarg).
-    "aiohttp>=3.8,<3.14",
+    "aiohttp>=3.8",
     "async-timeout",
 ]
 classifiers = [
@@ -36,7 +34,11 @@ dev = [
     "pytest",
     "pytest-asyncio",
     "pytest-cov",
+    # aioresponses 0.7.9 (latest) doesn't yet support aiohttp's ClientResponse
+    # signature change in 3.14.0 (new required `stream_writer` kwarg), so the
+    # test suite is pinned below the runtime package's own aiohttp floor.
     "aioresponses",
+    "aiohttp<3.14",
 ]
 
 [tool.setuptools.packages.find]

{loqedapi-2.1.14 → loqedapi-2.1.16}/src/loqedAPI/loqed.py

@@ -103,6 +103,14 @@ class Lock:
         """Return the BLE strength of the lock."""
         return self.raw_data["ble_strength"]
 
+    @property
+    def online(self) -> bool:
+        """Return whether the lock is connected to the bridge."""
+        if "lock_online" in self.raw_data:
+            return bool(int(self.raw_data["lock_online"]))
+        # ble_strength of -1 means the lock is not connected to the bridge
+        return self.raw_data.get("ble_strength") != -1
+
     @property
     def battery_type(self) -> str:
         """Return the battery type of the lock."""
@@ -288,15 +296,30 @@ class Lock:
             }
             _LOGGER.error("ERROR: %s", error)
             return error
+        # ONLINE STATUS
+        if "wifi_strength" in data:
+            self.raw_data["wifi_strength"] = data["wifi_strength"]
+        if "ble_strength" in data:
+            self.raw_data["ble_strength"] = data["ble_strength"]
+            self.raw_data["lock_online"] = 0 if data["ble_strength"] == -1 else 1
+
         if "battery_percentage" in data:
             self.battery_percentage = data["battery_percentage"]
-        elif "ble_strength" in data:
-            self.raw_data["ble_strength"] = data["ble_strength"]
+            if "battery_type" in data:
+                self.raw_data["battery_type"] = data["battery_type"]
+            # The bridge reports -1 while the lock is offline, so a real battery
+            # reading is what tells us it has reconnected (no ble_strength is sent then)
+            if "ble_strength" not in data:
+                self.raw_data["lock_online"] = 0 if data["battery_percentage"] == -1 else 1
+        elif "ble_strength" in data or "wifi_strength" in data:
+            pass
         else:
             self.last_event = data["event_type"].strip().lower()
             # BOLT STATE CHANGE
             if self.last_event.split("_")[0] == "state":
                 self.bolt_state = str.replace(self.last_event, "state_changed_", "")
+                # The lock itself reported a state, so it is connected to the bridge
+                self.raw_data["lock_online"] = 1
             else:
                 # GOTO_STATE, only update the state if the target state is unequal to the current state
                 if "night_lock" in self.last_event and "night_lock" not in self.bolt_state:

{loqedapi-2.1.14 → loqedapi-2.1.16}/src/loqedAPI.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: loqedAPI
-Version: 2.1.14
+Version: 2.1.16
 Summary: Python package to use the Loqed Smart Door Lock APIs in a local network. To be used by Home Assistant.
 Author-email: Casper Polhout <cpolhout@gmail.com>, Mike Woudenberg <mwoudenberg@xebia.com>
 License: BSD 2-Clause License
@@ -39,13 +39,14 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: aiohttp<3.14,>=3.8
+Requires-Dist: aiohttp>=3.8
 Requires-Dist: async-timeout
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-asyncio; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
 Requires-Dist: aioresponses; extra == "dev"
+Requires-Dist: aiohttp<3.14; extra == "dev"
 Dynamic: license-file
 
 # Loqed Touch Smart Lock — Python client
@@ -111,6 +112,12 @@ Notes:
 - The library is async-first and uses `aiohttp` for HTTP calls.
 - `APIClient` accepts `base_url` and an optional `token` (for authorization) or you can provide your own `aiohttp.ClientSession`.
 
+### Online status
+
+`Lock.online` is `True` when the lock is connected to the bridge. It is read from `lock_online` in the `/status` response (refreshed by `Lock.update()`) and kept current by `trigger_online_status` webhooks (bit 8, enabled by the default `registerWebhook` flags), which carry `ble_strength` (`-1` means not connected) and `wifi_strength`.
+
+While the lock is offline the bridge reports `battery_percentage` as `-1`, so check `lock.online` before using the battery value.
+
 ## Testing
 
 Run the test suite with pytest (the project uses `pytest-asyncio` and `aioresponses`).

{loqedapi-2.1.14 → loqedapi-2.1.16}/src/loqedAPI.egg-info/requires.txt

@@ -1,4 +1,4 @@
-aiohttp<3.14,>=3.8
+aiohttp>=3.8
 async-timeout
 
 [dev]
@@ -6,3 +6,4 @@ pytest
 pytest-asyncio
 pytest-cov
 aioresponses
+aiohttp<3.14

loqedapi-2.1.16/src/loqedAPI.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "2.1.16",
+  "distance": 0,
+  "node": "gd3a4d284d737b09782775ec779704e30b360bf68",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-09-30"
+}

{loqedapi-2.1.14 → loqedapi-2.1.16}/tests/test_loqed.py

@@ -28,6 +28,7 @@ def raw_data():
         "wifi_strength": "good",
         "ble_strength": "strong",
         "battery_voltage": "3.7",
+        "lock_online": 1,
     }
 
 @pytest_asyncio.fixture
@@ -79,6 +80,7 @@ async def test_lock_properties_and_commands(lock):
     assert lock.id == "lockid"
     assert lock.wifi_strength == "good"
     assert lock.ble_strength == "strong"
+    assert lock.online is True
 
 
 @pytest.mark.asyncio
@@ -167,6 +169,90 @@ async def test_receive_webhook_ble_strength(lock, valid_base64):
     assert lock.raw_data["ble_strength"] == "weak"
 
 
+@pytest.mark.asyncio
+async def test_online_falls_back_to_ble_strength(lock):
+    del lock.raw_data["lock_online"]
+    lock.raw_data["ble_strength"] = -1
+    assert lock.online is False
+    lock.raw_data["ble_strength"] = -60
+    assert lock.online is True
+
+
+@pytest.mark.asyncio
+async def test_update_offline(lock, raw_data):
+    with aioresponses() as m:
+        offline = {**raw_data, "lock_online": 0, "battery_percentage": -1}
+        m.get(f"{lock.apiclient.host}/status", payload=offline, status=200, headers={"Content-Type": "text/html"})
+        await lock.update()
+    assert lock.online is False
+
+
+@pytest.mark.asyncio
+async def test_receive_webhook_online_status(lock, valid_base64):
+    timestamp = int(time.time())
+
+    body = '{"ble_strength": -1, "wifi_strength": -50}'
+    await lock.receiveWebhook(body, compute_webhook_hash(body, timestamp, valid_base64), str(timestamp))
+    assert lock.online is False
+    assert lock.raw_data["wifi_strength"] == -50
+
+    body = '{"ble_strength": -60, "wifi_strength": -48}'
+    await lock.receiveWebhook(body, compute_webhook_hash(body, timestamp, valid_base64), str(timestamp))
+    assert lock.online is True
+    assert lock.ble_strength == -60
+
+
+@pytest.mark.asyncio
+async def test_receive_webhook_offline_then_reconnect(lock, valid_base64):
+    """Payloads captured from a real bridge when the battery was removed and re-inserted."""
+    timestamp = int(time.time())
+
+    body = '{"wifi_strength":51,"ble_strength":-1,"mac_wifi":"AA:BB:CC:00:00:01","mac_ble":"AA:BB:CC:00:00:02"}'
+    await lock.receiveWebhook(body, compute_webhook_hash(body, timestamp, valid_base64), str(timestamp))
+    assert lock.online is False
+
+    body = '{"battery_type":"NICKEL_METAL_HYDRIDE","battery_percentage":91,"mac_wifi":"AA:BB:CC:00:00:01","mac_ble":"AA:BB:CC:00:00:02"}'
+    await lock.receiveWebhook(body, compute_webhook_hash(body, timestamp, valid_base64), str(timestamp))
+    assert lock.online is True
+    assert lock.battery_percentage == 91
+    assert lock.battery_type == "NICKEL_METAL_HYDRIDE"
+
+
+@pytest.mark.asyncio
+async def test_receive_webhook_state_change_marks_online(lock, valid_base64):
+    lock.raw_data["lock_online"] = 0
+    body = '{"key_local_id": 3, "event_type": "STATE_CHANGED_NIGHT_LOCK"}'
+    timestamp = int(time.time())
+    await lock.receiveWebhook(body, compute_webhook_hash(body, timestamp, valid_base64), str(timestamp))
+    assert lock.online is True
+
+
+@pytest.mark.asyncio
+async def test_receive_webhook_goto_state_does_not_mark_online(lock, valid_base64):
+    lock.raw_data["lock_online"] = 0
+    body = '{"key_local_id": 4, "event_type": "GOTO_STATE_NIGHT_LOCK"}'
+    timestamp = int(time.time())
+    await lock.receiveWebhook(body, compute_webhook_hash(body, timestamp, valid_base64), str(timestamp))
+    assert lock.online is False
+
+
+@pytest.mark.asyncio
+async def test_receive_webhook_battery_offline_marker(lock, valid_base64):
+    body = '{"battery_percentage": -1}'
+    timestamp = int(time.time())
+    await lock.receiveWebhook(body, compute_webhook_hash(body, timestamp, valid_base64), str(timestamp))
+    assert lock.online is False
+
+
+@pytest.mark.asyncio
+async def test_receive_webhook_battery_and_ble_strength(lock, valid_base64):
+    body = '{"battery_percentage": 70, "ble_strength": -1}'
+    timestamp = int(time.time())
+    await lock.receiveWebhook(body, compute_webhook_hash(body, timestamp, valid_base64), str(timestamp))
+    assert lock.battery_percentage == 70
+    assert lock.online is False
+
+
 @pytest.mark.asyncio
 async def test_receive_webhook_bolt_state_change(lock, valid_base64):
     body = '{"key_local_id": 3, "event_type": "STATE_CHANGED_NIGHT_LOCK"}'

{loqedapi-2.1.14 → loqedapi-2.1.16}/uv.lock

@@ -680,6 +680,7 @@ dependencies = [
 
 [package.optional-dependencies]
 dev = [
+    { name = "aiohttp" },
     { name = "aioresponses" },
     { name = "pytest", version = "8.4.2", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version < '3.10'" },
     { name = "pytest", version = "9.1.1", source = { registry = "https://pypi.org/simple" }, marker = "python_full_version >= '3.10'" },
@@ -690,7 +691,8 @@ dev = [
 
 [package.metadata]
 requires-dist = [
-    { name = "aiohttp", specifier = ">=3.8,<3.14" },
+    { name = "aiohttp", specifier = ">=3.8" },
+    { name = "aiohttp", marker = "extra == 'dev'", specifier = "<3.14" },
     { name = "aioresponses", marker = "extra == 'dev'" },
     { name = "async-timeout" },
     { name = "pytest", marker = "extra == 'dev'" },

loqedapi-2.1.14/src/loqedAPI.egg-info/scm_version.json

@@ -1,8 +0,0 @@
-{
-  "tag": "2.1.14",
-  "distance": 0,
-  "node": "gdec8ab9a01e406d877f09f9e57ad80c79316d029",
-  "dirty": false,
-  "branch": "HEAD",
-  "node_date": "2026-09-17"
-}