Examples

All examples are available in C++, C, and Python (unless noted). Source code is in the examples/ directory.

Building Examples

C and C++ examples are built with the BUILD_EXAMPLES CMake flag:

mkdir -p build && cd build
cmake .. -DBUILD_EXAMPLES=ON
make

C++ binaries are symlinked into examples/bin/ for convenience (e.g. examples/bin/geofencing). C binaries are not symlinked — run them from the build tree, e.g. build/examples/c/geofencing/geofencing.

Python examples require the jimmypaputto module installed (see Installation).

Example Index

Example	Languages	HAT	Description
Print Navigation	C++, C, Python	All	Basic position, speed, time, fix info — Basic and Advanced (TUI dashboard) variants in C++
Print Satellites	C++, C, Python	All	Per-satellite table with signal quality — Basic and Advanced (color TUI) variants in C++
Geofencing	C++, C, Python	L1, RTK	Configure and monitor geofences
Jamming Detector	C++, C, Python	All	RF interference monitoring
Hot Start	C++, C, Python	All	Cold vs hot start timing benchmark
Timepulse Interrupt	C++, C, Python	All	PPS synchronization
RTK Base, Rover & NTRIP Server	C++, C, Python	RTK	RTK base station, rover, and pushing corrections to a remote NTRIP caster
Time Base	C++, C, Python	TIME	Time base mode for improved time accuracy
Time Mark	C++, C, Python	TIME	EXTINT event timestamping
Config from JSON	Python	All	JSON-driven configuration
25 Hz Benchmark	Python	All	High-rate measurement performance

Note
Also see Tools and Services for the standalone gnsshat-rtk-base, gnsshat-info, and gnsshat-probe CLI tools, and GPSD Daemon / Time Server in Guides for the gpsd/chrony integration examples.