1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
This file is Copyright (c) 2018 by the GPSD project
BSD terms apply: see the file COPYING in the distribution root for details.
-->
<!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id='zerk.1'>
<refentryinfo>
<date>18 Sep 2018</date>
</refentryinfo>
<refmeta>
<refentrytitle>zerk</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="source">The GPSD Project</refmiscinfo>
<refmiscinfo class="manual">GPSD Documentation</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>zerk</refname>
<refpurpose>All purpose GREIS fitting</refpurpose>
</refnamediv>
<refsynopsisdiv id='synopsis'>
<cmdsynopsis>
<command>zerk</command>
<arg choice='opt'>-? </arg>
<arg choice='opt'>-c <replaceable>command</replaceable>
</arg>
<arg choice='opt'>-d <replaceable>disable</replaceable>
</arg>
<arg choice='opt'>-e <replaceable>enable</replaceable>
</arg>
<arg choice='opt'>-f <replaceable>file/device</replaceable>
</arg>
<arg choice='opt'>-h </arg>
<arg choice='opt'>-O <replaceable>oaf</replaceable>
</arg>
<arg choice='opt'>-p <replaceable>preset</replaceable></arg>
<arg choice='opt'>-R <replaceable>rawfile</replaceable>
</arg>
<arg choice='opt'>-r </arg>
<arg choice='opt'>-S <replaceable>setspeed</replaceable>
</arg>
<arg choice='opt'>-s <replaceable>speed</replaceable>
</arg>
<arg choice='opt'>-V </arg>
<arg choice='opt'>-v <replaceable>verbosity</replaceable>
</arg>
<arg choice='opt'>-W </arg>
<arg choice='opt'>-w <replaceable>wait</replaceable>
</arg>
<arg choice='opt'>[server[:port[:device]]]</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1 id='description'>
<title>DESCRIPTION</title>
<para>
<application>zerk</application> is an all purpose GREIS fitting.
If you do not have a Javad GPS that speaks the GREIS protocol then you
can stop reading now.</para>
<para>This tool operates with your Javad GPS at a very low level.
To understand <application>zerk</application> you must first be familiar
with your Javad GPS and the documentation for the GREIS protocol.
<ulink url="http://www.javad.com/downloads/javadgnss/manuals/GREIS/GREIS_Reference_Guide.pdf">GREIS (GNSS Receiver External Interface Specification) Guide</ulink>.
</para>
<para>
<application>zerk</application> can decode common GREIS messages,
poll the GPS status, enable and disable GPS features, and send user
generated commands to the GPS. It can read GREIS messages from a file. It
can read and write directly through a serial device, or through a
running gpsd instance.</para>
</refsect1>
<refsect1 id='options'>
<title>OPTIONS</title>
<para>The program accepts the following options:</para>
<variablelist remap='TP'>
<varlistentry>
<term>-c COMMAND</term>
<listitem>
<para>Send a text string to the GPS. Accepts one parameter, COMMAND,
the command string to send to the GPS. The string is sent verbatim, except
a newline is appended.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-d OPTION</term>
<listitem>
<para>Disable an option in the GPS. Accepts one parameter, OPTION,
the option to disable. <application>zerk</application> will exit after
the GPS acknowledges the command, unless the -W is given.
</para>
<variablelist>
<varlistentry>
<term>4HZ</term>
<listitem>
<para>Disable basic GREIS messages at 4Hz. The messages are:
[RT], [UO], [GT], [PV], [SG], [DP], [SI], [EL], [AZ], [EC], [SS], and
[ET]</para>
</listitem>
</varlistentry>
<varlistentry>
<term>COMPASS</term>
<listitem>
<para>Disable use of the COMPASS (BeiDou) constellation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>CONS</term>
<listitem>
<para>Disable use of all constellations.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>DEFMSG</term>
<listitem>
<para>Disable the default message set (/dev/msg) at 1Hz.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GALILEO</term>
<listitem>
<para>Disable use of the GALILEO constellation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GLONASS</term>
<listitem>
<para>Disable use of the GLONASS constellation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GPS</term>
<listitem>
<para>Disable use of the GPS constellation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>IPR</term>
<listitem>
<para>Disable all Integer Pseudo Range messages. These are
[rx], [rc], [r1], [r2], [r3], [r5], [rl].</para>
</listitem>
</varlistentry>
<varlistentry>
<term>IRNSS</term>
<listitem>
<para>Disable use of the IRNSS constellation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>NMEA</term>
<listitem>
<para>Disable basic NMEA 4.1e messages at 4Hz. The messages are
GBS, GGA, GSA, GST, GSV, RMC, VTG, and ZDA.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>QZSS</term>
<listitem>
<para>Disable use of the QZSS constellation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>SBAS</term>
<listitem>
<para>Disable use of the SBAS constellation.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>SNR</term>
<listitem>
<para>Disable all SNR messages, except [EC]. The messages
disabled are: [E1], [E2], [E3], [E5], [El].</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>-e OPTION</term>
<listitem>
<para>Enable an option in the GPS. Accepts one parameter, OPTION,
the option to enable. <application>zerk</application> will exit after
the GPS acknowledges the command, unless the -W is given. -e accepts the
same OPTIONs as -d, except the action is to enable the option.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-f FILE</term>
<listitem>
<para>Connect to a file or device. Accepts one parameter, FILE,
the file or device to open. Files are opened read-only. Character
devices are opened red/write, unless the -r parameter is given.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-h</term>
<listitem>
<para>Makes <application>zerk</application> print
a usage message and exit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-O OAF</term>
<listitem>
<para>Load an Option Authorization File (OAF) into the GPS. Accepts
one parameter, OAF, command file to read. The OAF is just a special case
of a .jpo (GREIS command file). -O will send any valid .jpo file to
the GPS.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-p PRESET</term>
<listitem>
<para>Send a preset command the GPS. Accepts one parameter, PRESET,
the name of the command to send. <application>zerk</application> will exit after
the GPS acknowledges the command, unless the -W is given.
</para>
<variablelist>
<varlistentry>
<term>COLDBOOT</term>
<listitem>
<para>Coldboot the GPS.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>CONS</term>
<listitem>
<para>Poll the enabled constellations.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>DM</term>
<listitem>
<para>Disable all periodic GREIS messages..</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ID</term>
<listitem>
<para>Poll the receiver ID.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>IPR</term>
<listitem>
<para>Poll all Integer Pseudo Range messages. These are
[rx], [rc], [r1], [r2], [r3], [r5], [rl].</para>
</listitem>
</varlistentry>
<varlistentry>
<term>OAF</term>
<listitem>
<para>Poll all OAF options.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>RESET</term>
<listitem>
<para>Reset (reboot) the GPS.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>SERIAL</term>
<listitem>
<para>Poll receiver serial number.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>SNR</term>
<listitem>
<para>Poll all Signal to Noise Ratio (SNR) messages.
[EC], [E1], [E2], [E3], [E5], [El].</para>
</listitem>
</varlistentry>
<varlistentry>
<term>VENDOR</term>
<listitem>
<para>Poll GPS vendor.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>VER</term>
<listitem>
<para>Poll GPS version.</para>
</listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term>-r</term>
<listitem>
<para>Read only. Do not send anything to the GPS.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-R RAW</term>
<listitem>
<para>Save all raw data from the GPS into the file RAW.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-S SPEED</term>
<listitem>
<para>Configure the GPS serial speed to SPEED bps.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-s SPEED</term>
<listitem>
<para>Set local serial port speed to SPEED bps. Default 115,200 bps.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-V</term>
<listitem>
<para>Print <application>zerk</application> version and exit.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-v VERBOSITY</term>
<listitem>
<para>Set verbosity level to VERBOSITY. Verbosity can be from 0
(very quiet), to 4 (very noisy). Default 2.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-v VERBOSITY</term>
<listitem>
<para>Set verbosity level to VERBOSITY. Verbosity can be from 0
(very quiet), 2 (decode messages), to 4 (very noisy). Default 1.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-W</term>
<listitem>
<para>Force waiting the entire wait time. No early exit for completion
of -d, -e or -p command.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-w WAIT</term>
<listitem>
<para>Wait for WAIT seconds before exiting. Will exit early on command
completion of -d, -e or -p command, unless -W is given. Default 2.0 second.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>[server[:port[:device]]]</term>
<listitem>
<para>
By default, <application>zerk</application> collects data from all compatible devices on
localhost, using the default GPSD port 2947. An optional argument
may specify a server to get data from. A
colon-separated suffix is taken as a port number. If there is a
second colon-separated suffix, that is taken as a specific device
name to be watched. Further details on the
<citerefentry>
<refentrytitle>gps</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry> man page.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>-?</term>
<listitem>
<para>Makes <application>zerk</application> print
a usage message and exit.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 id='environment'>
<title>ENVIRONMENT</title>
<para>Options can be placed in the ZERKOPTS environment variable.
ZERKOPTS is processed before the CLI options.</para>
</refsect1>
<refsect1 id='examples'>
<title>EXAMPLES</title>
<para>
Print current Javad serial portC of GPS connected to local running gpsd::
<programlisting>
zerk -c "print,/cur/term"
</programlisting>
</para>
<para>
Decode raw log file:
<programlisting>
zerk -r -f greis-binary.log -v 2
</programlisting>
</para>
<para>
Change GPS port speed of device on /dev/ttyAMA0 to 230,400 bps::
<programlisting>
zerk -S 230400 -f /dev/ttyAMA0
</programlisting>
</para>
<para>
Watch entire GPS reset cycle:
<programlisting>
zerk -p RESET -v 2 -w 20 -W
</programlisting>
</para>
<para>
Poll SVs Status:
<programlisting>
zerk -W -w 2 -v 2 -c "out,,jps/{CS,ES,GS,Is,WS,QS}"
</programlisting>
Dump gpsd data from remote server:
<programlisting>
zerk -v 2 -w 5 server
</programlisting>
</para>
</refsect1>
<refsect1 id='see_also'>
<title>SEE ALSO</title>
<para>
<application>zerk</application> is written to conform to the official
Javad documentation for the GREIS protocol.
<ulink url="http://www.javad.com/downloads/javadgnss/manuals/GREIS/GREIS_Reference_Guide.pdf">GREIS (GNSS Receiver External Interface Specification) Guide</ulink>.
</para>
<para>
<citerefentry>
<refentrytitle>gpsd</refentrytitle>
<manvolnum>8</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>gps</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>cgps</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>xgps</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>gpsfake</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>gpsctl</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>gpscat</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>,
<citerefentry>
<refentrytitle>gnuplot</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>.
</para>
</refsect1>
<refsect1 id='maintainer'>
<title>AUTHOR</title>
<para>Gary E. Miller<email>gem@rellim.com</email>
</para>
</refsect1>
</refentry>
|