summaryrefslogtreecommitdiffstats
path: root/host/docs/general.rst
diff options
context:
space:
mode:
authorBen Hilburn <ben@ettus.com>2011-10-26 09:56:50 -0700
committerJosh Blum <josh@joshknows.com>2011-10-26 10:24:35 -0700
commit7990bd61357620b16bacd447a0504146c215abd3 (patch)
tree4828908bf768ad468cad3b7ae048094a6719d89c /host/docs/general.rst
parent86f7862584da78ff7b30aa8cd8f227e47a7882d5 (diff)
downloaduhd-7990bd61357620b16bacd447a0504146c215abd3.tar.gz
uhd-7990bd61357620b16bacd447a0504146c215abd3.tar.bz2
uhd-7990bd61357620b16bacd447a0504146c215abd3.zip
Line-wraps in general docs.
Diffstat (limited to 'host/docs/general.rst')
-rw-r--r--host/docs/general.rst16
1 files changed, 9 insertions, 7 deletions
diff --git a/host/docs/general.rst b/host/docs/general.rst
index aa6ac7aa0..5df89fc19 100644
--- a/host/docs/general.rst
+++ b/host/docs/general.rst
@@ -32,24 +32,26 @@ Tuning the receive chain:
::
//tuning to a desired center frequency
- usrp->set_rx_freq(my_frequency_in_hz);
+ usrp->set_rx_freq(target_frequency_in_hz);
--OR--
//advanced tuning with tune_request_t
- uhd::tune_request_t tune_req(my_frequency_in_hz, desired_lo_offset);
+ uhd::tune_request_t tune_req(target_frequency_in_hz, desired_lo_offset);
//fill in any additional/optional tune request fields...
usrp->set_rx_freq(tune_req);
+More information can be fonud in *tune_request.hpp*.
+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
RF front-end settling time
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
After tuning, the RF front-end will need time to settle into a usable state.
-Typically, this means that the local oscillators must be given time to lock before streaming begins.
-Lock time is not consistent; it varies depending upon the device and requested settings.
-After tuning and before streaming, the user should
-wait for the "lo_locked" sensor to become true,
-or sleep for a conservative amount of time (perhaps a second).
+Typically, this means that the local oscillators must be given time to lock
+before streaming begins. Lock time is not consistent; it varies depending upon
+the device and requested settings. After tuning and before streaming, the user
+should wait for the "lo_locked" sensor to become true, or sleep for
+a conservative amount of time (perhaps a second).
Pseudo-code for dealing with settling time after tuning on receive:
::