-
Notifications
You must be signed in to change notification settings - Fork 74
/
readsb.1
384 lines (384 loc) · 6.58 KB
/
readsb.1
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
.TH "readsb" 1 "12 December 2019" "" ""
.RS
.SH NAME
readsb \- Mode-S aircraft data processor for various receiver hardware.
.SH VERSION
v3.8.1
.SH DESCRIPTION
\fBreadsb Mode-S Receiver
.SH BUILD OPTIONS
.IP \(bu 3
ENABLE_RTLSDR
.IP \(bu 3
ENABLE_BLADERF
.SH USAGE
\fBreadsb [OPTION\.\.\.]
.SH OPTIONS
.TP
.B
\fB--dcfilter\fP
Apply a 1Hz DC filter to input data (requires more
CPU)
.TP
.B
\fB--enable-biastee\fP
Enable bias tee on supporting interfaces (default: disabled)
.TP
.B
\fB--debug\fP=<flags>
Debug mode (verbose), see flags below
.TP
.B
\fB--device-type\fP=<type>
Select SDR type
.TP
.B
\fB--fix\fP
Enable CRC single-bit error correction (default)
.TP
.B
\fB--forward-mlat\fP
Allow forwarding of received mlat results to
output ports
.TP
.B
\fB--freq\fP=<hz>
Set frequency (default: 1090 MHz)
.TP
.B
\fB--gain\fP=<db>
Set gain (default: max gain. Use \fB-10\fP for
auto-gain)
.TP
.B
\fB--gnss\fP
Show altitudes as GNSS when available
.TP
.B
\fB--interactive\fP
Interactive mode refreshing data on screen.
Implies \fB--throttle\fP
.TP
.B
\fB--interactive-ttl\fP=<sec>
Remove from list if idle for <sec> (default: 60)
.TP
.B
\fB--json-location-accuracy\fP=<n>
Accuracy of receiver location in json metadata:
.RS
.IP 0
no location
.IP 1
approximate
.IP 2
exact
.RE
.RE
.TP
.B
\fB--lat\fP=<lat>
Reference/receiver surface latitude
.TP
.B
\fB--lon\fP=<lon>
Reference/receiver surface longitude
.TP
.B
\fB--max-range\fP=<dist>
Absolute maximum range for position decoding (in
nm, default: 300)
.TP
.B
\fB--metric\fP
Use metric units
.TP
.B
\fB--mlat\fP
Display raw messages in Beast ASCII mode
.TP
.B
\fB--modeac\fP
Enable decoding of SSR Modes 3/A & 3/C
.TP
.B
\fB--no-crc-check\fP
Disable messages with invalid CRC (discouraged)
.TP
.B
\fB--no-fix\fP
Disable CRC single-bit error correction
.TP
.B
\fB--no-interactive\fP
Disable interactive mode, print to stdout
.TP
.B
\fB--no-modeac-auto\fP
Don't enable Mode A/C if requested by a Beast
connection
.TP
.B
\fB--onlyaddr\fP
Show only ICAO addresses
.TP
.B
\fB--quiet\fP
Disable output. Use for daemon applications
.TP
.B
\fB--raw\fP
Show only messages hex values
.TP
.B
\fB--show-only\fP=<addr>
Show only messages by given ICAO on stdout
.TP
.B
\fB--snip\fP=<level>
Strip IQ file removing samples < level
.TP
.B
\fB--stats\fP
With \fB--ifile\fP print stats at exit. No other output
.TP
.B
\fB--stats-every\fP=<sec>
Show and reset stats every <sec> seconds
.TP
.B
\fB--stats-range\fP
Collect/show range histogram
.TP
.B
\fB--write-json\fP=<dir>
Periodically write json output to <dir> (for
external webserver)
.TP
.B
\fB--write-json-every\fP=<t>
Write json output every t seconds (default 1)
.SS NETWORK OPTIONS
.TP
.B
\fB--net\fP
Enable networking
.TP
.B
\fB--net-bi-port\fP=<ports>
TCP Beast input listen ports (default:
30004,30104)
.TP
.B
\fB--net-vrs-port\fP=<ports>
TCP VRS json output listen ports (default: 0)
.TP
.B
\fB--net-beast-reduce-out-port\fP=<ports>
TCP BeastReduce output listen ports (default: 0)
.TP
.B
\fB--net-beast-reduce-interval\fP=<seconds>
BeastReduce position update interval, longer means less data
(default: 0.125, valid range: 0.000 - 14.999)
.TP
.B
\fB--net-bind-address\fP=<ip>
IP address to bind to (default: Any; Use 127.0.0.1 for private)
.TP
.B
\fB--net-bo-port\fP=<ports>
TCP Beast output listen ports (default: 30005)
.TP
.B
\fB--net-buffer\fP=<n>
TCP buffer size 64Kb * (2^n) (default: n=0, 64Kb)
.TP
.B
\fB--net-heartbeat\fP=<rate>
TCP heartbeat rate in seconds (default: 60 sec, 0 to disable)
.TP
.B
\fB--net-only\fP
Enable just networking, no RTL device or file used
.TP
.B
\fB--net-connector\fP=<ip,port,protocol>
Establish connection, can be specified multiple times (example: 127.0.0.1,23004,beast_out) Protocols: beast_out, beast_in, raw_out, raw_in, sbs_out, vrs_out.
.TP
.B
\fB--net-connector-delay\fP=<seconds>
Outbound re-connection delay (default: 30)
.TP
.B
\fB--net-ri-port\fP=<ports>
TCP raw input listen ports (default: 30001)
.TP
.B
\fB--net-ro-interval\fP=<rate>
TCP output memory flush rate in seconds
(default: 0)
.TP
.B
\fB--net-ro-port\fP=<ports>
TCP raw output listen ports (default: 30002)
.TP
.B
\fB--net-ro-size\fP=<size>
TCP output minimum size (default: 0)
.TP
.B
\fB--net-sbs-port\fP=<ports>
TCP BaseStation output listen ports (default: 30003)
.RE
.TP
.B
\fB--net-verbatim\fP
Forward messages unchanged
.SS RTLSDR OPTIONS
.I
use with \fB--device-type\fP rtlsdr
.TP
.B
\fB--device\fP=<index|serial>
Select device by index or serial number
.TP
.B
\fB--enable-agc\fP
Enable digital AGC (not tuner AGC!)
.TP
.B
\fB--ppm\fP=<correction>
Set oscillator frequency correction in PPM
.SS BLADERF OPTIONS
.I
use with \fB--device-type\fP bladerf
.TP
.B
\fB--bladerf-bandwidth\fP=<hz>
Set LPF bandwidth ('bypass' to bypass the
LPF)
.TP
.B
\fB--bladerf-decimation\fP=<N>
Assume FPGA decimates by a factor of N
.TP
.B
\fB--bladerf-fpga\fP=<path>
Use alternative FPGA bitstream ('' to disable FPGA load)
.TP
.B
\fB--device\fP=<ident>
Select device by bladeRF 'device identifier'
.SS MODES BEAST OPTIONS
.I
use with \fB--device-type\fP modesbeast
.PP
Beast binary protocol and hardware handshake are always enabled.
.TP
.B
\fB--beast-crc-off\fP
Turn OFF CRC checking
.TP
.B
\fB--beast-df045-on\fP
Turn ON DF0/4/5 filter
.TP
.B
\fB--beast-df1117-on\fP
Turn ON DF11/17-only filter
.TP
.B
\fB--beast-fec-off\fP
Turn OFF forward error correction
.TP
.B
\fB--beast-mlat-off\fP
Turn OFF MLAT time stamps
.TP
.B
\fB--beast-modeac\fP
Turn ON mode A/C
.TP
.B
\fB--beast-serial\fP=<path>
Path to Beast serial device (default
/dev/ttyUSB0)
.SS ADALM-Pluto OPTIONS
.I
use with \fB--device-type\fP plutosdr
.PP
Default device expected at hostname 'pluto.local'.
.TP
.B
\fB--pluto-uri\fP=<USB URI>
Create USB context from URI (eg. usb:1.2.5)
.TP
.B
\fB--pluto-network\fP=<hostname or IP>
Create network context from hostname or IP (default pluto.local)
.SS IFILE OPTIONS
.I
use with \fB--ifile\fP
.TP
.B
\fB--ifile\fP=<path>
Read samples from given file ('-' for stdin)
.TP
.B
\fB--iformat\fP=<type>
Set sample format (UC8, SC16, SC16Q11)
.TP
.B
\fB--throttle\fP
Process samples at the original capture speed
.SS HELP OPTIONS
.TP
.B
-?, \fB--help\fP
Give this help list
.TP
.B
\fB--usage\fP
Give a short usage message
.TP
.B
\fB-V\fP, \fB--version\fP
Print program version
.SH DEBUG MODE FLAGS
.TP
.B
d
Log frames decoded with errors
.TP
.B
D
Log frames decoded with zero errors
.TP
.B
c
Log frames with bad CRC
.TP
.B
C
Log frames with good CRC
.TP
.B
p
Log frames with bad preamble
.TP
.B
n
Log network debugging info
.TP
.B
j
Log frames to frames.js, loadable by debug.html
.PP
.SH CREDITS
Matthias Wirth aka wiedehopf
Taner Halicioglu aka tanerH
.SH BUGS
Report bugs to Michael Wolf <[email protected]>.
.SH AUTHOR
Michael Wolf