Metadata-Version: 2.4
Name: oaknut-econet-hat
Version: 13.6.1
Summary: PiEconetHAT transport for oaknut-econet: a user-space client of the econet-gpio kernel module, with a fake kernel device 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-hat
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
Dynamic: license-file

# oaknut-econet-hat

The **PiEconetHAT** transport for the `oaknut-econet` family — a user-space
client of the `econet-gpio` Linux kernel module that drives a Raspberry Pi HAT
carrying a real MC68B54 ADLC.

The kernel module runs the Econet four-way handshake in its interrupt handler
and exposes a character device, `/dev/econet-gpio`, through which user space
reads and writes AUN-format packets (`struct __econet_packet_aun`) and issues
ioctls (station-interest map, AUN mode, TX status, …). This package provides:

- the kernel packet-struct codec and the mapping to/from
  `oaknut.econet.core.EconetPacket`,
- `HatTransport`, an `EconetTransport` driven over a `KernelDevice`, and
- **`FakeKernelDevice`** — an in-process simulation of the char device, so the
  transport is fully testable in CI with no hardware.

The real device (`EconetGpioDevice`) uses only the standard library
(`os`/`fcntl`/`struct`); it is Linux-only at runtime and needs the `econet-gpio`
module loaded and the HAT present. It registers on the
`oaknut.econet.transport` axis as `hat`. The design — and the goal of cleanly
superseding PiEconetBridge — is in `docs/dev/econet-design.md`.
