Metadata-Version: 2.4
Name: oaknut-econet-piconet
Version: 13.6.1
Summary: Piconet transport for oaknut-econet: a Raspberry Pi Pico serial-to-Econet adapter, with a fake Piconet for hardware-free testing.
Author-email: Robert Smallshire <robert@smallshire.org.uk>
License-Expression: MIT
Project-URL: Homepage, https://github.com/rob-smallshire/oaknut/tree/master/packages/oaknut-econet-piconet
Project-URL: Repository, https://github.com/rob-smallshire/oaknut
Project-URL: Issues, https://github.com/rob-smallshire/oaknut/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: System :: Networking
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: oaknut-econet-core>=10.0
Provides-Extra: serial
Requires-Dist: pyserial-asyncio>=0.6; extra == "serial"
Dynamic: license-file

# oaknut-econet-piconet

The **Piconet** transport for the `oaknut-econet` family — a Raspberry Pi Pico
(RP2040) driving a real MC68B54 ADLC and presenting a USB-CDC serial-to-Econet
adapter to the host.

The Pico firmware runs the Econet four-way handshake itself and exposes a
line-based serial protocol: the host sends commands (`TX`, `BCAST`,
`SET_STATION`, …) and receives events (`RX_TRANSMIT`, `RX_BROADCAST`,
`TX_RESULT`, …) with base64-encoded payloads. This package provides:

- the serial protocol codec and the Econet frame parsing,
- the mapping between `oaknut.econet.core.EconetPacket` and the Piconet
  protocol,
- `PiconetTransport`, an `EconetTransport` driven over a `PicoLink`, and
- **`FakePiconet`** — an in-process simulation of the Pico firmware, so the
  transport is fully testable in CI with no hardware.

The real serial link (`SerialPicoLink`, via `pyserial-asyncio` behind the
`serial` extra) talks to an attached Pico. A Piconet consumes but does not
generate the Econet clock, so on-wire testing needs a clocked Econet and a peer
station (e.g. two Piconets plus a Raspberry Pi HAT / PiEconetBridge for the
clock). It registers on the `oaknut.econet.transport` axis as `piconet`. See
`docs/dev/econet-design.md` for the design.
