Skip to content

Update README to reflect official rigctl/Hamlib support and Mermaid architecture #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xylo04 merged 6 commits into from
Jun 30, 2026
Merged

Update README to reflect official rigctl/Hamlib support and Mermaid architecture #170

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7f67617
Update README with hamlib support and Mermaid architecture
Copilot Jun 30, 2026
9ec7d1d
Align README diagram labels with Hamlib support wording
Copilot Jun 30, 2026
e85aaf8
docs: clarify kel-agent is a protocol bridge, not an AI agent (#169)
Copilot Jun 30, 2026
567a998
Highlight kel-agent node in README Mermaid diagram
Copilot Jun 30, 2026
b9f4fbd
docs: clarify kel-agent is a protocol bridge, not an AI agent (#169)
Copilot Jun 30, 2026
a514dc4
Merge branch 'main' into copilot/update-readme-hamlib-support
xylo04 Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,29 @@ AI agent.
This bridge was built to support https://github.com/k0swe/forester but can be used by any web
application that needs to communicate with amateur radio installed programs.

![Architecture](architecture.svg)

This currently supports communication with WSJT-X. Planned support includes `rigctld` and Ham Radio
Deluxe for transceiver remote control.
```mermaid
flowchart LR
Internet([Internet]) --- Application[Web Application]
subgraph Computer
subgraph Browser[Web Browser]
Application
end
agent[kel-agent]
WSJTX[WSJT-X]
rigctld[rigctl/Hamlib]
HRD[HRD]
etc[...]
end
Application ---|websocket| agent
agent ---|UDP| WSJTX
agent ---|lib| rigctld
agent -.->|UDP| HRD
agent -.-> etc
style agent fill:#8ecfff,stroke:#1f2937,stroke-width:2px
```

This currently supports communication with WSJT-X, and now officially supports rig control via
`rigctl`/Hamlib. Ham Radio Deluxe support remains planned.

To get started using `kel-agent`, download an appropriate executable from the
[latest release](https://github.com/k0swe/kel-agent/releases/latest). Windows, Mac, Debian/Ubuntu
Expand Down
Loading