SmartSDR Command Line API

From SmartSDR Wiki
Jump to: navigation, search

The SmartSDR command line API exists for local debugging of the hardware and/or the SmartSDR Engine software. Commands that are similar between the Command Line API and TCP/IP API use the same Engine functions to complete the commands.

General Functions

  • b → display banner
  • cls → clear screen
  • exit → terminate SmartSDR application
  • help → request a list of commands
  • ?see help

SmartSDR Commands

  • chain → control or display signal chain details
  • client → control clients
  • display → add/remove or control displays
  • filt → adjust DSP filters in signal chains
  • fdx → control foundation receivers
  • fpga → read or write FPGA registers
  • meter → control metering functions
  • mmx → display status of mini-mixer receivers
  • scu → control signal capture units
  • sleep → sleep for one second
  • slice → control slice receivers
  • stream_stat → view status of in-bound streams (from FPGA)
  • sub → add subscription to data updates
  • sum → enable or disable summing
  • trace → ?
  • unsub → remove subscription to data updates
  • version → report software version number

Hardware Commands

SmartSDR runs on multiple hardware platforms and the commands for these platforms varies. Here is a list of the commands that are used on the MICROBURST hardware platform:

  • ad9122 → control or display DAC settings
  • ad9467 → control or display ADC settings
  • ad9512 → control or display master clock settings
  • adau1761 → control or display CODEC settings
  • adl5201 → control or display preamp/exciter settings
  • alc → read ALC ADC
  • date → display the current date
  • eeprom → read or write the EEPROM
  • fpga_raw_check → run an Ethernet check on data from FPGA to daVinci
  • gpio → read or write GPIO lines on the daVinci
  • i2c → execute raw I2C transfers
  • init → write factory values to EEPROM
  • io → read or write directly from or to daVinci memory
  • log → adjust logging function
  • m24c64 → read or write the TRX EEPROM
  • psoc → control or display PSoC settings
  • pa_relay → control relays on the PA board
  • spi → execute raw SPI transfers
  • time → display the current time
  • trx_relay → control relays on the TRX board


colors