Settings¶

Access application settings through QGroundControl.settingsManager. Each settings group is a sub-object whose properties are Fact objects.

import QGroundControl
import QGroundControl.FactSystem
import QGroundControl.Plugin

// Store a setting reference with the correct type
property Fact audioMuted: QGroundControl.settingsManager.appSettings.audioMuted

// Read its value
var isMuted = audioMuted.value

// React to changes
Connections {
    target: audioMuted
    onValueChanged: PluginManager.log("Audio muted: " + audioMuted.value)
}

Tip

Always declare setting references as property Fact rather than property var so QML can type-check the binding.

appSettings¶

General application preferences.

Fact	Type	Description
`offlineEditingFirmwareType`	`uint32`	Offline editing firmware type (enum: ArduPilot, PX4 Pro, Mavlink Generic)
`offlineEditingVehicleType`	`uint32`	Offline editing vehicle type (enum: Fixed Wing, Multi-Rotor, VTOL, Rover, Sub)
`offlineEditingCruiseSpeed`	`double`	Default cruise speed for mission statistics (m/s)
`offlineEditingHoverSpeed`	`double`	Default hover speed for mission statistics (m/s)
`offlineEditingAscentSpeed`	`double`	Ascent speed for mission duration calculation (m/s)
`offlineEditingDescentSpeed`	`double`	Descent speed for mission duration calculation (m/s)
`batteryPercentRemainingAnnounce`	`uint32`	Battery level at which to announce warnings (%)
`telemetrySave`	`bool`	Save telemetry log after each flight
`telemetrySaveNotArmed`	`bool`	Save telemetry log even if vehicle was not armed
`audioMuted`	`bool`	Mute all audio output
`enableWinchControl`	`bool`	Show winch control button in fly view
`checkInternet`	`bool`	Check internet connection before accessing resources
`appFontPointSize`	`uint32`	Application font size (pt, 6--48)
`indoorPalette`	`uint32`	Color scheme (enum: Indoor, Outdoor)
`showLargeCompass`	`bool`	Show large compass on instrument panel
`savePath`	`string`	Root save directory for all data files
`followTarget`	`uint32`	Stream GCS coordinates to autopilot (enum: Never, Always, When in Follow Me)
`language`	`uint32`	UI language (enum index)
`disableAllPersistence`	`bool`	Disable all data persistence to disk
`saveCsvTelemetry`	`bool`	Write all Facts to CSV at 1 Hz
`forwardMavlink`	`bool`	Enable MAVLink forwarding
`forwardMavlinkHostName`	`string`	MAVLink forwarding host (e.g. "localhost:14445")
`showDetailedBatteryInfo`	`bool`	Show additional battery info in dropdown
`defaultAltitudeType`	`uint8`	Default altitude type on dashboard (enum: HGT, MSL, AGL)
`showCameraProjection`	`bool`	Show camera projection on the fly view map
`showMarkersInVideo`	`bool`	Project markers in video feed
`useFixedGCSPosition`	`bool`	Use fixed GCS position for Remote ID
`fixedGCSPositionLatitude`	`double`	Fixed GCS latitude
`fixedGCSPositionLongitude`	`double`	Fixed GCS longitude
`fixedGCSPositionAltitude`	`double`	Fixed GCS altitude (WGS84, meters)
`enableAntiAliasing`	`bool`	Enable anti-aliasing (may impact performance)
`antiAliasingSamples`	`uint8`	Anti-aliasing sample count (enum: 2x, 4x, 8x)
`showDistanceSensorApp`	`bool`	Visualize distance sensor data
`enableAirspaceManagement`	`bool`	Visualize airspace data on map
`enableKBFlightControl`	`bool`	Enable keyboard flight control
`enablePIPControl`	`bool`	Enable tracker / picture-in-picture control
`showBreadCrumbs`	`bool`	Show vehicle trail on map
`backupLinkOnly`	`bool`	Use backup link only

unitsSettings¶

User-preferred measurement units. Each Fact value is an enum index.

Fact	Type	Description
`horizontalDistanceUnits`	`uint32`	Meters, feet, etc.
`verticalDistanceUnits`	`uint32`	Meters, feet, etc.
`areaUnits`	`uint32`	Square meters, hectares, acres, etc.
`speedUnits`	`uint32`	m/s, km/h, mph, knots
`temperatureUnits`	`uint32`	Celsius, Fahrenheit
`weightUnits`	`uint32`	Grams, kilograms, ounces, pounds
`coordinateUnits`	`uint32`	Decimal degrees, DMS, etc.

flyViewSettings¶

Settings that affect the fly view display.

Fact	Type	Description
`guidedActionsAltitudeFrame`	`uint8`	Altitude frame for guided actions (enum: HGT, AGL, MSL)
`guidedMinimumAltitude`	`double`	Minimum altitude for guided actions slider
`guidedMaximumAltitude`	`double`	Maximum altitude for guided actions slider
`guidedAbortAltitude`	`double`	Altitude for abort guided action
`mapIndicatorTarget`	`bool`	Active item distance indicator
`showLogReplayStatusBar`	`bool`	Show log replay status bar
`alternateInstrumentPanel`	`bool`	Use vertical instrument panel
`showAdditionalIndicatorsCompass`	`bool`	Show additional heading indicators on compass
`lockNoseUpCompass`	`bool`	Lock compass nose-up
`keepMapCenteredOnVehicle`	`bool`	Keep map centered on vehicle
`maxGoToLocationDistance`	`double`	Max distance for Go To / Orbit / Follow Target (m)
`gimbalNudgePitchRate`	`double`	Max pitch rate for gimbal nudging (deg)
`gimbalNudgeYawRate`	`double`	Max yaw rate for gimbal nudging (deg)
`enableTerrainCollisionChecks`	`bool`	Enable terrain collision checks in fly view
`mavlinkInspector`	`bool`	Show MAVLink inspector drawer
`displayMGRSCoordinates`	`bool`	Display MGRS coordinates
`displayGNSSDeniedFeatures`	`bool`	Display GNSS-denied features
`windEstimateEnabled`	`bool`	Enable wind estimation guided action
`vehicleHomePositionFeature`	`bool`	Allow setting vehicle home position on fly view
`mobileOperationsEnabled`	`bool`	Update home position based on GCS position
`visualiseFusionRawPositions`	`bool`	Show raw GPS and auxiliary position indicators
`compassType`	`uint8`	Compass type (enum: Heading, Horizon)

videoSettings¶

Video streaming configuration.

Fact	Type	Description
`videoSource`	`string`	Video source identifier
`manualVideoSetup`	`bool`	Use custom video stream URL, ignoring vehicle URL
`udpPort`	`uint16`	Video UDP port (default 5600)
`rtspUrl`	`string`	RTSP URL (e.g. "rtsp://192.168.42.1:554/live")
`tcpUrl`	`string`	TCP URL (e.g. "192.168.143.200:3001")
`aspectRatio`	`float`	Video aspect ratio (width/height, 0.0 to ignore)
`gridLines`	`uint32`	Video overlay (enum: None, 3/3 Grid, Crosshair, North Indicator)
`videoFit`	`uint32`	Video display fit (enum: Fit Width, Fit Height)
`showRecControl`	`bool`	Show recording control in UI
`recordingFormat`	`uint32`	Recording format (enum: mkv, mov, mp4)
`maxVideoSize`	`uint32`	Max video storage (MB)
`enableStorageLimit`	`bool`	Auto-delete old videos when storage limit exceeded
`rtspTimeout`	`uint32`	RTSP timeout before assuming link lost (s)
`doRetransmission`	`bool`	Enable video stream retransmission
`streamEnabled`	`bool`	Video stream enabled
`disableWhenDisarmed`	`bool`	Disable video stream when disarmed
`lowLatencyMode`	`bool`	Asynchronous sink mode for lower latency
`useSoftwareDecoder`	`bool`	Force software decoder
`enableVideoProxy`	`bool`	Enable video proxy
`videoProxyUrl`	`string`	Video proxy URL
`rtspBufferSizeMs`	`int32`	RTSP buffer size (ms, only when low-latency is off)
`storeOnGCS`	`bool`	Save media on GCS
`autoSwitchToIR`	`bool`	Auto-switch to IR during target landing transitions

Additional non-Fact property:

Property	Type	Description
`streamConfigured`	`bool`	Whether a video stream is fully configured (read-only)

flightMapSettings¶

Map provider and display options.

Fact	Type	Description
`mapProvider`	`string`	Map tile provider (e.g. "Bing")
`mapType`	`string`	Map type (e.g. "Hybrid")
`offlineTilePath`	`string`	Root directory for custom imagery tiles
`minZoomLevel`	`uint8`	Minimum zoom level (1--20)
`maxZoomLevel`	`uint8`	Maximum zoom level (1--20)
`customTileOpacity`	`double`	Custom tile opacity (0--1)
`overlayCustomMap`	`bool`	Overlay custom map layer from offline dataset
`overlayPolygons`	`bool`	Overlay KML/GeoJSON polygons on flight map
`overlayFile`	`string`	Path to map overlay file

gimbalSettings¶

Gimbal control preferences.

Fact	Type	Description
`showGimbalIndicator`	`bool`	Show gimbal direction indicator
`showVirtualGimbalJoystick`	`bool`	Show on-screen gimbal joystick
`invertGimbal`	`bool`	Invert gimbal pitch axis
`useEmbeddedGimbal`	`bool`	Use embedded gimbal
`sensitivity`	`double`	Gimbal control sensitivity (0--1)
`markerFilterTime`	`uint16`	Marker filter time (ms, 300--900)

rtkSettings¶

RTK base station configuration.

Fact	Type	Description
`surveyInAccuracyLimit`	`double`	Required survey-in accuracy (m)
`surveyInMinObservationDuration`	`uint32`	Minimum observation time (s)
`useFixedBasePosition`	`bool`	Use fixed position instead of survey-in
`fixedBasePositionLatitude`	`double`	Fixed base latitude
`fixedBasePositionLongitude`	`double`	Fixed base longitude
`fixedBasePositionAltitude`	`float`	Fixed base altitude (WGS84, m)
`fixedBasePositionAccuracy`	`float`	Fixed base position accuracy (m)

planViewSettings¶

Mission planning defaults.

Fact	Type	Description
`displayPresetsTabFirst`	`bool`	Show presets tab at start
`showMissionItemStatus`	`bool`	Show mission item status display
`takeoffItemNotRequired`	`bool`	Allow missions without a takeoff item
`useConditionGate`	`bool`	Use MAV_CMD_CONDITION_GATE for patterns (multi-rotor)
`showGimbalOnlyWhenSet`	`bool`	Show gimbal yaw visual only when explicitly set
`vtolTransitionDistance`	`double`	VTOL transition distance (m)
`defaultMissionItemAltitude`	`double`	Default waypoint altitude
`defaultMissionItemAltitudeMin`	`double`	Minimum waypoint altitude
`defaultMissionItemAltitudeMax`	`double`	Maximum waypoint altitude
`usePathPredictor`	`bool`	Use path predictor
`displayPredictedLabels`	`bool`	Show waypoint distance/ETA labels on map
`useDubinsPath`	`bool`	Use Dubins path prediction for multi-rotors
`missionAltitudeMode`	`uint32`	Altitude mode for mission items
`offlineTargetLandingSinkDistance`	`double`	Descent distance for offline vehicle planning (m)

brandImageSettings¶

Custom branding images.

Fact	Type	Description
`userBrandImageIndoor`	`string`	Brand image path for indoor palette
`userBrandImageOutdoor`	`string`	Brand image path for outdoor palette

autoConnectSettings¶

Automatic connection configuration.

Fact	Type	Description
`autoConnectUDP`	`bool`	Auto-connect via UDP
`autoConnectPixhawk`	`bool`	Auto-connect to Pixhawk via USB
`autoConnectSiKRadio`	`bool`	Auto-connect to SiK Radio
`autoConnectPX4Flow`	`bool`	Auto-connect to PX4 Flow via USB
`autoConnectRTKGPS`	`bool`	Auto-connect to RTK GPS via USB
`autoConnectLibrePilot`	`bool`	Auto-connect to LibrePilot via USB
`autoConnectARF`	`bool`	Auto-connect to ARF radio via UDP
`autoConnectNmeaPort`	`string`	NMEA GPS device for GCS position
`autoConnectNmeaBaud`	`uint32`	NMEA GPS baud rate
`udpListenPort`	`uint32`	UDP listen port for autoconnect
`udpTargetHostIP`	`string`	UDP target host IP
`udpTargetHostPort`	`uint32`	UDP target host port
`nmeaUdpPort`	`uint32`	UDP port for incoming NMEA streams

offlineMapsSettings¶

Offline map tile downloads.

Fact	Type	Description
`minZoomLevelDownload`	`uint32`	Minimum zoom level for downloads (1--20)
`maxZoomLevelDownload`	`uint32`	Maximum zoom level for downloads (1--20)
`maxTilesForDownload`	`uint32`	Maximum tile count for download

adsbVehicleManagerSettings¶

ADS-B receiver configuration.

Fact	Type	Description
`adsbServerConnectEnabled`	`bool`	Connect to ADS-B SBS server
`adsbServerHostAddress`	`string`	Server host address
`adsbServerPort`	`string`	Server port

cursorOnTargetSettings¶

Cursor-on-Target (CoT) streaming configuration.

Fact	Type	Description
`enableCursorOnTarget`	`bool`	Enable team awareness
`enableCursorOnTargetOnStartup`	`bool`	Enable on startup
`cursorOnTargetControllerCallsign`	`string`	Groundstation callsign
`cursorOnTargetVehicleNamePrefix`	`string`	Vehicle name prefix
`cursorOnTargetDestinationAddress`	`string`	Destination address
`cursorOnTargetDestinationPort`	`uint16`	Destination port
`cursorOnTargetSendUDP`	`bool`	Send via UDP (vs TCP)
`cursorOnTargetIncomingPort`	`uint16`	Incoming port
`cursorOnTargetReceiveUDP`	`bool`	Receive via UDP
`enableNextVisionMulticast`	`bool`	Enable NextVision multicast
`multicastAddress`	`string`	Multicast address
`multicastPort`	`uint16`	Multicast port

terrainSettings¶

Terrain data provider configuration.

Fact	Type	Description
`primaryProvider`	`string`	Primary terrain data provider
`fallbackProvider`	`string`	Fallback provider if primary unavailable
`offlineTilePath`	`string`	Root directory for custom elevation tiles
`userProvider`	`string`	User-selected provider name

linkSettings¶

Communication link configuration.

Fact	Type	Description
`apiEnabled`	`bool`	Enable the Link API and status broadcast
`apiIp`	`string`	API listen address
`apiPort`	`uint16`	API listen port
`apiStatusIp`	`string`	Status broadcast address
`apiStatusPort`	`uint16`	Status broadcast port
`isLowBandwidthGlobal`	`bool`	Global low-bandwidth mode (applies to all links)
`commLostTimeout`	`uint16`	Comm lost timeout (ms, 1000--5000)
`enableDistanceSwitchover`	`bool`	Switch to backup link based on distance
`switchoverDistance`	`uint16`	Distance threshold for link switchover (m, 50--10000)