1BTMON(1)                  Linux System Administration                 BTMON(1)
2
3
4

NAME

6       btmon - Bluetooth monitor
7

SYNOPSYS

9       btmon [OPTIONS ...]
10

DESCRIPTION

12       The   btmon(1)  command   provides   access  to the Bluetooth subsystem
13       monitor infrastructure for reading HCI traces.
14

OPTIONS

16       -r FILE, --read FILE
17              Read traces in btsnoop format from FILE.
18
19       -w FILE, --write FILE
20              Save traces in btsnoop format to FILE.
21
22       -a FILE, --analyze FILE
23              Analyze traces in btsnoop format from FILE.  It displays the de‐
24              vices  found in the FILE with its packets by type. If gnuplot is
25              installed on the system it also attempts to plot packet  latency
26              graph.
27
28       -s SOCKET, --server SOCKET
29              Start monitor server socket.
30
31       -p PRIORITY, --priority PRIORITY
32              Show only priority or lower for user log.
33
34                       ┌─────────┬───────────────────────────┐
35                       │PRIORITY │ NAME                      │
36                       ├─────────┼───────────────────────────┤
37                       │3        │ Error                     │
38                       ├─────────┼───────────────────────────┤
39                       │4        │ Warning                   │
40                       ├─────────┼───────────────────────────┤
41                       │6        │ Information (Default)     │
42                       ├─────────┼───────────────────────────┤
43                       │7        │ Debug. debug can be used. │
44                       └─────────┴───────────────────────────┘
45
46       -i NUM, --index NUM
47              Show  only specified controller. hciNUM is also acceptable. This
48              is useful to capture the traces  from  the  specific  controller
49              when the multiple controllers are presented.
50
51       -d TTY, --tty TTY
52              Read data from TTY.
53
54       -B SPEED, --rate SPEED
55              Set TTY speed. The default SPEED is 115300
56
57       -V COMPID, --vendor COMPID
58              Set  the default company identifier. The COMPID is a unique num‐
59              ber assigned by the Bluetooth SIG to a member company and can be
60              found/searched from the Bluetooth SIG webpage.
61
62              For example, Intel is 2 and Realtek is 93.
63
64       -M, --mgmt
65              Open channel for mgmt events.
66
67       -t, --time
68              Show a time instead of time offset.
69
70       -T, --date
71              Show a time and date information instead of time offset.
72
73       -S, --sco
74              Dump SCO traffic in raw hex format.
75
76       -A, --a2dp
77              Dump A2DP stream traffic in a raw hex format.
78
79       -E IP, --ellisys IP
80              Send Ellisys HCI Injection.
81
82       -P, --no-pager
83              Disable pager usage while reading the log file.
84
85       -J OPTIONS, --jlink OPTIONS
86              Read  data from RTT.  Each options are comma(,) seprated without
87              spaces.
88
89                      ┌──────────┬────────────────────────────┐
90                      │OPTIONS   │ Description                │
91                      ├──────────┼────────────────────────────┤
92                      │DEVICE    │ Required. Set  the  target │
93                      │          │ device.                    │
94                      ├──────────┼────────────────────────────┤
95                      │SERIALNO  │ (Optional) Set the USB se‐ │
96                      │          │ rial number. Default is 0. │
97                      ├──────────┼────────────────────────────┤
98                      │INTERFACE │ (Optional)  Target  inter‐ │
99                      │          │ face. Default is swd.      │
100                      ├──────────┼────────────────────────────┤
101                      │SPEED     │ (Optional)  Set target in‐ │
102                      │          │ terface speed in kHz.  De‐ │
103                      │          │ fault is 1000.             │
104                      └──────────┴────────────────────────────┘
105
106       -R OPTIONS, --rtt OPTIONS
107              RTT control block parameters. Each options are comma(,) seprated
108              without spaces.
109
110                       ┌────────┬────────────────────────────┐
111                       │OPTIONS │ Description                │
112                       ├────────┼────────────────────────────┤
113                       │ADDRESS │ (Optional) Address of  RTT │
114                       │        │ buffer. Default is 0x00    │
115                       ├────────┼────────────────────────────┤
116                       │AREA    │ (Optional)  Size  of range │
117                       │        │ to search in  RTT  buffer. │
118                       │        │ Default is 0               │
119                       ├────────┼────────────────────────────┤
120                       │NAME    │ (Optional)   Buffer  name. │
121                       │        │ Default is btmonitor       │
122                       └────────┴────────────────────────────┘
123
124       -C WIDTH, --columns WIDTH
125              Output width if not a terminal
126
127       -c MODE, --color MODE
128              Set  output  color.  The  possible  MODE  values  are:  auto|al‐
129              ways|never.
130
131              Default value is auto
132
133       -v, --version
134              Show version
135
136       -h, --help
137              Show help options
138

EXAMPLES

140   Capture the traces from hci0 to hcidump.log file
141          $ btmon -i hci0 -w hcidump.log
142
143   Open the trace file
144          $ btmon -r hcidump.log
145

RESOURCES

147       http://www.bluez.org
148

REPORTING BUGS

150       linux-bluetooth@vger.kernel.org
151

AUTHOR

153       Marcel  Holtmann  <marcel@holtmann.org>,  Tedd Ho-Jeong An <tedd.an@in‐
154       tel.com>
155

157       Free use of this software is granted under ther terms of the GNU Lesser
158       General Public Licenses (LGPL).
159
160
161
162
163BlueZ                             April 2021                          BTMON(1)
Impressum