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

NAME

6       gps2udp - feed the take from gpsd to one or more aggregation sites
7

SYNOPSIS

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

DESCRIPTION

16       gps2udp is a tool to connect to gpsd and output the received sentences
17       to one or many UDP host:port destinations. This makes the program
18       useful for feeding AIS information from gpsd to aishub, marinetraffic,
19       shipfinder,...
20
21       gps2udp does not require root privileges, but can run as root. It can
22       be run concurrently with other tools connecting to the local gpsd
23       without causing problems.
24
25       The output will consist of one or both of NMEA (-n option) or JSON (-j
26       option) gpsd sentences. The output is sent to one or many destinations
27       host through a UDP network socket (-u HOST:PORT options) .
28
29       Optionally a server, TCP/IP port number and remote device can be given.
30       If omitted, gps2udp connects to localhost on the default port (2947)
31       and watches all devices opened by gpsd.
32
33       gps2udp may be run as a daemon (-b option).
34
35       gps2udp is designed to run smoothly in background; it reconnects
36       automatically to gpsd whenever it is restarted. For debugging
37       purporses, there is an option to exit gracefully after a given count of
38       packets (-c option).
39

OPTIONS

41       -?, -h, --help
42           -Print a usage message and exit.
43
44       -a, --ais
45           Send only AIS messages.
46
47       -b, --daemon
48           Causes gps2udp to run as a daemon.
49
50       -c COUNT, --count COUNT
51           Exit after COUNT sentences are sent.
52
53       -d LVL, --debug LVL
54           Set debug level to LVL. LVL = 0 prints nothing. LVL = 1 prints sent
55           packet on stdout. LVL = 2 prints ignored packets.
56
57       -j, --json
58           Causes JSON sentences to be output.
59
60       -n, --nmea
61           Causes NMEA sentences to be output.
62
63       -t, --tpv
64           Only output TPV sentences. Implies --json.
65
66       -u HOST:PORT, --udp HOST:PORT
67           UDP destination for output sentenses (up to five destinations).
68
69       -v, -V, --version
70           Prints the program version, then exit. -v is deprecated December
71           2020.
72

ARGUMENTS

74       By default, clients collect data from the local gpsd daemon running on
75       localhost, using the default GPSD port 2947. The optional argument to
76       any client may override this behavior: [server[:port[:device]]]
77
78       For further explanation, and examples, see the ARGUMENTS section in the
79       gps(1) man page
80

EXAMPLES

82       With a running gpsd accessible on the network this will collect data
83       from localhost:gpsd display them on stdout and send a copy to test
84       aishub in NMEA format.
85
86           gps2udp -d 1 -n -u data.aishub.net:2222
87
88       This will collect data from a remote gpsd located on fridu.net host,
89       will filter AIS messages and send them to 3 destinations (aishub,
90       marinetraffic, shipfinder) in NMEA format, while running in background
91       mode
92
93           gps2udp -a -n -b -u data.aishub.net:2222 -u 5.9.207.224:5321 \
94              -u 109.200.19.151:4001 fridu.net:2947
95

RETURN VALUES

97       0
98           on success.
99
100       1
101           on failure
102

SEE ALSO

104       gpsd(8), gps(1)
105

RESOURCES

107       Project web site: https://gpsd.io/
108

COPYING

110       This file is Copyright 2013 by the GPSD project
111       SPDX-License-Identifier: BSD-2-clause
112

AUTHOR

114       Fulup Ar Foll
115
116
117
118GPSD Version 3.25                 2023-01-10                        GPS2UDP(1)