From 7fe986beccc407b05443da7c6cf0bcff16f9b9a5 Mon Sep 17 00:00:00 2001 From: Scott Penrose Date: Tue, 16 Jun 2026 05:02:54 +1000 Subject: [PATCH] update docs --- README.md | 11 +++++------ docs/PROTOCOL.md | 5 ----- 2 files changed, 5 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 64e7a12..f338525 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Build a system that can connect to an SPPro Serial Port to get sensible data out of it to display it on a serial console and be used in other projects. -PyAware seems to already decode Serial Data. Look at porting that to portable C for decoding. +Serial decoding is ported to portable C from the open-source [neerolyte/selpi](https://github.com/neerolyte/selpi) project. * Hardware necessary to connect to SPPro * https://www.selectronic.com.au/documents/TechNotes/TN0050_02%20SP%20PRO%20Serial%20Port%20Pin-out.pdf @@ -11,10 +11,10 @@ PyAware seems to already decode Serial Data. Look at porting that to portable C * A simple C parser, portable to allow parsing This repo is a **portable C parser** for the SP PRO serial protocol (ported from -[neerolyte/selpi](https://github.com/neerolyte/selpi) — PyAware itself is not open -source), packaged as a **PlatformIO / Arduino library** with an optional thin C++ -wrapper. Full protocol notes are in [docs/PROTOCOL.md](docs/PROTOCOL.md) and the ESP32 -wiring in [docs/HARDWARE.md](docs/HARDWARE.md). +[neerolyte/selpi](https://github.com/neerolyte/selpi)), packaged as a **PlatformIO / +Arduino library** with an optional thin C++ wrapper. Full protocol notes are in +[docs/PROTOCOL.md](docs/PROTOCOL.md) and the ESP32 wiring in +[docs/HARDWARE.md](docs/HARDWARE.md). ## Layout @@ -175,7 +175,6 @@ Two quirks when transcribing these: ## See Also -* pyAWARE - not open source * selpi - a Python set for seletronics * https://github.com/neerolyte/selpi * splink-influx diff --git a/docs/PROTOCOL.md b/docs/PROTOCOL.md index 978bcc0..b8d3dd4 100644 --- a/docs/PROTOCOL.md +++ b/docs/PROTOCOL.md @@ -5,11 +5,6 @@ This documents the Selectronic SP PRO serial "memory" protocol as implemented in [neerolyte/selpi](https://github.com/neerolyte/selpi)** (`memory/*.py`), cross-checked against the Go project [angus-g/splink-influx](https://github.com/angus-g/splink-influx). -> **Note on PyAware.** The project README pointed at PyAware as prior art. PyAware -> (PyPI, by Ampcontrol Group) is **not open source** — its PyPI metadata references a -> private SVN repository — so it could not be ported directly. `selpi` implements the -> same wire protocol and is fully open, so it was used as the reference instead. - ## Physical layer | Setting | Value |