pap-spinel 0.0.2__tar.gz

pap_spinel-0.0.2/.github/workflows/publish.yml

@@ -0,0 +1,30 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+        
+    - name: Install build tool
+      run: python -m pip install --upgrade pip build
+      
+    - name: Build package
+      run: python -m build
+      
+    - name: Publish package to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

pap_spinel-0.0.2/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

pap_spinel-0.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Levad
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pap_spinel-0.0.2/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.5
+Name: pap_spinel
+Version: 0.0.2
+Summary: Spinel protocol over UART/TCP for Papouch MCUs.
+Project-URL: Source, https://github.com/VladislavLevitskii/pap_spinel
+Author-email: VladislavLevitskii <vladlevitskii@gmail.com>
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: pyserial-asyncio>=0.6
+Requires-Dist: pyserial>=3.5

pap_spinel-0.0.2/README.md

@@ -0,0 +1,198 @@
+# pap_spinel
+
+An asynchronous Python library for the Papouch Spinel binary protocol (Format 97) over UART or TCP. It can construct and verify individual frames, incrementally parse an incoming data stream, and match responses to asynchronous requests using `SIG`.
+
+The library does not provide application-level instruction semantics or data structures. These are determined by the target device's firmware. However, the transport layer, Spinel framing, and standard response processing are common across devices.
+
+Requires Python 3.12 or newer.
+
+## Frame Format 97
+
+Each frame has the following binary structure:
+
+```text
+PRE  FRM  NUM (uint16 big-endian)  ADR  SIG  INST  DATA...  SUM  CR
+2A   61                            ..   ..   ..    ..      ..   0D
+
+```
+
+`NUM` equals `5 + length of DATA` and encompasses `ADR`, `SIG`, `INST`, `DATA`, `SUM`, and `CR` (it excludes the first four bytes). `SUM` is automatically calculated by `Packet97` so that the sum of all bytes from `PRE` to `SUM` equals `0xFF` modulo 256.
+
+Important constants exported by the package:
+
+| Constant | Value | Meaning |
+| --- | --- | --- |
+| `PRE` | `0x2A` | Start of frame |
+| `FRM` | `0x61` | Spinel format 97 |
+| `CR` | `0x0D` | End of frame |
+| `ADR_BROADCAST` | `0xFE` | Broadcast address |
+| `INST_INFO` | `0xF3` | INFO request instruction |
+
+The client chooses a `SIG` (signature) for each request. The response must carry the same `SIG` so that `SpinelClient` can route it to the correct call when handling multiple concurrent requests.
+
+## Constructing and Verifying a Single Frame
+
+`Packet97` is a low-level representation of a single complete frame. During serialization, it automatically calculates `NUM` and `SUM`; during parsing, it verifies the length, header, terminator, and checksum.
+
+```python
+from pap_spinel import Packet97
+
+# INFO broadcast with a custom SIG.
+request = Packet97(adr=0xFE, sig=0x42, inst=0xF3)
+wire_bytes = request.to_bytes()
+print(request.hex())
+# 2A 61 00 05 FE 42 F3 .. 0D
+
+# raw_reply must contain exactly one complete frame, without surrounding bytes.
+raw_reply = b"\x2A\x61\x00\x05\x31\x42\xF3\x09\x0D"
+reply = Packet97.from_bytes(raw_reply)
+
+print(f"ADR=0x{reply.adr:02X}, SIG=0x{reply.sig:02X}, INST=0x{reply.inst:02X}")
+print(f"DATA={reply.data.hex(' ').upper()}")
+
+```
+
+For a malformed frame, `Packet97.from_bytes()` raises a `SpinelProtocolError`. Use this method only when you already know the boundaries of the complete frame, such as when reading from a stored binary file.
+
+## Parsing a UART/TCP Stream
+
+Both serial and TCP reads can return arbitrarily fragmented data chunks: a single frame might arrive in multiple blocks, and a single block might contain multiple frames or noise preceding the header. For these scenarios, use `Packet97StreamParser`.
+
+```python
+from pap_spinel import Packet97StreamParser
+
+parser = Packet97StreamParser()
+
+for received_chunk in chunks_from_your_reader:
+    for packet, errors in parser.feed(received_chunk):
+        # By default, only valid frames are yielded.
+        assert not errors
+        print(packet.hex())
+
+```
+
+To diagnose corrupted communication, create the parser with `include_invalid=True`. It will then also yield frames with a valid length but an invalid checksum, along with the error (e.g., `['SUM']`).
+
+```python
+parser = Packet97StreamParser(include_invalid=True)
+for packet, errors in parser.feed(received_chunk):
+    if errors:
+        print(f"Invalid frame ({', '.join(errors)}): {packet.hex()}")
+    else:
+        print(f"Valid frame: {packet.hex()}")
+
+```
+
+The `dropped_bytes` and `bad_packets` properties indicate the number of bytes discarded during resynchronization and the number of invalid complete frames, respectively.
+
+## INFO over Serial Port
+
+`SpinelClient` runs a background reading task, continuously parses incoming data, and waits for a response with a matching `SIG`. Instantiate it using an asynchronous context manager. The following example sends an INFO request to a specific device at address `0x31` on port `COM5`.
+
+```python
+import asyncio
+
+from pap_spinel import Packet97, SerialTransport, SpinelClient
+
+
+def describe_info(packet: Packet97) -> None:
+    print(f"Device: ADR=0x{packet.adr:02X}, INST=0x{packet.inst:02X}")
+    print(f"INFO hex: {packet.data.hex(' ').upper() or '(empty)'}")
+
+    # ASCII is for diagnostic preview only. DATA format is defined by firmware.
+    text = packet.data.decode("ascii", errors="replace")
+    if text:
+        print(f"INFO ASCII: {text!r}")
+
+
+async def main() -> None:
+    transport = SerialTransport("COM5", baudrate=115_200)
+    async with SpinelClient(transport, default_timeout=2.0) as client:
+        info = await client.info(addr=0x31)
+        describe_info(info)
+
+
+asyncio.run(main())
+
+```
+
+For a broadcast, use `ADR_BROADCAST` (`0xFE`) instead of `0x31`, or omit the `addr` parameter entirely. A broadcast may trigger responses from multiple devices; the `info()` method will return the first response with a matching `SIG`. For deterministic results, use the address of a specific device.
+
+## INFO over TCP
+
+For Spinel tunneled over TCP (e.g., via Lantronix XPort), the code is identical; only the transport method changes.
+
+```python
+import asyncio
+
+from pap_spinel import TcpTransport, SpinelClient
+
+
+async def main() -> None:
+    async with SpinelClient(TcpTransport("192.0.2.10", 10001)) as client:
+        info = await client.info(addr=0x31, timeout=3.0)
+        print(info.hex())
+        print(info.data.hex(' ').upper())
+
+
+asyncio.run(main())
+
+```
+
+`192.0.2.10` is a documentation placeholder address; replace it with the actual IP address and TCP port of your tunnel. You can configure the connection timeout by setting `connect_timeout`, for example: `TcpTransport(host, port, connect_timeout=10.0)`.
+
+## Custom Instructions and ACKs
+
+To send data for a firmware-defined instruction, you can use `request()` or `send_and_ack()`. The latter expects an ACK frame: a frame where `INST <= 0x0F` and the first byte of `DATA` contains the ACK code. By default, only the `ACK_OK` (`0x00`) code is considered successful.
+
+```python
+import asyncio
+
+from pap_spinel import SerialTransport, SpinelClient, SpinelNakError
+
+
+async def main() -> None:
+    async with SpinelClient(SerialTransport("COM5", 115_200)) as client:
+        try:
+            await client.send_and_ack(
+                addr=0x31,
+                inst=0xE0,  # Replace with an instruction from your device's documentation.
+                data=b"\x01\x02",
+            )
+        except SpinelNakError as error:
+            print(f"Device rejected the request: 0x{error.code:02X} ({error.name})")
+
+
+asyncio.run(main())
+
+```
+
+The `request()` method returns the first response with a matching `SIG`, without assuming it's an ACK frame. Use it for instructions that return a data response. `send_raw()` transmits a pre-constructed `Packet97` and does not wait for a response.
+
+## Unsolicited Frames and Errors
+
+A frame that does not belong to any pending request can be handled via the `on_unsolicited` callback. The callback can be a standard or an asynchronous function.
+
+```python
+from pap_spinel import Packet97, SerialTransport, SpinelClient
+
+
+def on_unsolicited(packet: Packet97) -> None:
+    print(f"Event from 0x{packet.adr:02X}: INST=0x{packet.inst:02X}")
+
+
+client = SpinelClient(
+    SerialTransport("COM5", 115_200),
+    on_unsolicited=on_unsolicited,
+)
+
+```
+
+When working with the client, you should handle the following exceptions:
+
+| Exception | Situation |
+| --- | --- |
+| `SpinelProtocolError` | Invalid individual frame in `Packet97.from_bytes()` |
+| `SpinelTimeoutError` | Device did not respond within the specified timeout |
+| `SpinelNakError` | `send_and_ack()` received an unpermitted ACK code |
+| `SpinelTransportError` | Failed to open or use the UART/TCP transport |

pap_spinel-0.0.2/pyproject.toml

@@ -0,0 +1,23 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pap_spinel"
+version = "0.0.2"
+description = "Spinel protocol over UART/TCP for Papouch MCUs."
+requires-python = ">=3.12"
+license = { text = "MIT" }
+authors = [
+    { name = "VladislavLevitskii", email = "vladlevitskii@gmail.com" }
+]
+dependencies = [
+    "pyserial>=3.5",
+    "pyserial-asyncio>=0.6",
+]
+
+[project.urls]
+Source = "https://github.com/VladislavLevitskii/pap_spinel"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pap_spinel"]

pap_spinel-0.0.2/src/pap_spinel/__init__.py

@@ -0,0 +1,61 @@
+"""Spinel protocol (Papouch) over UART/TCP."""
+
+from .ack import (
+    ACK_DATA_ERROR,
+    ACK_FAILURE,
+    ACK_GENERAL_ERROR,
+    ACK_NAMES,
+    ACK_NO_DATA,
+    ACK_NOT_PERMITTED,
+    ACK_OK,
+    ACK_UNKNOWN_INSTRUCTION,
+    ack_name,
+)
+from .client import SpinelClient
+from .errors import (
+    SpinelError,
+    SpinelNakError,
+    SpinelProtocolError,
+    SpinelTimeoutError,
+    SpinelTransportError,
+)
+from .packet import (
+    ADR_BROADCAST,
+    CR,
+    FRM,
+    INST_INFO,
+    PRE,
+    Packet97,
+    Packet97StreamParser,
+)
+from .transport import SerialTransport, SpinelTransport, TcpTransport
+
+__version__ = "0.0.2"
+
+__all__ = [
+    "ACK_DATA_ERROR",
+    "ACK_FAILURE",
+    "ACK_GENERAL_ERROR",
+    "ACK_NAMES",
+    "ACK_NOT_PERMITTED",
+    "ACK_NO_DATA",
+    "ACK_OK",
+    "ACK_UNKNOWN_INSTRUCTION",
+    "ADR_BROADCAST",
+    "CR",
+    "FRM",
+    "INST_INFO",
+    "PRE",
+    "Packet97",
+    "Packet97StreamParser",
+    "SerialTransport",
+    "SpinelClient",
+    "SpinelError",
+    "SpinelNakError",
+    "SpinelProtocolError",
+    "SpinelTimeoutError",
+    "SpinelTransport",
+    "SpinelTransportError",
+    "TcpTransport",
+    "ack_name",
+]

pap_spinel-0.0.2/src/pap_spinel/ack.py

@@ -0,0 +1,25 @@
+"""Spinel ACK code table (response when INST <= 0x0F)."""
+
+from __future__ import annotations
+
+ACK_OK = 0x00
+ACK_GENERAL_ERROR = 0x01
+ACK_UNKNOWN_INSTRUCTION = 0x02
+ACK_DATA_ERROR = 0x03
+ACK_NOT_PERMITTED = 0x04
+ACK_FAILURE = 0x05
+ACK_NO_DATA = 0x06
+
+ACK_NAMES: dict[int, str] = {
+    ACK_OK: "Ok",
+    ACK_GENERAL_ERROR: "General error",
+    ACK_UNKNOWN_INSTRUCTION: "Unknown instruction code",
+    ACK_DATA_ERROR: "Data error",
+    ACK_NOT_PERMITTED: "Not permitted",
+    ACK_FAILURE: "Failure (service needed)",
+    ACK_NO_DATA: "No data available",
+}
+
+
+def ack_name(code: int) -> str:
+    return ACK_NAMES.get(code, f"Unknown ACK 0x{code:02X}")

pap_spinel-0.0.2/src/pap_spinel/client.py

@@ -0,0 +1,171 @@
+"""Asyncio Spinel client: request/response with SIG matching + unsolicited packet handler.
+
+Usage:
+    async with SpinelClient(SerialTransport("COM5", 115200)) as c:
+        info = await c.info(addr=0xFE)
+        await c.send_and_ack(addr=0x31, inst=0xE0, data=b"\\x01")
+"""
+
+from __future__ import annotations
+
+import asyncio
+import logging
+from collections.abc import Awaitable, Callable
+from typing import Self
+
+from .ack import ACK_OK, ack_name
+from .errors import SpinelNakError, SpinelTimeoutError, SpinelTransportError
+from .packet import INST_INFO, Packet97, Packet97StreamParser
+from .transport import SpinelTransport
+
+logger = logging.getLogger("pap_spinel")
+
+OnPacket = Callable[[Packet97], Awaitable[None] | None]
+
+
+class SpinelClient:
+    """Async Spinel client. Owns a reader task that demultiplexes responses by SIG."""
+
+    def __init__(
+        self,
+        transport: SpinelTransport,
+        *,
+        default_timeout: float = 2.0,
+        on_unsolicited: OnPacket | None = None,
+        include_invalid: bool = False,
+    ) -> None:
+        self.transport = transport
+        self.default_timeout = default_timeout
+        self.on_unsolicited = on_unsolicited
+        self._parser = Packet97StreamParser(include_invalid=include_invalid)
+        self._sig_counter = 0x37  # mirrors JS init (55)
+        self._pending: dict[int, asyncio.Future[Packet97]] = {}
+        self._reader_task: asyncio.Task[None] | None = None
+        self._closed = False
+
+    # ---- lifecycle ------------------------------------------------------
+
+    async def open(self) -> None:
+        await self.transport.open()
+        self._reader_task = asyncio.create_task(self._reader_loop(), name="spinel-rx")
+
+    async def close(self) -> None:
+        self._closed = True
+        if self._reader_task is not None:
+            self._reader_task.cancel()
+            try:
+                await self._reader_task
+            except asyncio.CancelledError:
+                pass
+            finally:
+                self._reader_task = None
+        await self.transport.close()
+        # Wake up any pending futures
+        for fut in self._pending.values():
+            if not fut.done():
+                fut.set_exception(SpinelTransportError("Client closed"))
+        self._pending.clear()
+
+    async def __aenter__(self) -> Self:
+        await self.open()
+        return self
+
+    async def __aexit__(self, *exc: object) -> None:
+        await self.close()
+
+    # ---- SIG management -------------------------------------------------
+
+    def _next_sig(self) -> int:
+        sig = self._sig_counter & 0xFF
+        self._sig_counter = (self._sig_counter + 1) & 0xFF
+        return sig
+
+    # ---- send -----------------------------------------------------------
+
+    async def send_raw(self, packet: Packet97) -> None:
+        """Send a packet without waiting for any response."""
+        if self._closed:
+            raise SpinelTransportError("Client closed")
+        logger.debug("TX: %s", packet.hex())
+        await self.transport.write(packet.to_bytes())
+
+    async def request(
+        self,
+        *,
+        addr: int,
+        inst: int,
+        data: bytes = b"",
+        sig: int | None = None,
+        timeout: float | None = None,
+    ) -> Packet97:
+        """Send packet and await first response matching its SIG. Raises SpinelTimeoutError."""
+        if sig is None:
+            sig = self._next_sig()
+        pkt = Packet97(adr=addr, sig=sig, inst=inst, data=data)
+        fut: asyncio.Future[Packet97] = asyncio.get_running_loop().create_future()
+        # Last-writer-wins on SIG collision — matches JS stack append behavior
+        self._pending[sig] = fut
+        try:
+            await self.send_raw(pkt)
+            return await asyncio.wait_for(fut, timeout or self.default_timeout)
+        except TimeoutError as exc:
+            raise SpinelTimeoutError(
+                f"No response for SIG=0x{sig:02X} INST=0x{inst:02X} ADR=0x{addr:02X}"
+                f" within {timeout or self.default_timeout}s"
+            ) from exc
+        finally:
+            self._pending.pop(sig, None)
+
+    async def send_and_ack(
+        self,
+        *,
+        addr: int,
+        inst: int,
+        data: bytes = b"",
+        sig: int | None = None,
+        timeout: float | None = None,
+        allowed_acks: tuple[int, ...] = (ACK_OK,),
+    ) -> Packet97:
+        """Send + require ACK with code in ``allowed_acks`` (default just 0x00 Ok). Raises SpinelNakError."""
+        resp = await self.request(addr=addr, inst=inst, data=data, sig=sig, timeout=timeout)
+        if not resp.is_ack():
+            return resp  # Not an ACK frame, return as-is (caller decides)
+        code = resp.ack_code()
+        if code is None or code not in allowed_acks:
+            raise SpinelNakError(code or -1, ack_name(code or -1), packet=resp)
+        return resp
+
+    async def info(self, addr: int = 0xFE, *, timeout: float | None = None) -> Packet97:
+        """Send INFO (INST 0xF3) and wait for reply."""
+        return await self.request(addr=addr, inst=INST_INFO, timeout=timeout)
+
+    # ---- reader loop ----------------------------------------------------
+
+    async def _reader_loop(self) -> None:
+        try:
+            while not self._closed:
+                try:
+                    chunk = await self.transport.read(4096)
+                except SpinelTransportError as exc:
+                    logger.warning("Reader loop exiting: %s", exc)
+                    break
+                if not chunk:
+                    logger.debug("Reader loop exiting: EOF received")
+                    break
+                for pkt, errors in self._parser.feed(chunk):
+                    if errors:
+                        logger.warning("invalid packet: %s %s", errors, pkt.hex())
+                    fut = self._pending.get(pkt.sig)
+                    if fut is not None and not fut.done():
+                        fut.set_result(pkt)
+                        continue
+                    if self.on_unsolicited is not None:
+                        result = self.on_unsolicited(pkt)
+                        if asyncio.iscoroutine(result):
+                            asyncio.create_task(result)
+                    else:
+                        logger.debug("RX unmatched SIG=0x%02X INST=0x%02X", pkt.sig, pkt.inst)
+        except asyncio.CancelledError:
+            raise
+        except Exception:
+            logger.exception("reader loop crashed")

pap_spinel-0.0.2/src/pap_spinel/errors.py

@@ -0,0 +1,33 @@
+"""Exception hierarchy for pap_spinel."""
+
+from __future__ import annotations
+
+
+class SpinelError(Exception):
+    """Base for all Spinel errors."""
+
+
+class SpinelProtocolError(SpinelError):
+    """Malformed packet (PRE/FRM/NUM/CR/SUM)."""
+
+    def __init__(self, message: str, errors: list[str] | None = None) -> None:
+        super().__init__(message)
+        self.errors = errors or []
+
+
+class SpinelTimeoutError(SpinelError):
+    """No response within timeout."""
+
+
+class SpinelNakError(SpinelError):
+    """Device replied with ACK != 0x00."""
+
+    def __init__(self, code: int, name: str, packet: object | None = None) -> None:
+        super().__init__(f"NAK 0x{code:02X} ({name})")
+        self.code = code
+        self.name = name
+        self.packet = packet
+
+
+class SpinelTransportError(SpinelError):
+    """Underlying transport (serial/TCP) failure."""

pap_spinel-0.0.2/src/pap_spinel/packet.py

@@ -0,0 +1,199 @@
+"""Spinel format 97 (binary, 0x61 = 'a') packet.
+
+Wire layout:
+    PRE(0x2A) FRM(0x61) NUM(uint16 BE) ADR SIG INST DATA... SUM CR(0x0D)
+where NUM = 5 + len(DATA) and SUM = 0xFF - (sum of all bytes from PRE through DATA) & 0xFF.
+
+Ported from Dockbox4/backend/spinel.js (class PacketSpinel97).
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from .errors import SpinelProtocolError
+
+PRE = 0x2A
+FRM = 0x61  # 97 decimal — 'a'
+CR = 0x0D
+MIN_LEN = 9  # header(4) + ADR + SIG + INST + SUM + CR
+ADR_BROADCAST = 0xFE
+INST_INFO = 0xF3
+
+
+@dataclass
+class Packet97:
+    """Spinel format 97 packet."""
+
+    adr: int = ADR_BROADCAST
+    sig: int = 0x00
+    inst: int = INST_INFO
+    data: bytes = b""
+    # Optional override of decoded SUM (for diagnostics / round-tripping malformed packets)
+    sum_override: int | None = field(default=None, repr=False)
+
+    # ---- size + checksum ------------------------------------------------
+
+    @property
+    def num(self) -> int:
+        """NUM = 5 + len(DATA)."""
+        return 5 + len(self.data)
+
+    def compute_sum(self) -> int:
+        """SUM byte = 0xFF - (sum of PRE..last DATA byte) & 0xFF."""
+        hi = (self.num >> 8) & 0xFF
+        lo = self.num & 0xFF
+        s = PRE + FRM + hi + lo + (self.adr & 0xFF) + (self.sig & 0xFF) + (self.inst & 0xFF)
+        for b in self.data:
+            s += b & 0xFF
+        return 0xFF - (s & 0xFF)
+
+    # ---- encode ---------------------------------------------------------
+
+    def to_bytes(self) -> bytes:
+        """Serialize packet to on-wire bytes (auto-computes SUM)."""
+        num = self.num
+        out = bytearray(4 + num)
+        out[0] = PRE
+        out[1] = FRM
+        out[2] = (num >> 8) & 0xFF
+        out[3] = num & 0xFF
+        out[4] = self.adr & 0xFF
+        out[5] = self.sig & 0xFF
+        out[6] = self.inst & 0xFF
+        if self.data:
+            out[7 : 7 + len(self.data)] = self.data
+        out[7 + len(self.data)] = self.compute_sum()
+        out[8 + len(self.data)] = CR
+        return bytes(out)
+
+    # ---- decode ---------------------------------------------------------
+
+    @classmethod
+    def from_bytes(cls, raw: bytes) -> Packet97:
+        """Parse a single complete packet. Raises SpinelProtocolError if malformed."""
+        if len(raw) < MIN_LEN:
+            raise SpinelProtocolError(f"Packet too short: {len(raw)} < {MIN_LEN}")
+        if raw[0] != PRE:
+            raise SpinelProtocolError(f"Bad PRE 0x{raw[0]:02X}", ["PRE"])
+        if raw[1] != FRM:
+            raise SpinelProtocolError(f"Bad FRM 0x{raw[1]:02X}", ["FRM"])
+        num = (raw[2] << 8) | raw[3]
+        expected_len = 4 + num
+        if len(raw) != expected_len:
+            raise SpinelProtocolError(
+                f"Length mismatch: got {len(raw)}, NUM says {expected_len}", ["NUM"]
+            )
+        if raw[-1] != CR:
+            raise SpinelProtocolError(f"Missing CR (last byte 0x{raw[-1]:02X})", ["CR"])
+        data_len = num - 5
+        pkt = cls(
+            adr=raw[4],
+            sig=raw[5],
+            inst=raw[6],
+            data=bytes(raw[7 : 7 + data_len]) if data_len else b"",
+        )
+        expected_sum = pkt.compute_sum()
+        actual_sum = raw[7 + data_len]
+        if expected_sum != actual_sum:
+            pkt.sum_override = actual_sum
+            raise SpinelProtocolError(
+                f"Bad SUM: got 0x{actual_sum:02X}, expected 0x{expected_sum:02X}",
+                ["SUM"],
+            )
+        return pkt
+
+    # ---- helpers --------------------------------------------------------
+
+    def hex(self, sep: str = " ") -> str:
+        return self.to_bytes().hex(sep).upper()
+
+    def is_ack(self) -> bool:
+        """Packets with INST <= 0x0F are ACK responses (first DATA byte is ACK code)."""
+        return self.inst <= 0x0F
+
+    def ack_code(self) -> int | None:
+        if not self.is_ack() or not self.data:
+            return None
+        return self.data[0]
+
+
+# ---------------------------------------------------------------------------
+# Streaming parser — accepts arbitrary chunks, yields complete Packet97s.
+# Tolerates leading garbage and packet boundaries split across chunks.
+# ---------------------------------------------------------------------------
+
+
+class Packet97StreamParser:
+    """In-memory bytearray buffer + iterative parser for Spinel 97 packets.
+
+    Drops single bytes when header doesn't match (resyncing on next PRE).
+    Returns invalid packets too when ``include_invalid=True`` (paired with errors list).
+    """
+
+    def __init__(self, *, include_invalid: bool = False, max_buffer: int = 1 << 20):
+        self._buf = bytearray()
+        self.include_invalid = include_invalid
+        self.max_buffer = max_buffer
+        self.dropped_bytes = 0
+        self.bad_packets = 0
+
+    def feed(self, chunk: bytes) -> list[tuple[Packet97, list[str]]]:
+        """Append chunk and return list of (packet, errors) tuples for any complete packets."""
+        if chunk:
+            self._buf.extend(chunk)
+        if len(self._buf) > self.max_buffer:
+            drop = len(self._buf) - self.max_buffer
+            del self._buf[:drop]
+            self.dropped_bytes += drop
+        out: list[tuple[Packet97, list[str]]] = []
+        while True:
+            result = self._try_parse_one()
+            if result is None:
+                break
+            out.append(result)
+        return out
+
+    def _try_parse_one(self) -> tuple[Packet97, list[str]] | None:
+        buf = self._buf
+        # Find PRE+FRM boundary
+        while len(buf) >= 2:
+            if buf[0] == PRE and buf[1] == FRM:
+                break
+            del buf[0]
+            self.dropped_bytes += 1
+        if len(buf) < MIN_LEN:
+            return None
+        num = (buf[2] << 8) | buf[3]
+        if num < 5:
+            del buf[0]
+            self.dropped_bytes += 1
+            return self._try_parse_one()
+        full_len = 4 + num
+        if len(buf) < full_len:
+            return None  # need more data
+        if buf[full_len - 1] != CR:
+            # Not a real header — drop one byte and rescan
+            del buf[0]
+            self.dropped_bytes += 1
+            return self._try_parse_one()
+        raw = bytes(buf[:full_len])
+        del buf[:full_len]
+        try:
+            pkt = Packet97.from_bytes(raw)
+            return (pkt, [])
+        except SpinelProtocolError as exc:
+            self.bad_packets += 1
+            if not self.include_invalid:
+                # consume and continue; caller doesn't see it
+                return self._try_parse_one()
+            # Build a packet skeleton with the parsed fields if possible
+            data_len = num - 5
+            pkt = Packet97(
+                adr=raw[4],
+                sig=raw[5],
+                inst=raw[6],
+                data=bytes(raw[7 : 7 + data_len]) if data_len else b"",
+                sum_override=raw[7 + data_len],
+            )
+            return (pkt, exc.errors or ["INVALID"])

pap_spinel-0.0.2/src/pap_spinel/transport.py

@@ -0,0 +1,154 @@
+"""Asyncio transports for Spinel: Serial (pyserial-asyncio) and TCP.
+
+All transports expose the same async interface:
+    await transport.open()
+    await transport.write(data: bytes)
+    await transport.read(n: int = 4096) -> bytes        # may return b'' if closed
+    await transport.close()
+"""
+
+from __future__ import annotations
+
+import asyncio
+from abc import ABC, abstractmethod
+from typing import Self
+
+import serial_asyncio  # type: ignore[import-untyped]
+
+from .errors import SpinelTransportError
+
+
+class SpinelTransport(ABC):
+    @abstractmethod
+    async def open(self) -> None: ...
+
+    @abstractmethod
+    async def write(self, data: bytes) -> None: ...
+
+    @abstractmethod
+    async def read(self, n: int = 4096) -> bytes: ...
+
+    @abstractmethod
+    async def close(self) -> None: ...
+
+    async def __aenter__(self) -> Self:
+        await self.open()
+        return self
+
+    async def __aexit__(self, *exc: object) -> None:
+        await self.close()
+
+
+# ---------------------------------------------------------------------------
+
+
+class SerialTransport(SpinelTransport):
+    """USB-UART serial transport via pyserial-asyncio."""
+
+    def __init__(
+        self,
+        port: str,
+        baudrate: int = 115_200,
+        *,
+        bytesize: int = 8,
+        parity: str = "N",
+        stopbits: float = 1,
+    ) -> None:
+        self.port = port
+        self.baudrate = baudrate
+        self.bytesize = bytesize
+        self.parity = parity
+        self.stopbits = stopbits
+        self._reader: asyncio.StreamReader | None = None
+        self._writer: asyncio.StreamWriter | None = None
+
+    async def open(self) -> None:
+        try:
+            self._reader, self._writer = await serial_asyncio.open_serial_connection(
+                url=self.port,
+                baudrate=self.baudrate,
+                bytesize=self.bytesize,
+                parity=self.parity,
+                stopbits=self.stopbits,
+            )
+        except Exception as exc:
+            raise SpinelTransportError(f"Failed to open {self.port}: {exc}") from exc
+
+    async def write(self, data: bytes) -> None:
+        if self._writer is None:
+            raise SpinelTransportError("Serial transport not open")
+        try:
+            self._writer.write(data)
+            await self._writer.drain()
+        except OSError as exc:
+            raise SpinelTransportError(f"Serial write failed: {exc}") from exc
+
+    async def read(self, n: int = 4096) -> bytes:
+        if self._reader is None:
+            raise SpinelTransportError("Serial transport not open")
+        try:
+            return await self._reader.read(n)
+        except OSError as exc:
+            raise SpinelTransportError(f"Serial read failed: {exc}") from exc
+
+    async def close(self) -> None:
+        if self._writer is not None:
+            self._writer.close()
+            try:
+                await self._writer.wait_closed()
+            except (ConnectionError, OSError):
+                pass
+        self._reader = None
+        self._writer = None
+
+
+# ---------------------------------------------------------------------------
+
+
+class TcpTransport(SpinelTransport):
+    """TCP transport (e.g. Lantronix XPort tunneling Spinel over Ethernet)."""
+
+    def __init__(self, host: str, port: int, *, connect_timeout: float = 5.0) -> None:
+        self.host = host
+        self.port = port
+        self.connect_timeout = connect_timeout
+        self._reader: asyncio.StreamReader | None = None
+        self._writer: asyncio.StreamWriter | None = None
+
+    async def open(self) -> None:
+        try:
+            self._reader, self._writer = await asyncio.wait_for(
+                asyncio.open_connection(self.host, self.port),
+                timeout=self.connect_timeout,
+            )
+        except (OSError, TimeoutError) as exc:
+            raise SpinelTransportError(
+                f"Failed to connect to {self.host}:{self.port}: {exc}"
+            ) from exc
+
+    async def write(self, data: bytes) -> None:
+        if self._writer is None:
+            raise SpinelTransportError("TCP transport not open")
+        try:
+            self._writer.write(data)
+            await self._writer.drain()
+        except (ConnectionError, OSError) as exc:
+            raise SpinelTransportError(f"TCP write failed: {exc}") from exc
+
+    async def read(self, n: int = 4096) -> bytes:
+        if self._reader is None:
+            raise SpinelTransportError("TCP transport not open")
+        try:
+            return await self._reader.read(n)
+        except (ConnectionError, OSError) as exc:
+            raise SpinelTransportError(f"TCP read failed: {exc}") from exc
+
+    async def close(self) -> None:
+        if self._writer is not None:
+            self._writer.close()
+            try:
+                await self._writer.wait_closed()
+            except (ConnectionError, OSError):
+                pass
+        self._reader = None
+        self._writer = None