CLI Reference¶
The icom-lan CLI provides quick access to radio control from the terminal.
Global Options¶
All commands accept these options:
| Option | Env Var | Default | Description |
|---|---|---|---|
--host |
ICOM_HOST |
192.168.1.100 |
Radio IP address |
--port |
ICOM_PORT |
50001 |
Control port |
--user |
ICOM_USER |
"" |
Username |
--pass |
ICOM_PASS |
"" |
Password |
--timeout |
— | 5.0 |
Timeout in seconds |
Use Environment Variables
Set ICOM_HOST, ICOM_USER, and ICOM_PASS in your shell profile to avoid typing them every time.
Commands¶
status¶
Show radio status (frequency, mode, S-meter, power).
JSON output:
freq¶
Get or set the operating frequency.
# Get current frequency
icom-lan freq
# Set frequency (multiple formats)
icom-lan freq 14074000 # Hz
icom-lan freq 14074k # kHz
icom-lan freq 14.074m # MHz
mode¶
Get or set the operating mode.
Available modes: LSB, USB, AM, CW, RTTY, FM, WFM, CW_R, RTTY_R, DV
power¶
Get or set the RF power level (0–255).
Power Scale
The 0–255 value is the radio's internal representation. The mapping to actual watts depends on your radio model and mode.
meter¶
Read all available meters.
Info
SWR and ALC are only available during TX. They show n/a when receiving.
ptt¶
Toggle Push-To-Talk.
Caution
Activating PTT will key your transmitter. Ensure your antenna is connected and you are authorized to transmit on the current frequency.
cw¶
Send CW text via the radio's built-in keyer.
The text is sent in chunks of up to 30 characters. Supports A–Z, 0–9, and standard prosigns.
power-on / power-off¶
Remote power control.
Warning
power-on only works if the radio supports wake-on-LAN and the network connection is maintained in standby mode.
discover¶
Discover Icom radios on the local network via UDP broadcast.
Exit Codes¶
| Code | Meaning |
|---|---|
0 |
Success |
1 |
Error (connection, auth, command failure) |