Skip to main content

rigplane

PyPI Python 3.11+ CI Docs Website License: MIT

RigPlane 3.0 is released. A plain pip install rigplane installs it. Upgrading from 2.x? 3.0 requires the radio model (--model); see What's New in 3.0 and the migration guide. Known gaps are listed in 3.0 known limitations. Tried it on your radio? Send a 3.0 report.

rigplane is an open-source (MIT) Python asyncio library and web UI for Icom radios (LAN/USB) and the Yaesu FTX-1 (USB), with a rigctld server. It has native providers for Icom CI-V and Yaesu CAT paths. The rigctld server lets Hamlib-aware programs such as WSJT-X, fldigi and JS8Call control the radio.

rigplane Web UI — IC-7610 dual-RX desktop with scope and waterfall

Quickstart

pip install rigplane
rigplane --model IC-7610 web   # discovers the radio's IP on the LAN
# open http://localhost:8080

Or as a library:

import asyncio
from rigplane import create_radio, LanBackendConfig

async def main():
    async with create_radio(LanBackendConfig(host="192.168.1.100",
                                             username="user",
                                             password="pass",
                                             model="IC-7610")) as radio:
        await radio.set_frequency(14_074_000)
        await radio.set_mode("USB")
        print(await radio.get_s_meter())

asyncio.run(main())

Full guides: getting started, CLI, public API surface.

Supported radios

Radio --model value Transport Notes
Icom IC-7610 IC-7610 LAN, USB CI-V Dual receiver; see known limitations
Icom IC-7300 IC-7300 USB CI-V Single receiver, USB-only
Icom IC-7300MK2 IC-7300MK2 LAN, USB CI-V
Yaesu FTX-1 FTX-1 USB CAT 17 modes, VHF/UHF, C4FM, audio-derived panadapter (no hardware scope)
Yaesu FT-991A FT-991A USB CAT HF/VHF/UHF; not yet verified on hardware
Icom IC-705 IC-705 LAN (WiFi), USB CI-V CI-V 0xA4, QRP 10 W
Icom IC-9700 IC-9700 LAN, USB CI-V VHF/UHF/SHF
Icom IC-905 IC-905 LAN, USB CI-V Documented profile only: 5.6 GHz spectrum and wide spans do not work yet, no 10 GHz/DD/ATV
Xiegu X6200 X6200 USB CI-V CI-V 0xA4, 19200 baud, QRP 8 W
Xiegu G7250 G7250 USB CI-V; LAN (wfview mode, firmware V1.0.1+) 115200 baud, HF/50 MHz; audio-derived panorama only (no network scope yet); TX not verified; see radios
Xiegu X6100 X6100 USB CI-V Profile only, no backend yet
Lab599 TX-500 TX-500 USB Kenwood CAT Profile only, no backend yet; QRP, minimal CAT

Native radio capabilities are declared in rigs/*.toml. For long-tail serial CAT radios, the intended path is Hamlib-backed control underneath RigPlane's capability model, with structured discovery candidates and safe read-only probing where possible. See adding a new radio.

Why 1.0

  • Public API stability commitment. The Tier 1 surface — the Radio protocol, the capability protocols (AudioCapable, ScopeCapable, MetersCapable, LevelsCapable, StatePollable, RigctldRoutable, UsbAudioCapable, …), create_radio / BackendConfig, and the local-extensions/ host API — is now under SemVer. See docs/api/public-api-surface.md.
  • Capability-driven multi-radio architecture. Implement the relevant Capability Protocols and your backend slots into the runtime, Web UI, and rigctld layers without any of those layers knowing about your radio. See ARCHITECTURE.md.
  • 5,600+ unit tests. import-linter enforces 11-layer package boundaries; mypy is clean across the public surface; ruff lints in CI.
  • Verified against the digital-mode ecosystem. WSJT-X, fldigi, and JS8Call golden-replay tests pass over the rigctld bridge with full per-VFO routing.

Web UI

rigplane web boots a self-contained HTTP + WebSocket server. The frontend is a Svelte 5 single-page app served from the same process; no native shell, no Electron, no Tauri — just a browser tab.

Four user-facing skins resolve from frontend/src/skins/registry.ts:

  • Desktop v2 — default skin: dual-RX VFO, scope + waterfall, meters dock, control panels.
  • LCD Scope — alternative dual-RX layout with vintage-LCD typography and the same scope + meters dock.
  • LCD Cockpit — single-RX or dual-cockpit variants with retro LCD styling, telemetry strip, AmberScope (also resolves under the legacy amber-lcd alias).
  • Mobile — chip-scroll IA, persistent guarded PTT FAB, container-query responsive layout.

LCD Scope skin — dual-RX with vintage-LCD typography and scope panel LCD Cockpit (amber) skin with vintage-LCD typography and AmberScope

Architecture

src/rigplane/ is organised into 11 layered Python packages (core/, commands/, profiles/, audio/, scope/, dsp/, runtime/, backends/, web/, rigctld/, cli/) with explicit boundaries enforced by import-linter. Higher layers depend on lower ones; siblings are independent. See ARCHITECTURE.md for the layout and per-layer charters in src/rigplane/<layer>/LAYER.md.

Extensibility is centred on Capability Protocols in rigplane.radio_protocol. A new backend implements the protocols it supports; consumers (Web UI, rigctld, CLI, third-party scripts) feature-detect via isinstance(radio, ScopeCapable) and never branch on backend identity. The Radio protocol plus the capability suite is the stable contract between the open core and downstream consumers.

The frontend extension surface lives at frontend/src/lib/local-extensions/ — a Tier 1 contract for embedders shipping panels, dock items, or keyboard scopes into the open-core shell.

Documentation

License

MIT — see LICENSE. Protocol knowledge derived from the wfview project's reverse-engineering work; this is an independent clean-room implementation, not a derivative of wfview's GPLv3 code. Icom™ and IC-* product names are registered trademarks of Icom Incorporated, used here for nominative fair-use compatibility identification only — this project is not affiliated with, endorsed by, or sponsored by Icom.

rigplane is the open-core half of a planned product split. RigPlane Pro (rigplane-pro), the commercial desktop app, is in public beta and can be downloaded from rigplane.com/downloads. It integrates with this library through the public Radio protocol and the local-extensions/ host API. Open-core constraints — no telemetry, headless mode is sacred, no hollowing out — are codified in docs/architecture/open-core-policy.md.

Status

KN4KYD's personal project. Each supported radio is described by its rigs/*.toml profile and uses the same Capability Protocols. Issues, profile contributions, and field reports are welcome.

73 de KN4KYD

Metadata

Release files for rigplane 3.2.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rigplane 3.2.2
File Size Uploaded Provenance Actions
rigplane-3.2.2.tar.gz 18.9 MB Without provenance Details for rigplane-3.2.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for rigplane 3.2.2
File Interpreter ABI Platform Actions
rigplane-3.2.2-py3-none-any.whl Python 3 none any Details for rigplane-3.2.2-py3-none-any.whl

Total release size: 22.0 MB

Release files / rigplane-3.2.2.tar.gz

Download URL rigplane-3.2.2.tar.gz
Size 18.9 MB
Tags Source
SHA-256 checksum
How to use checksums
1b881927c4d0edf28cc99890cab9951502e5cce5c10f2e6cd216b605b7767609
BLAKE2b-256 checksum
How to use checksums
b05bfa6b869c7d029fe5fa01cabd17bb8b1ab3da5a4b3f29cb57e6260b67bd26
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / rigplane-3.2.2-py3-none-any.whl

Download URL rigplane-3.2.2-py3-none-any.whl
Size 3.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
5ca3361850040a88355d778a18dcdc4a64363256b1ea9e4b232f0e5a2f1035ca
BLAKE2b-256 checksum
How to use checksums
8a1a163f664456f33ce041530a271746fde3452539e90d5f1991401e249ad2cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.9 {"installer":{"name":"uv","version":"0.13.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"22.04","id":"jammy","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for rigplane 3.2.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

3.2.2 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page