aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs
diff options
context:
space:
mode:
authorMartin Braun <martin.braun@ettus.com>2020-03-05 12:08:56 -0800
committerAaron Rossetto <aaron.rossetto@ni.com>2020-04-02 11:55:17 -0500
commita1f96194696494b756d691ff54e384a1ce478fc2 (patch)
tree1a1d480b5e35a239c5599ebcda1984e29bd0dd55 /host/docs
parent3fe5ccf700a0c6f27dca9511386460194dcc593c (diff)
downloaduhd-a1f96194696494b756d691ff54e384a1ce478fc2.tar.gz
uhd-a1f96194696494b756d691ff54e384a1ce478fc2.tar.bz2
uhd-a1f96194696494b756d691ff54e384a1ce478fc2.zip
uhd: cal: Use usrp::cal::database instead of CSV files
Now that we have cal::iq_cal and cal::database, there's no need to manually wrangle CSV files for calibration data. This commit replaces all CSV operations with cal::database calls and uses cal::iq_cal as a container. CSV files can still be read, but are considered deprecated.
Diffstat (limited to 'host/docs')
-rw-r--r--host/docs/calibration.dox24
1 files changed, 18 insertions, 6 deletions
diff --git a/host/docs/calibration.dox b/host/docs/calibration.dox
index 4bf89a8bc..b9b82e5c7 100644
--- a/host/docs/calibration.dox
+++ b/host/docs/calibration.dox
@@ -8,7 +8,7 @@ UHD software comes with several self-calibration utilities for
minimizing IQ imbalance and DC offset. These utilities perform
calibration sweeps using transmit leakage into the receive path (special
equipment is not required). The results from a calibration are written
-to a CSV file in the user's home directory. UHD software will
+to a file in the user's home directory. UHD software will
automatically apply corrections at runtime when the user re-tunes the
daughterboard LO. Calibration results are specific to an individual RF
board.
@@ -34,6 +34,7 @@ utilities:
- SBX Series transceiver boards
- CBX Series transceiver boards
- UBX Series transceiver boards
+- USRP N320
\subsection calibration_self_utils Calibration Utilities
@@ -74,6 +75,20 @@ Calibration files can easily be moved from one machine to another by copying the
calibration file. The old calibration file will be renamed so it may be
recovered by the user.
+\subsection calibration_data_csv Converting UHD 3.x calibration data to UHD 4
+
+Older versions of UHD used a CSV-based format for storing calbration data for
+IQ imbalance and DC offset correction on some devices (e.g., X300, N200
+motherboards and WBX/SBX/CBX/UBX daughterboards).
+
+Going forward, all calibration data is stored as binary, to facilitate storing
+it on device's flash memory, among other reasons. Running the `uhd_cal_*`
+utilities will automatically generate the calibration data in the new format.
+
+To convert existing calbration data to the new format, use the convert_cal_data.py
+utility. By default, it will convert all existing data. Use `convert_cal_data.py --help`
+to get a full list of command line options.
+
\subsection ignore_cal_file Ignoring Calibration Files
@@ -82,15 +97,12 @@ adding "ignore-cal-file" to the arguments. With the UHD API, it can be done as
follows:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp}
- uhd::device_addr_t hint;
- hint["type"] = "usrp1";
- hint["ignore-cal-file"] = "";
- uhd::device_addrs_t dev_addrs = uhd::device::find(hint);
+ auto usrp = uhd::usrp::multi_usrp::make("type=x300,ignore-cal-file=1");
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Using tx_waveforms as an example, the user can apply this argument as follows:
- tx_waveforms --args="addr=192.168.10.2,ignore-cal-file" --freq=100e6 --rate=1e6
+ tx_waveforms --args="addr=192.168.10.2,ignore-cal-file=1" --freq=100e6 --rate=1e6
*/
// vim:ft=doxygen: