zerk(1) - f33

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       -c COMMAND
31           Send a text string to the GPS. Accepts one parameter, COMMAND, the
32           command string to send to the GPS. The string is sent verbatim,
33           except a newline is appended.
34
35       -d OPTION
36           Disable an option in the GPS. Accepts one parameter, OPTION, the
37           option to disable.  zerk will exit after the GPS acknowledges the
38           command, unless the -W is given.
39
40           4HZ
41               Disable basic GREIS messages at 4Hz. The messages are: [RT],
42               [UO], [GT], [PV], [SG], [DP], [SI], [EL], [AZ], [EC], [SS], and
43               [ET]
44
45           COMPASS
46               Disable use of the COMPASS (BeiDou) constellation.
47
48           CONS
49               Disable use of all constellations.
50
51           DEFMSG
52               Disable the default message set (/dev/msg) at 1Hz.
53
54           GALILEO
55               Disable use of the GALILEO constellation.
56
57           GLONASS
58               Disable use of the GLONASS constellation.
59
60           GPS
61               Disable use of the GPS constellation.
62
63           IPR
64               Disable all Integer Pseudo Range messages. These are [rx],
65               [rc], [r1], [r2], [r3], [r5], [rl].
66
67           IRNSS
68               Disable use of the IRNSS constellation.
69
70           NMEA
71               Disable basic NMEA 4.1e messages at 4Hz. The messages are GBS,
72               GGA, GSA, GST, GSV, RMC, VTG, and ZDA.
73
74           QZSS
75               Disable use of the QZSS constellation.
76
77           SBAS
78               Disable use of the SBAS constellation.
79
80           SNR
81               Disable all SNR messages, except [EC]. The messages disabled
82               are: [E1], [E2], [E3], [E5], [El].
83
84       -e OPTION
85           Enable an option in the GPS. Accepts one parameter, OPTION, the
86           option to enable.  zerk will exit after the GPS acknowledges the
87           command, unless the -W is given. -e accepts the same OPTIONs as -d,
88           except the action is to enable the option.
89
90       -f FILE
91           Connect to a file or device. Accepts one parameter, FILE, the file
92           or device to open. Files are opened read-only. Character devices
93           are opened read/write, unless the -r parameter is given. Requires
94           the pyserial module.
95
96       -h
97           Makes zerk print a usage message and exit.
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       -v VERBOSITY
165           Set verbosity level to VERBOSITY. Verbosity can be from 0 (very
166           quiet), 2 (decode messages), to 4 (very noisy). Default 1.
167
168       -W
169           Force waiting the entire wait time. No early exit for completion of
170           -d, -e or -p command.
171
172       -w WAIT
173           Wait for WAIT seconds before exiting. Will exit early on command
174           completion of -d, -e or -p command, unless -W is given. Default 2.0
175           second.
176
177       [server[:port[:device]]]
178           By default, zerk collects data from all compatible devices on
179           localhost, using the default GPSD port 2947. An optional argument
180           may specify a server to get data from. A colon-separated suffix is
181           taken as a port number. If there is a second colon-separated
182           suffix, that is taken as a specific device name to be watched.
183           Further details on the gps(1) man page.
184
185       -?
186           Makes zerk print a usage message and exit.
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 portC of GPS connected to local running
194       gpsd::
195
196            zerk -c "print,/cur/term"
197
198       Decode raw log file:
199
200           zerk -r -f greis-binary.log -v 2
201
202       Change GPS port speed of device on /dev/ttyAMA0 to 230,400 bps::
203
204           zerk -S 230400 -f /dev/ttyAMA0
205
206       Watch entire GPS reset cycle:
207
208           zerk -p RESET -v 2 -w 20 -W
209
210       Poll SVs Status:
211
212           zerk -W -w 2 -v 2 -c "out,,jps/{CS,ES,GS,Is,WS,QS}"
213
214       Dump gpsd data from remote server:
215
216           zerk -v 2 -w 5 server
217
218

AUTHOR

228       Gary E. Miller<gem@rellim.com>
229

NOTES

231        1. GREIS (GNSS Receiver External Interface Specification) Guide
232           http://www.javad.com/downloads/javadgnss/manuals/GREIS/GREIS_Reference_Guide.pdf
233
234
235
236The GPSD Project                  18 Sep 2018                          ZERK(1)