sjg/trx-rs

Files

T

[docs](trx-rs): show multi-server topology in README diagram

Replace single-server Mermaid diagram with two trx-servers: one with two
SDRs, the other with an SDR and FT-817, both feeding a single trx-client.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Stan Grams <sjg@haxx.space>

2026-03-29 14:06:16 +02:00

3.3 KiB

Raw Blame History

trx-rs

A modular amateur radio control stack written in Rust.

trx-rs splits radio hardware access from user-facing interfaces so you can run rig control, SDR DSP, decoding, audio streaming, and web access as separate, composable pieces.


Backends	Yaesu FT-817, Yaesu FT-450D, SoapySDR
Frontends	Web UI, rigctl-compatible TCP, JSON-over-TCP
Decoders	AIS, APRS, CW, FT8, RDS, VDES, WSPR
Audio	Opus streaming between server, client, and browser

Quick Start

1. Install dependencies

Debian / Ubuntu

sudo apt install build-essential pkg-config cmake libopus-dev libasound2-dev
# Optional — SDR support
sudo apt install libsoapysdr-dev

Fedora

sudo dnf install gcc pkg-config cmake opus-devel alsa-lib-devel
# Optional — SDR support
sudo dnf install SoapySDR-devel

Arch Linux

sudo pacman -S base-devel pkgconf cmake opus alsa-lib
# Optional — SDR support
sudo pacman -S soapysdr

macOS (Homebrew)

brew install cmake opus
# Optional — SDR support
brew install soapysdr

See Build Requirements in the wiki for details on each library.

2. Build and run

cargo build --release
cp trx-rs.toml.example trx-rs.toml   # edit for your environment
cargo run -p trx-server
cargo run -p trx-client

Open the configured HTTP frontend address in a browser (default http://localhost:8080).

Build without SDR support: cargo build --release --no-default-features

How It Works

graph TD
    SDR1["SDR #1"] & SDR2["SDR #2"] <-->|USB| S1["trx-server A"]
    SDR3["SDR #3"] & FT817["FT-817"] <-->|USB / serial| S2["trx-server B"]

    S1 <-->|"JSON-TCP :4530"| C1["trx-client"]
    S1 -->|"Opus-TCP :4531"| C1
    S2 <-->|"JSON-TCP :4530"| C1
    S2 -->|"Opus-TCP :4531"| C1

    C1 <-->|internal channels| F1["Web UI :8080"]
    C1 <-->|internal channels| F2["rigctl :4532"]
    C1 <-->|internal channels| F3["JSON-TCP"]

Each trx-server owns one or more rigs and runs DSP, decoding, and audio capture locally. A trx-client connects to any number of servers over TCP and exposes them through a unified set of frontends.

Documentation

Resource	Description
User Manual	Configuration, features, and usage
Architecture	System design, crate layout, data flow, and internals
Optimization Guidelines	Performance guidelines for the real-time DSP pipeline
Planned Features	Roadmap and design notes
Contributing	Commit conventions, workflow, and code style

License

BSD-2-Clause. See LICENSES for bundled third-party license files.

3.3 KiB Raw Blame History