Quick Start¶
Get your first connection in under 5 minutes.
1. Set Credentials¶
Use environment variables to avoid putting credentials in code:
export ICOM_HOST=192.168.1.100 # Your radio's IP
export ICOM_USER=myuser # Network username
export ICOM_PASS=mypass # Network password
2. Try the CLI¶
Expected output:
# Change frequency
icom-lan freq 14.074m
# Change mode
icom-lan mode USB
# Read meters as JSON
icom-lan meter --json
3. Python API¶
import asyncio
from icom_lan import IcomRadio
async def main():
async with IcomRadio(
"192.168.1.100",
username="myuser",
password="mypass",
) as radio:
# Read current state
freq = await radio.get_frequency()
mode = await radio.get_mode()
s_meter = await radio.get_s_meter()
print(f"{freq/1e6:.3f} MHz {mode.name} S={s_meter}")
# Tune to 20m FT8
await radio.set_frequency(14_074_000)
await radio.set_mode("USB")
asyncio.run(main())
4. Discover Radios¶
Don't know your radio's IP? Use autodiscovery:
What's Next?¶
- CLI Reference — full list of CLI commands
- CI-V Commands — frequency, mode, meters, PTT, CW, VFO
- API Reference — complete
IcomRadioAPI documentation - Connection Lifecycle — understand the handshake and keep-alive