diff options
Diffstat (limited to 'host/docs')
-rw-r--r-- | host/docs/CMakeLists.txt | 6 | ||||
-rw-r--r-- | host/docs/devices.dox | 4 | ||||
-rw-r--r-- | host/docs/uhd_cal_rx_iq_balance.1 | 2 | ||||
-rw-r--r-- | host/docs/uhd_cal_tx_dc_offset.1 | 2 | ||||
-rw-r--r-- | host/docs/uhd_cal_tx_iq_balance.1 | 2 | ||||
-rw-r--r-- | host/docs/uhd_config_info.1 | 2 | ||||
-rw-r--r-- | host/docs/uhd_find_devices.1 | 2 | ||||
-rw-r--r-- | host/docs/uhd_image_loader.1 | 2 | ||||
-rw-r--r-- | host/docs/uhd_images_downloader.1 | 2 | ||||
-rw-r--r-- | host/docs/uhd_usrp_probe.1 | 2 | ||||
-rw-r--r-- | host/docs/usrp2_card_burner.1 | 2 | ||||
-rw-r--r-- | host/docs/usrp_n2xx_simple_net_burner.1 | 2 | ||||
-rw-r--r-- | host/docs/usrpctl.1 | 93 | ||||
-rw-r--r-- | host/docs/usrpctl.dox | 72 |
14 files changed, 185 insertions, 10 deletions
diff --git a/host/docs/CMakeLists.txt b/host/docs/CMakeLists.txt index 9f6b1eb2b..fc1d2f928 100644 --- a/host/docs/CMakeLists.txt +++ b/host/docs/CMakeLists.txt @@ -123,6 +123,12 @@ set(man_page_sources usrp2_card_burner.1 ) +if (ENABLE_PYTHON_API) + set(man_page_sources + usrpctl.1 + ) +endif(ENABLE_PYTHON_API) + ######################################################################## # Setup man pages ######################################################################## diff --git a/host/docs/devices.dox b/host/docs/devices.dox index b081a03d5..f65d48960 100644 --- a/host/docs/devices.dox +++ b/host/docs/devices.dox @@ -56,5 +56,9 @@ unless stated otherwise, they will still work with this version of UHD. \li \subpage page_octoclock +## Usrpctl + +\li \subpage page_usrpctl + */ // vim:ft=doxygen: diff --git a/host/docs/uhd_cal_rx_iq_balance.1 b/host/docs/uhd_cal_rx_iq_balance.1 index df77afb2c..3ca187bd2 100644 --- a/host/docs/uhd_cal_rx_iq_balance.1 +++ b/host/docs/uhd_cal_rx_iq_balance.1 @@ -55,7 +55,7 @@ uhd_cal_tx_dc_offset(1) uhd_cal_tx_iq_balance(1) This manual page was written by Maitland Bottoms and Nicholas Corgan for the Debian project (but may be used by others). .SH COPYRIGHT -Copyright (c) 2012 Ettus Research LLC +Copyright (c) 2012-2022 Ettus Research, A National Instruments Brand .LP This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/host/docs/uhd_cal_tx_dc_offset.1 b/host/docs/uhd_cal_tx_dc_offset.1 index 50d3899e8..4830b7161 100644 --- a/host/docs/uhd_cal_tx_dc_offset.1 +++ b/host/docs/uhd_cal_tx_dc_offset.1 @@ -55,7 +55,7 @@ uhd_cal_rx_iq_balance(1) uhd_cal_tx_iq_balance(1) This manual page was written by Maitland Bottoms and Nicholas Corgan for the Debian project (but may be used by others). .SH COPYRIGHT -Copyright (c) 2012 Ettus Research LLC +Copyright (c) 2012-2022 Ettus Research, A National Instruments Brand .LP This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/host/docs/uhd_cal_tx_iq_balance.1 b/host/docs/uhd_cal_tx_iq_balance.1 index 859cf9a84..accba9f6a 100644 --- a/host/docs/uhd_cal_tx_iq_balance.1 +++ b/host/docs/uhd_cal_tx_iq_balance.1 @@ -55,7 +55,7 @@ uhd_cal_tx_dc_offset(1) uhd_cal_rx_iq_balance(1) This manual page was written by Maitland Bottoms and Nicholas Corgan for the Debian project (but may be used by others). .SH COPYRIGHT -Copyright (c) 2012 Ettus Research LLC +Copyright (c) 2012-2022 Ettus Research, A National Instruments Brand .LP This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/host/docs/uhd_config_info.1 b/host/docs/uhd_config_info.1 index edc1b7532..adc6cb859 100644 --- a/host/docs/uhd_config_info.1 +++ b/host/docs/uhd_config_info.1 @@ -51,7 +51,7 @@ This manual page was written by Nicholas Corgan for the Debian project (but may be used by others). .SH COPYRIGHT -Copyright (c) 2015 National Instruments Corp. +Copyright (c) 2015-2022 Ettus Research, A National Instruments Brand .LP This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/host/docs/uhd_find_devices.1 b/host/docs/uhd_find_devices.1 index c628a2d86..15e94a1f1 100644 --- a/host/docs/uhd_find_devices.1 +++ b/host/docs/uhd_find_devices.1 @@ -98,7 +98,7 @@ uhd_usrp_probe(1) This manual page was written by Maitland Bottoms and Nicholas Corgan for the Debian project (but may be used by others). .SH COPYRIGHT -Copyright (c) 2010 Ettus Research LLC +Copyright (c) 2010-2022 Ettus Research, A National Instruments Brand .LP This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/host/docs/uhd_image_loader.1 b/host/docs/uhd_image_loader.1 index 982784f9e..f3b033a70 100644 --- a/host/docs/uhd_image_loader.1 +++ b/host/docs/uhd_image_loader.1 @@ -115,7 +115,7 @@ uhd_images_downloader(1) usrp2_card_burner(1) This manual page was written by Nicholas Corgan for the Debian project (but may be used by others). .SH COPYRIGHT -Copyright (c) 2015 Ettus Research LLC +Copyright (c) 2015-2022 Ettus Research, A National Instruments Brand .LP This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/host/docs/uhd_images_downloader.1 b/host/docs/uhd_images_downloader.1 index 19f109ec5..1f9fbc875 100644 --- a/host/docs/uhd_images_downloader.1 +++ b/host/docs/uhd_images_downloader.1 @@ -38,7 +38,7 @@ usrp2_card_burner(1) usrp_n2xx_simple_net_burner(1) usrp_x3xx_fpga_burner(1) oct This manual page was written by Maitland Bottoms and Nicholas Corgan for the Debian project (but may be used by others). .SH COPYRIGHT -Copyright (c) 2012,2014 Ettus Research LLC +Copyright (c) 2012-2022 Ettus Research, A National Instruments Brand .LP This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/host/docs/uhd_usrp_probe.1 b/host/docs/uhd_usrp_probe.1 index 7d72b32fb..48f2d8667 100644 --- a/host/docs/uhd_usrp_probe.1 +++ b/host/docs/uhd_usrp_probe.1 @@ -112,7 +112,7 @@ uhd_find_devices(1) This manual page was written by Maitland Bottoms and Nicholas Corgan for the Debian project (but may be used by others). .SH COPYRIGHT -Copyright (c) 2010 Ettus Research LLC +Copyright (c) 2010-2022 Ettus Research, A National Instruments Brand .LP This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/host/docs/usrp2_card_burner.1 b/host/docs/usrp2_card_burner.1 index b43484b99..ebf5f560d 100644 --- a/host/docs/usrp2_card_burner.1 +++ b/host/docs/usrp2_card_burner.1 @@ -39,7 +39,7 @@ uhd_images_downloader(1) usrp_n2xx_simple_net_burner(1) usrp_x3xx_fpga_burner(1) This manual page was written by Nicholas Corgan for the Debian project (but may be used by others). .SH COPYRIGHT -Copyright (c) 2012,2014 Ettus Research LLC +Copyright (c) 2012-2022 Ettus Research, A National Instruments Brand .LP This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/host/docs/usrp_n2xx_simple_net_burner.1 b/host/docs/usrp_n2xx_simple_net_burner.1 index 85538ee22..719edc76c 100644 --- a/host/docs/usrp_n2xx_simple_net_burner.1 +++ b/host/docs/usrp_n2xx_simple_net_burner.1 @@ -46,7 +46,7 @@ uhd_images_downloader(1) usrp2_card_burner(1) usrp_x3xx_fpga_burner(1) octoclock This manual page was written by Nicholas Corgan for the Debian project (but may be used by others). .SH COPYRIGHT -Copyright (c) 2012,2014 Ettus Research LLC +Copyright (c) 2012-2022 Ettus Research, A National Instruments Brand .LP This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/host/docs/usrpctl.1 b/host/docs/usrpctl.1 new file mode 100644 index 000000000..1cf0f01eb --- /dev/null +++ b/host/docs/usrpctl.1 @@ -0,0 +1,93 @@ +.TH "usrpctl" 1 "4.0.0" UHD "User Commands" +.SH NAME +usrpctl \- USRP Hardware Driver Peripheral Configuration Tool +.SH DESCRIPTION +Report detailed information on UHD-supported Software Radio Peripherals +attached by USB, network, or embedded configuration. +Allows update and configuration of attached devices. +.LP +The UHD package is the universal hardware driver for Ettus Research products. The goal +is to provide a host driver and API for current and future Ettus Research products. +Users will be able to use the UHD driver standalone or with 3rd party applications. +.LP +Details include unit names, revision numbers, and available sensors on all attached +USRP motherboards and daughterboards. +.SH SYNOPSIS +.B usrpctl [ID] COMMAND [OPTIONS] +.SH ID +ID is the optional device argument. It is used to define a set +of USRP devices that COMMAND should be applied to. If ID is omitted +COMMAND is applied to all reachable devices. + +usrpctl understands the device args argument used by other UHD +tools like uhd_find_devices. + +.SH COMMAND +Is the action the tool is to take. Every command can be either applied to a +single device or a group of devices. Commands that run on a group of +devices repeat the command for every device. + +- Single device commands: + - config: Read/write configuration variables (e.g., IP address) + - probe: reads extended information about the USRP +- Multi device commands: + - update: Update binaries (e.g., FPGA image) + - reset: Reset the device or parts thereof (e.g., only reset MPM) + - find: finds all available USRPs in this network + +.SH OPTIONS +The options are not always mandatory. It depends on the given COMMAND. + +.SH find command + +The find command takes no further options. If ID is not given it scans the +system for available, supported devices and prints a list of discovered devices. +The print out is compatible to uhd_find_devices. +ID can be used to narrow down the list of discovered devices. + +.SH probe command +.IP "Print a complete property tree:" +-tree +.TP +The probe command can only be applied to a single device so make sure that +ID identifies exactly one device. Without arguments it displays detailed +information about the device such as name, serial, revision numbers, +firmware version sensor information on attached motherboard and daughterboards. + +.SH EXAMPLES +.TP \w'usrpctl\ 'u +.BI usrpctl\ find +find all supported devices +.TP +.BI usrpctl\ type=x300,product=X310 find +find all x310 devices +.TP +.BI usrpctl\ name=my_usrp\ find +find a device named my_usrp +.TP +.BI usrpctl\ addr=192.168.10.2\ find +find a device with the given IP. +.TP +.BI usrpctl\ addr=192.168.10.2\ probe +display device information for USRP with the given ID +.TP +.BI usprctl\ name=my_usrp\ probe\ \-tree +display property tree of device with the name my_usrp +.TP + +.SH SEE ALSO +UHD documentation: +.B http://files.ettus.com/manual/ +.LP +.SH COPYRIGHT +Copyright (c) 2022 Ettus Research, A National Instruments Brand +.LP +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. +.LP +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. diff --git a/host/docs/usrpctl.dox b/host/docs/usrpctl.dox new file mode 100644 index 000000000..431f2ee66 --- /dev/null +++ b/host/docs/usrpctl.dox @@ -0,0 +1,72 @@ +/*! \page page_usrpctl Usrpctl + +\tableofcontents + +\section usrpctl_description Description + +usrpctl is the central and universal tool to +query, update or configure USRP devices. The command structure is: + + usrpctl $ID $COMMAND $OPTIONS + +`usrpctl` will run $COMMAND on the devices identified by $ID. $OPTIONS +is dependend on the chosen command. + +\section usrpctl_id $ID + +$ID is the optional device argument. It is used to define a set +of USRP devices that `$COMMAND` should be applied to. If `$ID` is omitted +$COMMAND is applied to all reachable devices. + +`usrpctl` understands the device args argument used by other UHD +tools like `uhd_find_devices`. + +\section usrpctl_command $COMMAND +Is the action the tool is to take. Every command can be either applied to a +single device or a group of devices. Commands that run on a group of +devices repeat the command for every device. + +- Single device commands: + - `config`: Read/write configuration variables (e.g., IP address) + - `probe`: reads extended information about the USRP +- Multi device commands: + - `update`: Update binaries (e.g., FPGA image) + - `reset`: Reset the device or parts thereof (e.g., only reset MPM) + - `find`: finds all available USRPs in this network + +\section usrpctl_options $OPTIONS + +The options depend on the chosen command. Optional arguments are prepended +with a dash, mandatory are not. + +\section usrpctl_commands Available commands + +\section usrpctl_find find + +The find command takes no further options. If `$ID` is not given it scans the +system for available, supported devices and prints a list of discovered devices. +The print out is compatible to \ref id_identifying_cmdline "`uhd_find_devices`". +`$ID` can be used to narrow down the list of discovered devices. + +Examples: + +- `usrpctl find` find all supported devices +- `usrpctl type=x300,product=X310 find` find all x310 devices +- `usrpctl name=my_usrp find` find a device named my_usrp +- `usrpctl addr=192.168.10.2 find` find a device with the given IP. + +\subsection usrpctl_probe probe +Arguments: +-`-tree`: print a list of the device property tree + +The probe command can only be applied to a single device so make sure that +$ID identifies exactly one device. Without arguments it displays detailed +information about the device such as name, serial, revision numbers, +firmware version sensor information on attached motherboard and daughterboards. + +Examples: +- `usrpctl addr=192.168.10.2 probe` display device information for USRP with the given ID +- `usprctl name=my_usrp probe -tree` display property tree of device with the name my_usrp + +*/ +// vim:ft=doxygen: |