diff options
author | Marcus Müller <marcus.mueller@ettus.com> | 2015-12-08 09:27:37 -0800 |
---|---|---|
committer | Martin Braun <martin.braun@ettus.com> | 2015-12-08 09:27:37 -0800 |
commit | f0171cbd5e3ea235ec6fb424ac93106a9a3b22fa (patch) | |
tree | 47a361db72b91636282a531a33a42cce8e022b38 | |
parent | 36c8e0f81addfc38441dad6bbd56e8f60574ba4d (diff) | |
download | uhd-f0171cbd5e3ea235ec6fb424ac93106a9a3b22fa.tar.gz uhd-f0171cbd5e3ea235ec6fb424ac93106a9a3b22fa.tar.bz2 uhd-f0171cbd5e3ea235ec6fb424ac93106a9a3b22fa.zip |
docs: Fixed many typos, recompressed and cropped images
-rw-r--r-- | host/docs/calibration.dox | 10 | ||||
-rw-r--r-- | host/docs/dboards.dox | 21 | ||||
-rw-r--r-- | host/docs/res/N2xx-JTAG.jpg | bin | 534084 -> 83425 bytes | |||
-rwxr-xr-x | host/docs/res/TRRS.png | bin | 2955 -> 1280 bytes | |||
-rw-r--r-- | host/docs/res/e3x0_fp_overlay.png | bin | 28114 -> 6320 bytes | |||
-rw-r--r-- | host/docs/res/e3x0_imu_demo.png | bin | 85901 -> 15469 bytes | |||
-rw-r--r-- | host/docs/res/e3x0_rp_overlay.png | bin | 19780 -> 4993 bytes | |||
-rw-r--r-- | host/docs/res/e3xx_conn_photo.jpg | bin | 0 -> 8963 bytes | |||
-rw-r--r-- | host/docs/res/e3xx_conn_photo.png | bin | 62566 -> 0 bytes | |||
-rw-r--r-- | host/docs/res/e3xx_conn_render.png | bin | 25154 -> 24350 bytes | |||
-rw-r--r-- | host/docs/res/x3x0_gpio_conn.png | bin | 13651 -> 2586 bytes | |||
-rw-r--r-- | host/docs/res/x3x0_rp_overlay.png | bin | 32965 -> 5679 bytes | |||
-rw-r--r-- | host/docs/sync.dox | 2 | ||||
-rw-r--r-- | host/docs/transport.dox | 8 | ||||
-rw-r--r-- | host/docs/usrp1.dox | 2 | ||||
-rw-r--r-- | host/docs/usrp_b100.dox | 2 | ||||
-rw-r--r-- | host/docs/usrp_b200.dox | 2 | ||||
-rw-r--r-- | host/docs/usrp_e3x0.dox | 2 |
18 files changed, 26 insertions, 23 deletions
diff --git a/host/docs/calibration.dox b/host/docs/calibration.dox index eecb7af5c..02ad41699 100644 --- a/host/docs/calibration.dox +++ b/host/docs/calibration.dox @@ -39,19 +39,19 @@ utilities: UHD software installs the calibration utilities into `<install-path>/bin`. **Disconnect** any external hardware from the RF antenna ports, and run the following from the command line. Each -utility will take several minutes to complete. : +utility will take several minutes to complete: uhd_cal_rx_iq_balance --verbose --args=<optional device args> uhd_cal_tx_iq_balance --verbose --args=<optional device args> uhd_cal_tx_dc_offset --verbose --args=<optional device args> -See the output given by --help for more advanced options, such as: +See the output given by `--help` for more advanced options, such as manually choosing the frequency range and step size for the sweeps. <b>Note:</b> Your daughterboard needs a serial number to run a calibration utility. Some older daughterboards may not have a serial number. If this is the case, run the following command to burn a serial number into the -daughterboard's EEPROM: : +daughterboard's EEPROM: <install dir>/lib/uhd/utils/usrp_burn_db_eeprom --ser=<desired serial> --args=<optional device args> @@ -76,7 +76,9 @@ recovered by the user. \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: +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; diff --git a/host/docs/dboards.dox b/host/docs/dboards.dox index a0188b25c..99314b105 100644 --- a/host/docs/dboards.dox +++ b/host/docs/dboards.dox @@ -80,7 +80,7 @@ Sensors: \subsection dboards_dbsrx2 DBSRX2 The DBSRX2 board has 1 quadrature frontend. It defaults to direct -conversion, but can use a low IF through lo_offset in uhd::tune_request_t. +conversion, but can use a low IF through `lo_offset` in uhd::tune_request_t. Receive Antennas: **J3** @@ -387,13 +387,14 @@ the standard daughterboard clock lines. \subsubsection dboards_dbsrxmod_1 Step 1: Move the clock configuration resistor -Remove **R193** (which is 10 Ohms, 0603 size), and put it on **R194**, -which is empty. This is made somewhat more complicated by the fact that -the silkscreen is not clear in that area. **R193** is on the back, -immediately below the large beige connector, **J2**. **R194** is just -below, and to the left of **R193**. The silkscreen for **R193** is ok, -but for **R194**, it is upside down, and partially cut off. If you lose -**R193**, you can use anything from 0 to 10 Ohms there. +Remove **R193** (which is 10 Ohms, 0603 size), and put it on **R194**, which is +empty. This is made somewhat more complicated by the fact that the silkscreen +is not clear in that area. **R193** is on the back, immediately below the large +beige connector, **J2**. **R194** is just below, and to the left of **R193**. + +The silkscreen for **R193** is ok, but for **R194**, it is upside down, and +partially cut off. If you lose **R193**, you can use anything from 0 to 10 Ohms +there. \subsubsection dboards_dbsrxmod_2 Step 2: Burn a new daughterboard id into the EEPROM @@ -402,9 +403,9 @@ With the daughterboard plugged-in, run the following commands: cd <install-path>/lib/uhd/utils ./usrp_burn_db_eeprom --id=0x000d --unit=RX --args=<args> --slot=<slot> -- **\<args\>** are device address arguments (optional if only one USRP +- `<args>` are device address arguments (optional if only one USRP device is on your machine) -- **\<slot\>** is the name of the daughterboard slot (optional if the +- `<slot>` is the name of the daughterboard slot (optional if the USRP device has only one slot) \subsection dboards_rfxmod RFX - Modify to use motherboard oscillator diff --git a/host/docs/res/N2xx-JTAG.jpg b/host/docs/res/N2xx-JTAG.jpg Binary files differindex acecc0592..64cc43242 100644 --- a/host/docs/res/N2xx-JTAG.jpg +++ b/host/docs/res/N2xx-JTAG.jpg diff --git a/host/docs/res/TRRS.png b/host/docs/res/TRRS.png Binary files differindex 78619c869..8dc9bf9eb 100755 --- a/host/docs/res/TRRS.png +++ b/host/docs/res/TRRS.png diff --git a/host/docs/res/e3x0_fp_overlay.png b/host/docs/res/e3x0_fp_overlay.png Binary files differindex c8f1af1be..416a75e9b 100644 --- a/host/docs/res/e3x0_fp_overlay.png +++ b/host/docs/res/e3x0_fp_overlay.png diff --git a/host/docs/res/e3x0_imu_demo.png b/host/docs/res/e3x0_imu_demo.png Binary files differindex cbf156224..72be046b1 100644 --- a/host/docs/res/e3x0_imu_demo.png +++ b/host/docs/res/e3x0_imu_demo.png diff --git a/host/docs/res/e3x0_rp_overlay.png b/host/docs/res/e3x0_rp_overlay.png Binary files differindex f351ffc24..e7dc24098 100644 --- a/host/docs/res/e3x0_rp_overlay.png +++ b/host/docs/res/e3x0_rp_overlay.png diff --git a/host/docs/res/e3xx_conn_photo.jpg b/host/docs/res/e3xx_conn_photo.jpg Binary files differnew file mode 100644 index 000000000..a63a1c67c --- /dev/null +++ b/host/docs/res/e3xx_conn_photo.jpg diff --git a/host/docs/res/e3xx_conn_photo.png b/host/docs/res/e3xx_conn_photo.png Binary files differdeleted file mode 100644 index dd12f5ac2..000000000 --- a/host/docs/res/e3xx_conn_photo.png +++ /dev/null diff --git a/host/docs/res/e3xx_conn_render.png b/host/docs/res/e3xx_conn_render.png Binary files differindex 52e6ce5d9..c37024ce8 100644 --- a/host/docs/res/e3xx_conn_render.png +++ b/host/docs/res/e3xx_conn_render.png diff --git a/host/docs/res/x3x0_gpio_conn.png b/host/docs/res/x3x0_gpio_conn.png Binary files differindex 0147bf422..f09363dea 100644 --- a/host/docs/res/x3x0_gpio_conn.png +++ b/host/docs/res/x3x0_gpio_conn.png diff --git a/host/docs/res/x3x0_rp_overlay.png b/host/docs/res/x3x0_rp_overlay.png Binary files differindex c34936ac3..4665dc88b 100644 --- a/host/docs/res/x3x0_rp_overlay.png +++ b/host/docs/res/x3x0_rp_overlay.png diff --git a/host/docs/sync.dox b/host/docs/sync.dox index 59f849e1a..1789a70a9 100644 --- a/host/docs/sync.dox +++ b/host/docs/sync.dox @@ -166,7 +166,7 @@ chains will remain constant after each re-tune. See notes below: - This phase offset will drift over time due to thermal and other characteristics - Periodic calibration will be necessary for phase-coherent applications -Code snippet example, tuning with timed commands: : +Code snippet example, tuning with timed commands: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~{.cpp} //we will tune the frontends in 100ms from now diff --git a/host/docs/transport.dox b/host/docs/transport.dox index eb7232f36..72d59fb2a 100644 --- a/host/docs/transport.dox +++ b/host/docs/transport.dox @@ -16,7 +16,7 @@ for the various transports in the UHD software: \section transport_udp UDP Transport (Sockets) The UDP transport is implemented with user-space sockets. This means -standard Berkeley sockets API using send()/recv(). +standard Berkeley sockets API using `send()`/`recv()`. \subsection transport_udp_params Transport parameters @@ -97,12 +97,12 @@ Set the values permanently by editing `/etc/sysctl.conf`. \subsection transport_udp_windows Windows specific notes -**UDP send fast-path:** It is important to change the default UDP +<b>UDP send fast-path:</b> It is important to change the default UDP behavior such that 1500 byte packets still travel through the fast path of the sockets stack. This can be adjusted with the -FastSendDatagramThreshold registry key: +`FastSendDatagramThreshold` registry key: -- FastSendDatagramThreshold registry key documented here: +- `FastSendDatagramThreshold` registry key documented here: - <http://www.microsoft.com/windows/windowsmedia/howto/articles/optimize_web.aspx#appendix_e> diff --git a/host/docs/usrp1.dox b/host/docs/usrp1.dox index e82df0a7b..2f7b26e05 100644 --- a/host/docs/usrp1.dox +++ b/host/docs/usrp1.dox @@ -87,7 +87,7 @@ Run the following commands to record the setting into the EEPROM: ./usrp_burn_mb_eeprom --args=<optional device args> --values="mcr=<rate>" The user may override the clock rate specified in the EEPROM by using a -device address: Example: +device address. Example: uhd_usrp_probe --args="mcr=52e6" diff --git a/host/docs/usrp_b100.dox b/host/docs/usrp_b100.dox index a7d67f50f..89bc6ea64 100644 --- a/host/docs/usrp_b100.dox +++ b/host/docs/usrp_b100.dox @@ -64,7 +64,7 @@ position. To communicate the desired clock rate into UHD software, specify the special device address argument, where the key is -**master_clock_rate** and the value is a rate in Hz. Example: : +`master_clock_rate` and the value is a rate in Hz. Example: uhd_usrp_probe --args="master_clock_rate=52e6" diff --git a/host/docs/usrp_b200.dox b/host/docs/usrp_b200.dox index 0afcf99da..be63b8fe8 100644 --- a/host/docs/usrp_b200.dox +++ b/host/docs/usrp_b200.dox @@ -20,7 +20,7 @@ \section b200_power Power In most cases, USB 3.0 bus power will be sufficient to power the device. -If using USB 2.0 or a internal GPSDO, an external power supply or a cable designed +If using USB 2.0 or an internal GPSDO, an external power supply or a cable designed to pull power from 2 USB ports (USB 3.0 dual A to micro-B or B) must be used. \section b200_imgs Specifying a Non-standard Image diff --git a/host/docs/usrp_e3x0.dox b/host/docs/usrp_e3x0.dox index 807d82e4d..bdcfe8bfb 100644 --- a/host/docs/usrp_e3x0.dox +++ b/host/docs/usrp_e3x0.dox @@ -443,7 +443,7 @@ The USRP E312 (and with upgraded firmware E310) supports LiIon Battery packs (e. The connector J1 on E312's motherboard is a Molex 53014-6310. The corresponding mating connector is a Molex 51004-0300. -\image html e3xx_conn_photo.png "Battery pack connector" +\image html e3xx_conn_photo.jpg "Battery pack connector" The pins are as follows: - Pin 1 (Red): VBat |