aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/calibration.dox
diff options
context:
space:
mode:
authorNicholas Corgan <nick.corgan@ettus.com>2014-08-15 16:06:28 -0700
committerMartin Braun <martin.braun@ettus.com>2014-09-02 12:08:36 +0200
commitda018c53b473428bc5a53134136db24bdc3cf4dc (patch)
tree2d8c7670613930b25fca080e2a7912cbabcc508b /host/docs/calibration.dox
parentc219cee65a691792154e0ae2cdf9d81e539b1da8 (diff)
downloaduhd-da018c53b473428bc5a53134136db24bdc3cf4dc.tar.gz
uhd-da018c53b473428bc5a53134136db24bdc3cf4dc.tar.bz2
uhd-da018c53b473428bc5a53134136db24bdc3cf4dc.zip
Give user the option to ignore daughterboard's calibration file at runtime
* Add "ignore-cal-file" to the uhd::device_addr_t arguments * Added documentation for new feature
Diffstat (limited to 'host/docs/calibration.dox')
-rw-r--r--host/docs/calibration.dox15
1 files changed, 15 insertions, 0 deletions
diff --git a/host/docs/calibration.dox b/host/docs/calibration.dox
index 494cfca49..42a5825ca 100644
--- a/host/docs/calibration.dox
+++ b/host/docs/calibration.dox
@@ -66,5 +66,20 @@ recovered by the user.
- **Linux:** `${HOME}/.uhd/cal/`
- **Windows:** `%APPDATA%\.uhd\cal\`
+\subsection ignore_cal_file Ignoring Calibration Files
+
+At runtime, the user can choose to ignore a daughterboard's calibration file by 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);
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+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
+
*/
// vim:ft=doxygen: