mirror of
https://github.com/saymrwulf/uhd.git
synced 2026-05-16 21:10:10 +00:00
99ad89609b
Over the years the UHD code base got a whole bunch of tools to control and configure devices. This is an attempt to unify these tools into one. Co-authored-by: Alexander Weber <alexander.weber@ni.com>
125 lines
3.8 KiB
Groff
125 lines
3.8 KiB
Groff
.TH "uhd_usrp_probe" 1 "3.7.0" UHD "User Commands"
|
|
.SH NAME
|
|
uhd_usrp_probe \- USRP Hardware Driver Peripheral Report Utility
|
|
.SH DESCRIPTION
|
|
Report detailed information on UHD-supported Software Radio Peripherals
|
|
attached by USB, network, or embedded configuration.
|
|
.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 uhd_usrp_probe [OPTIONS]
|
|
.SH OPTIONS
|
|
.IP "Device Address Arguments:"
|
|
--args \fIarg\fR
|
|
.IP "Print a complete property tree:"
|
|
--tree
|
|
.IP "Query a string value from the properties tree:"
|
|
--string \fIarg\fR
|
|
.IP "Query an integer value from the properties tree:"
|
|
--int \fIarg\fR
|
|
.IP "Query a double value from the properties tree:"
|
|
--double \fIarg\fR
|
|
.IP "Spawn an interactive prompt to peek/poke registers on an RFNoC block:"
|
|
--interactive-reg-iface \fIarg\fR
|
|
.IP "Print the version string and exit:"
|
|
--version
|
|
.IP "This help information:"
|
|
--help
|
|
.SH IDENTIFYING USRP DEVICES
|
|
.sp
|
|
Devices are addressed through key/value string pairs.
|
|
These string pairs can be used to narrow down the search for a specific device or group of devices.
|
|
Most UHD utility applications and examples have a \-\-args parameter that takes a device address,
|
|
where the device address is expressed as a delimited string.
|
|
See the documentation in types/device_addr.hpp for reference.
|
|
|
|
Every device has several ways of identifying it on the host system.
|
|
.SS Identifying by hardware identifier
|
|
.sp
|
|
|
|
All USRP devices can be found through their hardware series identifier, which match to USRP
|
|
devices as follows:
|
|
|
|
Argument | Device
|
|
|
|
type=usrp1 | USRP1
|
|
|
|
type=usrp2 | USRP2, USRP N200, USRP N210
|
|
|
|
type=b100 | USRP B100
|
|
|
|
type=b200 | USRP B200, USRP B210
|
|
|
|
type=e3x0 | USRP E310
|
|
|
|
type=x300 | USRP X300, USRP X310
|
|
|
|
|
|
.SS Identifying by serial number
|
|
|
|
All USRP devices are given a unique serial number, which can be used to identify a device as follows:
|
|
|
|
serial=12345678
|
|
|
|
.SS Identifying by IP address
|
|
|
|
USRP2, USRP N200, USRP N210, USRP X300, and USRP X310 devices connected to the host machine can all be found through their
|
|
IP addresses, as follows:
|
|
|
|
addr=192.168.10.2
|
|
|
|
.SS Identifying by name
|
|
|
|
Users have the option of giving their USRP devices short names using the usrp_burn_mb_eeprom utility
|
|
in lib/uhd/utils. Devices that have been given a name can be identified as follows:
|
|
|
|
name=foo
|
|
|
|
.fi
|
|
.fi
|
|
.SH EXAMPLES
|
|
.SS Device discovery via command line
|
|
.sp
|
|
Device address arguments can be supplied to narrow the scope of the search.
|
|
.sp
|
|
.nf
|
|
.ft C
|
|
uhd_usrp_probe \-\-args="type=usrp1"
|
|
|
|
\-\- OR \-\-
|
|
|
|
uhd_usrp_probe \-\-args="serial=12345678"
|
|
.ft P
|
|
.fi
|
|
.IP "Find all devices available to this system:"
|
|
uhd_usrp_probe
|
|
.SH SEE ALSO
|
|
UHD documentation:
|
|
.B http://files.ettus.com/manual/
|
|
.LP
|
|
GR-UHD documentation:
|
|
.B http://gnuradio.org/doc/doxygen/page_uhd.html
|
|
.LP
|
|
Other UHD programs:
|
|
.sp
|
|
uhd_find_devices(1)
|
|
.SH AUTHOR
|
|
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-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.
|