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 [-g item] [-h] [-i port] [-m mode] [-P protver] [-p preset]
11 [-R rawfile] [-r] [-S setspeed] [-s speed] [-V] [-v verbosity]
12 [-w wait] [-x item] [-z item,val] [[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 on GPS model and firmware revision. Use the
22 u-blox documentation for your model and firmware.
23 ubxtool can decode common u-blox binary messages, poll the GPS status,
25 enable and disable GPS features, and send user generated commands to
26 the GPS. It can read binary messages from a file. It can read and write
27 directly through a serial device, or through a running gpsd instance.
28
30 The program accepts the following options:
31 -?
33 Makes ubxtool print a usage message and exit.
34 -c COMMAND
36 Send a command to the GPS. Accepts one parameter, COMMAND, a
37 comma-separated list of hexadecimal bytes specifying the class, the
38 ID, and any needed payload. The header, length, and checksum are
39 added automatically.
40 -d OPTION
42 Disable an option in the GPS. Accepts one parameter, OPTION, the
43 option to disable.
44 BEIDOU
46 Disable use of the BeiDou (COMPASS) constellation.
47 BINARY
49 Disable sending of the basic binary messages.
50 ECEF
52 Disable sending of ECEF binary messages.
53 GALILEO
55 Disable use of the GALILEO constellation.
56 GLONASS
58 Disable use of the GLONASS constellation.
59 GPS
61 Disable use of the GPS and QZSS constellations.
62 NED
64 Disable sending of NED binary messages. UBX-NAV-VELNED and
65 UBX-NAV-RELPOSNED.
66 NMEA
68 Disable sending basic NMEA messages. The messages are GBS, GGA,
69 GSA, GGL, GST, GSV, RMC, VTG, and ZDA.
70 PPS
72 Disable TIMEPULSE 0.
73 RAWX
75 Disable sending of the UBX-RXM-RAWX messages.
76 SBAS
78 Disable use of the SBAS constellation.
79 SFRBX
81 Disable use of the SFRBX messages.
82 SURVEYIN
84 Disable survey-in mode with TMODE2.
85 TP
87 Disable sending UBX-TIM-TP.
88 -e OPTION
90 Enable an option in the GPS. Accepts one parameter, OPTION, the
91 option to enable. -e accepts the same OPTIONs as -d, except the
92 action is to enable the option.
93 -f FILE
95 Connect to a file or device. Accepts one parameter, FILE, the file
96 or device to open. Files are opened read-only. Character devices
97 are opened read/write, unless the -r parameter is given. Requires
98 the pyserial module.
99 -g ITEM
101 Get the value of ITEM name from the GPS (UBX-CFG-VALGET). See the
102 section on CONFIGURATION ITEMS
103 -h
105 Makes ubxtool print a usage message and exit.
106 -i port
108 Specifies port (interface) for port-related commands.
109 -m mode
111 Sets optional mode parameter to a -p PRESET command.
112 -P protver
114 Sets the protocol version to use for sending commands. Minimum 10
115 (ublox 5). Maximum 29 (u-blox 9). Use "ubxtool -p MON-VER" to see
116 the version your GPS supports.
117 -p PRESET
119 Send a preset command the GPS. Accepts one parameter, PRESET, the
120 name of the command to send. Only the common PRESETS are shown
121 here. To see the full list run "ubxtool -h -v 2".
122 COLDBOOT
124 Coldboot the GPS (UBX-CFG-RST).
125 HOTBOOT
127 Hotboot the GPS (UBX-CFG-RST).
128 MODEL
130 Configure the Dynamic Platform Model. (UBX-CFG-NAV5).
131 PMS
133 Set power management settings (UBX-CFG-PMS).
134 RESET
136 Reset configuration to defaults (UBX-CFG-CFG).
137 SAVE
139 Save current configuration (UBX-CFG-CFG).
140 MON-RESETODO
142 Reset the odometer (UBX-MON-RESETODO).
143 MON-VER
145 Poll GPS version (UBX-MON-VER).
146 WARMBOOT
148 Warmboot the GPS (UBX-CFG-RST).
149 The PRESET parameters not shown above are all simple poll commands.
151 They merely poll the GPS to respond with the associated message.
152 For example "ubxtool -p CFG-GNSS" asks the GPS to respond with a
153 UBX-CFG-GNSS message describing the current GNSS configuration.
154 Increase the verbosity of the decode by adding the "-v 2" or "-v 3"
155 options.
156 -R RAW
158 Save all raw serial data received from the GPS into the file RAW.
159 -r
161 Read only. Do not send anything to the GPS.
162 -S SPEED
164 Set the GPS serial port speed to SPEED bps.
165 -s SPEED
167 Set local serial port speed to SPEED bps. Default 9,600 bps.
168 -V
170 Print ubxtool version and exit.
171 -v VERBOSITY
173 Set verbosity level to VERBOSITY. Verbosity can be from 0 (very
174 quiet), 2 (decode messages), to 4 (very noisy). Default 1.
175 -w WAIT
177 Wait for WAIT seconds before exiting. Default 2 seconds.
178 -x ITEM
180 Delete the value of ITEM name from the GPS (UBX_CFG-VALDEL).
181 Returning to the GPS default for that item. See the section on
182 CONFIGURATION ITEMS
183 -z ITEM,VAL
185 Set the value of ITEM name to VAL in the GPS (UBX-CFG-VALSET). See
186 the section on CONFIGURATION ITEMS
187 [server[:port[:device]]]
189 By default, ubxtool collects data from all compatible devices on
190 localhost, using the default GPSD port 2947. An optional argument
191 may specify a server to get data from. A colon-separated suffix is
192 taken as a port number. If there is a second colon-separated
193 suffix, that is taken as a specific device name to be watched.
194 Further details on the gps(1) man page.
195
197 Configuring u-blox GPS with the traditional configuration messages is
198 fraught with problems. Many configuration messages interact in odd
199 ways. Something as simple as changing the serial port speed requires
200 you to read the curent configuration using UBX-CFG-PRT for the proper
201 port, merging in the change, the writing back the changed UBX-CFG-PRT
202 message. Or just guessing at the current configuration and overwriting
203 it all.
204 The u-blox 9 series, protocol version 27+, tries, but does not
206 completely succeed, to solve the problem with Configuration Items. If
207 your GPS does not support protocol version 27+, then this section does
208 not apply to you.
209 Most of the configuration variables in the GPS have been assigned a
211 32-bit Key ID. Each Key ID has been assigned a Key Name. Over 600 Key
212 Names are supported by ubxtool. To see them all do: "ubxtool -h -v 3".
213 Each Key references one specific value.
214 To get the value related to an item, use "-g ITEM".
216 To reset the value related to an item to it default value, use "-x
218 ITEM".
219 To set an ITEM name to a value, use "-z ITEM,VAL".
221 See the EXAMPLES section for concrete examples.
223
225 Decode raw log file:
226 ubxtool -r -f ublox-neo-m8n.log
228 Change GPS port speed of device on /dev/ttyAMA0 to 230,400 bps:
230 ubxtool -S 230400 -f /dev/ttyAMA0
232 Watch entire GPS reset cycle, include $GPTXT messages:
234 ubxtool -p COLDBOOT -w 20 -v 2
236 Poll Enabled Constellations:
238 ubxtool -p CFG-GNSS
240 Dump gpsd data from a remote server named x.example.com:
242 ubxtool -w 5 x.example.com
244 Version 27+ examples
247 The following examples require a GPS supporting protocol 27 or greater.
248 To check the current dynamic model, change it to 6 (AIR1, Airborne with
250 <1g acceleration), revert to the default setting, and verify the faults
251 was restored.
252 $ ubxtool -g CFG-NAVSPG-DYNMODEL
254 [...]
255 UBX-CFG-VALGET:
256 version 1 layer 0 reserved 0,0
257 layers (ram)
258 item CFG-NAVSPG-DYNMODEL/0x20110021 val 2
259 [...]
260 $ ubxtool -z CFG-NAVSPG-DYNMODEL,6
261 [...]
262 UBX-ACK-ACK:
263 ACK to Class x6 (CFG) ID x8a (VALSET)
264 [...]
265 $ ubxtool -g CFG-NAVSPG-DYNMODEL
266 [...]
267 UBX-CFG-VALGET:
268 version 1 layer 0 reserved 0,0
269 layers (ram)
270 item CFG-NAVSPG-DYNMODEL/0x20110021 val 6
271 [...]
272 $ ubxtool -x CFG-NAVSPG-DYNMODEL
273 [...]
274 UBX-ACK-ACK:
275 ACK to Class x6 (CFG) ID x8c (VALDEL)
276 [...]
277 $ ubxtool -g CFG-NAVSPG-DYNMODEL
278 [...]
279 UBX-CFG-VALGET:
280 version 1 layer 0 reserved 0,0
281 layers (ram)
282 item CFG-NAVSPG-DYNMODEL/0x20110021 val 6
283 Notice that the current DYNMODEL stayed at 6 (AIR1). The "-x" only
285 affects the saved setting, not the current setting. To change the
286 current setting you must set it with "-z".
287
289 Options can be placed in the UBXOPTS environment variable. UBXOPTS is
290 processed before the CLI options.
291
293 ubxtool is written to conform to the official u-blox documentation for
294 the u-blox binary protocol.
295 https://www.u-blox.com/en/product-resources
296 cgps(1), gpscat(1), gpsctl(1), gpsfake(1), xgps(1), gpsd(8),
298
300 Gary E. Miller<gem@rellim.com>
301The GPSD Project 26 Jun 2019 UBXTOOL(1)