osmocom_fft(1)

πŸ“¦
version 0.2.6 Β· 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing

🌸 osmocom_fft(1) β€” the manual, but make it cute 🌸

okay bestie, welcome to the osmocom_fft manual page πŸ’– this is the User Commands side of the house, and I'm about to walk you through every single flag like we're texting at 2am.


✨ NAME ✨

osmocom_fft β€” Spectrum Browser πŸ“‘βœ¨


🫢 SYNOPSIS 🫢

osmocom_fft [options]

πŸ’… DESCRIPTION πŸ’…

Spectrum Browser. that's the whole vibe. it browses spectra. main character energy fr fr πŸ‘‘


πŸŽ€ OPTIONS πŸŽ€

  • -h, --help β€” show this help message and exit πŸ™‹β€β™€οΈ
  • -a ARGS, --args=ARGS β€” Device args, [default=] (yes, the default is literally empty, that's not me being lazy, that's the manpage)
  • -A ANTENNA, --antenna=ANTENNA β€” Select RX antenna where appropriate πŸ“Ά
  • -s SAMP_RATE, --samp-rate=SAMP_RATE β€” Set sample rate (bandwidth), minimum by default
  • -f FREQ, --center-freq=FREQ β€” Set frequency to FREQ 🎯
  • -c FREQ_CORR, --freq-corr=FREQ_CORR β€” Set frequency correction (ppm)
  • -g GAIN, --gain=GAIN β€” Set gain in dB (default is midpoint)
  • -W, --waterfall β€” Enable waterfall display 🌊 (iconic, obviously)
  • -S, --oscilloscope β€” Enable oscilloscope display πŸ“ˆ
  • --avg-alpha=AVG_ALPHA β€” Set fftsink averaging factor, default=[0.1]
  • --averaging β€” Enable fftsink averaging, default=[False]
  • --ref-scale=REF_SCALE β€” Set dBFS=0dB input value, default=[1.0]
  • --fft-size=FFT_SIZE β€” Set number of FFT bins [default=1024]
  • --fft-rate=FFT_RATE β€” Set FFT update rate, [default=30]
  • -v, --verbose β€” Use verbose console output [default=False] πŸ—£οΈ

πŸ¦‹ SEE ALSO πŸ¦‹

The full documentation for linux; is maintained as a Texinfo manual. If the info and linux; programs are properly installed at your site, the command

info linux;

should give you access to the complete manual.

no bestie I don't know why it says linux; either, that's literally what it says, so that's literally what I'm telling you πŸ’€

🌈 Device specification 🌈

You can specify the source or sink device using a comma separated string of argument=value pairs. The always-up-to-date block documentation with examples is available right here.


πŸ“ FCD Source πŸ“

  • fcd=<device-index> β€” 0-based device identifier, optional
  • device=hw:2 β€” overrides the audio device
  • type=2 β€” selects the dongle type, 1 for Classic, 2 for Pro+

The device argument overrides the audio device used by the underlying driver to access the dongle's IQ sample stream. 🎧

The type argument selects the dongle type, 1 for Classic, 2 for Pro+. ✌️


πŸ’œ OsmoSDR Source πŸ’œ

  • osmosdr=<device-index> β€” 0-based device identifier
  • buffers=<number-of-buffers> β€” Default is 32
  • buflen=<length-of-buffer> β€” Default is 256kB, must be multiple of 512

πŸ”₯ RTL-SDR Source πŸ”₯

  • rtl=<device-index> β€” 0-based device identifier OR serial number
  • rtl_xtal=<frequency> β€” Frequency (Hz) used for the RTL chip, accepts eng notation
  • tuner_xtal=<frequency> β€” Frequency (Hz) used for the tuner chip, accepts eng notation
  • buffers=<number-of-buffers> β€” Default is 32
  • buflen=<length-of-buffer> β€” Default is 256kB, must be multiple of 512
  • direct_samp=0|1|2 β€” Enable direct sampling mode on the RTL chip. 0: Disable, 1: use I channel, 2: use Q channel
  • offset_tune=0|1 β€” Enable offset tune mode for E4000 tuners
NOTE: use rtl_eeprom -s to program your own serial number to the device πŸ“
NOTE: if you don't specify rtl_xtal/tuner_xtal, the underlying driver will use 28.0MHz ⏰

⭐ RTL-SDR TCP Source ⭐

  • rtl_tcp=<hostname>:<port> β€” hostname defaults to "localhost", port to "1234"
  • psize=<payload-size> β€” Default is 16384 bytes
  • direct_samp=0|1|2 β€” Enable direct sampling mode on the RTL chip 0=Off, 1=I-ADC input enabled, 2=Q-ADC input enabled
  • offset_tune=0|1 β€” Enable offset tune mode for E4000 tuners

🧚 Miri Source 🧚

  • miri=<device-index> β€” 0-based device identifier
  • buffers=<number-of-buffers> β€” Default is 32

πŸ‘‘ UHD Source / Sink πŸ‘‘

  • uhd β€” Use this argument without a value
  • nchan=<channel-count> β€” For multichannel USRP configurations use the subdev parameter to specify stream mapping
  • subdev=<subdev-spec> β€” Examples: "A:0", "B:0", "A:0 B:0" when nchan=2. Refer original ettus documentation on this
  • lo_offset=<frequency> β€” Offset frequency in Hz, must be within daughterboard bandwidth. Accepts eng notation

Additional argument/value pairs will be passed to the underlying driver, for more information see specifying the subdevice and common device identifiers in the Ettus documentation. πŸ“š


πŸŽ€ bladeRF Source / Sink πŸŽ€

  • bladerf[=0] β€” 0-based device identifier (optional)
  • fw='/path/to/the/firmware.img' β€” program MCU firmware from given file. usually not needed. power cycle required. πŸ”Œ
  • fpga='/path/to/the/bitstream.rbf' β€” load FPGA bitstream from given file. required only at first run at the moment.

πŸ“‘ HackRF Source / Sink πŸ“‘

  • hackrf β€” Use this argument without a value
  • buffers=<number-of-buffers> β€” Default is 32

Only the first device found may be used at the moment because of libhackrf limitation. πŸ™ˆ

Transmit support has been verified by using the crc-mmbTools DAB sdr transmitter.


🌸 IQ File Source 🌸

  • file=<path-to-file-name>
  • freq=<frequency> β€” Center frequency in Hz, accepts eng notation
  • rate=<sampling-rate> β€” Mandatory, in samples/s, accepts eng notation
  • repeat=true|false β€” Default is true
  • throttle=true|false β€” Throttle flow of samples, default is true

✨ EXAMPLES ✨

osmocom_fft -a rtl=0 -v -f 100e6 -s 2.4e6 -g 15
osmocom_fft -a hackrf -v
osmocom_fft -a uhd -v

πŸ’– SEE ALSO πŸ’–

osmocom_siggen(1) osmocom_siggen_nogui(1) osmocom_spectrum_sense(1)


and that's the whole page bestie, you ate it, no crumbs left 🫢✨ this lil masterpiece comes to you from OSMOCOM, dated October 2013, and it's the osmocom_fft(1) page β€” go forth and browse some spectra, periodt πŸ’…πŸŒˆ

πŸ“¦ where this page comes from