shellcommands.txt

Protocol
========

NanoVNA sends the prompt 'ch> ' when ready to receive a command.
Send command string terminated with '\r' (<CR> = 0x0D)
NanoVNA echoes the command string terminated with '\r\n' (<CR>,<LF> = 0x0D,0x0A)
NanoVNA sends the command response - format depends on type of command
NanoVNA terminates the response with '\r\n'
NanoVNA sends the prompt 'ch> ' and waits for next command

(This protocol is also used by tinySA)

NanoVNA Commands
================

  bandwidth cal capture clearconfig color config data dump edelay freq frequencies
  help info marker measure pause power recall refresh release reset resume s21offset
  save saveconfig scan scan_bin smooth sweep tcxo threshold time touch touchcal touchtest
  trace transform usart usart_cfg vbat vbat_offset version

Command Syntax
==============

- bandwidth {bw}
  Show or set bandwidth, bw=0: 4000 Hz, 1: 2000 Hz, n: 4000 Hz / (bw+1)

- cal [load|open|short|thru|isoln|done|reset|on|off|in]
  Show calibration or calibrate

- capture
  Capture screenshot as 320 x 240 binary rgb565 (big-endian!)

- clearconfig {protection key}
  Clear all flash memory configuration (useful if FW update shows issues), protection key = 1234

- color {id} {rgb24}
  Show or set the different item colors

- config {auto|avg|connection|mode|grid|dot|bk|flip|separator} [0|1]

- data [array]
  Get complex data
  0: S11, 1: S21,
  2: CAL_LOAD, 3: CAL_OPEN, 4: CAL_SHORT, 5: CAL_THRU, 6: CAL_ISOLN
  or 2: ETERM_ED, 3: ETERM_ES, 4: ETERM_ER, 5: ETERM_ET, 6: ETERM_EX

- dump
  Returns buffer with data received from audio codec

- edelay {t(ps)}
  Show or set edelay

- freq {frequency(Hz)}
  Stops sweeping and set port 0 output to Hz, max output is 299999999 Hz

- frequencies
  Show sample frequencies

- help
  Show available commands

- info
  Show HW/FW info

- marker [n] [off|{index}]
  Show value of active marker

- measure {none|lc|lcshunt|lcseries|xtal|cable|resonance}

- pause
  Pause measurement and screen update

- power {0-3}|{255 - auto}
  Show or set output power

- recall {id}
  Recall setting id = 0..4

- refresh

- release
  touch up event

- reset
  Reset NanoVNA

- reset dfu
  Reset NanoVNA into DFU mode

- resume
  Resume measurement and screen update

- s21offset

- save {id}
  Save setting id = 0..4

- saveconfig
  Save touchscreen calibration, vbat_offset calibration and threshold values

- scan {start(Hz)} {stop(Hz)} [points] [outmask]
  Pause sweep, do one scan from start to stop and return the output enabled by outmask
  Outmask: 1: freq, 2: S11, 4: S21, 8: return uncalibrated values, 128: scan binary

- scan_bin {start(Hz)} {stop(Hz)} [points] [outmask]
  Same as above, but binary output format, freq, s11 and s21 are enabled by mask:
  uint16_t mask; uint16_t points;
  struct { uint32_t freq; float s11_re; float s11_im; float s21_re; float s21_im; } data[ points ]

- smooth {s}
  Show or set the data smooting

- sweep {start(Hz)} [stop(Hz)] [points]
- sweep {start|stop|center|span|cw} {freq(Hz)}
  Set sweep parameter that also affect LCD (get results with command "data")

- tcxo
  Show or set the TCXO frequency (default = 26 MHz)

- threshold {frequency(Hz)}
  Show or set the frequency when to switch into harmonic mode

- time
  time {[y|m|d|h|min|sec] 0-99} or {b 0xYYMMDD 0xHHMMSS}

- touch {x y}
  touch down event at x:y

- touchcal
  Initialize the touch calibration

- touchtest
  Start a touch test

- trace {0|1|2|3|all} [logmag|phase|smith|linear|delay|swr|off] [src]
  Show the values of the current traces or changes values

- transform {on|off|impulse|step|bandpass|minimum|normal|maximum} [...]
  Switch into TDR mode

- usart

- usart_cfg

- vbat
  Show battery voltage

- vbat_offset
  Show or set the battery voltage offset (diode)

- version
  Show FW version


tinySA Commands
===============

version reset freq dac saveconfig clearconfig data frequencies scan scanraw zero sweep test
touchcal touchtest pause resume repeat status caloutput save recall trace trigger marker line
usart usart_cfg capture refresh touch release vbat vbat_offset help info color if actual_freq
attenuate level sweeptime leveloffset levelchange modulation rbw mode spur load ext_gain output
deviceid selftest correction calc threads

Command Syntax
==============

version
reset
freq
dac
saveconfig
clearconfig
data
frequencies
scan
scanraw
zero
sweep
test
touchcal
touchtest
pause
resume
repeat
status
caloutput
save
recall
trace
trigger
marker
line
usart
usart_cfg
capture
refresh
touch
release
vbat
vbat_offset
help
info
color
if
actual_freq
attenuate
level
sweeptime
leveloffset
levelchange
modulation
rbw
mode
spur
load
ext_gain
output
deviceid
selftest
correction
calc
threads