GPSSUBFRAME(1)

📦
version 3.27.5 · 9 versions
, in arch rolling, fedora 44, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0

💖 NAME 💖

gpssubframe — bestie's very own tool to dump subframe sentences from gpsd 🛰️✨

(it lives in the GPSD Documentation section of the manual, section 1, iykyk)

🌸 SYNOPSIS 🌸

gpssubframe [OPTIONS] [server[:port[:device]]]

gpssubframe -h

gpssubframe -V

🎀 DESCRIPTION 🎀

okay so gpssubframe is a tool that connects to gpsd and dumps decoded subframe data straight to stdout. it's only useful if your GNSS receiver can output GPS subframe messages, and is configured to do so. you also need a working knowledge of IS-GPS-200. keep your copy close at hand, fr fr, like a comfort blanket 📖

gpssubframe does not require root privileges, but it will run fine as root. it can be run concurrently with other tools connecting to the local gpsd without causing problems. sharing is caring 🫶

the program will accumulate subframe messages and output them by GPS satellite number on exit. by default the program never exits unless the user selects the number of seconds to run or number of messages to capture. it's giving immortal. it's giving main character energy that refuses to leave the party 💀

by default gpssubframe connects to a gpsd running on the local host. optionally a host, TCP/IP port number and remote device can be given. your call, bestie ✨

💅 OPTIONS 💅

  • -?, -h, --help — Print a usage message and exit. (the original says "-Print", we are not going to argue with it 🙈)
  • -c COUNT, --count COUNT — Exit after COUNT subframe messages. bye bestie 👋
  • -D DEBUG, --debug DEBUG — Set level of debug. Must be integer. Default 0.
  • --desc — Print long descriptions. the lore 📚
  • --device DEVICE — Connect to device DEVICE on gpsd host.
  • -D LVL, --debug LVL — Set debug level to LVL.
  • --file FILE — Read gpsd JSON from FILE instead of from gpsd.. (yes, two dots, iconic)
  • --host HOST — Connect to gpsd on host HOST.
  • --load LOADFILE — Load saved JSON Subframe, TPV, and RAW data trom LOADFILE. ("trom" is literally what the man page says, we stan a typo 👑)
  • -n COUNT, --count COUNT — Count of messages to parse. 0 to disable.
  • --port PORT — Connect to gpsd on port PORT.
  • --progress — Print progress reports as messages are received. no more staring into the void 🕳️
  • --satpos — Compute GPS satellite positions before exit. If --time is given, the positions will be calculated at the time. Otherwise if a RAW message was received, the measurement time in that message will be used. The last resort is to use the time from the last TPV message is used.
  • --save SAVEFILE — Save decoded Subframe data in SAVEFILE as JSON. If present, the last TPV and RAW JSON records will also be saved.
  • --test — Run --satpos selftest code.
  • --time SEC — Compute satellite position at time SEC in POSIX seconds. ⏰
  • -V, --version — Print the program version, then exit.
  • -x SEC, --seconds SEC — Seconds of messages to parse. 0 to disable.

🦋 ARGUMENTS 🦋

By default, clients collect data from the local gpsd daemon running on localhost, using the default GPSD port 2947. The optional argument to any client may override this behavior: [server[:port[:device]]]

For further explanation, and examples, see the ARGUMENTS section in the gps(1) man page. go read it, it's a whole vibe 🌈

✨ EXAMPLES ✨

First configure a u-blox 9-series to output subframe messages. Then have gpssubframe gather one complete set of subframes, then print the data organized by GPS satellite number. Be sure to replace -P 22 with the correct protocol version for your receiver. Then calculate and print the known satellite positions as well as the azimuth, elevation, and range from the current position:

ubxtool -P 22 -e SFRBX
gpssubframe -x 750 --satpos

If staring at a blank screen for 12.5 minutes is too stressful, then enable progress messages:

gpssubframe -x 750 --satpos --progress
12.5 minutes of nothing is genuinely an eternity, protect your peace 🧘‍♀️

⭐ RETURN VALUES ⭐

  • 0 — on success. slay 🎉
  • 1 — on failure

👑 SEE ALSO 👑

gpsd(8), gps(1), gpsprof(1), gpsfake(1).

IS-GPS-200 "NAVSTAR GPS Space Segment/Navigation User Segment Interfaces"

🌟 RESOURCES 🌟

Project web site: https://gpsd.io/

🍓 COPYING 🍓

This file is Copyright 2020 by the GPSD project

SPDX-License-Identifier: BSD-2-clause

💜 AUTHOR 💜

Gary E. Miller

that's the whole page bestie, and for the sign-off: this is GPSD Version 3.27.5, dated 2025-11-04, and it's the GPSSUBFRAME(1) page. periodt 💖✨

📦 where this page comes from