Skip to content

Command Reference

Jump to bottom
null edited this page Jun 17, 2026 · 3 revisions

All commands are typed into the serial console (or Python CLI) at 115200 baud.
Commands are case‑sensitive. Parameters in <angle> brackets are required.

📋 Table of Contents

⚙️ Basic Configuration

Command Description
setmodulation <mode> Set modulation: 0=2‑FSK, 1=GFSK, 2=ASK/OOK, 3=4‑FSK, 4=MSK.
setmhz <frequency> Centre frequency in MHz (e.g. 433.92). Valid ranges: 300‑348, 387‑464, 779‑928.
setdeviation <deviation> Frequency deviation in kHz (1.58 – 380.85).
setchannel <channel> Channel number (0–255). Default 0.
setchsp <spacing> Channel spacing in kHz (25.39 – 405.45). Multiplied by channel and added to base frequency.
setrxbw <bw> Receive bandwidth in kHz (58.03 – 812.50).
setdrate <datarate> Data rate in kBaud (0.02 – 1621.83).
setpa <power> TX power in dBm. Allowed: -30, -20, -15, -10, -6, 0, 5, 7, 10, 11, 12. Default = max.

📦 Packet & FIFO Settings

Command Description
setsyncmode <mode> Sync‑word qualifier:
• 0 = No preamble/sync
• 1 = 16 sync bits
• 2 = 16/16 sync bits
• 3 = 30/32 sync bits
• 4 = No sync, carrier‑sense
• 5 = 15/16 + carrier‑sense
• 6 = 16/16 + carrier‑sense
• 7 = 30/32 + carrier‑sense
setsyncword <LOW, HIGH> Two‑byte sync word in decimal (e.g. 211,145). Must match on TX and RX.
setadrchk <mode> Address check: 0=off, 1=check (no broadcast), 2=check + 0x00 broadcast, 3=check + 0x00 & 0xFF broadcast.
setaddr <address> Node address (0–255) for packet filtering.
setwhitedata <mode> Data whitening: 0=off, 1=on.
setpktformat <mode> Packet format: 0=Normal FIFO, 1=Sync serial, 2=Random TX, 3=Async serial.
setlengthconfig <mode> Length mode: 0=Fixed, 1=Variable, 2=Infinite, 3=Reserved.
setpacketlength <length> Packet length in bytes (fixed mode) or max length (variable).
setcrc <mode> CRC: 0=off, 1=on.
setcrcaf <mode> Auto‑flush RX FIFO on CRC error: 0=off, 1=on.
setdcfilteroff <mode> DC blocking filter: 0=enable (better sensitivity), 1=disable (optimised for >250 kBaud).
setmanchester <mode> Manchester encoding: 0=off, 1=on.
setfec <mode> Forward Error Correction (fixed packet only): 0=off, 1=on.
setpre <mode> Preamble bytes (0–7): 0:2, 1:3, 2:4, 3:6, 4:8, 5:12, 6:16, 7:24.
setpqt <mode> Preamble quality estimator threshold (0–255).
setappendstatus <mode> Append RSSI/LQI status bytes to payload: 0=off, 1=on.

📊 Advanced RF Controls

Command Description
getrssi Show RSSI and LQI of the last received frame.
analyze Scan the current band (hopping) and report the strongest signal.
jam Toggle continuous jamming on the selected frequency. Stop with x.

🕵️ Sniffing & Monitoring

Command Description
rx Toggle sniffer – prints every received packet in hex.
rxraw <microseconds> Sample the radio at the given interval (µs) and print raw bytes.
recsig Start recording fixed‑code remote signals for later replay.
showbit Display the recording buffer as a binary bitstream.

💾 Recording & Replaying

Command Description
rec Toggle recording of complete packet payloads into the buffer.
recraw <microseconds> Record raw OOK samples with the given sampling interval (µs).
add <hex‑vals> Manually add a frame payload (max 64 hex bytes) to the buffer.
addraw <hex‑vals> Manually add raw chunks (max 60 hex bytes) to the buffer.
show Display all recorded frames (payloads).
showraw Display recorded raw data.
flush Clear the recording buffer.
play <N> Replay frame N (or 0 for all frames) from the buffer.
playraw <microseconds> Replay raw data with the specified sampling interval.
playsig Replay the fixed‑code remote signal stored in the buffer.
save Store the current payload buffer to non‑volatile memory (flash).
load Load the payload buffer from flash.
saveraw Store the raw buffer to flash.
loadraw Load the raw buffer from flash.

🛠️ Utility Commands

Command Description
brute <usec> <bits> Brute‑force a garage remote with the given symbol time (µs) and bit length.
chat Enable broadcast chat mode between devices. No exit – disconnect to quit.
echo <mode> Toggle serial echo: 0=off, 1=on.
x Stop all ongoing activities (jamming, receiving, recording).
init Reset the CC1101 to its default configuration (as defined in the firmware).

💡 Quick Tips

  • Use help at any time to see a summary.
  • Most settings take effect immediately – no restart needed.
  • The analyze command can help you find active frequencies before sniffing.
  • Always use x to gracefully stop operations like jam, rx, or rec.

➡️ Next Steps

Now that you know the commands, check out the Usage Examples page for practical walkthroughs, or dive into Recording & Replay Workflow to master signal capture.

Clone this wiki locally