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

NAME

6       gpsplot - tool to dynamically dump plot data from gpsd
7

SYNOPSIS

9       gpsplot [OPTIONS] [server[:port[:device]]]
10
11       gpsplot -h
12
13       gpsplot -V
14

DESCRIPTION

16       gpsplot is a tool to connect to gpsd and dynamically plot data to the
17       users screen. Plot types include scatterplots and stripcharts.
18
19       Plotting requires the Python Matplotlib module, and its many
20       dependencies be installed on the display host. If the display host is
21       not the gpsd host, then Matplotlib is not required to be on the gpsd
22       host.
23
24       gpslot does not require root privileges, but can be run as root.
25       Running under sudo will cause some loss of functionality. It can be run
26       concurrently with other tools connecting to the local gpsd without
27       causing problems.
28

OPTIONS

30       -?, -h, --help
31           Print a usage message and exit.
32
33       -b BACKEND, --backend BACKEND
34           Set the Matplotlib interactive backend to BACKEND.
35
36       -B, --backends
37           Print available Matplotlib interactive backends, then exit. The
38           Matplotlib backends vary wildly in how fst they run and how good
39           they look. Try them all to see for yourself.
40
41       -d LVL, --debug LVL
42           Set debug level to LVL.
43
44       --device DEVICE
45           The DEVICE on the gpsd to connect to. Defaults to all.
46
47       --exit
48           Exit after --count, --file, or --file completes.
49
50       --fields FIELDS
51           The code for the fields to plot. FIELDS is one of: llh
52           (lat/lon/altHAE) or llm (lat/lon/altMSL).
53
54       --file FILE
55           Read JSON from FILE instead of from gpsd..
56
57       --host HOST
58           Connect to the gpsd on HOST (server). Defaults to localhost.
59
60       --image IMAGE.EXT
61           Save plot as IMAGE.EXT. EXT determines image type (.jpg, .png,
62           etc.). Which EXT are supported is installation dependent.
63
64       -n COUNT, --count COUNT
65           Stop after COUNT plot messages. 0 to disable. Default 0',
66
67       --plottype PLOTTYPE
68           The type of plot to make. PLOTTYPE is one of 'scatterplot' or
69           'stripchart'.
70
71       -p PORT, --port PORT
72           Use PORT to connect to gpsd. Defaults to 2947.
73
74       -V, --version
75           Print the program version and exit.
76
77       -x SECONDS, --seconds SECONDS
78           Stop after SECONDS. 0 to disable. Default 0',
79

ARGUMENTS

81       By default, clients collect data from the local gpsd daemon running on
82       localhost, using the default GPSD port 2947. The optional argument to
83       any client may override this behavior: [server[:port[:device]]]
84
85       For further explanation, and examples, see the ARGUMENTS section in the
86       gps(1) man page
87

ENVIRONMENT

89       You can set the environment varable MPLBACKEND to your desired
90       Matplotlib backend. This save you from using -b BACKEND every time you
91       run gpsplot.
92

EXAMPLES

94       Generate a scatterplot of Latitude, Longitude and the Altitude above
95       Mean Sea Level (altMSL). Stop after 60 seconds:
96
97           gpsplot --seconds 60 --fields llm
98
99       Generate a scatterplot of Latitude, Longitude and the Height Above
100       Ellipsoid (altHAE). Stop after 60 fixes:
101
102           gpsplot --count 60 --plottype stripchart
103
104       Use the WXAgg backend to repeat the last experiment to see if it is
105       faster or looks better to you.
106
107           export MPLBACKEND=WX
108           gpsplot --count 60 --plottype stripchart
109
110       Generate a scatterplot locally of Latitude, Longitude and altMSL from a
111       remote gpsd instance at host "example.com" and the remote device
112       "/dev/ttyS0". Collect 60 fixes, Stop, save the plot as "save.jpg, and
113       exit:
114
115           gpsplot --count 60 --exit --fields llm --image save.jpg example.com::/dev/ttyS0
116

RETURN VALUES

118       0
119           on success.
120
121       1
122           on failure
123

SEE ALSO

125       gpsd(8), gpsprof(1), gpsfake(1).
126

RESOURCES

128       Project web site: https://gpsd.io/
129

COPYING

131       This file is Copyright 2020 by the GPSD project
132       SPDX-License-Identifier: BSD-2-clause
133

AUTHOR

135       Gary E. Miller
136
137
138
139GPSD 3.24                         2021-09-20                        GPSPLOT(1)
Impressum