Devuan fork of gpsd
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

376 lines
8.2 KiB

  1. '\" t
  2. .\" Title: zerk
  3. .\" Author: [see the "AUTHOR" section]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/>
  5. .\" Date: 18 Sep 2018
  6. .\" Manual: GPSD Documentation
  7. .\" Source: The GPSD Project
  8. .\" Language: English
  9. .\"
  10. .TH "ZERK" "1" "18 Sep 2018" "The GPSD Project" "GPSD Documentation"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. zerk \- All purpose GREIS fitting
  32. .SH "SYNOPSIS"
  33. .HP \w'\fBzerk\fR\ 'u
  34. \fBzerk\fR [\-?] [\-c\ \fIcommand\fR] [\-d\ \fIdisable\fR] [\-e\ \fIenable\fR] [\-f\ \fIfile/device\fR] [\-h] [\-O\ \fIoaf\fR] [\-p\ \fIpreset\fR] [\-R\ \fIrawfile\fR] [\-r] [\-S\ \fIsetspeed\fR] [\-s\ \fIspeed\fR] [\-V] [\-v\ \fIverbosity\fR] [\-W] [\-w\ \fIwait\fR] [[server[:port[:device]]]]
  35. .SH "DESCRIPTION"
  36. .PP
  37. zerk
  38. 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\&.
  39. .PP
  40. This tool operates with your Javad GPS at a very low level\&. To understand
  41. zerk
  42. you must first be familiar with your Javad GPS and the documentation for the GREIS protocol\&.
  43. \m[blue]\fBGREIS (GNSS Receiver External Interface Specification) Guide\fR\m[]\&\s-2\u[1]\d\s+2\&.
  44. .PP
  45. zerk
  46. 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\&.
  47. .SH "OPTIONS"
  48. .PP
  49. The program accepts the following options:
  50. .PP
  51. \-c COMMAND
  52. .RS 4
  53. 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\&.
  54. .RE
  55. .PP
  56. \-d OPTION
  57. .RS 4
  58. Disable an option in the GPS\&. Accepts one parameter, OPTION, the option to disable\&.
  59. zerk
  60. will exit after the GPS acknowledges the command, unless the \-W is given\&.
  61. .PP
  62. 4HZ
  63. .RS 4
  64. Disable basic GREIS messages at 4Hz\&. The messages are: [RT], [UO], [GT], [PV], [SG], [DP], [SI], [EL], [AZ], [EC], [SS], and [ET]
  65. .RE
  66. .PP
  67. COMPASS
  68. .RS 4
  69. Disable use of the COMPASS (BeiDou) constellation\&.
  70. .RE
  71. .PP
  72. CONS
  73. .RS 4
  74. Disable use of all constellations\&.
  75. .RE
  76. .PP
  77. DEFMSG
  78. .RS 4
  79. Disable the default message set (/dev/msg) at 1Hz\&.
  80. .RE
  81. .PP
  82. GALILEO
  83. .RS 4
  84. Disable use of the GALILEO constellation\&.
  85. .RE
  86. .PP
  87. GLONASS
  88. .RS 4
  89. Disable use of the GLONASS constellation\&.
  90. .RE
  91. .PP
  92. GPS
  93. .RS 4
  94. Disable use of the GPS constellation\&.
  95. .RE
  96. .PP
  97. IPR
  98. .RS 4
  99. Disable all Integer Pseudo Range messages\&. These are [rx], [rc], [r1], [r2], [r3], [r5], [rl]\&.
  100. .RE
  101. .PP
  102. IRNSS
  103. .RS 4
  104. Disable use of the IRNSS constellation\&.
  105. .RE
  106. .PP
  107. NMEA
  108. .RS 4
  109. Disable basic NMEA 4\&.1e messages at 4Hz\&. The messages are GBS, GGA, GSA, GST, GSV, RMC, VTG, and ZDA\&.
  110. .RE
  111. .PP
  112. QZSS
  113. .RS 4
  114. Disable use of the QZSS constellation\&.
  115. .RE
  116. .PP
  117. SBAS
  118. .RS 4
  119. Disable use of the SBAS constellation\&.
  120. .RE
  121. .PP
  122. SNR
  123. .RS 4
  124. Disable all SNR messages, except [EC]\&. The messages disabled are: [E1], [E2], [E3], [E5], [El]\&.
  125. .RE
  126. .RE
  127. .PP
  128. \-e OPTION
  129. .RS 4
  130. Enable an option in the GPS\&. Accepts one parameter, OPTION, the option to enable\&.
  131. zerk
  132. 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\&.
  133. .RE
  134. .PP
  135. \-f FILE
  136. .RS 4
  137. 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 read/write, unless the \-r parameter is given\&. Requires the pyserial module\&.
  138. .RE
  139. .PP
  140. \-h
  141. .RS 4
  142. Makes
  143. zerk
  144. print a usage message and exit\&.
  145. .RE
  146. .PP
  147. \-O OAF
  148. .RS 4
  149. 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\&.
  150. .RE
  151. .PP
  152. \-p PRESET
  153. .RS 4
  154. Send a preset command the GPS\&. Accepts one parameter, PRESET, the name of the command to send\&.
  155. zerk
  156. will exit after the GPS acknowledges the command, unless the \-W is given\&.
  157. .PP
  158. COLDBOOT
  159. .RS 4
  160. Coldboot the GPS\&.
  161. .RE
  162. .PP
  163. CONS
  164. .RS 4
  165. Poll the enabled constellations\&.
  166. .RE
  167. .PP
  168. DM
  169. .RS 4
  170. Disable all periodic GREIS messages\&.\&.
  171. .RE
  172. .PP
  173. ID
  174. .RS 4
  175. Poll the receiver ID\&.
  176. .RE
  177. .PP
  178. IPR
  179. .RS 4
  180. Poll all Integer Pseudo Range messages\&. These are [rx], [rc], [r1], [r2], [r3], [r5], [rl]\&.
  181. .RE
  182. .PP
  183. OAF
  184. .RS 4
  185. Poll all OAF options\&.
  186. .RE
  187. .PP
  188. RESET
  189. .RS 4
  190. Reset (reboot) the GPS\&.
  191. .RE
  192. .PP
  193. SERIAL
  194. .RS 4
  195. Poll receiver serial number\&.
  196. .RE
  197. .PP
  198. SNR
  199. .RS 4
  200. Poll all Signal to Noise Ratio (SNR) messages\&. [EC], [E1], [E2], [E3], [E5], [El]\&.
  201. .RE
  202. .PP
  203. VENDOR
  204. .RS 4
  205. Poll GPS vendor\&.
  206. .RE
  207. .PP
  208. VER
  209. .RS 4
  210. Poll GPS version\&.
  211. .RE
  212. .RE
  213. .PP
  214. \-r
  215. .RS 4
  216. Read only\&. Do not send anything to the GPS\&.
  217. .RE
  218. .PP
  219. \-R RAW
  220. .RS 4
  221. Save all raw data from the GPS into the file RAW\&.
  222. .RE
  223. .PP
  224. \-S SPEED
  225. .RS 4
  226. Configure the GPS serial speed to SPEED bps\&.
  227. .RE
  228. .PP
  229. \-s SPEED
  230. .RS 4
  231. Set local serial port speed to SPEED bps\&. Default 115,200 bps\&.
  232. .RE
  233. .PP
  234. \-V
  235. .RS 4
  236. Print
  237. zerk
  238. version and exit\&.
  239. .RE
  240. .PP
  241. \-v VERBOSITY
  242. .RS 4
  243. Set verbosity level to VERBOSITY\&. Verbosity can be from 0 (very quiet), to 4 (very noisy)\&. Default 2\&.
  244. .RE
  245. .PP
  246. \-v VERBOSITY
  247. .RS 4
  248. Set verbosity level to VERBOSITY\&. Verbosity can be from 0 (very quiet), 2 (decode messages), to 4 (very noisy)\&. Default 1\&.
  249. .RE
  250. .PP
  251. \-W
  252. .RS 4
  253. Force waiting the entire wait time\&. No early exit for completion of \-d, \-e or \-p command\&.
  254. .RE
  255. .PP
  256. \-w WAIT
  257. .RS 4
  258. 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\&.
  259. .RE
  260. .PP
  261. [server[:port[:device]]]
  262. .RS 4
  263. By default,
  264. zerk
  265. 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
  266. \fBgps\fR(1)
  267. man page\&.
  268. .RE
  269. .PP
  270. \-?
  271. .RS 4
  272. Makes
  273. zerk
  274. print a usage message and exit\&.
  275. .RE
  276. .SH "ENVIRONMENT"
  277. .PP
  278. Options can be placed in the ZERKOPTS environment variable\&. ZERKOPTS is processed before the CLI options\&.
  279. .SH "EXAMPLES"
  280. .PP
  281. Print current Javad serial portC of GPS connected to local running gpsd::
  282. .sp
  283. .if n \{\
  284. .RS 4
  285. .\}
  286. .nf
  287. zerk \-c "print,/cur/term"
  288. .fi
  289. .if n \{\
  290. .RE
  291. .\}
  292. .PP
  293. Decode raw log file:
  294. .sp
  295. .if n \{\
  296. .RS 4
  297. .\}
  298. .nf
  299. zerk \-r \-f greis\-binary\&.log \-v 2
  300. .fi
  301. .if n \{\
  302. .RE
  303. .\}
  304. .PP
  305. Change GPS port speed of device on /dev/ttyAMA0 to 230,400 bps::
  306. .sp
  307. .if n \{\
  308. .RS 4
  309. .\}
  310. .nf
  311. zerk \-S 230400 \-f /dev/ttyAMA0
  312. .fi
  313. .if n \{\
  314. .RE
  315. .\}
  316. .PP
  317. Watch entire GPS reset cycle:
  318. .sp
  319. .if n \{\
  320. .RS 4
  321. .\}
  322. .nf
  323. zerk \-p RESET \-v 2 \-w 20 \-W
  324. .fi
  325. .if n \{\
  326. .RE
  327. .\}
  328. .PP
  329. Poll SVs Status:
  330. .sp
  331. .if n \{\
  332. .RS 4
  333. .\}
  334. .nf
  335. zerk \-W \-w 2 \-v 2 \-c "out,,jps/{CS,ES,GS,Is,WS,QS}"
  336. .fi
  337. .if n \{\
  338. .RE
  339. .\}
  340. .sp
  341. Dump gpsd data from remote server:
  342. .sp
  343. .if n \{\
  344. .RS 4
  345. .\}
  346. .nf
  347. zerk \-v 2 \-w 5 server
  348. .fi
  349. .if n \{\
  350. .RE
  351. .\}
  352. .sp
  353. .SH "SEE ALSO"
  354. .PP
  355. zerk
  356. is written to conform to the official Javad documentation for the GREIS protocol\&.
  357. \m[blue]\fBGREIS (GNSS Receiver External Interface Specification) Guide\fR\m[]\&\s-2\u[1]\d\s+2\&.
  358. .PP
  359. \fBgpsd\fR(8),
  360. \fBgps\fR(1),
  361. \fBcgps\fR(1),
  362. \fBxgps\fR(1),
  363. \fBgpsfake\fR(1),
  364. \fBgpsctl\fR(1),
  365. \fBgpscat\fR(1),
  366. \fBgnuplot\fR(1)\&.
  367. .SH "AUTHOR"
  368. .PP
  369. Gary E\&. Miller<gem@rellim\&.com>
  370. .SH "NOTES"
  371. .IP " 1." 4
  372. GREIS (GNSS Receiver External Interface Specification) Guide
  373. .RS 4
  374. \%http://www.javad.com/downloads/javadgnss/manuals/GREIS/GREIS_Reference_Guide.pdf
  375. .RE