readme.md
HackRF input plugin
Introduction
This intput sample source plugin gets its samples from a HackRF device.
Build
The plugin will be built only if the HackRF host library is installed in your system. If you build it from source and install it in a custom location say: /opt/install/libhackrf you will have to add -DLIBHACKRF_INCLUDE_DIR=/opt/install/libhackrf/include -DLIBHACKRF_LIBRARIES=/opt/install/libhackrf/lib/libhackrf.so to the cmake command line.
The HackRF Host library is also provided by many Linux distributions and is built in the SDRangel binary releases.
Interface
1: Common stream parameters
1.1: Frequency
This is the center frequency of reception in kHz.
1.2: Start/Stop
Device start / stop button.
- Blue triangle icon: device is ready and can be started
- Green square icon: device is running and can be stopped
- Red square icon: an error occured. In the case the device was accidentally disconnected you may click on the icon, plug back in and start again.
If you have the Tx open in another tab and it is running then it will be stopped automatically before the Rx starts. In a similar manner the Rx will be stopped before the Tx is started from the Tx tab.
The settings on Rx or Tx tab are reapplied on start so these settings can be considered independent.
1.3: Record
Record baseband I/Q stream toggle button
1.4: Baseband sample rate
Baseband I/Q sample rate in kS/s. This is the device sample rate (4) divided by the decimation factor (6).
2: Local Oscillator correction
Use this slider to adjust LO correction in ppm. It can be varied from -10.0 to 10.0 in 0.1 steps and is applied in software.
3: Auto correction options
These buttons control the local DSP auto correction options:
- DC: auto remove DC component
- IQ: auto make I/Q balance. The DC correction must be enabled for this to be effective.
3A: Link Tx frequency
Use this button to toggle the device Tx frequency link.
When active (button lit) and a tab is opened for the Tx part of the same device this option will activate the link of the Tx frequency to the Rx frequency. Thus when changing the Rx frequency the Tx frequency will vary by the same amount. This facilitates the split operation or repeater operation. You can also set the Tx frequency so that it follows exactly the Rx frequency (simplex).
The amount of shift is simply set by changing the frequency in the Tx tab.
4: Bias tee
Use this checkbox to toggle the +5V power supply on the antenna connector.
5:RF amp
Use this checkbox to toggle the extra low noise amplifier (LNA). This gives an additional gain of 14 dB.
6: Device sample rate
This is the HackRF device ADC sample rate in S/s.
Use the wheels to adjust the sample rate. Left click on a digit sets the cursor position at this digit. Right click on a digit sets all digits on the right to zero. This effectively floors value at the digit position. Wheels are moved with the mousewheel while pointing at the wheel or by selecting the wheel with the left mouse click and using the keyboard arroews. Pressing shift simultanoeusly moves digit by 5 and pressing control moves it by 2.
7: Rx filter bandwidth
This is the Rx filter bandwidth in kHz. Possible values are: 1750, 2500, 3500, 5000, 5500, 6000, 7000, 8000, 9000, 10000, 12000, 14000, 15000, 20000, 24000, 28000 kHz.
8: Decimation factor
The device stream from the HackRF is decimated to obtain the baseband stream. Possible values are:
- 1: no decimation
- 2: divide devcie stream sample rate by 2
- 4: divide devcie stream sample rate by 4
- 8: divide devcie stream sample rate by 8
- 16: divide devcie stream sample rate by 16
- 32: divide devcie stream sample rate by 32
10: Internal LNA gain
The LNA gain can be adjusted from 0 dB to 40 dB in 8 dB steps.
11: Rx variable gain amplifier gain
The Rx VGA gain can be adjusted from 0 dB to 62 dB in 2 dB steps.