1GPSPIPE(1)                    GPSD Documentation                    GPSPIPE(1)
2
3
4

NAME

6       gpspipe - tool to connect to gpsd and retrieve sentences
7

SYNOPSIS

9       gpspipe [-h] [-d] [-l] [-o filename] [-n count] [-r] [-R]
10               [-s serial-device] [-t] [-T timestamp-format] [-u] [-p] [-w]
11               [-S] [-2] [-v] [-D debug-level] [server [:port [:device]]]
12

DESCRIPTION

14       gpspipe is a tool to connect to gpsd and output the received sentences
15       to stdout. This makes the program useful as a pipe from gpsd to another
16       program or file.
17
18       gpspipe does not require root privileges, and can be run concurrently
19       with other tools connecting to the local gpsd without causing problems.
20
21       The output will consist of one or both of the raw NMEA or native gpsd
22       sentences. Each line can be optionally time stamped. There is also an
23       option to exit gracefully after a given count of packets.
24
25       Optionally a server, TCP/IP port number and remote device can be given.
26       If omitted, gpspipe connects to localhost on the default port (2947)
27       and watches all devices opened by gpsd.
28
29       gpspipe may be run as a daemon, but requires the -o flag for writing
30       the output to a file.
31

OPTIONS

33       -h makes gpspipe print a usage message and exit.
34
35       -d causes gpspipe to run as a daemon.
36
37       -l causes gpspipe to sleep for ten seconds before attempting to connect
38       to gpsd. This is very useful when running as a daemon, giving gpsd time
39       to start before attempting a connection.
40
41       -r causes raw NMEA sentences to be output.
42
43       -R causes super-raw (gps binary) data to be output. This overrides NMEA
44       and gpsd output modes.
45
46       -s option causes the collected data to be written to the specified
47       serial device with settings 4800 8N1. Thus gpspipe can be used with -s
48       and -r options to emulate a serial port hardwired to a GPS that gpsd is
49       managing.
50
51       -o option causes the collected data to be written to the specified
52       file. Use of this option is mandatory if gpspipe is run as a daemon.
53
54       -w causes native gpsdsentences to be output.
55
56       -S sets the scaled flag.
57
58       -2 sets the split24 flag on AIS reports. Note: this option is
59       experimental and may be changed or removed in a future release.
60
61       -t adds a timestamp to each sentence output.
62
63       -T sets the format of the timestamp. See strftime(3) for the available
64       placeholders. Setting this option implies -t. Default setting is "%F
65       %T"
66
67       -u usec resolution time stamp, implies -t. Use -uu to output sec.usec.
68
69       -p enables dumping of profiling information in JSON.
70
71       -P enables dumping of PPS drift JSON in NMEA and raw modes.
72
73       -n [count] causes [count] sentences to be output.  gpspipe will then
74       exit gracefully.
75
76       -v causes gpspipe to show a spinning activity indicator on stderr. This
77       is useful if stdout is redirected into a file or a pipe. By default the
78       spinner is advanced with every messages written; specifying -v more
79       than once will double the number of messages required to rotate the
80       spinner.
81
82       -V prints the version, then exits.
83
84       At least one of -R, -r or -w must be specified.
85

EXAMPLE

87       When gpsd is running gpspipe -r -n 100 will send one hundred raw NMEA
88       sentences to standard output, then exit.
89

SEE ALSO

91       gpsd(8), gps(1), libgps(3), libgpsmm(3), gpsprof(1), gpsfake(1),
92       gpsctl(1), gpscat(1).  gpsmon(1).
93

AUTHOR

95       Gary E. Miller <gem@rellim.com>.
96
97
98
99The GPSD Project                  03 Aug 2005                       GPSPIPE(1)
Impressum