summaryrefslogtreecommitdiff
path: root/docs/BAYCOM.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/BAYCOM.md')
-rw-r--r--docs/BAYCOM.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/BAYCOM.md b/docs/BAYCOM.md
new file mode 100644
index 0000000..14ef442
--- /dev/null
+++ b/docs/BAYCOM.md
@@ -0,0 +1,57 @@
+# BayCom/based · HyBBX
+
+Public mark: **BayCom/based**. Never **Konverter** / **converter**.
+
+**Transport plugin** (`plugins/baycom/`) for PC-COM / SER12-class hardware via MAX25. SER12 L1 (HDLC + UART modem-control) lives in **MAX25 max25-bcpr** (device **`max25e0`**) — not inside HyBBX `packet_radio`.
+
+## Status: available and usable
+
+| Item | Value |
+|------|-------|
+| Build | `HYBBX_PLUGIN_BAYCOM=ON` (**default**) |
+| Enable | `[networks] baycom=yes` + `[transport.baycom1]` |
+| Standalone Main | `[instance] standalone=yes` — local RF with TNC + BayCom on one host |
+| KISS device | **`/tmp/max25-bcpr/kiss-bc0`** (max25d releases PTY after prep) |
+| Start order | **max25d first** → `[max25] check=yes` → hybbxd |
+| INI examples | `share/hybbx-standalone.ini.example` · `share/hybbx/baycom-ser12-host.ini.example` |
+
+`packet_radio` rejects `tnc=baycom` / `tnc=pccom` (not TNC profiles). Use the **baycom** transport for PC-COM.
+
+## Minimal INI
+
+```ini
+[instance]
+standalone = yes
+
+[networks]
+ax25 = yes
+baycom = yes
+
+[transport.baycom1]
+backend = kiss
+device = /tmp/max25-bcpr/kiss-bc0
+serial_baud = 1200
+frequency_mhz = 26.675
+
+[max25]
+check = yes
+host = 127.0.0.1
+port = 7325
+```
+
+## Operator notes
+
+| Rule | Detail |
+|------|--------|
+| RX before TX | Prove decode / Soft-DCD before live TX on PC-COM |
+| Circuit | BayCom link connects to internal HBX hub (`circuit_host` / `circuit_port`) |
+| Broadcast | AX.25 auto-beacon includes baycom link when circuit QoS qualifies |
+
+## Related
+
+| Goal | Doc |
+|------|-----|
+| TNC serial (`packet_radio`) | [TNCS.md](TNCS.md) |
+| Manual | [MANUAL.md](MANUAL.md) |
+| MAX25 BayCom/based | MAX25-Stack [docs/BAYCOM.md](../MAX25-Stack/docs/BAYCOM.md) · device `max25e0` |
+| Co-host runbook | [MASTER-GUIDE.md](MASTER-GUIDE.md) |
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com