summaryrefslogtreecommitdiff
path: root/stacks/tncs/README.md
diff options
context:
space:
mode:
authorinfo@mode42.com <info@mode42.com>2026-08-07 18:25:13 +0000
committerinfo@mode42.com <info@mode42.com>2026-08-07 18:25:13 +0000
commit04d965d67a7264a1c7c211494aebda1953df7603 (patch)
tree0ebd700a6e219f84a26a656f4bee8778bc75da7b /stacks/tncs/README.md
Initial push
Diffstat (limited to 'stacks/tncs/README.md')
-rw-r--r--stacks/tncs/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/stacks/tncs/README.md b/stacks/tncs/README.md
new file mode 100644
index 0000000..e07a9ac
--- /dev/null
+++ b/stacks/tncs/README.md
@@ -0,0 +1,40 @@
+# stacks/tncs — Serial TNC tools
+
+Operator tools and docs for **Landolt TNC2C** and **PK-TNC2** (TheFirmware TNC-2 class). HyBBX attaches via `packet_radio` after MAX25 prep.
+
+**Recovery:** software-first (no power cycle in normal ops). Power-cycle boot-wait is rescue only. See [docs/TNC-RECOVERY.md](docs/TNC-RECOVERY.md).
+
+## Quick start
+
+```bash
+./scripts/build.sh
+./scripts/max25-ctl start --hardware tncs --device tnc2c
+```
+
+Adjust serial port in `tnc2c-serial.env` before first use.
+
+## Documentation
+
+| Doc | Content |
+|-----|---------|
+| [docs/TNC-RECOVERY.md](docs/TNC-RECOVERY.md) | Software ladder, rescue power-cycle |
+| [docs/TNC2C-OPERATIONS.md](docs/TNC2C-OPERATIONS.md) | Boot-wait, health, HyBBX handoff |
+| [docs/TNC2C-REFERENCE.md](docs/TNC2C-REFERENCE.md) | Parameters, tools, example profile |
+| [docs/HYBBX-TNC2C.md](docs/HYBBX-TNC2C.md) | HyBBX Secondary attach |
+
+HyBBX INI: [`hybbx-tnc2c.ini`](hybbx-tnc2c.ini) (onboard ttyS4 example) · shipped copy: `../../share/hybbx/tnc2c-host.ini.example` · dual TNC: [`hybbx-dual.ini`](hybbx-dual.ini)
+
+## Tools
+
+| Tool | Purpose |
+|------|---------|
+| `tnc2c-host-reset.sh` | Software recovery (no power cycle) |
+| `tnc2c-boot-wait.sh` | DTR during power-on — **rescue**; `--recover-only` for ladder only |
+| `pktnc2-boot-wait.sh` | PK-TNC2 wrapper (9600 8N1); supports `--recover-only` |
+| `tnc2c-integration-test.sh` | HyBBX-ready check |
+| `tnc2c-health.sh` | Serial/TNC check (no TX) |
+| `tnc2c-probe` | Scan serial ports for TNC response |
+
+## Safety
+
+KISS and TX tests can key the radio. Use a dummy load for transmit tests.
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com