aboutsummaryrefslogtreecommitdiffstats
path: root/host/docs/uhd_find_devices.1
blob: 7f92966be175032a12c84d8b09dacf7d28482cf1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
.TH "uhd_find_devices" 1 "3.7.0" UHD "User Commands"
.SH NAME
uhd_find_devices \- USRP Hardware Driver Discovery Utility
.SH DESCRIPTION
Find UHD-supporting Ettus Research products 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.
.SH SYNOPSIS
.B  uhd_find_devices [OPTIONS]
.SH OPTIONS
.IP "Device Address Arguments:"
--args \fIarg\fR
.IP "This help information:"
--help
.SH IDENTIFYING 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 Ettus Research devices can be found through their hardware series identifier, which match to
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=e100      |  USRP E100, USRP E110

type=x300      |  USRP X300, USRP X310

type=octoclock |  OctoClock

.SS Identifying by serial number

All Ettus Research 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, USRP X310, and OctoClock 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 devices short names using the usrp_burn_mb_eeprom and octoclock_burn_eeprom
utilities in lib/uhd/utils. Devices that have been given a name can be identified as follows:

name=foo

.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_find_devices \-\-args="type=usrp1"

\-\- OR \-\-

uhd_find_devices \-\-args="serial=12345678"
.ft P
.fi
.IP "Find all devices available to this system:"
uhd_find_devices
.SH SEE ALSO
UHD documentation:
.B http://files.ettus.com/uhd_docs/manual/html/index.html
.LP
GR-UHD documentation:
.B http://gnuradio.org/doc/doxygen/page_uhd.html
.LP
Other UHD programs:
.sp
uhd_usrp_probe(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 Ettus Research LLC
.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.