qt-test Documentation

Welcome to the complete documentation for qt-test and SitePoint GPS devices.

This documentation serves both end-users of the qt-test application and developers building applications that communicate with SitePoint GPS receivers via Bluetooth Low Energy.

Contents:

• Introduction
  • Project Overview
  • SitePoint Protocol Overview
  • NTRIP and RTCM Overview
  • Data Update Rates
  • Aiding Data
  • Application Architecture
  • Target Audience
  • Document Organization
• Quick Start Guide
  • Prerequisites
  • Running the Application
  • Using the Documentation
  • Next Steps
• Building qt-test
  • Prerequisites
  • Quick Start
  • Building for Windows (MSVC)
  • Building for Android
  • Library Configuration
  • Troubleshooting
  • Advanced Topics
  • Additional Resources
  • Getting Help
• Theory of Operation
  • RTK GPS Positioning
  • Data Flow Architecture
  • BLE Communication Model
  • SQTP Protocol Details
  • Correction Data Flow
  • Change Detection Optimization
  • Device Modes
  • Real-Time Performance Architecture
• BLE Communication with SitePoint GPS Devices
  • Key Qt Classes Used
  • SitePoint Device Architecture
  • Initializing the BLE Manager
  • Scanning for Devices
  • Connecting to a Device
  • Transmitting RTCM Correction Data
  • Receiving GPS Data
  • Device Mode Changes
  • MTU Negotiation and Fragmentation
  • Complete Usage Example
  • Performance Considerations
  • API Reference
• Programming Guide
  • Basic BLE Connection
  • Adding NTRIP Corrections
  • Device Configuration and Modes
  • Working with Position Data
  • Working with Status Data
  • Error Handling
  • Complete Application Example
  • Using DataManager for Formatted Display
  • Real-Time Map Display with MapManager
  • QML User Interface Components
  • Next Steps
• Device Configuration
  • Device Modes Overview
  • Mode Selection Guidelines
  • Mode Comparison
  • Configuration Data
  • Mode Change Timing
  • Best Practices
  • Troubleshooting
  • Next Steps
• API Reference
  • Architecture Overview
  • Manager Classes
  • BLEManager
  • NTRIPManager
  • DataManager
  • MapManager
  • Data Structures
  • Enumerations
  • Global Variables
  • Signals and Slots
  • Public Methods
  • Constants and Definitions
  • Usage Examples
  • Index and Search

Document Organization

This documentation is organized into the following sections:

Introduction

Project overview, technology stack, protocol descriptions (SQSP, SQTP, NTRIP, RTCM), and data structures. Start here for background information.

Quick Start Guide

Get started quickly with basic application usage and documentation access.

Building qt-test

Comprehensive instructions for building the application from source, including prerequisites, platform-specific build steps, and troubleshooting.

Theory of Operation

Detailed theory of RTK GPS positioning, data flow architecture, BLE communication model, and device operational modes.

BLE Communication with SitePoint GPS Devices

Complete guide to Bluetooth Low Energy communication with SitePoint devices, including RTCM transmission FSM and SQTP protocol handling.

Programming Guide

Comprehensive programming guide with complete code examples for integrating SitePoint GPS devices into your applications.

Device Configuration

Device modes, configuration options, mode selection guidelines, and troubleshooting.

API Reference

Complete API reference with auto-generated documentation from source code.

Using the Documentation

The project provides documentation in multiple formats:

Format	Location	Best For
Qt Help	doxygen_output/docs/qt-test.qch	Integrated IDE help, context-sensitive F1 lookup
HTML (API)	doxygen_output/html/index.html	Browsable API reference with search
HTML (Manual)	docs/_build/index.html	User guide and tutorials
PDF	docs/_build_latex/qt-test.pdf	Offline reading, printing

Viewing PDF Documentation

# Windows
start docs\_build_latex\qt-test.pdf

# Linux
xdg-open docs/_build_latex/qt-test.pdf

# macOS
open docs/_build_latex/qt-test.pdf

Viewing HTML Documentation

# Windows
start docs\_build\index.html

# Linux
xdg-open docs/_build/index.html

# macOS
open docs/_build/index.html

Using Qt Help in Qt Creator

1. Open Qt Creator

2. Go to Help → Documentation → Add…

3. Navigate to doxygen_output/docs/qt-test.qch

4. Click OK

5. Press F1 on any class for context help

Note

Pre-built documentation is included in releases. Documentation building is only necessary for developers who need to regenerate the documentation from source.

For detailed documentation building instructions, see README.md in the project root directory.

Indices and tables

• Index

• Search Page