Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

rigplane

PyPI Python 3.11+ CI Docs License: MIT

RigPlane 3.0 is in public beta. Install it with pip install --pre rigplane; a plain pip install rigplane still installs the 2.x line. See What's New in 3.0 and the 3.0 beta known limitations. Testing the beta? File a 3.0 beta 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 --pre rigplane     # 3.0 is in beta; without --pre, pip installs 2.x
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 Transport Status Notes
Icom IC-7610 LAN, USB CI-V Tested on 3.0 hardware (LAN) MAIN+SUB dual-receive not hardware-certified this beta, see known limitations
Icom IC-7300 USB CI-V Tested on 3.0 hardware Single receiver, USB-only
Yaesu FTX-1 USB CAT Tested on 3.0 hardware 17 modes, VHF/UHF, C4FM, audio-derived panadapter (no hardware scope)
Icom IC-705 LAN (WiFi), USB CI-V Community-validated on 2.x; not yet validated on 3.0 CI-V 0xA4, QRP 10 W
Icom IC-9700 LAN, USB CI-V Reported by a user; not validated on 3.0 hardware VHF/UHF/SHF
Xiegu X6200 USB CI-V Validated on 2.x hardware; not yet validated on 3.0 CI-V 0xA4, 19200 baud, QRP 8 W
Xiegu X6100 USB CI-V (no backend yet) Profile only; not validated on 3.0 hardware
Lab599 TX-500 USB Kenwood CAT (no backend yet) Profile only; not validated on 3.0 hardware 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. A proprietary commercial layer (rigplane-pro) is under active development and will integrate 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. Production-grade for IC-7610 (the author's daily driver) and the Yaesu FTX-1; secondary radios are validated against the same Capability Protocols but receive less hardware-in-the-loop time. Issues, profile contributions, and field reports are welcome.

73 de KN4KYD

Metadata

Release files for rigplane 3.0.0b13

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.0.0b13
File Size Uploaded Provenance Actions
rigplane-3.0.0b13.tar.gz 19.0 MB With provenance Details for rigplane-3.0.0b13.tar.gz

Built distribution (wheel)

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

Total release size: 21.5 MB

Release files / rigplane-3.0.0b13.tar.gz

Download URL rigplane-3.0.0b13.tar.gz
Size 19.0 MB
Tags Source
SHA-256 checksum
How to use checksums
5750e11e9e038a3d363d6346d463aa88cfba68144dd6ae777a4a3fef91b80a2b
BLAKE2b-256 checksum
How to use checksums
825ce0d762011ba8fd2bd016b432816a0a98ba29e54d86f01732f1f9c34c941a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

Release files / rigplane-3.0.0b13-py3-none-any.whl

Download URL rigplane-3.0.0b13-py3-none-any.whl
Size 2.5 MB
Tags Python 3
SHA-256 checksum
How to use checksums
e1096b48fdf9080b3e41177fa98c2baaff6c20596ef89ca94a476ca6f52a2c20
BLAKE2b-256 checksum
How to use checksums
1376733c44ced6642fe72157d8d3abbaa6d67e6d8c7e1d1b6fa611bbfbc87f6e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

Security for rigplane 3.0.0b13

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for rigplane-3.0.0b13.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

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
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