asf02 0.1.0__py3-none-any.whl

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",
+]

asf02/client.py

@@ -0,0 +1,311 @@
+"""ASF02 device client: connect, unlock, and the JSON-RPC command set.
+
+Built on `bleak`. All command methods are transient-connection friendly:
+connect, do the work, disconnect — the feeders run autonomously between
+visits (mirrors the vendor app's usage pattern).
+
+Key protocol behaviors (live-verified against a real unit):
+- The device is locked across every (re)connect; only ``info`` works while
+  locked. ``connect_unlocked()`` performs the unlock dance.
+- ``time.calibration`` takes epoch SECONDS and a tz offset in SECONDS
+  (e.g. -25200 for PDT, DST included).
+- Plan writes must use the full 10-slot array form; the write *response* is
+  the authoritative confirmation (reads are unreliable on some firmware).
+- ``feeder.plan`` reads require a ``p`` field (e.g. ``""``); omitting it
+  yields device silence.
+- ``feeder.log`` may return no notification at all — callers get ``None``.
+"""
+from __future__ import annotations
+
+import asyncio
+import contextlib
+import json
+import time
+from typing import Any, Iterable, Sequence
+
+from bleak import BleakClient
+
+from .protocol import (
+    ASF02Error,
+    CCCD_UUID,
+    NOTIFY_CHAR_UUID,
+    SERVICE_UUID,
+    WRITE_CHAR_UUID,
+    decode_plan_slot,
+    encode_request,
+    generate_token,
+    parse_response,
+    unlock_code_for,
+)
+
+
+class ASF02ProtocolError(ASF02Error):
+    """Local protocol violation (bad frame shape, missing service, ...)."""
+
+
+class ASF02LockedError(ASF02Error):
+    """The device refused a command because it is locked (code -31400)."""
+
+
+def _wrap_errors(e: Exception) -> Exception:
+    if isinstance(e, ASF02Error):
+        if e.code == -31400:
+            return ASF02LockedError(e.code, e.message)
+        return e
+    return e
+
+
+class ASF02Client:
+    """A single ASF02 feeder.
+
+    Example:
+        async with ASF02Client("<DEVICE_MAC>", token="<BIND_TOKEN>") as f:
+            info = await f.info()
+            await f.sync_time(tz_offset_seconds=-25200)
+            schedule = await f.get_schedule()
+            await f.set_schedule([(15, 30, 1), (16, 0, 1)])
+            await f.feed(1)
+    """
+
+    def __init__(self, address: str, token: str, *, response_timeout: float = 10.0,
+                 post_connect_delay: float = 1.0):
+        self.address = address
+        self.token = token
+        self.response_timeout = response_timeout
+        self.post_connect_delay = post_connect_delay
+        self._client: BleakClient | None = None
+        self._req_id = 0
+        self._pending: dict[int, asyncio.Future] = {}
+        self._unlocked = False
+
+    # ------------------------------------------------------------------
+    # Connection lifecycle
+    # ------------------------------------------------------------------
+    async def __aenter__(self) -> "ASF02Client":
+        await self.connect()
+        return self
+
+    async def __aexit__(self, *exc) -> None:
+        await self.disconnect()
+
+    async def connect(self) -> None:
+        """Connect and enable notifications. Device is locked until unlock()."""
+        if self._client is not None:
+            return
+        client = BleakClient(self.address, timeout=20)
+        await client.connect()
+        await client.start_notify(NOTIFY_CHAR_UUID, self._on_notify)
+        # Give the controller a moment before the first command (matches the
+        # vendor app's connect-then-poll behavior and avoids early drops).
+        if self.post_connect_delay:
+            await asyncio.sleep(self.post_connect_delay)
+        self._client = client
+
+    async def disconnect(self) -> None:
+        client, self._client = self._client, None
+        self._unlocked = False
+        for fut in self._pending.values():
+            if not fut.done():
+                fut.cancel()
+        self._pending.clear()
+        if client is not None:
+            with contextlib.suppress(Exception):
+                await client.disconnect()
+
+    async def unlock(self) -> dict:
+        """Unlock the device using the configured token. Returns the device's
+        unlock result dict (contains device time ``t``, tz ``z``, ``l``, ``k``)."""
+        if self._client is None:
+            raise ASF02ProtocolError(0, "not connected")
+        result = await self._request("unlock", {"s": unlock_code_for(self.token)})
+        self._unlocked = True
+        return result
+
+    async def connect_unlocked(self) -> dict:
+        """connect() + unlock() in one step (the usual entry point)."""
+        await self.connect()
+        return await self.unlock()
+
+    @property
+    def connected(self) -> bool:
+        return self._client is not None
+
+    # ------------------------------------------------------------------
+    # Commands
+    # ------------------------------------------------------------------
+    async def info(self) -> dict:
+        """Device info (works even while locked): firmware ``f``, hw ``h``,
+        model ``m``, serial ``s``, timezone offset ``z`` (seconds)."""
+        return await self._request("info")
+
+    async def sync_time(self, tz_offset_seconds: int, *, epoch: int | None = None) -> dict:
+        """Calibrate the device clock.
+
+        ``tz_offset_seconds`` = total UTC offset **in seconds, including DST**
+        (e.g. -25200 for PDT, -28800 for PST — match the vendor app, which
+        sends ``(rawOffset + dstSavings) / 1000``). The device clock can drift
+        seconds a month, so sync as needed.
+        """
+        t = int(epoch if epoch is not None else time.time())
+        return await self._request("time.calibration", {"t": t, "z": tz_offset_seconds})
+
+    async def status(self) -> dict:
+        """Live status: ``s`` state, ``n``/``t`` total feed counter, ``b``
+        battery (units unconfirmed; <=410 = low per vendor app), ``u`` uptime-ish
+        counter, ``d`` (unknown, 0)."""
+        return await self._request("feeder.status")
+
+    async def feed(self, portions: int) -> Any:
+        """Dispense ``portions`` immediately (1-99, matching the vendor app's
+        picker). Returns ``True`` as a near-instant ACK — the dispense runs
+        ASYNCHRONOUSLY afterwards (s=1 while the motor runs; a single
+        feed(10) was observed to take ~50s). The device drops the GATT
+        connection during the feed, so do NOT poll status() while it runs:
+        disconnect, wait, reconnect, then read. The status ``n``/``t``
+        counters increment by ``portions`` (live-verified: feed(10) moved n
+        by +10, confirmed across three independent deltas)."""
+        if not isinstance(portions, int) or not 1 <= portions <= 99:
+            raise ValueError("portions must be an integer 1..99")
+        return await self._request("feeder.feed", {"n": portions})
+
+    async def stop(self) -> Any:
+        """Stop an in-progress feed (safe no-op when idle)."""
+        return await self._request("feeder.stop")
+
+    async def get_schedule(self) -> list:
+        """Read the schedule as a list of :class:`~asf02.protocol.PlanEntry`.
+
+        Returns the non-empty slots in device slot order. Returns an empty
+        list when the device stays silent (observed with an empty schedule on
+        some firmware) or reports only empty slots.
+        """
+        r = await self._request("feeder.plan", params_raw="", silent_ok=True)
+        slots = r.get("p") if isinstance(r, dict) else None
+        if not isinstance(slots, list):
+            return []
+        entries = [decode_plan_slot(s) for s in slots if isinstance(s, str)]
+        return [e for e in entries if e is not None]
+
+    async def set_schedule(self, entries: Iterable, *, clear: bool = False) -> list:
+        """Replace the entire schedule (device stores a fixed 10-slot array).
+
+        ``entries`` is an iterable of ``(hour, minute, portion)`` or
+        ``(hour, minute, portion, enabled)`` tuples, max 10. Use ``clear=True``
+        (or an empty iterable) to wipe the schedule.
+
+        Returns the full 10-slot array the device confirmed as stored —
+        this response is the authoritative confirmation.
+        """
+        entries = list(entries)
+        if clear:
+            payload = ["0000000000"] + [""] * 9
+        elif not entries:
+            payload = ["0000000000"] + [""] * 9
+        else:
+            if len(entries) > 10:
+                raise ValueError(f"too many schedule entries: {len(entries)} (max 10)")
+            from .protocol import encode_plan_entry
+
+            payload = [encode_plan_entry(h, m, w, on) for (h, m, w, *rest) in entries
+                       for on in [bool(rest[0]) if rest else True]]
+            payload += [""] * (10 - len(payload))
+        r = await self._request("feeder.plan", params_raw=json.dumps(payload, separators=(",", ":")))
+        slots = r.get("p") if isinstance(r, dict) else None
+        return list(slots) if isinstance(slots, list) else []
+
+    async def get_log(self) -> list | None:
+        """Read feed history. Returns the device's ``d`` row list, or ``None``
+        when the device stays silent (common on some firmware/empty history)."""
+        r = await self._request("feeder.log", silent_ok=True)
+        if isinstance(r, dict) and "d" in r:
+            return r["d"]
+        return None
+
+    # ------------------------------------------------------------------
+    # Pairing
+    # ------------------------------------------------------------------
+    @staticmethod
+    def new_token() -> str:
+        """Generate a fresh bind token (10 chars, vendor charset)."""
+        return generate_token()
+
+    async def bind(self, token: str | None = None, *, home_id: str = "0",
+                   tz_offset_seconds: int = 0) -> dict:
+        """(Re)bind the device to ``token`` — overwrites any previous token.
+        ``tz_offset_seconds`` = total UTC offset in seconds incl. DST (same
+        convention as :meth:`sync_time`). After this call the old token no
+        longer unlocks the device."""
+        tok = token if token is not None else self.token
+        return await self._request(
+            "bind", {"h": str(home_id), "d": "0000", "t": tok, "z": tz_offset_seconds}
+        )
+
+    # ------------------------------------------------------------------
+    # Core request/response machinery
+    # ------------------------------------------------------------------
+    async def _request(self, method: str, params: dict | None = None,
+                       *, params_raw: str | None = None,
+                       silent_ok: bool = False) -> Any:
+        """Send one command and await its response.
+
+        - ``params``: normal dict params (serialized compactly).
+        - ``params_raw``: raw JSON fragment for ``p`` (used for the plan
+          read/write quirks where the param shape matters exactly).
+        - ``silent_ok``: if True, a missing response returns ``None`` instead
+          of raising (used for feeder.log, which may stay silent).
+
+        Raises :class:`ASF02LockedError` / :class:`ASF02Error` on device
+        errors, ``asyncio.TimeoutError`
+        on silence (unless ``silent_ok``).
+        """
+        client = self._client
+        if client is None:
+            raise ASF02ProtocolError(0, "not connected")
+        self._req_id += 1
+        req_id = self._req_id
+        if params_raw is not None:
+            payload = f'{{"m":"{method}","i":{req_id},"p":{params_raw}}}'.encode("utf-8")
+        else:
+            payload = encode_request(method, req_id, params)
+
+        loop = asyncio.get_running_loop()
+        fut: asyncio.Future = loop.create_future()
+        self._pending[req_id] = fut
+        try:
+            # Register the future BEFORE writing: fast device replies (e.g.
+            # info) can arrive immediately and must not be dropped.
+            await client.write_gatt_char(WRITE_CHAR_UUID, payload, response=True)
+            try:
+                return await asyncio.wait_for(fut, self.response_timeout)
+            except asyncio.TimeoutError:
+                if silent_ok:
+                    return None
+                raise
+        except ASF02Error as e:
+            raise _wrap_errors(e) from None
+
+    def _on_notify(self, _char: Any, data: bytearray) -> None:
+        raw = bytes(data)
+        try:
+            resp = parse_response(raw)
+        except ASF02Error as e:
+            fut = self._pending.pop(self._guess_id(raw), None)
+            if fut is not None and not fut.done():
+                fut.set_exception(_wrap_errors(e))
+            return
+        except ValueError:
+            return  # non-JSON noise; ignore
+        fut = self._pending.pop(resp["i"], None)
+        if fut is None or fut.done():
+            return
+        if resp["ok"]:
+            fut.set_result(resp["r"])
+        else:
+            fut.set_exception(resp["error"])
+
+    @staticmethod
+    def _guess_id(raw: bytes) -> int:
+        """Best-effort id extraction from a malformed-error frame."""
+        with contextlib.suppress(Exception):
+            return int(json.loads(raw.decode("utf-8"))["i"])
+        return -1

asf02/discovery.py

@@ -0,0 +1,66 @@
+"""Discovery: scan for ASF02 feeders via bleak.
+
+Uses the feeder's advertising record (name ``ASF02-<last6MAC>`` +
+manufacturer data ``0203 ... <MAC>``). Company id 0xFFFF, type prefix 0203.
+"""
+from __future__ import annotations
+
+import asyncio
+from dataclasses import dataclass
+
+from bleak import BleakScanner
+
+from .protocol import ADV_COMPANY_ID, decode_advertisement
+
+
+@dataclass
+class DiscoveredFeeder:
+    address: str
+    name: str
+    model: str | None
+    mac: str
+    rssi: int
+    raw_manufacturer_data: str  # hex
+
+
+async def discover_feeders(timeout: float = 10.0, *, address_filter: str | None = None) -> list[DiscoveredFeeder]:
+    """Scan up to ``timeout`` seconds and return all feeders seen.
+
+    ``address_filter`` (a MAC like ``"AA:BB:CC:DD:EE:FF"``) limits results to
+    one device (useful when several feeders are nearby).
+    """
+    found: dict[str, DiscoveredFeeder] = {}
+
+    def on_adv(device, adv) -> None:
+        if address_filter and device.address != address_filter:
+            return
+        mfg = None
+        for cid, data in (adv.manufacturer_data or {}).items():
+            if cid == ADV_COMPANY_ID:
+                mfg = data
+                break
+        if mfg is None:
+            return
+        try:
+            decoded = decode_advertisement(mfg, local_name=adv.local_name or device.name)
+        except ValueError:
+            return
+        rec = found.setdefault(device.address, DiscoveredFeeder(
+            address=device.address,
+            name=device.name or "",
+            model=decoded.get("model"),
+            mac=decoded["mac"],
+            rssi=adv.rssi,
+            raw_manufacturer_data=mfg.hex(),
+        ))
+        rec.rssi = max(rec.rssi, adv.rssi)
+        if adv.local_name:
+            rec.name = adv.local_name
+
+    scanner = BleakScanner(on_adv)
+    await scanner.start()
+    try:
+        await asyncio.sleep(timeout)
+    finally:
+        await scanner.stop()
+    return sorted(found.values(), key=lambda f: f.rssi, reverse=True)

asf02/protocol.py

@@ -0,0 +1,221 @@
+"""ASF02 feeder wire protocol: constants, framing, and pure codecs.
+
+Everything here is pure (no I/O, no asyncio) so it can be unit-tested against
+captured wire traffic. Live-verified against a real ASF02 unit (firmware
+1.19.12).
+
+Protocol summary
+----------------
+JSON-RPC-ish messages over two GATT characteristics of service ``55535343-...``:
+
+  request  (written, UTF-8):  {"m":"<method>","i":<id>,"p":<params>}
+  response (notified, UTF-8): {"i":<id>,"r":<result>}   or   {"i":<id>,"e":{"c":<code>,"m":"<msg>"}}
+
+Responses do NOT echo the method; matching is by ``i``. The device is locked
+across every (re)connect; only ``info`` works while locked. ``feeder.log`` may
+return no notification at all (treat timeout as empty).
+"""
+from __future__ import annotations
+
+import hashlib
+import secrets
+import string
+from dataclasses import dataclass
+
+SERVICE_UUID = "55535343-fe7d-4ae5-8fa9-9fafd205e455"
+WRITE_CHAR_UUID = "49535343-8841-43f4-a8d4-ecbe34729bb3"
+NOTIFY_CHAR_UUID = "49535343-1e4d-4bd9-ba61-23c647249616"
+CCCD_UUID = "00002902-0000-1000-8000-00805f9b34fb"
+
+# Advertising: manufacturer data (company id 0xFFFF) layout:
+#   0203 0010 aabbccddeeff
+#   ^^^^ ^^^^ ^^^^^^^^^^^^
+#   type flags   MAC of the device (12 hex chars)
+ADV_COMPANY_ID = 0xFFFF
+ADV_TYPE_PREFIX = b"\x02\x03"  # pet feeder
+PLAN_SLOT_COUNT = 10  # device-side fixed schedule array
+CLEAR_MARKER = "0000000000"
+
+# Known error codes (live-captured)
+ERR_DEVICE_LOCKED = -31400
+ERR_INVALID_PARAMS = -32602
+ERR_LOCK_STATE_2 = -31402  # app reacts; semantics unconfirmed
+ERR_LOCK_STATE_4 = -31404  # app reacts; semantics unconfirmed
+
+_TOKEN_ALPHABET = string.ascii_lowercase + string.ascii_uppercase + string.digits
+
+
+# ---------------------------------------------------------------------------
+# Errors
+# ---------------------------------------------------------------------------
+class ASF02Error(Exception):
+    """Base class for ASF02 protocol errors (carries the device error payload)."""
+
+    def __init__(self, code: int, message: str):
+        super().__init__(f"device error {code}: {message}")
+        self.code = code
+        self.message = message
+
+
+# ---------------------------------------------------------------------------
+# Token / unlock
+# ---------------------------------------------------------------------------
+def generate_token(n: int = 10) -> str:
+    """Generate a random bind token (same charset the vendor app uses)."""
+    return "".join(secrets.choice(_TOKEN_ALPHABET) for _ in range(n))
+
+
+def unlock_code_for(token: str) -> str:
+    """Compute the unlock code for a bind token.
+
+    Mirrors the vendor app: ``BigInteger(1, md5("0000:" + token)).toString(16)``
+    — hex of the digest as an unsigned big-endian integer, so leading zero
+    nibbles are dropped. A plain ``hexdigest()`` will NOT match when the digest
+    starts with a 0x0x byte.
+
+    >>> unlock_code_for("ExampleTok1")
+    'a587ea45721f8a612c0fcbf507d69adc'
+    """
+    digest = hashlib.md5(f"0000:{token}".encode("utf-8")).digest()
+    return format(int.from_bytes(digest, "big"), "x")
+
+
+# ---------------------------------------------------------------------------
+# Plan strings
+# ---------------------------------------------------------------------------
+@dataclass(frozen=True)
+class PlanEntry:
+    """One schedule slot: time (hour, minute), portion count, enabled flag.
+
+    ``portion`` = how many auger revolutions to dispense (one revolution
+    is one portion).
+    """
+
+    hour: int
+    minute: int
+    portion: int  # 1..255 (vendor UI offers a small subset)
+    enabled: bool
+
+
+def encode_plan_entry(hour: int, minute: int, portion: int, enabled: bool = True) -> str:
+    """Encode a schedule entry as the device's 10-char hex string.
+
+    Layout: ``"00" + HH + MM + PP + XX`` (HH/MM/PP hex, XX enable flag).
+    """
+    if not 0 <= hour <= 23:
+        raise ValueError(f"hour out of range: {hour}")
+    if not 0 <= minute <= 59:
+        raise ValueError(f"minute out of range: {minute}")
+    if not 0 <= portion <= 255:
+        raise ValueError(f"portion out of range: {portion}")
+    return f"00{hour:02x}{minute:02x}{portion:02x}{0x01 if enabled else 0x00:02x}"
+
+
+def decode_plan_entry(entry: str) -> PlanEntry:
+    """Decode a 10-char hex plan string into a :class:`PlanEntry`."""
+    if not plan_entry_valid(entry):
+        raise ValueError(f"malformed plan entry: {entry!r}")
+    return PlanEntry(
+        hour=int(entry[2:4], 16),
+        minute=int(entry[4:6], 16),
+        portion=int(entry[6:8], 16),
+        enabled=entry[8:10] == "01",
+    )
+
+
+def plan_entry_valid(entry: str) -> bool:
+    """True if *entry* is a well-formed 10-char plan string (any time/portion)."""
+    if len(entry) != 10 or entry[0:2] != "00":
+        return False
+    try:
+        int(entry, 16)
+    except ValueError:
+        return False
+    return not (0 <= int(entry[2:4], 16) > 23) and not (0 <= int(entry[4:6], 16) > 59)
+
+
+def is_clear_marker(entry: str) -> bool:
+    """True for the all-zeros entry, which the device treats as 'clear schedule'."""
+    return entry == CLEAR_MARKER
+
+
+def decode_plan_slot(slot: str) -> PlanEntry | None:
+    """Decode one slot of the 10-slot array.
+
+    The device returns ``""`` for unused slots and ``"0000000000"`` as a clear
+    marker; both map to ``None`` here.
+    """
+    if not slot or is_clear_marker(slot):
+        return None
+    return decode_plan_entry(slot)
+
+
+# ---------------------------------------------------------------------------
+# Advertising
+# ---------------------------------------------------------------------------
+def decode_advertisement(manufacturer_data: bytes, local_name: str | None = None) -> dict:
+    """Decode a feeder's advertising payload.
+
+    ``manufacturer_data`` is the *value* of the manufacturer-specific data
+    field (without the company-id prefix). Returns a dict with:
+
+    - ``product_type``: first 2 bytes (``b'\\x02\\x03'`` = pet feeder)
+    - ``mac``: the device MAC (last 6 bytes), e.g. ``"AA:BB:CC:DD:EE:FF"``
+    - ``model``: from the local name (``ASF02-DDEEFF`` -> ``"ASF02"``) or None
+
+    Raises ``ValueError`` if the payload doesn't look like a feeder ad.
+    """
+    if len(manufacturer_data) < 8 or not manufacturer_data.startswith(ADV_TYPE_PREFIX):
+        raise ValueError("not a feeder advertisement")
+    mac_bytes = manufacturer_data[-6:]
+    mac = ":".join(f"{b:02X}" for b in mac_bytes)
+    model = None
+    if local_name and "-" in local_name:
+        model = local_name.split("-", 1)[0]
+    return {
+        "product_type": manufacturer_data[:2],
+        "mac": mac,
+        "model": model,
+    }
+
+
+# ---------------------------------------------------------------------------
+# Message framing
+# ---------------------------------------------------------------------------
+def encode_request(method: str, req_id: int, params=None) -> bytes:
+    """Encode a request as the exact JSON the vendor app writes (compact, no spaces).
+
+    ``params`` is embedded as a raw JSON value; pass ``None`` to omit the field.
+    """
+    if params is None:
+        body = f'{{"m":"{method}","i":{req_id}}}'
+    else:
+        import json as _json
+
+        body = f'{{"m":"{method}","i":{req_id},"p":{_json.dumps(params, separators=(",", ":"))}}}'
+    return body.encode("utf-8")
+
+
+def parse_response(data: bytes) -> dict:
+    """Parse a notification payload into a normalized response dict.
+
+    Returns one of:
+      ``{"ok": True, "i": <id>, "r": <result>}``
+      ``{"ok": False, "i": <id>, "error": ASF02Error}``
+
+    Raises ``ValueError`` for non-JSON or structurally invalid payloads.
+    """
+    import json as _json
+
+    try:
+        msg = _json.loads(data.decode("utf-8"))
+    except (UnicodeDecodeError, ValueError) as e:
+        raise ValueError(f"unparseable response: {data!r}") from e
+    if not isinstance(msg, dict) or "i" not in msg:
+        raise ValueError(f"malformed response (missing id): {data!r}")
+    if "r" in msg:
+        return {"ok": True, "i": msg["i"], "r": msg["r"]}
+    if "e" in msg:
+        e = msg["e"]
+        raise ASF02Error(int(e.get("c", 0)), str(e.get("m", "unknown")))
+    raise ValueError(f"response has neither r nor e: {data!r}")

asf02-0.1.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,9 @@
+asf02/__init__.py,sha256=Fl92KfIUxUACdNIsTAWeH7xNjomk1TAHTFKEAt7QQ0E,1173
+asf02/client.py,sha256=WdT-3f4D00NlYlZACnTlve0BUPxct85oB9XLeoXJaiM,12898
+asf02/discovery.py,sha256=VHtGd2IatMIeDptjIioBp-2fLhvxVcHf_Px-H5sWhCk,2002
+asf02/protocol.py,sha256=6Nowoa_LvEiACi05Gv18PZ6JmevhHdGYbUhWEKRpCJ4,8145
+asf02-0.1.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+asf02-0.1.0.dist-info/METADATA,sha256=-DpTocHyZnhqLs8SLhyxtT5L-5sACOGKnfWVNyRapNE,6120
+asf02-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+asf02-0.1.0.dist-info/top_level.txt,sha256=WHty8Y5Ba8n3RKG8OhB3lHgwhiDvHa5g7ltXpF0aoOU,6
+asf02-0.1.0.dist-info/RECORD,,

asf02-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

asf02-0.1.0.dist-info/licenses/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.dist-info/top_level.txt

@@ -0,0 +1 @@
+asf02