trx-rs logo # trx-rs A modular amateur radio control stack written in Rust. [![License](https://img.shields.io/badge/license-BSD--2--Clause-blue.svg)](LICENSES)
`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 ```bash sudo apt install build-essential pkg-config cmake libopus-dev libasound2-dev # Optional — SDR support sudo apt install libsoapysdr-dev ```
Fedora ```bash sudo dnf install gcc pkg-config cmake opus-devel alsa-lib-devel # Optional — SDR support sudo dnf install SoapySDR-devel ```
Arch Linux ```bash sudo pacman -S base-devel pkgconf cmake opus alsa-lib # Optional — SDR support sudo pacman -S soapysdr ```
macOS (Homebrew) ```bash brew install cmake opus # Optional — SDR support brew install soapysdr ```
See [Build Requirements](https://github.com/sgrams/trx-rs/wiki/User-Manual#build-requirements) in the wiki for details on each library. ### 2. Build ```bash cargo build --release ``` Build without SDR support: `cargo build --release --no-default-features` ### 3. Configure Run the interactive setup wizard to generate config files for your station: ```bash ./target/release/trx-configurator ``` The wizard walks you through rig selection, serial port detection, audio settings, and frontend options, then writes `trx-server.toml` and `trx-client.toml`. Alternatively, generate example configs and edit them by hand: ```bash ./target/release/trx-server --print-config > trx-server.toml ./target/release/trx-client --print-config > trx-client.toml ``` ### 4. Run ```bash ./target/release/trx-server --config trx-server.toml ./target/release/trx-client --config trx-client.toml ``` Open the configured HTTP frontend address in a browser (default `http://localhost:8080`). ## How It Works ```mermaid 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 per rig"| C1 S2 <-->|"JSON-TCP :4530"| C1 S2 -->|"Opus-TCP per rig"| C1 C1 <-->|internal channels| F1["Web UI :8080"] C1 <-->|internal channels| F2["rigctl :4532"] ``` 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](https://github.com/sgrams/trx-rs/wiki/User-Manual) | Configuration, features, and usage | | [Architecture](https://github.com/sgrams/trx-rs/wiki/Architecture) | System design, crate layout, data flow, and internals | | [Optimization Guidelines](https://github.com/sgrams/trx-rs/wiki/Optimization-Guidelines) | Performance guidelines for the real-time DSP pipeline | | [Planned Features](https://github.com/sgrams/trx-rs/wiki/Planned-Features) | Roadmap and design notes | | [Contributing](CONTRIBUTING.md) | Commit conventions, workflow, and code style | ## License BSD-2-Clause. See [`LICENSES`](LICENSES) for bundled third-party license files.