asf02 0.1.0__tar.gz

asf02-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

asf02-0.1.0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: asf02
+Version: 0.1.0
+Summary: Python client for Lulumiao pet slow feeders (OEM ASF02 / CWH01L-A1, BLE JSON-RPC)
+Author: cptskippy, AgentCarlBrutananadilewski
+License-Expression: Apache-2.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Home Automation
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Hardware
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: bleak>=0.22
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Dynamic: license-file
+
+# asf02
+
+Lulumiao pet slow feeders can only be managed via an App that has since been 
+delisted from the Google Play store. Without the App, owners cannot update
+feed schedules or synchronize the feeder clock which is prone to drift.  This
+library allows you to once again manage your slow feeder and save it from 
+the landfill.
+
+Python client library for managing **Lulumiao pet slow feeders** over BLE.
+The protocol was reverse-engineered from the vendor Android app and
+**verified to work with devices having v1.19.12 firmware**.
+
+The feeder speaks a small JSON-RPC dialect over two GATT characteristics. 
+This library wraps the whole conversation — discovery, pairing, unlock, 
+schedule management, on-demand feeding, and status — behind a tiny async 
+API. Built on [`bleak`](https://github.com/hbldh/bleak); no other runtime 
+dependencies.
+
+## Product Details
+| | |
+|---|---|
+| Brand | Lulumiao |
+| Device | Pet slow feeder |
+| Manufacturer | Hong Kong M Spacer Limited |
+| Model | CWH01L-A1 (OEM model `ASF02`, per `info` and BLE advertising) |
+| FCC ID | [2A9QN-CWH01L-A1](https://fccid.io/2A9QN-CWH01L-A1) |
+
+## Product Images
+![Lulumiao pet slow feeder](slowfeeder.png "Lulumiao pet slow feeder")
+
+## Install
+
+### From a local repo checkout
+```bash
+pip install -e ".[dev]"  # includes pytest
+```
+
+### From GitHub
+```bash
+pip install git+https://github.com/cptskippy/asf02.git
+```
+
+### From PyPI
+```bash
+pip install asf02
+```
+
+## Quick start
+
+```python
+import asyncio
+from asf02 import ASF02Client
+
+async def main():
+    async with ASF02Client("<DEVICE_MAC>", token="<BIND_TOKEN>") as feeder:
+        await feeder.unlock()                 # required on every connect
+        await feeder.sync_time(-25200)        # PDT w/DST in seconds
+        info = await feeder.info()            # {'f': '1.19.12', 'm': 'ASF02', ...}
+        status = await feeder.status()        # {'n': 1065, 'b': 458, ...}
+        await feeder.feed(1)                  # dispense 1 portion now
+        await feeder.set_schedule([(15, 30, 1), (16, 0, 1)])
+
+asyncio.run(main())
+```
+
+## Discovery
+
+```python
+from asf02 import discover_feeders
+
+async def main():
+    for f in await discover_feeders(timeout=10):
+        print(f.address, f.model, f.rssi)
+```
+
+Feeders advertise continuously: local name `ASF02-<last6 of MAC>` plus
+manufacturer data (company `0xFFFF`) starting `02 03`, with the MAC embedded.
+
+
+## Pairing / tokens
+
+- Generate a token: `ASF02Client.new_token()` (10 chars, same charset as the vendor app).
+- Keep the token with your device config. The unlock code is always derived
+  from it (`md5("0000:"+token)` — see `unlock_code_for`).
+- Store it in the device: `await feeder.bind(token)`. **Re-binding overwrites**
+  the previous token — the old one stops working.
+
+## Schedules
+
+- The device stores a **fixed 10-slot array**; `set_schedule` replaces it.
+- Entries are `(hour, minute, portion)` or `(hour, minute, portion, enabled)`.
+- `set_schedule([])` (or `clear=True`) wipes the schedule.
+- **Time fields are hex on the wire** — the library handles this, but know it:
+  `0012000200` is 18:00, not 12:00.
+- The **write response** is the authoritative confirmation (some firmware
+  builds answer schedule *reads* with stale/empty data).
+
+## Behavior notes (learned from the hardware)
+
+- The device **locks across every (re)connect** — call `unlock()` each time
+  (or use `connect_unlocked()`). Only `info` works while locked.
+- `time.calibration` takes **epoch seconds** + tz offset in **seconds**
+  (incl. DST; e.g. −25200 for PDT — same convention the vendor app uses).
+  Always re-sync on connect; schedules run on the device clock.
+- `feeder.log` may return **no notification at all** — `get_log()` returns
+  `None` in that case instead of erroring.
+- No MTU negotiation needed for any documented command (the link carries the
+  full 79-byte responses fine).
+- Transient connections are fine: connect → work → disconnect. The feeders
+  run autonomously between visits.
+- The feeder clock drifts over time and freezes entirely while unpowered.
+  Sync it (`sync_time()`) semi-regularly — and on every reconnect if you
+  want schedules to stay on time — since the schedule runs on the device
+  clock, not yours.
+
+## API Status
+
+| Method | Status |
+|---|---|
+| `info` | ✅ Working |
+| `bind` | ✅ Working |
+| `unlock` | ✅ Working |
+| `time.calibration` | ✅ Working |
+| `feeder.status` | ✅ Working |
+| `feeder.feed` | ✅ Working |
+| `feeder.stop` | ✅ Working |
+| `feeder.plan` (read) | ⚠️ No result on v1.19.12 firmware |
+| `feeder.plan` (write) | ✅ Working |
+| `feeder.log` | ⚠️ No result on v1.19.12 firmware |
+
+**IMPORTANT NOTE:** While `feeder.plan` (read) and `feeder.log` are defined, the 
+v1.19.12 firmware appears to have a bug and it will always return `null`.  It 
+is advised to retain a copy of any plan sent the feeder as you may not be 
+able to retrieve it in the future.
+
+## Project layout
+
+```
+asf02/
+  protocol.py    pure codecs + constants (unit-testable, no I/O)
+  client.py      async device client (bleak)
+  discovery.py   scanner
+examples/cli.py  demo CLI (run on a machine with Bluetooth)
+tests/           unit tests anchored to real captured wire traffic
+```
+
+## Publishing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for how releases are cut and how
+PyPI publishing is configured.
+
+## License
+
+Apache-2.0

asf02-0.1.0/README.md

@@ -0,0 +1,154 @@
+# asf02
+
+Lulumiao pet slow feeders can only be managed via an App that has since been 
+delisted from the Google Play store. Without the App, owners cannot update
+feed schedules or synchronize the feeder clock which is prone to drift.  This
+library allows you to once again manage your slow feeder and save it from 
+the landfill.
+
+Python client library for managing **Lulumiao pet slow feeders** over BLE.
+The protocol was reverse-engineered from the vendor Android app and
+**verified to work with devices having v1.19.12 firmware**.
+
+The feeder speaks a small JSON-RPC dialect over two GATT characteristics. 
+This library wraps the whole conversation — discovery, pairing, unlock, 
+schedule management, on-demand feeding, and status — behind a tiny async 
+API. Built on [`bleak`](https://github.com/hbldh/bleak); no other runtime 
+dependencies.
+
+## Product Details
+| | |
+|---|---|
+| Brand | Lulumiao |
+| Device | Pet slow feeder |
+| Manufacturer | Hong Kong M Spacer Limited |
+| Model | CWH01L-A1 (OEM model `ASF02`, per `info` and BLE advertising) |
+| FCC ID | [2A9QN-CWH01L-A1](https://fccid.io/2A9QN-CWH01L-A1) |
+
+## Product Images
+![Lulumiao pet slow feeder](slowfeeder.png "Lulumiao pet slow feeder")
+
+## Install
+
+### From a local repo checkout
+```bash
+pip install -e ".[dev]"  # includes pytest
+```
+
+### From GitHub
+```bash
+pip install git+https://github.com/cptskippy/asf02.git
+```
+
+### From PyPI
+```bash
+pip install asf02
+```
+
+## Quick start
+
+```python
+import asyncio
+from asf02 import ASF02Client
+
+async def main():
+    async with ASF02Client("<DEVICE_MAC>", token="<BIND_TOKEN>") as feeder:
+        await feeder.unlock()                 # required on every connect
+        await feeder.sync_time(-25200)        # PDT w/DST in seconds
+        info = await feeder.info()            # {'f': '1.19.12', 'm': 'ASF02', ...}
+        status = await feeder.status()        # {'n': 1065, 'b': 458, ...}
+        await feeder.feed(1)                  # dispense 1 portion now
+        await feeder.set_schedule([(15, 30, 1), (16, 0, 1)])
+
+asyncio.run(main())
+```
+
+## Discovery
+
+```python
+from asf02 import discover_feeders
+
+async def main():
+    for f in await discover_feeders(timeout=10):
+        print(f.address, f.model, f.rssi)
+```
+
+Feeders advertise continuously: local name `ASF02-<last6 of MAC>` plus
+manufacturer data (company `0xFFFF`) starting `02 03`, with the MAC embedded.
+
+
+## Pairing / tokens
+
+- Generate a token: `ASF02Client.new_token()` (10 chars, same charset as the vendor app).
+- Keep the token with your device config. The unlock code is always derived
+  from it (`md5("0000:"+token)` — see `unlock_code_for`).
+- Store it in the device: `await feeder.bind(token)`. **Re-binding overwrites**
+  the previous token — the old one stops working.
+
+## Schedules
+
+- The device stores a **fixed 10-slot array**; `set_schedule` replaces it.
+- Entries are `(hour, minute, portion)` or `(hour, minute, portion, enabled)`.
+- `set_schedule([])` (or `clear=True`) wipes the schedule.
+- **Time fields are hex on the wire** — the library handles this, but know it:
+  `0012000200` is 18:00, not 12:00.
+- The **write response** is the authoritative confirmation (some firmware
+  builds answer schedule *reads* with stale/empty data).
+
+## Behavior notes (learned from the hardware)
+
+- The device **locks across every (re)connect** — call `unlock()` each time
+  (or use `connect_unlocked()`). Only `info` works while locked.
+- `time.calibration` takes **epoch seconds** + tz offset in **seconds**
+  (incl. DST; e.g. −25200 for PDT — same convention the vendor app uses).
+  Always re-sync on connect; schedules run on the device clock.
+- `feeder.log` may return **no notification at all** — `get_log()` returns
+  `None` in that case instead of erroring.
+- No MTU negotiation needed for any documented command (the link carries the
+  full 79-byte responses fine).
+- Transient connections are fine: connect → work → disconnect. The feeders
+  run autonomously between visits.
+- The feeder clock drifts over time and freezes entirely while unpowered.
+  Sync it (`sync_time()`) semi-regularly — and on every reconnect if you
+  want schedules to stay on time — since the schedule runs on the device
+  clock, not yours.
+
+## API Status
+
+| Method | Status |
+|---|---|
+| `info` | ✅ Working |
+| `bind` | ✅ Working |
+| `unlock` | ✅ Working |
+| `time.calibration` | ✅ Working |
+| `feeder.status` | ✅ Working |
+| `feeder.feed` | ✅ Working |
+| `feeder.stop` | ✅ Working |
+| `feeder.plan` (read) | ⚠️ No result on v1.19.12 firmware |
+| `feeder.plan` (write) | ✅ Working |
+| `feeder.log` | ⚠️ No result on v1.19.12 firmware |
+
+**IMPORTANT NOTE:** While `feeder.plan` (read) and `feeder.log` are defined, the 
+v1.19.12 firmware appears to have a bug and it will always return `null`.  It 
+is advised to retain a copy of any plan sent the feeder as you may not be 
+able to retrieve it in the future.
+
+## Project layout
+
+```
+asf02/
+  protocol.py    pure codecs + constants (unit-testable, no I/O)
+  client.py      async device client (bleak)
+  discovery.py   scanner
+examples/cli.py  demo CLI (run on a machine with Bluetooth)
+tests/           unit tests anchored to real captured wire traffic
+```
+
+## Publishing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for how releases are cut and how
+PyPI publishing is configured.
+
+## License
+
+Apache-2.0

asf02-0.1.0/asf02/__init__.py

@@ -0,0 +1,45 @@
+"""ASF02 — Python client library for Lulumiao pet slow feeders (OEM model ASF02, sold as CWH01L-A1; BLE JSON-RPC).
+
+Talks the JSON-RPC-over-GATT protocol used by the ASF02 pet feeder family:
+connect, bind/unlock, schedule management, on-demand feeding, and status.
+
+Requires `bleak` for BLE. No other runtime dependencies.
+"""
+from asf02.client import ASF02Client, ASF02Error, ASF02ProtocolError, ASF02LockedError
+from asf02.protocol import (
+    SERVICE_UUID,
+    WRITE_CHAR_UUID,
+    NOTIFY_CHAR_UUID,
+    decode_advertisement,
+    encode_plan_entry,
+    decode_plan_entry,
+    plan_entry_valid,
+    unlock_code_for,
+    generate_token,
+    decode_plan_slot,
+    is_clear_marker,
+    PlanEntry,
+)
+from asf02.discovery import discover_feeders
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "ASF02Client",
+    "ASF02Error",
+    "ASF02ProtocolError",
+    "ASF02LockedError",
+    "SERVICE_UUID",
+    "WRITE_CHAR_UUID",
+    "NOTIFY_CHAR_UUID",
+    "decode_advertisement",
+    "encode_plan_entry",
+    "decode_plan_entry",
+    "decode_plan_slot",
+    "plan_entry_valid",
+    "is_clear_marker",
+    "unlock_code_for",
+    "generate_token",
+    "PlanEntry",
+    "discover_feeders",
+]