1GPSPIPE(1) GPSD Documentation GPSPIPE(1)
2
6 gpspipe - tool to connect to gpsd and retrieve sentences
7
9 gpspipe [-2] [-?] [-d] [-D debug-level] [-h] [-l] [-n count]
10 [-o filename] [-p] [-P] [-r] [-R] [-S] [-s serial-device] [-t]
11 [-T timestamp-format] [-u] [-v] [-V] [-w] [-x seconds] [-Z]
12 [server [:port [:device]]]
13
15 gpspipe is a tool to connect to gpsd and output the received sentences
16 to stdout. This makes the program useful as a pipe from gpsd to another
17 program or file.
18 gpspipe does not require root privileges, and can be run concurrently
20 with other tools connecting to the local gpsd without causing problems.
21 The output will consist of one or both of the raw NMEA or native gpsd
23 sentences. Each line can be optionally time stamped. There is also an
24 option to exit gracefully after a given count of packets.
25 Optionally a server, TCP/IP port number and remote device can be given.
27 If omitted, gpspipe connects to localhost on the default port (2947)
28 and watches all devices opened by gpsd.
29 gpspipe may be run as a daemon, but requires the -o flag for writing
31 the output to a file.
32
34 -2 sets the split24 flag on AIS reports. Note: this option is
35 experimental and may be changed or removed in a future release.
36 -? makes gpspipe print a usage message and exit.
38 -d causes gpspipe to run as a daemon.
40 -D [debug-level] set debug level..
42 -h makes gpspipe print a usage message and exit.
44 -l causes gpspipe to sleep for ten seconds before attempting to connect
46 to gpsd. This is very useful when running as a daemon, giving gpsd time
47 to start before attempting a connection.
48 -n [count] causes [count] sentences to be output. gpspipe will then
50 exit gracefully.
51 -o [filename] option causes the collected data to be written to the
53 specified file. Use of this option is mandatory if gpspipe is run as a
54 daemon.
55 -p enables dumping of profiling information in JSON.
57 -P enables dumping of PPS drift JSON in NMEA and raw modes.
59 -r causes raw NMEA sentences to be output.
61 -R causes super-raw (gps binary) data to be output. This overrides NMEA
63 and gpsd output modes.
64 -s option causes the collected data to be written to the specified
66 serial device with settings 4800 8N1. Thus gpspipe can be used with -s
67 and -r options to emulate a serial port hardwired to a GPS that gpsd is
68 managing.
69 -S sets the scaled flag. This is for AIS and subframe data, but
71 currently appears to do nothing.
72 -t adds a UTC timestamp to each sentence output.
74 -T sets the format of the timestamp. See strftime(3) for the available
76 placeholders. Setting this option implies -t. Default setting is "%F
77 %T"
78 -u usec resolution time stamp, implies -t. Use -uu to output sec.usec.
80 -v causes gpspipe to show a spinning activity indicator on stderr. This
82 is useful if stdout is redirected into a file or a pipe. By default the
83 spinner is advanced with every messages written; specifying -v more
84 than once will double the number of messages required to rotate the
85 spinner.
86 -V prints the version, then exits.
88 -w causes native gpsd sentences to be output.
90 -x [seconds] Exit after delay of [seconds].
92 -Z sets the timestamp format iso8601: implies '-t'
94 At least one of -R, -r or -w must be specified.
96 You must use -o if you use -d.
98
100 When gpsd is running, gpspipe -r -n 100 will send one hundred raw NMEA
101 sentences to standard output, then exit.
102 When gpsd is running, gpspipe -x 5 -w|sed -n '/TPV/{p;q}' will wait at
104 most 5 seconds for a TPV message, print it to stdout, then exit.
105
107 gpsd(8), gps(1), libgps(3), libgpsmm(3), gpsprof(1), gpsfake(1),
108 gpsctl(1), gpscat(1). gpsmon(1).
109
111 Gary E. Miller <gem@rellim.com>.
112The GPSD Project 14 Dec 2018 GPSPIPE(1)