summaryrefslogtreecommitdiff
path: root/plugins/external
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 /plugins/external
Initial push
Diffstat (limited to 'plugins/external')
-rw-r--r--plugins/external/README.md28
-rw-r--r--plugins/external/ardop/README.md30
-rw-r--r--plugins/external/ardop/plugin.yaml32
3 files changed, 90 insertions, 0 deletions
diff --git a/plugins/external/README.md b/plugins/external/README.md
new file mode 100644
index 0000000..b035c09
--- /dev/null
+++ b/plugins/external/README.md
@@ -0,0 +1,28 @@
+# Optional plugins — ARDOP-plugin
+
+**CRDOP (MAX25-SoftModem)** is the **MAX25-Stack standard** modem — built and installed by default (`MAX25_BUILD_CRDOP=ON`). See `plugins/devices/soft-crdop/`.
+
+## ARDOP-plugin
+
+| Item | Detail |
+|------|--------|
+| **Plugin** | **ARDOP-plugin** — optional registry for third-party ARDOP host wire |
+| **Registry** | [ardop/plugin.yaml](ardop/plugin.yaml) |
+| **CRDOP coupling** | **None** — ARDOP is not enabled via `soft-crdop` or `crdop.ini` |
+| **Standard alternative** | Native CRDOP / M25-KISS host (default) |
+
+### Using ARDOP-plugin
+
+1. Install and run an ARDOP-capable modem host on the operator machine (third-party software).
+2. Attach HyBBX or another consumer per that ARDOP host's documentation.
+3. Keep CRDOP on native M25/KISS — do not mix ARDOP wire mode into CRDOP configs.
+
+See [ardop/README.md](ardop/README.md).
+
+## MAX25 standard (not ARDOP-plugin)
+
+| Item | Role |
+|------|------|
+| **CRDOP / MAX25-SoftModem** | In-house standard — `MAX25_BUILD_CRDOP=ON` (default) |
+| `stacks/crdop/` | CRDOP subproject — INI, launcher, native M25 host, docs |
+| `max25d` `crdop-tcp` backend | Standard integration (native M25/KISS) |
diff --git a/plugins/external/ardop/README.md b/plugins/external/ardop/README.md
new file mode 100644
index 0000000..b15469d
--- /dev/null
+++ b/plugins/external/ardop/README.md
@@ -0,0 +1,30 @@
+# ARDOP-plugin
+
+Optional **MAX25-Stack plugin** for operators who run **third-party ARDOP host software** alongside MAX25.
+
+**CRDOP (MAX25-SoftModem)** is the MAX25 standard sound-card modem — native M25/KISS on TCP :8515/:8516. ARDOP is **not** part of CRDOP and is **not** enabled via `soft-crdop` or `crdop.ini`.
+
+## When to use
+
+| Path | Use |
+|------|-----|
+| **CRDOP (default)** | Native MAX25-SoftModem — M25/KISS host via `crdopc` / `audio-dummyd` |
+| **ARDOP-plugin** | Operator-provided ARDOP host (Winlink-class wire) — separate from CRDOP |
+
+## Platform
+
+| Host | Notes |
+|------|-------|
+| **Linux / KLinux** | Typical for third-party ARDOP host software |
+| **FreeBSD / *BSD** | CRDOP/OSS only — ARDOP host not integrated in MAX25 |
+| **macOS / Windows** | Out of scope for MAX25 daemon path |
+
+## Operator workflow
+
+1. Install and run an ARDOP-capable modem host on the operator machine (third-party software).
+2. Point HyBBX or another consumer at the ARDOP host TCP ports per that software's documentation.
+3. Do **not** set CRDOP or `soft-crdop` INI flags for ARDOP — CRDOP remains native M25/KISS only.
+
+## Metadata
+
+[plugin.yaml](plugin.yaml) · [../README.md](../README.md)
diff --git a/plugins/external/ardop/plugin.yaml b/plugins/external/ardop/plugin.yaml
new file mode 100644
index 0000000..3a25e72
--- /dev/null
+++ b/plugins/external/ardop/plugin.yaml
@@ -0,0 +1,32 @@
+id: ardop-plugin
+type: optional
+parent_stack: MainAX25-Stack (MAX25-Stack)
+label: ARDOP-plugin
+status: optional
+
+note: |
+ ARDOP-plugin is an optional MAX25-Stack plugin registry entry for third-party
+ ARDOP host wire mode. It is separate from CRDOP (MAX25-SoftModem).
+ MAX25 ships CRDOP as the standard sound-card modem with native M25/KISS host.
+ Operators who need ARDOP run external ARDOP host software independently.
+
+policy:
+ max25_standard_modem: CRDOP
+ crdop_code_in_max25: true
+ ardop_modem_binary_in_max25: false
+ crdop_ardop_compat: false
+
+standard_modem:
+ product: MAX25-SoftModem
+ device: soft-crdop
+ stack: stacks/crdop
+ protocol: max25-softmodem
+
+wire:
+ format: ardop-host-tcp
+ note: Third-party ARDOP host — not wired through CRDOP or soft-crdop INI
+
+docs:
+ - plugins/external/README.md
+ - plugins/external/ardop/README.md
+ - docs/CRDOP.md
git clone -b <branch> https://cgit.mode42.com/<repo>.git
git clone -b <branch> git://cgit.mode42.com/<repo>.git

info@mode42.com