mirror of
https://github.com/f4exb/sdrangel.git
synced 2024-12-22 17:45:48 -05:00
BladeRF: updated documentation
This commit is contained in:
f4exb
parent
c37f219696
commit
d0bb485ba2
Binary file not shown.
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 25 KiB |
Binary file not shown.
Binary file not shown.
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 21 KiB |
Binary file not shown.
@ -42,9 +42,11 @@ Device start / stop button.
|
||||
- Red square icon: device is running and can be stopped
|
||||
- Magenta (or pink) square icon: an error occurred. In the case the device was accidentally disconnected you may click on the icon, plug back in and start again.
|
||||
|
||||
<h3>2: Baseband sample rate</h3>
|
||||
<h3>2: Stream sample rate</h3>
|
||||
|
||||
This is the baseband sample rate in kS/s before interpolation (4) to produce the final stream that is sent to the BladeRF device. Thus this is the device sample rate (6) divided by the interpolation factor (4).
|
||||
In host to device sample rate input mode (6A) this is the baseband I/Q sample rate in kS/s. This is the host to device sample rate (6) divided by the interpolation factor (7).
|
||||
|
||||
In baseband sample rate input mode (6A) this is the host to device sample rate in kS/s. This is the baseband sample rate (6) multiplied by the software interpolation factor (7)
|
||||
|
||||
Transmission latency depends essentially in the delay in the sample FIFO. The FIFO size is calculated as follows:
|
||||
|
||||
|
||||
@ -11,22 +11,24 @@ The plugin will be built only if the [BladeRF host library](https://github.com/N
|
||||
Note that the libbladeRF v2 (specifically the git tag 2018.08) is used. The FPGA image v0.7.3 should be used accordingly. The FPGA .rbf file should be copied to the folder where the `sdrangel` binary resides. You can download FPGA images from [here](https://www.nuand.com/fpga_images/)
|
||||
|
||||
The BladeRF Host library is also provided by many Linux distributions (check its version) and is built in the SDRangel binary releases.
|
||||
|
||||
|
||||
<h2>Interface</h2>
|
||||
|
||||
|
||||
|
||||
<h3>1: Start/Stop</h3>
|
||||
|
||||
Device start / stop button.
|
||||
Device start / stop button.
|
||||
|
||||
- Blue triangle icon: device is ready and can be started
|
||||
- Red square icon: device is running and can be stopped
|
||||
- Magenta (or pink) square icon: an error occurred. In the case the device was accidentally disconnected you may click on the icon, plug back in and start again.
|
||||
|
||||
<h3>2: Baseband sample rate</h3>
|
||||
|
||||
This is the baseband sample rate in kS/s before interpolation (4) to produce the final stream that is sent to the BladeRF device. Thus this is the device sample rate (6) divided by the interpolation factor (4).
|
||||
<h3>2: Stream sample rate</h3>
|
||||
|
||||
In host to device sample rate input mode (7A) this is the baseband I/Q sample rate in kS/s. This is the host to device sample rate (7) divided by the interpolation factor (8).
|
||||
|
||||
In baseband sample rate input mode (7A) this is the host to device sample rate in kS/s. This is the baseband sample rate (7) multiplied by the software interpolation factor (8)
|
||||
|
||||
Transmission latency depends essentially in the delay in the sample FIFO. The FIFO size is calculated as follows:
|
||||
|
||||
@ -36,8 +38,8 @@ For interpolation by 32 the size is fixed at 150000 samples, Delay is 150000 / B
|
||||
|
||||
For lower interpolation rates the size is calculated to give a fixed delay of 250 ms or 75000 samples whichever is bigger. Below is the delay in seconds vs baseband sample rate in kS/s from 48 to 400 kS/s. The 250 ms delay is reached at 300 kS/s:
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>3: Frequency</h3>
|
||||
|
||||
This is the center frequency of transmission in kHz. The center frequency is the same for all Tx channels. The GUI of the sibling channel if present is adjusted automatically.
|
||||
@ -62,7 +64,7 @@ Note that if you mouse over the button a tooltip appears that displays the trans
|
||||
|
||||
You can set the translating frequency in Hz with this dial. 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 arrows. Pressing shift simultaneously moves digit by 5 and pressing control moves it by 2.
|
||||
|
||||
The frequency set in the device is the frequency on the main dial (1) minus this frequency. Thus it is positive for up converters and negative for down converters.
|
||||
The frequency set in the device is the frequency on the main dial (1) minus this frequency. Thus it is positive for up converters and negative for down converters.
|
||||
|
||||
For example with a mixer at 120 MHz for HF operation you would set the value to -120,000,000 Hz so that if the main dial frequency is set to 7,130 kHz the PlutoSDR will be set to 127.130 MHz.
|
||||
|
||||
@ -78,11 +80,20 @@ Use this toggle button to activate or deactivate the frequency translation
|
||||
|
||||
<h4>6.3: Confirmation buttons</h4>
|
||||
|
||||
Use these buttons to confirm ("OK") or dismiss ("Cancel") your changes.
|
||||
Use these buttons to confirm ("OK") or dismiss ("Cancel") your changes.
|
||||
|
||||
<h3>7: Device sample rate</h3>
|
||||
<h3>7A: Host to device sample rate / Baseband sample rate input toggle</h3>
|
||||
|
||||
This is the BladeRF device DAC sample rate in S/s.
|
||||
Use this toggle button to switch the sample rate input next (7) between host to device sample rate and baseband sample rate input. The button shows the current mode:
|
||||
|
||||
- **SR**: host to device sample rate input mode. The baseband sample rate (2) is the host to device sample rate (7) divided by the interpolation factor (8).
|
||||
- **BB**: baseband sample rate input mode. The host to device sample rate (2) is the baseband sample rate (7) multiplied by the interpolation factor (8).
|
||||
|
||||
<h3>7: Sample rate</h3>
|
||||
|
||||
This is the BladeRF device DAC sample rate sample rate or baseband sample rate in samples per second (S/s). The control (7A) is used to switch between the two input modes. The device to/from host stream sample rate is the same for the Rx and Tx systems.
|
||||
|
||||
The limits are adjusted automatically. In baseband input mode the limits are driven by the interpolation factor (8). You may need to increase this interpolation factor to be able to reach lower values.
|
||||
|
||||
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 arrows. Pressing shift simultaneously moves digit by 5 and pressing control moves it by 2.
|
||||
|
||||
@ -97,7 +108,7 @@ The baseband stream is interpolated by this value before being sent to the Blade
|
||||
- **16**: multiply baseband stream sample rate by 16
|
||||
- **32**: multiply baseband stream sample rate by 32
|
||||
|
||||
The main samples buffer is based on the baseband sample rate and will introduce ~500ms delay for interpolation by 16 or lower and ~1s for interpolation by 32.
|
||||
The main samples buffer is based on the baseband sample rate and will introduce ~500ms delay for interpolation by 16 or lower and ~1s for interpolation by 32.
|
||||
|
||||
<h3>9: Gain control</h3>
|
||||
|
||||
|
||||
@ -38,7 +38,9 @@ Record baseband I/Q stream toggle button
|
||||
|
||||
<h4>1.4: Stream sample rate</h4>
|
||||
|
||||
Baseband I/Q sample rate in kS/s. This is the device sample rate (4) divided by the decimation factor (6).
|
||||
In device to host sample rate input mode (4A) this is the baseband I/Q sample rate in kS/s. This is the device to host sample rate (4) divided by the decimation factor (5).
|
||||
|
||||
In baseband sample rate input mode (4A) this is the device to host sample rate in kS/s. This is the baseband sample rate (4) multiplied by the decimation factor (5)
|
||||
|
||||
<h3>2: Auto correction options</h3>
|
||||
|
||||
|
||||
@ -26,19 +26,21 @@ This is the center frequency of reception in kHz. The center frequency is the sa
|
||||
|
||||
<h4>1.2: Start/Stop</h4>
|
||||
|
||||
Device start / stop button.
|
||||
Device start / stop button.
|
||||
|
||||
- Blue triangle icon: device is ready and can be started
|
||||
- Green square icon: device is running and can be stopped
|
||||
- Magenta (or pink) square icon: an error occurred. In the case the device was accidentally disconnected you may click on the icon, plug back in and start again.
|
||||
|
||||
|
||||
<h4>1.3: Record</h4>
|
||||
|
||||
Record baseband I/Q stream toggle button
|
||||
|
||||
<h4>1.4: Stream sample rate</h4>
|
||||
|
||||
Baseband I/Q sample rate in kS/s. This is the device sample rate (4) divided by the decimation factor (6).
|
||||
In device to host sample rate input mode (6A) this is the baseband I/Q sample rate in kS/s. This is the device to host sample rate (6) divided by the decimation factor (8).
|
||||
|
||||
In baseband sample rate input mode (6A) this is the device to host sample rate in kS/s. This is the baseband sample rate (6) multiplied by the decimation factor (8)
|
||||
|
||||
<h3>2: LO ppm correction</h3>
|
||||
|
||||
@ -50,7 +52,7 @@ 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.
|
||||
|
||||
|
||||
<h3>4: Rx filter bandwidth</h3>
|
||||
|
||||
This is the Rx filter bandwidth in kHz. Minimum and maximum values are adjusted automatically. Normal range is from 200 kHz to 56 MHz. The Rx filter bandwidth is the same for all Rx channels. The GUI of the sibling channel if present is adjusted automatically.
|
||||
@ -67,7 +69,7 @@ Note that if you mouse over the button a tooltip appears that displays the trans
|
||||
|
||||
You can set the translating frequency in Hz with this dial. 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 arrows. Pressing shift simultaneously moves digit by 5 and pressing control moves it by 2.
|
||||
|
||||
The frequency set in the device is the frequency on the main dial (1) minus this frequency. Thus it is positive for down converters and negative for up converters.
|
||||
The frequency set in the device is the frequency on the main dial (1) minus this frequency. Thus it is positive for down converters and negative for up converters.
|
||||
|
||||
For example a mixer at 120 MHz for HF operation you would set the value to -120,000,000 Hz so that if the main dial frequency is set at 7,130 kHz the PlutoSDR will be set to 127.130 MHz.
|
||||
|
||||
@ -83,11 +85,20 @@ Use this toggle button to activate or deactivate the frequency translation
|
||||
|
||||
<h4>5.3: Confirmation buttons</h4>
|
||||
|
||||
Use these buttons to confirm ("OK") or dismiss ("Cancel") your changes.
|
||||
Use these buttons to confirm ("OK") or dismiss ("Cancel") your changes.
|
||||
|
||||
<h3>6: Device sample rate</h3>
|
||||
<h3>6A: Device sample rate / Baseband sample rate input toggle</h3>
|
||||
|
||||
This is the BladeRF device ADC sample rate in S/s.
|
||||
Use this toggle button to switch the sample rate input next (6) between device sample rate and baseband sample rate input. The button shows the current mode:
|
||||
|
||||
- **SR**: device sample rate input mode. The baseband sample rate (1.4) is the device sample rate (6) divided by the decimation factor (8).
|
||||
- **BB**: baseband sample rate input mode. The device sample rate (1.4) is the baseband sample rate (6) multiplied by the decimation factor (8).
|
||||
|
||||
<h3>6: Sample rate</h3>
|
||||
|
||||
This is the BladeRF device ADC sample rate or baseband sample rate in samples per second (S/s). The control (4A) is used to switch between the two input modes.
|
||||
|
||||
The limits are adjusted automatically. In baseband input mode the limits are driven by the decimation factor (5). You may need to increase this decimation factor to be able to reach lower values.
|
||||
|
||||
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 arrows. Pressing shift simultaneously moves digit by 5 and pressing control moves it by 2.
|
||||
|
||||
@ -98,10 +109,10 @@ The ADC sample rate is the same for all Rx channels. The GUI of the sibling chan
|
||||
Possible values are:
|
||||
|
||||
- **Cen**: the decimation operation takes place around the BladeRF Rx center frequency Fs
|
||||
- **Inf**: the decimation operation takes place around Fs - Fc.
|
||||
- **Inf**: the decimation operation takes place around Fs - Fc.
|
||||
- **Sup**: the decimation operation takes place around Fs + Fc.
|
||||
|
||||
With SR as the sample rate before decimation Fc is calculated as:
|
||||
|
||||
With SR as the sample rate before decimation Fc is calculated as:
|
||||
|
||||
- if decimation n is 4 or lower: Fc = SR/2^(log2(n)-1). The device center frequency is on the side of the baseband. You need a RF filter bandwidth at least twice the baseband.
|
||||
- if decimation n is 8 or higher: Fc = SR/n. The device center frequency is half the baseband away from the side of the baseband. You need a RF filter bandwidth at least 3 times the baseband.
|
||||
|
||||
@ -168,22 +168,22 @@ Use this checkbox to toggle on/off the reverse API feature. With reverse API eng
|
||||
|
||||
```
|
||||
{
|
||||
"deviceHwType": "HackRF",
|
||||
"deviceHwType": "HackRF",
|
||||
"hackRFInputSettings": {
|
||||
"LOppmTenths": 0,
|
||||
"bandwidth": 1750000,
|
||||
"biasT": 0,
|
||||
"centerFrequency": 435000000,
|
||||
"dcBlock": 0,
|
||||
"devSampleRate": 2400000,
|
||||
"fcPos": 2,
|
||||
"iqCorrection": 0,
|
||||
"linkTxFrequency": 0,
|
||||
"lnaExt": 0,
|
||||
"lnaGain": 16,
|
||||
"log2Decim": 0,
|
||||
"LOppmTenths": 0,
|
||||
"bandwidth": 1750000,
|
||||
"biasT": 0,
|
||||
"centerFrequency": 435000000,
|
||||
"dcBlock": 0,
|
||||
"devSampleRate": 2400000,
|
||||
"fcPos": 2,
|
||||
"iqCorrection": 0,
|
||||
"linkTxFrequency": 0,
|
||||
"lnaExt": 0,
|
||||
"lnaGain": 16,
|
||||
"log2Decim": 0,
|
||||
"vgaGain": 16
|
||||
},
|
||||
},
|
||||
"tx": 0
|
||||
}
|
||||
```
|
||||
@ -701,25 +701,25 @@ Use this checkbox to toggle on/off the reverse API feature. With reverse API eng
|
||||
```
|
||||
{
|
||||
"SSBDemodSettings": {
|
||||
"agc": 0,
|
||||
"agcClamping": 0,
|
||||
"agcPowerThreshold": -40,
|
||||
"agcThresholdGate": 4,
|
||||
"agcTimeLog2": 7,
|
||||
"audioBinaural": 0,
|
||||
"audioDeviceName": "System default device",
|
||||
"audioFlipChannels": 0,
|
||||
"audioMute": 0,
|
||||
"dsb": 0,
|
||||
"inputFrequencyOffset": 0,
|
||||
"lowCutoff": 300,
|
||||
"rfBandwidth": 3000,
|
||||
"rgbColor": -16711936,
|
||||
"spanLog2": 3,
|
||||
"title": "SSB Demodulator",
|
||||
"agc": 0,
|
||||
"agcClamping": 0,
|
||||
"agcPowerThreshold": -40,
|
||||
"agcThresholdGate": 4,
|
||||
"agcTimeLog2": 7,
|
||||
"audioBinaural": 0,
|
||||
"audioDeviceName": "System default device",
|
||||
"audioFlipChannels": 0,
|
||||
"audioMute": 0,
|
||||
"dsb": 0,
|
||||
"inputFrequencyOffset": 0,
|
||||
"lowCutoff": 300,
|
||||
"rfBandwidth": 3000,
|
||||
"rgbColor": -16711936,
|
||||
"spanLog2": 3,
|
||||
"title": "SSB Demodulator",
|
||||
"volume": 3
|
||||
},
|
||||
"channelType": "SSBDemod",
|
||||
},
|
||||
"channelType": "SSBDemod",
|
||||
"tx": 0
|
||||
}
|
||||
```
|
||||
@ -763,7 +763,7 @@ The spectrum display is controlled by the display control (4).
|
||||
|
||||
<h4>8.1. SDRangel version</h4>
|
||||
|
||||
Self explanatory
|
||||
This is the current tag or the latest tag followed by the number of commits since the latest tag followed by the git commit SHA1 (8 hex characters) preceded by 'g'. Ex: `v4.5.3-29-gf5f2349d`
|
||||
|
||||
<h4>8.2. Qt version</h4>
|
||||
|
||||
@ -779,4 +779,4 @@ Pretty print of the operating system in which SDRangel is running.
|
||||
|
||||
<h4>8.5. Local date and time</h4>
|
||||
|
||||
Local time timestamp according to system clock
|
||||
Local time timestamp according to system clock. Format: `yyyy-mm-dd HH:MM:ss TZ`
|
||||
|
||||
Loading…
Reference in New Issue
Block a user