1UBXTOOL(1) GPSD Documentation UBXTOOL(1)
2
6 ubxtool - u-blox tool
7
9 ubxtool [-?] [-c command] [-d disable] [-e enable] [-f file/device]
10 [-h] [-m mode] [-P protver] [-p preset] [-R rawfile] [-r]
11 [-S setspeed] [-s speed] [-V] [-v verbosity] [-w wait]
12 [[server[:port[:device]]]]
13
15 ubxtool is a tool for u-blox GPS. If you do not have a u-blox GPS then
16 can stop reading now.
17 This tool operates with your u-blox GPS at a very low level. To
19 understand ubxtool you must first be familiar with your u-blox GPS and
20 the documentation for the u-blox binary protocol. The u-blox protocol
21 varies greatly depending o GPS model and firmware revision.
22 ubxtool can decode common u-blox binary messages, poll the GPS status,
24 enable and disable GPS features, and send user generated commands to
25 the GPS. It can read binary messages from a file. It can read and write
26 directly through a serial device, or through a running gpsd instance.
27
29 The program accepts the following options:
30 -c COMMAND
32 Send a text string to the GPS. Accepts one parameter, COMMAND, the
33 command string to send to the GPS. The string is sent verbatim,
34 except a newline is appended.
35 -d OPTION
37 Disable an option in the GPS. Accepts one parameter, OPTION, the
38 option to disable.
39 BEIDOU
41 Disable use of the BeiDou (COMPASS) constellation.
42 BINARY
44 Disable sending of the basic binary messages.
45 ECEF
47 Disable sending of ECEF binary messages.
48 GALILEO
50 Disable use of the GALILEO constellation.
51 GLONASS
53 Disable use of the GLONASS constellation.
54 GPS
56 Disable use of the GPS and QZSS constellations.
57 NMEA
59 Disable sending basic NMEA messages. The messages are GBS, GGA,
60 GSA, GGL, GST, GSV, RMC, VTG, and ZDA.
61 RAWX
63 Disable sending of the UBX-RXM-RAWX messages.
64 SBAS
66 Disable use of the SBAS constellation.
67 TMODE2
69 Disable sending TMODE2.
70 TP
72 Disable sending UBX-TIM-TP.
73 -e OPTION
75 Enable an option in the GPS. Accepts one parameter, OPTION, the
76 option to enable. -e accepts the same OPTIONs as -d, except the
77 action is to enable the option.
78 -f FILE
80 Connect to a file or device. Accepts one parameter, FILE, the file
81 or device to open. Files are opened read-only. Character devices
82 are opened red/write, unless the -r parameter is given.
83 -h
85 Makes ubxtool print a usage message and exit.
86 -m mode
88 Sets optional mode parameter to a -p PRESET command.
89 -P protver
91 Sets the protocol version to use for sending commands. Minimum 10
92 (ublox 5). Maximum 27 (u-blox 9)
93 -p PRESET
95 Send a preset command the GPS. Accepts one parameter, PRESET, the
96 name of the command to send. ubxtool will exit after the GPS
97 acknowledges the command, unless the -W is given.
98 ANT
100 Poll the antenna configuration (UBX-CFG-ANT).
101 COLDBOOT
103 Coldboot the GPS (UBX-CFG-RST).
104 GNSS
106 Poll the enabled constellations (UBX-CFG-GNSS).
107 HOTBOOT
109 Hotboot the GPS (UBX-CFG-RST).
110 MODEL
112 Configure the Dynamic Platform Model. (UBX-CFG-NAV5).
113 NAV5
115 Poll the Nav Engines settings (UBX-CFG-NAV6.
116 RXM-RAWX
118 Poll UBX-RXM-RAWX message.
119 RESET
121 Reset configuration to defaults (UBX-CFG-CFG).
122 SAVE
124 Save current configuration (UBX-CFG-CFG).
125 SVIN
127 Poll survey in data (UBX-CFG-SVIN).
128 TMODE2
130 Poll Time Mode 2 configuration (UBX-CFG-TMODE2).
131 TP
133 Poll time pulse timedata (UBX-TIM-TP).
134 TP5
136 Get Time Pulse decodes (UBX-TIM-TP5).
137 VER
139 Poll GPS version.
140 WARMBOOT
142 Warmboot the GPS (UBX-CFG-RST).
143 -R RAW
145 Save all raw data from the GPS into the file RAW.
146 -r
148 Read only. Do not send anything to the GPS.
149 -S SPEED
151 Set the GPS serial port speed to SPEED bps.
152 -s SPEED
154 Set local serial port speed to SPEED bps. Default 115,200 bps.
155 -V
157 Print ubxtool version and exit.
158 -v VERBOSITY
160 Set verbosity level to VERBOSITY. Verbosity can be from 0 (very
161 quiet), to 4 (very noisy). Default 2.
162 -v VERBOSITY
164 Set verbosity level to VERBOSITY. Verbosity can be from 0 (very
165 quiet), 2 (decode messages), to 4 (very noisy). Default 1.
166 -w WAIT
168 Wait for WAIT seconds before exiting. Will exit early on command
169 completion of -d, -e or -p command, unless -W is given. Default 2.0
170 second.
171 -?
173 Makes ubxtool print a usage message and exit.
174 [server[:port[:device]]]
176 By default, ubxtool collects data from all compatible devices on
177 localhost, using the default GPSD port 2947. An optional argument
178 may specify a server to get data from. A colon-separated suffix is
179 taken as a port number. If there is a second colon-separated
180 suffix, that is taken as a specific device name to be watched.
181 Further details on the gps(1) man page.
182
184 Options can be placed in the UBXOPTS environment variable. UBXOPTS is
185 processed before the CLI options.
186
188 Decode raw log file:
189 ubxtool -r -f ublox-neo-m8n.log
191 Change GPS port speed of device on /dev/ttyAMA0 to 230,400 bps::
193 ubxtool -S 230400 -f /dev/ttyAMA0
195 Watch entire GPS reset cycle, include $GPTXT messages:
197 ubxtool -p COLDBOOT -w 20 -v 2
199 Poll Enabled Constellations:
201 ubxtool -p GNSS
203 Dump gpsd data from remote server:
205 ubxtool -w 5 server
207
210 ubxtool is written to conform to the official u-blox documentation for
211 the u-blox binary protocol.
212 https://www.u-blox.com/en/product-resources
213 gpsd(8), gps(1), cgps(1), xgps(1), gpsfake(1), gpsctl(1), gpscat(1),
215 gnuplot(1).
216
218 Gary E. Miller<gem@rellim.com>
219The GPSD Project 24 Sep 2018 UBXTOOL(1)