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 NMEA
64 Disable sending basic NMEA messages. The messages are GBS, GGA,
65 GSA, GGL, GST, GSV, RMC, VTG, and ZDA.
66 PPS
68 Disable TIMEPULSE 0.
69 RAWX
71 Disable sending of the UBX-RXM-RAWX messages.
72 SBAS
74 Disable use of the SBAS constellation.
75 SFRBX
77 Disable use of the SFRBX messages.
78 SURVEYIN
80 Disable survey-in mode with TMODE2.
81 TP
83 Disable sending UBX-TIM-TP.
84 -e OPTION
86 Enable an option in the GPS. Accepts one parameter, OPTION, the
87 option to enable. -e accepts the same OPTIONs as -d, except the
88 action is to enable the option.
89 -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 -g ITEM
97 Get the value of ITEM name from the GPS (UBX-CFG-VALGET). See the
98 section on CONFIGURATION ITEMS
99 -h
101 Makes ubxtool print a usage message and exit.
102 -i port
104 Specifies port (interface) for port-related commands.
105 -m mode
107 Sets optional mode parameter to a -p PRESET command.
108 -P protver
110 Sets the protocol version to use for sending commands. Minimum 10
111 (ublox 5). Maximum 29 (u-blox 9). Use "ubxtool -p MON-VER" to see
112 the version your GPS supports.
113 -p PRESET
115 Send a preset command the GPS. Accepts one parameter, PRESET, the
116 name of the command to send. Only the common PRESETS are shown
117 here. To see the full list run "ubxtool -h -v 2".
118 COLDBOOT
120 Coldboot the GPS (UBX-CFG-RST).
121 HOTBOOT
123 Hotboot the GPS (UBX-CFG-RST).
124 MODEL
126 Configure the Dynamic Platform Model. (UBX-CFG-NAV5).
127 PMS
129 Set power management settings (UBX-CFG-PMS).
130 RESET
132 Reset configuration to defaults (UBX-CFG-CFG).
133 SAVE
135 Save current configuration (UBX-CFG-CFG).
136 MON-RESETODO
138 Reset the odometer (UBX-MON-RESETODO).
139 MON-VER
141 Poll GPS version (UBX-MON-VER).
142 WARMBOOT
144 Warmboot the GPS (UBX-CFG-RST).
145 The PRESET parameters not shown above are all simple poll commands.
147 They merely poll the GPS to respond with the associated message.
148 For example "ubxtool -p CFG-GNSS" asks the GPS to respond with a
149 UBX-CFG-GNSS message describing the current GNSS configuration.
150 Increase the verbosity of the decode by adding the "-v 2" or "-v 3"
151 options.
152 -R RAW
154 Save all raw serial data received from the GPS into the file RAW.
155 -r
157 Read only. Do not send anything to the GPS.
158 -S SPEED
160 Set the GPS serial port speed to SPEED bps.
161 -s SPEED
163 Set local serial port speed to SPEED bps. Default 9,600 bps.
164 -V
166 Print ubxtool version and exit.
167 -v VERBOSITY
169 Set verbosity level to VERBOSITY. Verbosity can be from 0 (very
170 quiet), 2 (decode messages), to 4 (very noisy). Default 1.
171 -w WAIT
173 Wait for WAIT seconds before exiting. Default 2 seconds.
174 -x ITEM
176 Delete the value of ITEM name from the GPS (UBX_CFG-VALDEL).
177 Returning to the GPS default for that item. See the section on
178 CONFIGURATION ITEMS
179 -z ITEM,VAL
181 Set the value of ITEM name to VAL in the GPS (UBX-CFG-VALSET). See
182 the section on CONFIGURATION ITEMS
183 [server[:port[:device]]]
185 By default, ubxtool collects data from all compatible devices on
186 localhost, using the default GPSD port 2947. An optional argument
187 may specify a server to get data from. A colon-separated suffix is
188 taken as a port number. If there is a second colon-separated
189 suffix, that is taken as a specific device name to be watched.
190 Further details on the gps(1) man page.
191
193 Configuring u-blox GPS with the traditional configuration messages is
194 fraught with problems. Many configuration messages interact in odd
195 ways. Something as simple as changing the serial port speed requires
196 you to read the curent configuration using UBX-CFG-PRT for the proper
197 port, merging in the change, the writing back the changed UBX-CFG-PRT
198 message. Or just guessing at the current configuration and overwriting
199 it all.
200 The u-blox 9 series, protocol version 27+, tries, but does not
202 completely succeed, to solve the problem with Configuration Items. If
203 your GPS does not support protocol version 27+, then this section does
204 not apply to you.
205 Most of the configuration variables in the GPS have been assigned a
207 32-bit Key ID. Each Key ID has been assigned a Key Name. Over 600 Key
208 Names are supported by ubxtool. To see them all do: "ubxtool -h -v 3".
209 Each Key references one specific value.
210 To get the value related to an item, use "-g ITEM".
212 To reset the value related to an item to it default value, use "-x
214 ITEM".
215 To set an ITEM name to a value, use "-z ITEM,VAL".
217 See the EXAMPLES section for concrete examples.
219
221 Decode raw log file:
222 ubxtool -r -f ublox-neo-m8n.log
224 Change GPS port speed of device on /dev/ttyAMA0 to 230,400 bps:
226 ubxtool -S 230400 -f /dev/ttyAMA0
228 Watch entire GPS reset cycle, include $GPTXT messages:
230 ubxtool -p COLDBOOT -w 20 -v 2
232 Poll Enabled Constellations:
234 ubxtool -p CFG-GNSS
236 Dump gpsd data from a remote server named x.example.com:
238 ubxtool -w 5 x.example.com
240 Version 27+ examples
243 The following examples require a GPS supporting protocol 27 or greater.
244 To check the current dynamic model, change it to 6 (AIR1, Airborne with
246 <1g acceleration), revert to the default setting, and verify the faults
247 was restored.
248 $ ubxtool -g CFG-NAVSPG-DYNMODEL
250 [...]
251 UBX-CFG-VALGET:
252 version 1 layer 0 reserved 0,0
253 layers (ram)
254 item CFG-NAVSPG-DYNMODEL/0x20110021 val 2
255 [...]
256 $ ubxtool -z CFG-NAVSPG-DYNMODEL,6
257 [...]
258 UBX-ACK-ACK:
259 ACK to Class x6 (CFG) ID x8a (VALSET)
260 [...]
261 $ ubxtool -g CFG-NAVSPG-DYNMODEL
262 [...]
263 UBX-CFG-VALGET:
264 version 1 layer 0 reserved 0,0
265 layers (ram)
266 item CFG-NAVSPG-DYNMODEL/0x20110021 val 6
267 [...]
268 $ ubxtool -x CFG-NAVSPG-DYNMODEL
269 [...]
270 UBX-ACK-ACK:
271 ACK to Class x6 (CFG) ID x8c (VALDEL)
272 [...]
273 $ ubxtool -g CFG-NAVSPG-DYNMODEL
274 [...]
275 UBX-CFG-VALGET:
276 version 1 layer 0 reserved 0,0
277 layers (ram)
278 item CFG-NAVSPG-DYNMODEL/0x20110021 val 6
279 Notice that the current DYNMODEL stayed at 6 (AIR1). The "-x" only
281 affects the saved setting, not the current setting. To change the
282 current setting you must set it with "-z".
283
285 Options can be placed in the UBXOPTS environment variable. UBXOPTS is
286 processed before the CLI options.
287
289 ubxtool is written to conform to the official u-blox documentation for
290 the u-blox binary protocol.
291 https://www.u-blox.com/en/product-resources
292 cgps(1), gpscat(1), gpsctl(1), gpsfake(1), xgps(1), gpsd(8),
294
296 Gary E. Miller<gem@rellim.com>
297The GPSD Project 26 Jun 2019 UBXTOOL(1)