Sh3d/SPPro
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Scott Penrose
2026-06-16 05:02:54 +10:00
parent 436d452deb
commit 7fe986becc
2 changed files with 5 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -6
View File
@@ -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. 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 * Hardware necessary to connect to SPPro
* https://www.selectronic.com.au/documents/TechNotes/TN0050_02%20SP%20PRO%20Serial%20Port%20Pin-out.pdf * 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 * A simple C parser, portable to allow parsing
This repo is a **portable C parser** for the SP PRO serial protocol (ported from 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 [neerolyte/selpi](https://github.com/neerolyte/selpi)), packaged as a **PlatformIO /
source), packaged as a **PlatformIO / Arduino library** with an optional thin C++ Arduino library** with an optional thin C++ wrapper. Full protocol notes are in
wrapper. Full protocol notes are in [docs/PROTOCOL.md](docs/PROTOCOL.md) and the ESP32 [docs/PROTOCOL.md](docs/PROTOCOL.md) and the ESP32 wiring in
wiring in [docs/HARDWARE.md](docs/HARDWARE.md). [docs/HARDWARE.md](docs/HARDWARE.md).
## Layout ## Layout
@@ -175,7 +175,6 @@ Two quirks when transcribing these:
## See Also ## See Also
* pyAWARE - not open source
* selpi - a Python set for seletronics * selpi - a Python set for seletronics
* https://github.com/neerolyte/selpi * https://github.com/neerolyte/selpi
* splink-influx * splink-influx
docs/PROTOCOL.md
-5
View File
@@ -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 [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). 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 ## Physical layer
| Setting | Value | | Setting | Value |