Class: QgsGpsDetector

Class to detect the GPS port

Class Hierarchy

Base classes

QObject

Methods

advance
connDestroyed
takeConnection	Returns the detected GPS connection, and removes it from the detector.

Static Methods

availablePorts

Signals

connectionDetected	Emitted when a GPS connection is successfully detected.
detected	Emitted when the GPS connection has been detected.
detectionFailed	Emitted when the detector could not find a valid GPS connection.

class qgis.core.QgsGpsDetector

Bases: QObject

__init__(portName: str | None = '', useUnsafeSignals: bool = True)

Constructor for QgsGpsDetector.

If portName is specified, then only devices from the given port will be scanned. Otherwise all connection types will be attempted (including internal GPS devices).

Since QGIS 3.38, the useUnsafeSignals parameter can be set to False to avoid emitting the dangerous and fragile detected() signal. This is highly recommended, but is opt-in to avoid breaking stable QGIS 3.x API. If useUnsafeSignals is set to False, only the safe connectionDetected() signal will be emitted and clients must manually take ownership of the detected connection via a call to takeConnection().

Parameters:

• portName (Optional[str] = '')

• useUnsafeSignals (bool = True)

advance(self)

static availablePorts() → List[Tuple[str, str]]

Return type:

List[Tuple[str, str]]

connDestroyed(self, a0: QObject | None)

Parameters:

a0 (Optional[QObject])

signal connectionDetected

Emitted when a GPS connection is successfully detected.

Call takeConnection() to take ownership of the detected connection.

Added in version 3.38.

signal detected

Emitted when the GPS connection has been detected. A single connection must listen for this signal and immediately take ownership of the connection object.

Deprecated since version 3.40: This signal is dangerous and extremely unsafe! It is recommended to instead set the useUnsafeSignals parameter to False in the QgsGpsDetector constructor and use the safe connectionDetected() signal instead.

signal detectionFailed

Emitted when the detector could not find a valid GPS connection.

takeConnection(self) → QgsGpsConnection | None

Returns the detected GPS connection, and removes it from the detector.

The caller takes ownership of the connection. Only the first call to this method following a connectionDetected() signal will be able to retrieve the detected connection – subsequent calls will return None.

Warning

Do not call this method if the useUnsafeSignals option in the QgsGpsDetector constructor was set to True.

Added in version 3.38.

Return type:

Optional[QgsGpsConnection]