zerk(1) - f37

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

NAME

6       zerk - All purpose GREIS fitting
7

OPTIONS

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

DESCRIPTION

16       zerk is an all purpose GREIS (GNSS Receiver External Interface
17       Specification) fitting. If you do not have a Javad GPS that speaks the
18       GREIS protocol then you can stop reading now.
19
20       This tool operates with your Javad GPS at a very low level. To
21       understand zerk you must first be familiar with your Javad GPS and the
22       documentation for the GREIS protocol. GREIS Guide
23       <https://www.javad.com/downloads/javadgnss/manuals/GREIS/GREIS_Reference_Guide.pdf>.
24
25       zerk can decode common GREIS messages, poll the GPS status, enable and
26       disable GPS features, and send user-generated commands to the GPS. It
27       can read GREIS messages from a file. It can read and write directly
28       through a serial device, or through a running gpsd instance.
29
30       zerk does not require root privileges, except maybe to access the
31       serial port in direct mode. It will run fine as root. Running under
32       sudo will cause loss of functionality.
33

OPTIONS

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

ARGUMENTS

181       By default, clients collect data from the local gpsd daemon running on
182       localhost, using the default GPSD port 2947. The optional argument to
183       any client may override this behavior: [server[:port[:device]]]
184
185       For further explanation, and examples, see the ARGUMENTS section in the
186       gps(1) man page
187

ENVIRONMENT

189       Options can be placed in the ZERKOPTS environment variable. ZERKOPTS is
190       processed before the CLI options.
191

EXAMPLES

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

RETURN VALUES

218       0
219           on success.
220
221       1
222           on failure
223

RESOURCES

232       Project web site: https://gpsd.io/
233

COPYING

235       This file is Copyright 2013 by the GPSD project
236       SPDX-License-Identifier: BSD-2-clause
237

AUTHOR

239       Gary E. Miller
240
241
242
243GPSD, Version 3.24                2021-09-20                           ZERK(1)