Add Ntrip client to qfield by natuition · Pull Request #7025 · opengisch/QField

natuition · 2026-02-05T15:10:01Z

Add NTRIP client integration for RTK corrections

Add complete NTRIP client implementation to provide real-time kinematic
corrections to external GNSS receivers via Bluetooth.

Changes

Core Implementation

Add NtripSocketClient for low-level TCP connection and NTRIP protocol
Add NtripClient as high-level wrapper with byte counter tracking
Integrate NTRIP client into PositioningSource with configuration properties

Properties & State Management

Add NTRIP properties: host, port, mountpoint, username, password
Replace ntripStatus (QString) with ntripState (enum: Connected/Disconnected)
Add ntripLastError property for error reporting (similar to deviceLastError)
Add streamConnected and streamDisconnected signals
Track NTRIP bytes sent/received for monitoring

Bug Fixes

Fix TCP header fragmentation by buffering data until headers complete

Requirements

The NTRIP client is only enabled when an external receiver is active and
properly configured with all required connection parameters.

Testing

Tested on macOS with NavX GNSS receiver.

Screenshots

RTK positioning active with NTRIP corrections (using Centipede network) :

NTRIP client configuration panel :

Resolved conflicts: - Updated mReceiver to use std::unique_ptr (from upstream) - Preserved NTRIP client functionality (from ntrip-client branch) - Added onDeviceSocketStateChanged connection for NTRIP support

…plugins.

…ents

… request size estimation

…ce method

… after headers

…rror messages if need

…ion state and last error

qfield-fairy · 2026-02-06T00:28:10Z

Other Android architectures

🐧 Linux AppImage builds

Download a Linux AppImage build of this PR for testing.
(Built from commit ba90d60)

nirvn · 2026-02-06T02:50:28Z

@natuition , that's super nice -- are you cooperating with @edgecase14 or you took his initial submission and pushed it further? In any case, it's super nice, I'm just trying to understand how this came to be :)

natuition · 2026-02-06T08:21:41Z

Hi, I took his initial proposal and expanded on it :) Having a client ntrip feature in your application is quite requested, and we believe it can open up many new use cases. I work for NATUITION, and we sell an RTK rover (https://natuition.odoo.com/en_GB/shop/n2168-navx-2678); we would be delighted to use it with your software.

natuition · 2026-02-06T08:27:04Z

🐧 Linux / build (linux) (pull_request)

Don't hesitate to give me feedback if I need to change anything; I'm happy to help. I tried building the Android version on my macOS M4, but I couldn't get your Docker image to work, so I'm currently exploring using the NDK version available through Android Studio and compiling it. I'd really appreciate knowing how to compile so I can continue contributing to the project if needed.

…uage file.

…er to use a virtual mountpoint

…ettings

… the French file.

…ments

natuition · 2026-03-10T08:23:36Z

I'm working on it today :)

…onnections to handle HTTP errors and chunked transfers. Improved NTRIP versioning in NtripSocketClient and NtripSourceTableFetcher.

…ude version parameter

… destructor handling

…e naming format

…d update destructor to be noexcept

…SourceTableFetcher

…ct attempts when socket is busy

…ed layout consistency

src/app/CMakeLists.txt

…mponents

… file

natuition · 2026-03-10T13:33:30Z

Pull request Summary

Generation date: 2026-03-10
Analyzed branch: ntrip-client-finish
Reference branch: origin/master

Compared to origin/master, this branch mainly adds a full NTRIP workflow to QField, from connection and data handling in the core positioning stack to user-facing settings in QML. The implementation introduces dedicated NTRIP components, extends GNSS and Bluetooth behavior for better stability, and adds UI/translation updates so the new capabilities are configurable and visible to users.

Validation note: commit 4b832b0 was tested on both Android and macOS with NavX, and it is functional on both platforms.

What this pull request adds over master

A complete NTRIP client architecture in core positioning with three new components:
NtripClient, NtripSocketClient, and NtripSourceTableFetcher.
Support for NTRIP protocol version handling, including settings and integration points used by fetcher/client flows.
Improved network/socket behavior around NTRIP connections, including better handling of headers, HTTP-related conditions, disconnections, and busy socket states.
RTCM data logging support in the NTRIP client pipeline.
NMEA sentence sending support to caster endpoints, including a user toggle in positioning settings.
Integration updates in positioning source and positioning management layers so NTRIP is wired into existing GNSS workflows.
UI updates in QML settings screens (QFieldSettings, PositioningSettings, and app QML wiring) to expose new NTRIP options.
French translation additions for NTRIP-related settings and labels.
Build system updates (CMakeLists.txt files) to compile and link the new NTRIP sources.
General code quality/maintainability updates (modern signal-slot syntax, destructor/noexcept cleanups, and formatting refactors) accompanying the feature work.

Co-authored-by: Matthias Kuhn <matthias@opengis.ch>

i18n/qfield_fr.ts

Removed NTRIP-related messages and translations from French localization for automatic addition by transifex.

nirvn

I had a quick look through it, it's progressing super nicely. I've dropped some comments based on a local build (without a Bluetooth device yet, that'll be tomorrow).

nirvn · 2026-03-15T09:38:30Z

src/core/positioning/bluetoothreceiver.cpp

+  const char *stateStr = nullptr;
+  switch ( int( mSocket->state() ) )
+  {
+    case int( QAbstractSocket::UnconnectedState ):
+      stateStr = "UnconnectedState";
+      break;
+    case int( QAbstractSocket::HostLookupState ):
+      stateStr = "HostLookupState";
+      break;
+    case int( QAbstractSocket::ConnectingState ):
+      stateStr = "ConnectingState";
+      break;
+    case int( QAbstractSocket::ConnectedState ):
+      stateStr = "ConnectedState";
+      break;
+    case int( QAbstractSocket::BoundState ):
+      stateStr = "BoundState";
+      break;
+    case int( QAbstractSocket::ClosingState ):
+      stateStr = "ClosingState";
+      break;
+    case int( QAbstractSocket::ListeningState ):
+      stateStr = "ListeningState";
+      break;
+    default:
+      stateStr = "UnknownState";
+      break;
+  }
+
+  qInfo() << "Bluetooth Socket State: Error:" << stateStr;
+


Is this needed? If it is, I'd rather incorporate that into the error message we already have a few lines above. Also, we don't use const char * in the code, we stick to QString unless a function parameter requires otherwise.

nirvn · 2026-03-15T09:39:32Z

src/core/positioning/bluetoothreceiver.cpp

+    case QBluetoothSocket::SocketState::ServiceLookupState:
+      // Service discovery is part of the connection handshake, do not treat it as disconnected.
+      currentState = QAbstractSocket::ConnectingState;
+      break;


I'm seeing some nice fixes including this one that would be nice to have submitted as separate PRs. It'd make this PR a little smaller, and fixes easier to merge / backport.

nirvn · 2026-03-15T09:42:37Z

src/core/positioning/bluetoothreceiver.cpp

+  if ( mSocket->state() == QBluetoothSocket::SocketState::ServiceLookupState
+       || mSocket->state() == QBluetoothSocket::SocketState::ConnectingState
+       || mSocket->state() == QBluetoothSocket::SocketState::ConnectedState )
+  {
+    qInfo() << "BluetoothReceiver: Skipping connect attempt, socket busy in state" << mSocket->state();
+    return;
+  }


We handle the ConnectedState state situation in BluetoothReceiver::handleConnectDevice , if there's a need to add the ConnectingState and ServiceLookupState, we should do that over there, where we gracefully then attempt to disconnect and auto-connecting afterwards.

nirvn · 2026-03-15T09:48:40Z

src/core/positioning/ntripclient.cpp

+ begin                : 05.02.2026
+ copyright            : (C) 2026 by Vincent LAMBERT
+ email                :


Could we have an email from you? :) valid for all 6 files introduced into the source tree.

nirvn · 2026-03-15T09:56:09Z

src/core/positioning/positioning.h

+    Q_PROPERTY( QString ntripHost READ ntripHost WRITE setNtripHost NOTIFY ntripHostChanged )
+    Q_PROPERTY( int ntripPort READ ntripPort WRITE setNtripPort NOTIFY ntripPortChanged )
+    Q_PROPERTY( int ntripVersion READ ntripVersion WRITE setNtripVersion NOTIFY ntripVersionChanged )
+    Q_PROPERTY( QString ntripMountpoint READ ntripMountpoint WRITE setNtripMountpoint NOTIFY ntripMountpointChanged )
+    Q_PROPERTY( QString ntripUsername READ ntripUsername WRITE setNtripUsername NOTIFY ntripUsernameChanged )
+    Q_PROPERTY( QString ntripPassword READ ntripPassword WRITE setNtripPassword NOTIFY ntripPasswordChanged )


Here instead of adding 6 properties, I'd prefer to pass on a single ntrip configuration. The actual configuration would be a NtripConfiguration class flagged as Q_GADGET so remote object handles its properties smoothly (just like we do with GnssPositionInformation). That'll give us a nice way to grow configuration settings without having to expose countless properties attached to the Positioning item itself.

The other big, big advantage here is that ATM, we disconnect and reconnect every time a property is changed. So, it means that when first passing on the properties when QField launches, we call the ntrip client's start() functions 6 distinct times. By passing on a single configuration property, we will only connect once :)

nirvn · 2026-03-15T10:26:43Z

src/qml/QFieldSettings.qml

+                      onClicked: {
+                        ntripFetcher.fetch(positioningSettings.ntripHost, positioningSettings.ntripPort, positioningSettings.ntripUsername, positioningSettings.ntripPassword, positioningSettings.ntripVersion);


We should clear the text in ntripFetchErrorLabel when re-fetching, it's otherwise quite confusing for users to understand a new fetching operation is ongoing.

nirvn · 2026-03-15T10:35:54Z

src/core/positioning/ntripsourcetablefetcher.cpp

+  const int headerEnd = data.indexOf( "\r\n\r\n" );
+  const QByteArray body = ( headerEnd >= 0 ) ? data.mid( headerEnd + 4 ) : data;


The logic needs tweaking here. With the NTRIP server I'm testing here, the \r\n\r\n chunk arrives at the very end of the buffer.

You could trim the data, that'd remove the last \r\n\r\n.

nirvn · 2026-03-15T10:38:54Z

src/core/positioning/positioningsource.cpp

+#ifdef WITH_BLUETOOTH
+    if ( auto bluetoothReceiver = dynamic_cast<BluetoothReceiver *>( mReceiver.get() ) )
+    {
+      connect( mNtripClient.get(), &NtripClient::correctionDataReceived, bluetoothReceiver, &BluetoothReceiver::onCorrectionDataReceived );
+    }
+#endif


I think we can expand that to tcp and serial port.

And here - as well as when setting up the receiver - instead of an #ifdef , we should rely on a new receiver capability flag (see AbstractGnssReceiver::Capability).

nirvn · 2026-03-15T10:44:55Z

src/core/positioning/positioningsource.h

+    bool mNtripSendNmea = true;
+    QString mNtripHost = "crtk.net";
+    int mNtripPort = 2101;
+    int mNtripVersion = 1;
+    QString mNtripMountpoint = "NEAR";
+    QString mNtripUsername = "QfieldNtripClient";
+    QString mNtripPassword = "QfieldNtripClient";


This will become a NtripConfiguration object. When we finalize the PR, let's make sure the default host, mount point, username and password are empty.

For the time being I understand it makes it super easy for you to test things out :)

nirvn · 2026-03-15T10:46:02Z

src/qml/QFieldSettings.qml

+                QfSwitch {
+                  id: enableNtripClient
+                  Layout.preferredWidth: implicitContentWidth
+                  Layout.alignment: Qt.AlignTop
+                  checked: positioningSettings.enableNtripClient
+                  onCheckedChanged: {
+                    positioningSettings.enableNtripClient = checked;
+                  }
+                }
+              }


When NTRIP is disabled here, we should hide the NTRIP configuration settings (you can see the network proxy in the general tab as a good example of that UX).

nirvn · 2026-03-15T10:49:53Z

@natuition , oh BTW, this branch failed to rebase against current master for me. I assume a manual rebase on your end will be needed.

For the time being, I manually inserted changes and made a test branch (https://github.com/opengisch/QField/tree/ntrip_review) to test against latest Qt 6.10.2.

natuition · 2026-03-17T11:55:13Z

Hello, I have a week of vacation, so I'll look at it later. Thanks for the feedback.

edgecase14 and others added 19 commits July 29, 2025 22:25

initial NTRIP client POC

3e702f7

Merge branch 'opengisch:master' into gnss-crs

df743ca

Merge branch 'master' into ntrip-client

ed85b5e

add UI for NTRIP client

8f37c5a

fix banned keyword

9c56799

forgot a stashed file

8a48b47

Merge branch 'opengisch:master' into ntrip-client

77437dd

Merge upstream/master into ntrip-client

a85adb2

Resolved conflicts: - Updated mReceiver to use std::unique_ptr (from upstream) - Preserved NTRIP client functionality (from ntrip-client branch) - Added onDeviceSocketStateChanged connection for NTRIP support

fixes for 4.0.1 merge

d910ed7

Merge remote-tracking branch 'upstream/master' into ntrip-client-finish

e4472ad

fix: Add macOS Info.plist generation and update Bluetooth permission …

33fcc03

…plugins.

refactor: Clean up NtripClient by removing unused debug logs and comm…

8bd3989

…ents

feat: Enhance NtripSocketClient with improved connection handling and…

56c883c

… request size estimation

refactor: Reorder Positioning methods and fix one entry

4c05e63

fix: Refactor Ntrip client handling and restore triggerDisconnectDevi…

50c8d1b

…ce method

refactor: Separate NTRIP parts from the rest

62752b9

fix: Accumulate header data in NtripSocketClient and emit corrections…

bbb8ff8

… after headers

fix: Handle disconnection events in NtripSocketClient with specific e…

98e658a

…rror messages if need

refactor: Update NTRIP client status handling to use enum for connect…

4c40b1b

…ion state and last error

nirvn closed this Feb 6, 2026

nirvn reopened this Feb 6, 2026

Vincentvlb added 5 commits February 6, 2026 16:25

feat: Add translations for NTRIP client parameters in the French lang…

80f6dcd

…uage file.

feat: Implementation of NMEA frame management and sending to the cast…

220a9bd

…er to use a virtual mountpoint

feat: Add NTRIP NMEA sending option with a UI toggle in positioning s…

3c8b7cf

…ettings

feat: Add the translation for sending NMEA sentences to the caster in…

5c3566e

… the French file.

feat: Update NTRIP client settings with default values and UI improve…

e700845

…ments

Vincentvlb added 14 commits March 10, 2026 09:47

fix: Added support for RTCM data logging in NtripClient and updated c…

53fe9b9

…onnections to handle HTTP errors and chunked transfers. Improved NTRIP versioning in NtripSocketClient and NtripSourceTableFetcher.

fix: Update fetch method signature in NtripSourceTableFetcher to incl…

4bb81a9

…ude version parameter

fix: Refactor NtripSocketClient to use QTcpSocket pointer and improve…

91f1438

… destructor handling

fix: Update NtripClient destructor to be noexcept and improve log fil…

1527ec9

…e naming format

fix: Refactor NtripSourceTableFetcher to use modern connect syntax an…

febaa1f

…d update destructor to be noexcept

fix: Refactor code for Format checks

beee3ef

fix: Refactor code for Format checks

becff38

style: Refactor code for Format checks

c60d2bb

style : Refactor code for Format checks

75a30f6

fix: Added noexcept to the NtripClien destructor

5018f82

fix: Migrate to new signal-slot syntax in NtripSocketClient and Ntrip…

2d28801

…SourceTableFetcher

fix: Update NtripFetcher fetch method to include a new parameter

9065f8d

fix: Handle ServiceLookupState in BluetoothReceiver and prevent conne…

ec86cac

…ct attempts when socket is busy

fix: Replace RowLayout with ColumnLayout in NTRIP settings for improv…

ca2e385

…ed layout consistency

m-kuhn reviewed Mar 10, 2026

View reviewed changes

src/app/CMakeLists.txt Outdated Show resolved Hide resolved

Vincentvlb added 2 commits March 10, 2026 13:27

fix: Add NTRIP version support in Positioning settings and related co…

8409709

…mponents

fix: Add the translation for the NTRIP version to the French language…

4b832b0

… file

natuition marked this pull request as ready for review March 10, 2026 13:33

Update src/app/CMakeLists.txt

576d37e

Co-authored-by: Matthias Kuhn <matthias@opengis.ch>

nirvn reviewed Mar 11, 2026

View reviewed changes

i18n/qfield_fr.ts Outdated Show resolved Hide resolved

natuition and others added 4 commits March 11, 2026 12:41

Remove NTRIP client and related translations

7bf69f3

Removed NTRIP-related messages and translations from French localization for automatic addition by transifex.

Merge branch 'opengisch:master' into ntrip-client-finish

159ecb0

style: Align socket connection signals for improved readability

2554cac

fix: Change dynamic_cast to const in Ntrip client receiver

ba90d60

natuition requested a review from nirvn March 12, 2026 16:13

nirvn reviewed Mar 15, 2026

View reviewed changes

		onClicked: {
		ntripFetcher.fetch(positioningSettings.ntripHost, positioningSettings.ntripPort, positioningSettings.ntripUsername, positioningSettings.ntripPassword, positioningSettings.ntripVersion);

		const int headerEnd = data.indexOf( "\r\n\r\n" );
		const QByteArray body = ( headerEnd >= 0 ) ? data.mid( headerEnd + 4 ) : data;

Uh oh!

Conversation

natuition commented Feb 5, 2026

Add NTRIP client integration for RTK corrections

Changes

Core Implementation

Properties & State Management

Bug Fixes

Requirements

Testing

Screenshots

Uh oh!

qfield-fairy commented Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🍎 MacOS DMG universal builds

🪟 Windows builds

📱 Android builds

🐧 Linux AppImage builds

Uh oh!

nirvn commented Feb 6, 2026

Uh oh!

natuition commented Feb 6, 2026

Uh oh!

natuition commented Feb 6, 2026

Uh oh!

natuition commented Mar 10, 2026

Uh oh!

Uh oh!

natuition commented Mar 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull request Summary

What this pull request adds over master

Uh oh!

Uh oh!

nirvn left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nirvn commented Mar 15, 2026

Uh oh!

natuition commented Mar 17, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

qfield-fairy commented Feb 6, 2026 •

edited

Loading

natuition commented Mar 10, 2026 •

edited

Loading