summaryrefslogtreecommitdiff
path: root/plugins/hardware/soft-modems/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/hardware/soft-modems/README.md')
-rw-r--r--plugins/hardware/soft-modems/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/plugins/hardware/soft-modems/README.md b/plugins/hardware/soft-modems/README.md
new file mode 100644
index 0000000..d3cdd53
--- /dev/null
+++ b/plugins/hardware/soft-modems/README.md
@@ -0,0 +1,23 @@
+# Hardware: Soft Modems
+
+Sound-card software modems — **MAX25-SoftModem (CRDOP)** is the in-house standard. **CRDOP** = stack acronym for **MAX25-SoftModem** (device id `soft-crdop`).
+
+| Device | Stack | HyBBX plugin | Protocol | v1 |
+|--------|-------|--------------|----------|-----|
+| `soft-crdop` | `stacks/crdop` | `crdop` | MAX25-native M25/KISS host | **active** |
+
+## CRDOP (standard)
+
+**CRDOP (MAX25-SoftModem)** — MAX25-Stack standard (`stacks/crdop/`). Built by default (`MAX25_BUILD_CRDOP=ON`). Native M25 host protocol on TCP :8515/:8516.
+
+**ARDOP-plugin** — optional separate registry for third-party ARDOP host software — see [plugins/external/ardop/README.md](../../external/ardop/README.md). Not coupled to CRDOP.
+
+## Start (operator)
+
+```bash
+./scripts/max25-ctl start --hardware soft-modems --device soft-crdop
+```
+
+Then attach HyBBX with `share/hybbx/crdop-host.ini.example`.
+
+CRDOP is acoustically AX.25-compatible at 1200 baud+; host path uses native MAX25 SoftModem TCP (M25/KISS).
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com