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

NAME

6       zerk - All purpose GREIS fitting
7

SYNOPSIS

9       zerk [-?] [-c command] [-d disable] [-e enable] [-f file/device] [-h]
10            [-O oaf] [-p preset] [-R rawfile] [-r] [-S setspeed] [-s speed]
11            [-V] [-v verbosity] [-W] [-w wait] [[server[:port[:device]]]]
12

DESCRIPTION

14       zerk is an all purpose GREIS fitting. If you do not have a Javad GPS
15       that speaks the GREIS protocol then you can stop reading now.
16
17       This tool operates with your Javad GPS at a very low level. To
18       understand zerk you must first be familiar with your Javad GPS and the
19       documentation for the GREIS protocol.  GREIS (GNSS Receiver External
20       Interface Specification) Guide[1].
21
22       zerk can decode common GREIS messages, poll the GPS status, enable and
23       disable GPS features, and send user generated commands to the GPS. It
24       can read GREIS messages from a file. It can read and write directly
25       through a serial device, or through a running gpsd instance.
26

OPTIONS

28       The program accepts the following options:
29
30       -?, -h
31           Makes zerk print a usage message and exit.
32
33       -c COMMAND
34           Send a text string to the GPS. Accepts one parameter, COMMAND, the
35           command string to send to the GPS. The string is sent verbatim,
36           except a newline is appended.
37
38       -d OPTION
39           Disable an option in the GPS. Accepts one parameter, OPTION, the
40           option to disable.  zerk will exit after the GPS acknowledges the
41           command, unless the -W is given.
42
43           4HZ
44               Disable basic GREIS messages at 4Hz. The messages are: [RT],
45               [UO], [GT], [PV], [SG], [DP], [SI], [EL], [AZ], [EC], [SS], and
46               [ET]
47
48           COMPASS
49               Disable use of the COMPASS (BeiDou) constellation.
50
51           CONS
52               Disable use of all constellations.
53
54           DEFMSG
55               Disable the default message set (/dev/msg) at 1Hz.
56
57           GALILEO
58               Disable use of the GALILEO constellation.
59
60           GLONASS
61               Disable use of the GLONASS constellation.
62
63           GPS
64               Disable use of the GPS constellation.
65
66           IPR
67               Disable all Integer Pseudo Range messages. These are [rx],
68               [rc], [r1], [r2], [r3], [r5], [rl].
69
70           IRNSS
71               Disable use of the IRNSS constellation.
72
73           NMEA
74               Disable basic NMEA 4.1e messages at 4Hz. The messages are GBS,
75               GGA, GSA, GST, GSV, RMC, VTG, and ZDA.
76
77           QZSS
78               Disable use of the QZSS constellation.
79
80           SBAS
81               Disable use of the SBAS constellation.
82
83           SNR
84               Disable all SNR messages, except [EC]. The messages disabled
85               are: [E1], [E2], [E3], [E5], [El].
86
87       -e OPTION
88           Enable an option in the GPS. Accepts one parameter, OPTION, the
89           option to enable.  zerk will exit after the GPS acknowledges the
90           command, unless the -W is given. -e accepts the same OPTIONs as -d,
91           except the action is to enable the option.
92
93       -f FILE
94           Connect to a file or device. Accepts one parameter, FILE, the file
95           or device to open. Files are opened read-only. Character devices
96           are opened read/write, unless the -r parameter is given. Requires
97           the pyserial module.
98
99       -O OAF
100           Load an Option Authorization File (OAF) into the GPS. Accepts one
101           parameter, OAF, command file to read. The OAF is just a special
102           case of a '.jpo' (GREIS command file). -O will send any valid .jpo
103           file to the GPS.
104
105       -p PRESET
106           Send a preset command the GPS. Accepts one parameter, PRESET, the
107           name of the command to send.  zerk will exit after the GPS
108           acknowledges the command, unless the -W is given.
109
110           COLDBOOT
111               Coldboot the GPS.
112
113           CONS
114               Poll the enabled constellations.
115
116           DM
117               Disable all periodic GREIS messages.
118
119           ID
120               Poll the receiver ID.
121
122           IPR
123               Poll all Integer Pseudo Range messages. These are [rx], [rc],
124               [r1], [r2], [r3], [r5], [rl].
125
126           OAF
127               Poll all OAF options.
128
129           RESET
130               Reset (reboot) the GPS.
131
132           SERIAL
133               Poll receiver serial number.
134
135           SNR
136               Poll all Signal to Noise Ratio (SNR) messages. [EC], [E1],
137               [E2], [E3], [E5], [El].
138
139           VENDOR
140               Poll GPS vendor.
141
142           VER
143               Poll GPS version.
144
145       -r
146           Read only. Do not send anything to the GPS.
147
148       -R RAW
149           Save all raw data from the GPS into the file RAW.
150
151       -S SPEED
152           Configure the GPS serial speed to SPEED bps.
153
154       -s SPEED
155           Set local serial port speed to SPEED bps. Default 115,200 bps.
156
157       -V
158           Print zerk version and exit.
159
160       -v VERBOSITY
161           Set verbosity level to VERBOSITY. Verbosity can be from 0 (very
162           quiet), to 4 (very noisy). Default 2.
163
164       -W
165           Force waiting the entire wait time. No early exit for completion of
166           -d, -e or -p command.
167
168       -w WAIT
169           Wait for WAIT seconds before exiting. Will exit early on command
170           completion of -d, -e or -p command, unless -W is given. Default 2.0
171           second.
172
173       [server[:port[:device]]]
174           By default, zerk collects data from all compatible devices on
175           localhost, using the default GPSD port 2947. An optional argument
176           may specify a server to get data from. A colon-separated suffix is
177           taken as a port number. If there is a second colon-separated
178           suffix, that is taken as a specific device name to be watched.
179           Further details on the gps(1) man page.
180

ENVIRONMENT

182       Options can be placed in the ZERKOPTS environment variable. ZERKOPTS is
183       processed before the CLI options.
184

EXAMPLES

186       Print current Javad serial portC of GPS connected to local running
187       gpsd::
188
189            zerk -c "print,/cur/term"
190
191       Decode raw log file:
192
193           zerk -r -f greis-binary.log -v 2
194
195       Change GPS port speed of device on /dev/ttyAMA0 to 230,400 bps::
196
197           zerk -S 230400 -f /dev/ttyAMA0
198
199       Watch entire GPS reset cycle:
200
201           zerk -p RESET -v 2 -w 20 -W
202
203       Poll SVs Status:
204
205           zerk -W -w 2 -v 2 -c "out,,jps/{CS,ES,GS,Is,WS,QS}"
206
207       Dump gpsd data from remote server:
208
209           zerk -v 2 -w 5 server
210
211

SEE ALSO

213       zerk is written to conform to the official Javad documentation for the
214       GREIS protocol.  GREIS (GNSS Receiver External Interface Specification)
215       Guide[1].
216
217       gpsd(8), gps(1), cgps(1), xgps(1), gpsfake(1), gpsctl(1), gpscat(1),
218       gnuplot(1).
219

AUTHOR

221       Gary E. Miller<gem@rellim.com>
222

NOTES

224        1. GREIS (GNSS Receiver External Interface Specification) Guide
225           http://www.javad.com/downloads/javadgnss/manuals/GREIS/GREIS_Reference_Guide.pdf
226
227
228
229The GPSD Project                6 December 2020                        ZERK(1)
Impressum