Overview

This page is generated from docs/api/ (./build/octave --dump-api docs/api, then python wiki/build_api_reference.py); tst_apidocs fails when that copy is out of date. The protocol itself (hello, describe, get, set, call, subscribe, rows, stream, pair) is specified in docs/api/protocol.json (JSON Schema, checked against the server) and described in Utilities: Service protocol; versioning and the dashboard file schema in docs/api/README.md and docs/api/dashboard-spec.schema.json. What each member means is in the hand-written Signals & Slots API.

The same objects are QML context properties under the same names. Types are Qt's names (QString, QVariantMap, ...); on the wire they are JSON. 26 objects:

Objects

airPlayManager — AirPlayManager

Hand-written notes: Signals & Slots API. Raw: docs/api/airPlayManager.json.

PropertyTypeAccessNotify
available (experimental)boolconstant–
enabled (experimental)boolreadenabledChanged
state (experimental)QStringreadstateChanged
status (experimental)QStringreadstateChanged
receiverName (experimental)QStringreadstateChanged
deviceName (experimental)QStringreadstateChanged
deviceModel (experimental)QStringreadstateChanged
pin (experimental)QStringreadstateChanged
mirroring (experimental)boolreadstateChanged
audioStreaming (experimental)boolreadstateChanged
frameWidth (experimental)intreadframeSizeChanged
frameHeight (experimental)intreadframeSizeChanged
title (experimental)QStringreadmediaChanged
artist (experimental)QStringreadmediaChanged
album (experimental)QStringreadmediaChanged
addresses (experimental)QStringListreadstateChanged
videoSink (experimental)QObject*read / write (phone)videoSinkChanged
touchAvailable (experimental)boolconstant–
touchEnabled (experimental)boolreadtouchChanged
touchState (experimental)QStringreadtouchChanged
touchStatus (experimental)QStringreadtouchChanged
touchDevice (experimental)QStringreadtouchChanged
touchPairing (experimental)boolreadtouchChanged
touchCalibrating (experimental)boolreadtouchChanged
Method (call)ReturnsKindNeeds
setEnabled(bool enabled) (experimental)–invokablephone
setTouchEnabled(bool enabled) (experimental)–invokablephone
pairTouch(bool open) (experimental)–invokablephone
pairTouch() (experimental)–invokablephone
injectTouch(int pointerId, int action, double x, double y) (experimental)–invokablephone
scroll(int dx, int dy) (experimental)–invokablephone
calibrateTouch() (experimental)–invokablephone
cancelCalibration() (experimental)–invokablephone
forgetDevices() (experimental)–invokablephone

Signals (subscribe): enabledChanged() (experimental), stateChanged() (experimental), mediaChanged() (experimental), frameSizeChanged() (experimental), videoSinkChanged() (experimental), touchChanged() (experimental), mirroringStarted(), audioStreamingChanged(bool streaming).

androidAutoManager — AndroidAutoManager

Hand-written notes: Signals & Slots API. Raw: docs/api/androidAutoManager.json.

PropertyTypeAccessNotify
isDhuInstalledboolconstant–
dhuPathQStringconstant–
isDhuEmbeddedboolreaddhuEmbeddedChanged
dhuWindowHandleintreaddhuWindowReady
dhuCaptureQObject*constant–
backend (experimental)QStringreadbackendChanged
nativeAvailable (experimental)boolconstant–
nativeState (experimental)QStringreadnativeStateChanged
nativeStatus (experimental)QStringreadnativeStateChanged
phoneName (experimental)QStringreadnativeStateChanged
videoStreaming (experimental)boolreadvideoStreamingChanged
certificateDir (experimental)QStringconstant–
videoSink (experimental)QObject*read / write (phone)videoSinkChanged
Method (call)ReturnsKindNeeds
getDhuInstallInstructions()QStringslotread
launchDhuSeamless()boolslotphone
sendDhuClick(int x, int y)–slotphone
closeDhu()–slotphone
cleanup()–slotfull
startNative() (experimental)boolinvokablephone
stopNative() (experimental)–invokablephone
injectTouch(int pointerId, int action, double x, double y) (experimental)–invokablephone
setViewVisible(bool visible) (experimental)–invokablephone

Signals (subscribe): connectionProgress(QString message), error(QString message), dhuWindowReady(int windowHandle), dhuEmbeddedChanged(bool embedded), backendChanged() (experimental), nativeStateChanged() (experimental), videoStreamingChanged() (experimental), videoSinkChanged() (experimental).

audioAnalyzer — AudioAnalyzer

Hand-written notes: Signals & Slots API. Raw: docs/api/audioAnalyzer.json.

PropertyTypeAccessNotify
levelsQVariantListreadfftDataChanged
numBarsintconstant–
Method (call)ReturnsKindNeeds
setViewActive(bool active)–slotmedia
setDemand(QString consumer, bool wanted)–slotread
setPlaying(bool playing)–slotmedia
setLocalFile(QString filePath)–slotfull
setPosition(qlonglong positionMs)–slotmedia
analyze_file(QString filePath)–slotfull
update_position(float positionSeconds)–slotfull
set_active(bool active)–slotmedia
get_current_levels()QVariantListslotread
get_num_bars()intslotread
is_analyzed()boolslotread
clear()–slotmedia
set_live(bool live)–slotmedia
update_live()–slotfull
feed_live_pcm(QByteArray pcm, int bufferedMs)–slotfull

Signals (subscribe): fftDataChanged(QVariantList levels), analysisComplete(), analysisStarted().

berryIMU — BerryIMUManager

Hand-written notes: Signals & Slots API. Raw: docs/api/berryIMU.json.

PropertyTypeAccessNotify
connectedboolreadconnectionStatusChanged
hasTemperatureboolreadhasTemperatureChanged
Method (call)ReturnsKindNeeds
getConnectionStatus()QStringslotread
setEnabled(bool enabled)–slotvehicle
isEnabled()boolslotread
setEmitRate(int hz)–slotvehicle
emitRate()intslotread
setActive(bool active)–slotvehicle
setDemand(QString consumer, bool wanted)–slotread
calibrateTare()–slotvehicle
resetTare()–slotvehicle
cleanup()–slotfull

Signals (subscribe): orientationChanged(float w, float x, float y, float z), pitchChanged(float pitch), rollChanged(float roll), headingChanged(float heading), altitudeChanged(float altitude), accelMagnitudeChanged(float mag), lateralGChanged(float g), longitudinalGChanged(float g), baroTempChanged(float temp), connectionStatusChanged(QString status), hasTemperatureChanged(bool has).

clock — Clock

Hand-written notes: Signals & Slots API. Raw: docs/api/clock.json.

PropertyTypeAccessNotify
timeQStringreadtimeChanged
Method (call)ReturnsKindNeeds
update_time()–slotread

Signals (subscribe): timeChanged(QString timeStr).

dashboardManager — DashboardManager

Hand-written notes: Signals & Slots API. Raw: docs/api/dashboardManager.json.

PropertyTypeAccessNotify
dashboardsQVariantListreaddashboardsChanged
lastShareErrorQStringreadlastShareErrorChanged
lastErrorQStringreadlastErrorChanged
lastExportPathQStringreadlastExportPathChanged
lastImportReport (experimental)QVariantMapreadlastImportReportChanged
preview (experimental)QVariantMapreadpreviewChanged
widgetPresets (experimental)QVariantListreadwidgetPresetsChanged
hiddenBuiltInCountintreaddashboardsChanged
supportedSchemaintconstant–
widgetCatalogQVariantMapconstant–
templates (experimental)QVariantListconstant–
Method (call)ReturnsKindNeeds
saveDashboard(QVariantMap spec)QStringslotfiles
deleteDashboard(QString id)boolslotfiles
restoreBuiltInDashboards()boolslotfiles
duplicateDashboard(QString sourceId, QString newLabel)QStringslotfiles
exportDashboard(QString id)QStringslotfiles
copyDashboardToClipboard(QString id)boolslotfiles
importDashboard(QString fileOrUrl)QStringslotfiles
importDashboardFromClipboard()QStringslotfiles
importDashboardFromText(QString json)QStringslotfiles
saveWidgetPreset(QVariantMap preset) (experimental)QStringslotfiles
deleteWidgetPreset(QString id) (experimental)boolslotfiles
copyWidgetPresetToClipboard(QString id) (experimental)boolslotfiles
importWidgetPresetFromText(QString json) (experimental)QStringslotfiles
importWidgetPresetFromClipboard() (experimental)QStringslotfiles
previewDashboard(QVariantMap spec) (experimental)boolslotfiles
endPreview() (experimental)–slotfiles
refresh()–slotread
fromTemplate(QString id, QStringList supported) (experimental)QVariantMapinvokableread
loadDashboard(QString id)QVariantinvokableread
isBuiltIn(QString id)boolinvokableread
uniqueIdForLabel(QString label)QStringinvokableread
normalizedSpec(QVariantMap spec)QVariantMapinvokableread
canPlace(QVariantList cells, int gridColumns, int gridRows, int col, int row, int colSpan, int rowSpan, int exceptIndex)boolinvokableread
fitAt(QVariantList cells, int gridColumns, int gridRows, int col, int row, int colSpan, int rowSpan)QVariantMapinvokableread
arrange(QVariantList cells, int gridColumns, int gridRows, int index, int col, int row, int colSpan, int rowSpan) (experimental)QVariantMapinvokableread
nearestFree(QVariantList cells, int gridColumns, int gridRows, int col, int row, int colSpan, int rowSpan, int exceptIndex) (experimental)QVariantMapinvokableread
derivePortrait(QVariantList cells, int gridColumns, int gridRows) (experimental)QVariantMapinvokableread
orientedSpec(QVariantMap spec, bool portrait) (experimental)QVariantMapinvokableread
rescale(QVariantList cells, int fromColumns, int fromRows, int toColumns, int toRows) (experimental)QVariantMapinvokableread
minSpan(QString type, int gridColumns, int gridRows, double cellWidth, double cellHeight, double spacing) (experimental)QVariantMapinvokableread
sizeOptions(QString type, int gridColumns, int gridRows, double cellWidth, double cellHeight, double spacing) (experimental)QVariantListinvokableread
thumbnailFromImage(QVariant image) (experimental)QStringinvokableread
widgetPresetText(QString id) (experimental)QStringinvokableread

Signals (subscribe): dashboardsChanged(), lastShareErrorChanged(), lastErrorChanged(), lastExportPathChanged(), lastImportReportChanged(), previewChanged(), widgetPresetsChanged().

diagnosticsManager — DiagnosticsManager

Hand-written notes: Signals & Slots API. Raw: docs/api/diagnosticsManager.json.

PropertyTypeAccessNotify
logDirQStringconstant–
appVersionQStringconstant–
backendNameQStringconstant–
deviceInfoQStringconstant–
lastExportPathQStringreadlastExportPathChanged
canOpenFolderboolconstant–
Method (call)ReturnsKindNeeds
recentLogLines(int maxLines)QStringinvokablefiles
recentLogLines()QStringinvokablefiles
copyLogsToClipboard(int maxLines)boolinvokablefiles
copyLogsToClipboard()boolinvokablefiles
exportLogs()QStringinvokablefiles
openLogFolder()boolinvokablesystem
licenseText(QString name)QStringinvokableread

Signals (subscribe): lastExportPathChanged().

esp32VolumeManager — ESP32VolumeManager

Hand-written notes: Signals & Slots API. Raw: docs/api/esp32VolumeManager.json.

PropertyTypeAccessNotify
connectedboolreadconnectionStatusChanged
connectionStatusQStringreadconnectionStatusChanged
connectionDetailQStringreadconnectionDetailChanged
availablePortsQVariantListreadavailablePortsChanged
Method (call)ReturnsKindNeeds
connect_device()–slotvehicle
disconnect_device()–slotvehicle
get_available_ports()QVariantListslotread
is_connected()boolslotread
get_connection_status()QStringslotread
get_connection_detail()QStringslotread
refresh_ports()–slotvehicle
reset_reconnect_attempts()–slotvehicle
cleanup()–slotfull

Signals (subscribe): connectionStatusChanged(QString status), connectionDetailChanged(QString detail), availablePortsChanged(QVariantList ports), volumeChangeRequested(float delta), muteToggleRequested().

fontCatalog — FontCatalog

Hand-written notes: Signals & Slots API. Raw: docs/api/fontCatalog.json.

PropertyTypeAccessNotify
fontsQVariantListconstant–
symbolFamilyQStringconstant–

frontendManager — FrontendManager

Hand-written notes: Signals & Slots API. Raw: docs/api/frontendManager.json.

PropertyTypeAccessNotify
frontendsQVariantListreadfrontendsChanged
activeIdQStringreadactiveChanged
runningIdQStringconstant–
forcedQmlboolreadactiveChanged
forcedQmlReasonQStringreadactiveChanged
lastErrorQStringreadlastErrorChanged
Method (call)ReturnsKindNeeds
installFromFolder(QString path)QStringinvokablesystem
installFromZip(QString path)QStringinvokablesystem
remove(QString id)boolinvokablesystem
setActive(QString id)boolinvokablesystem
clearForcedQml()–invokablesystem
manifestOf(QString id)QVariantMapinvokableread

Signals (subscribe): frontendsChanged(), activeChanged(), lastErrorChanged(), installed(QString id).

gestureSensor — GestureManager

Hand-written notes: Signals & Slots API. Raw: docs/api/gestureSensor.json.

PropertyTypeAccessNotify
connectionStatusQStringreadconnectionStatusChanged
gesturesQStringListconstant–
actionsQVariantListconstant–
Method (call)ReturnsKindNeeds
getConnectionStatus()QStringslotread
setGestureAction(QString gesture, QString action)–slotvehicle
getGestureAction(QString gesture)QStringslotread
resetMappingToDefaults()–slotvehicle
setEnabled(bool enabled)–slotvehicle
setCooldown(int ms)–slotvehicle
isEnabled()boolslotread
cooldownMs()intslotread
cleanup()–slotfull

Signals (subscribe): gestureDetected(QString gesture), actionTriggered(QString action), connectionStatusChanged(QString status).

mediaManager — MediaManager

Hand-written notes: Signals & Slots API. Raw: docs/api/mediaManager.json.

PropertyTypeAccessNotify
audioOutputsQVariantListreadaudioOutputsChanged
currentAudioOutputQStringreadaudioOutputsChanged
Method (call)ReturnsKindNeeds
connect_settings_manager(QObject*)–slotfull
_save_playback_state()–slotfull
_clear_temp_files()–slotfull
flush_metadata_store()–slotfiles
play_file(QString filename)–slotmedia
next_track()–slotmedia
previous_track()–slotmedia
pause()–slotmedia
toggle_play()–slotmedia
setMuted(bool muted)–slotfull
toggle_shuffle()–slotmedia
setVolume(float volume)–slotfull
setDucking(float factor)–slotfull
set_position(int positionMs)–slotmedia
extract_colors_from_album_art(QString filename)–slotfull
extract_colors_from_image(QString imagePath)–slotfull
scan_library(bool resetDisplayNames)–slotmedia
scan_library()–slotmedia
set_library_root(QString path)–slotfiles
strip_filenames()–slotfiles
select_playlist(QString name)–slotmedia
create_playlist(QString name)boolslotfiles
delete_playlist(QString name)boolslotfiles
move_song_to_playlist(QString filename, QString targetPlaylist)boolslotfiles
delete_song(QString filename)boolslotfiles
play_file_at_path(QString filePath)boolslotmedia
invalidate_stats_cache()–slotfull
get_media_files(bool emitSignal)QStringListslotread
get_media_files()QStringListslotread
get_formatted_duration(QString filename)QStringslotread
get_band(QString filename)QStringslotread
get_album(QString filename)QStringslotread
get_album_art(QString filename)QStringslotread
get_current_file()QStringslotread
get_next_track_name()QStringslotread
get_previous_track_name()QStringslotread
get_next_track_album_art()QStringslotread
get_previous_track_album_art()QStringslotread
get_neighbor_album_arts()QStringListslotread
is_playing()boolslotread
is_paused()boolslotread
get_duration()floatslotread
get_position()floatslotread
is_muted()boolslotread
getVolume()floatslotread
is_shuffled()boolslotread
get_playlist_names()QStringListslotread
get_current_playlist_name()QStringslotread
get_current_song_list()QStringListslotread
get_movable_playlist_names()QStringListslotread
get_song_playlist_name(QString filename)QStringslotread
get_song_file_path(QString filename)QStringslotread
get_full_file_path(QString filename)QStringslotread
get_display_name(QString filename)QStringslotread
get_default_media_dir()QStringslotread
get_media_folder_name()QStringslotread
browse_music_folders(QString path)QVariantMapslotread
pick_browser_library()boolslotfiles
get_total_duration()QStringslotread
get_album_count()intslotread
get_artist_count()intslotread
sort_media_files(QString sortColumn, bool ascending)QStringListslotmedia
sort_media_files(QString sortColumn)QStringListslotmedia

Signals (subscribe): playbackStateChanged(int state), playStateChanged(bool playing), currentMediaChanged(QString filename), mediaListChanged(QStringList files), durationChanged(qlonglong durationMs), positionChanged(qlonglong positionMs), metadataChanged(QString title, QString artist, QString album), durationFormatChanged(QString formatted), volumeChanged(float volume), shuffleStateChanged(bool shuffled), totalDurationChanged(QString formatted), albumCountChanged(int count), artistCountChanged(int count), playlistsChanged(), currentPlaylistChanged(QString name), scanProgress(QString message), albumColorsExtracted(QString jsonColors), songDeleted(QString filename), audioOutputsChanged().

networkManager — NetworkManager

Hand-written notes: Signals & Slots API. Raw: docs/api/networkManager.json.

PropertyTypeAccessNotify
networkNameQStringreadnetworkNameChanged
isConnectedboolreadisConnectedChanged
updateStatusQStringreadupdateStatusChanged
updateMessageQStringreadupdateMessageChanged
remoteCommitQStringreadremoteCommitChanged
remoteCommitMsgQStringreadremoteCommitMsgChanged
workingTreeDirtyboolreadworkingTreeDirtyChanged
selfUpdateStatusQStringreadselfUpdateStatusChanged
selfUpdateMessageQStringreadselfUpdateMessageChanged
canSelfUpdateboolreadcanSelfUpdateChanged
Method (call)ReturnsKindNeeds
refreshNetwork()–slotread
checkForUpdates()–slotsystem
applySelfUpdate()–slotsystem
restartApp()–slotsystem
shutdown_device()–slotsystem
cleanup()–slotfull

Signals (subscribe): networkNameChanged(QString name), isConnectedChanged(bool connected), updateStatusChanged(QString status), updateMessageChanged(QString message), remoteCommitChanged(QString commit), remoteCommitMsgChanged(QString msg), workingTreeDirtyChanged(bool dirty), selfUpdateStatusChanged(QString status), selfUpdateMessageChanged(QString message), canSelfUpdateChanged(bool canUpdate).

nowPlaying — NowPlaying

Hand-written notes: Signals & Slots API. Raw: docs/api/nowPlaying.json.

PropertyTypeAccessNotify
sourceQStringreadsourceChanged
playingboolreadplayingChanged
hasTrackboolreadtrackInfoChanged
titleQStringreadtrackInfoChanged
artistQStringreadtrackInfoChanged
albumQStringreadtrackInfoChanged
artUrlQStringreadartUrlChanged
artRevisionintreadartUrlChanged
durationMsintreaddurationChanged
positionMsintreadpositionChanged
canSeekboolreadcapabilitiesChanged
canShuffleboolreadcapabilitiesChanged
shuffledboolreadshuffledChanged
Method (call)ReturnsKindNeeds
togglePlay()–slotmedia
next()–slotmedia
previous()–slotmedia
seek(int positionMs)–slotmedia
toggleShuffle()–slotmedia
useLocal()–slotmedia
extractArtColors()–slotfull

Signals (subscribe): sourceChanged(), playingChanged(), trackInfoChanged(), artUrlChanged(), durationChanged(), positionChanged(), capabilitiesChanged(), shuffledChanged(), trackChanged().

obdAdapterFinder — OBDAdapterFinder

Hand-written notes: Signals & Slots API. Raw: docs/api/obdAdapterFinder.json.

PropertyTypeAccessNotify
supportedboolconstant–
canScanboolconstant–
bluetoothOnboolreadbluetoothOnChanged
scanningboolreadscanningChanged
devicesQVariantListreaddevicesChanged
busyAddressQStringreadbusyChanged
statusQStringreadstatusChanged
statusIsErrorboolreadstatusChanged
Method (call)ReturnsKindNeeds
startScan()–slotvehicle
stopScan()–slotvehicle
connectAdapter(QString address)–slotvehicle
cancel()–slotvehicle
powerOn()–slotvehicle

Signals (subscribe): bluetoothOnChanged(), scanningChanged(), devicesChanged(), busyChanged(), statusChanged().

obdManager — OBDManager

Hand-written notes: Signals & Slots API. Raw: docs/api/obdManager.json.

PropertyTypeAccessNotify
connectedboolreadconnectionStatusChanged
simulatedboolreadsimulatedChanged
connectionStatusQStringreadconnectionStatusChanged
connectionStateOBDManager::ConnectionState (Disconnected | Connecting | Connected | NoVehicle | Failed)readconnectionStatusChanged
connectionDetailQStringreadconnectionStatusDetailChanged
connectionProgressintreadconnectionProgressChanged
connectionLogQStringListreadconnectionLogChanged
availableAdaptersQVariantListreadavailableAdaptersChanged
vinQStringreadvinChanged
vehicleMakeQStringreadvinChanged
vehicleModelYearintreadvinChanged
vehicleSupportedParametersQStringListreadvehicleSupportedParametersChanged
vehicleScanCompleteboolreadvehicleSupportedParametersChanged
Method (call)ReturnsKindNeeds
connect_obd()–slotvehicle
reconnect()–slotvehicle
force_connect()–slotvehicle
close()–slotvehicle
reset_connection()–slotvehicle
get_connection_status()QStringslotread
getConnectionStatus()QStringslotread
refresh_ports()–slotvehicle
get_available_ports()QVariantListslotread
scan()–slotvehicle
availableAdapters()QVariantListslotread
connect_to_adapter(QString identifier)–slotvehicle
platform_hint()QStringslotread
scan_vehicle()–slotvehicle
is_scanning()boolslotread
get_all_parameter_names()QStringListslotread
get_supported_commands()QVariantListslotread
enable_scanned_parameters(QVariantList paramNames)–slotvehicle
enable_all_supported()–slotvehicle
enter_diagnostic_mode()–slotvehicle
exit_diagnostic_mode()–slotvehicle
is_diagnostic_mode()boolslotread
read_dtc()–slotvehicle
read_current_dtc()–slotvehicle
read_status()–slotvehicle
clear_dtc()–slotvehicle
read_freeze_frame()–slotvehicle
read_vin()–slotvehicle
get_dtc_codes()QVariantListslotread
get_dtc_count()intslotread
get_mil_status()boolslotread
get_freeze_frame()QVariantListslotread
coolantTemp()floatslotread
voltage()floatslotread
engineLoad()floatslotread
throttlePosition()floatslotread
intakeTemp()floatslotread
timingAdvance()floatslotread
massAirFlow()floatslotread
speedMPH()floatslotread
rpm()floatslotread
airFuelRatio()floatslotread
fuelLevel()floatslotread
intakeManifoldPressure()floatslotread
shortTermFuelTrim()floatslotread
longTermFuelTrim()floatslotread
oxygenSensorVoltage()floatslotread
fuelPressure()floatslotread
engineOilTemp()floatslotread
ignitionTiming()floatslotread
refresh_values()–slotvehicle
open_bluetooth_settings()–slotsystem
set_target_address(QString address)–slotvehicle
connect_direct(QString mac, int channel)–slotvehicle
connect_direct(QString mac)–slotvehicle
set_auto_reconnect(bool enabled)–slotvehicle
set_connection_timeout(int timeoutSeconds)–slotvehicle
check_device_presence()boolslotvehicle
isConnected()boolinvokableread
clearConnectionLog()–invokablevehicle
is_connected()boolinvokableread
setParameterDemand(QString consumer, QStringList paramIds)–invokableread
setBackgroundDemand(QString consumer, QStringList paramIds)–invokableread

Signals (subscribe): coolantTempChanged(float value), voltageChanged(float value), engineLoadChanged(float value), throttlePositionChanged(float value), intakeAirTempChanged(float value), timingAdvanceChanged(float value), massAirFlowChanged(float value), speedMPHChanged(float value), rpmChanged(float value), airFuelRatioChanged(float value), fuelLevelChanged(float value), intakeManifoldPressureChanged(float value), shortTermFuelTrimChanged(float value), longTermFuelTrimChanged(float value), oxygenSensorVoltageChanged(float value), fuelPressureChanged(float value), engineOilTempChanged(float value), ignitionTimingChanged(float value), runTimeChanged(float value), distanceWithMILChanged(float value), fuelRailPressureChanged(float value), fuelRailPressureDirectChanged(float value), barometricPressureChanged(float value), ambientAirTempChanged(float value), relativeThrottlePosChanged(float value), absoluteThrottlePosBChanged(float value), acceleratorPosChanged(float value), catalystTempB1S1Changed(float value), catalystTempB1S2Changed(float value), evapVaporPressureChanged(float value), shortFuelTrim2Changed(float value), longFuelTrim2Changed(float value), o2SensorB1S2Changed(float value), o2SensorB2S1Changed(float value), o2SensorB2S2Changed(float value), distanceSinceCodesCleared(float value), warmupsSinceCodesCleared(float value), absoluteLoadChanged(float value), commandedEGRChanged(float value), egrErrorChanged(float value), ethanoPercentChanged(float value), o2SensorB1S3Changed(float value), o2SensorB1S4Changed(float value), o2SensorB2S3Changed(float value), o2SensorB2S4Changed(float value), o2S1WRVoltageChanged(float value), o2S2WRVoltageChanged(float value), o2S3WRVoltageChanged(float value), o2S4WRVoltageChanged(float value), o2S5WRVoltageChanged(float value), o2S6WRVoltageChanged(float value), o2S7WRVoltageChanged(float value), o2S8WRVoltageChanged(float value), o2S1WRCurrentChanged(float value), o2S2WRCurrentChanged(float value), o2S3WRCurrentChanged(float value), o2S4WRCurrentChanged(float value), o2S5WRCurrentChanged(float value), o2S6WRCurrentChanged(float value), o2S7WRCurrentChanged(float value), o2S8WRCurrentChanged(float value), catalystTempB2S1Changed(float value), catalystTempB2S2Changed(float value), throttlePosCChanged(float value), acceleratorPosEChanged(float value), acceleratorPosFChanged(float value), throttleActuatorChanged(float value), evaporativePurgeChanged(float value), fuelRailPressureAbsChanged(float value), fuelInjectTimingChanged(float value), fuelRateChanged(float value), runTimeMILChanged(float value), timeSinceDTCClearedChanged(float value), maxMAFChanged(float value), fuelTypeChanged(float value), evapVaporPressureAbsChanged(float value), evapVaporPressureAltChanged(float value), shortO2TrimB1Changed(float value), longO2TrimB1Changed(float value), shortO2TrimB2Changed(float value), longO2TrimB2Changed(float value), relativeAccelPosChanged(float value), hybridBatteryRemainingChanged(float value), elmVoltageChanged(float value), connectionStatusChanged(QString status), simulatedChanged(), simulatedAdapterRequested(), connectionLostUnexpectedly(QString reason), connectionStatusDetailChanged(QString detail), connectionProgressChanged(int progress), devicePresenceChanged(bool present), availablePortsChanged(QVariantList ports), availableAdaptersChanged(QVariantList adapters), supportedCommandsChanged(QVariantList commands), scanProgressChanged(int progress, QString message), scanCompleteChanged(QVariantList supportedParams), scanOutputChanged(QString output), vehicleSupportedParametersChanged(), dtcCodesChanged(QVariantList codes), dtcCountChanged(int count), milStatusChanged(bool status), dtcClearResult(bool success, QString message), freezeFrameChanged(QVariantList data), obdParameterChanged(QString paramId, float value), parameterSampled(QString paramId, float value), vinChanged(QString vin), connectionLogLineAppended(QString line), connectionLogChanged().

Enum ConnectionState: Disconnected, Connecting, Connected, NoVehicle, Failed (by name or number).

paramStore — ParameterStore

Hand-written notes: Signals & Slots API. Raw: docs/api/paramStore.json.

Method (call)ReturnsKindNeeds
ingest(QString id, float value)–slotfull
get(QString id)QVariantinvokableread
snapshot()QVariantMapinvokableread

Signals (subscribe): changed(QStringList ids).

parameterCatalog — ParameterCatalog

Hand-written notes: Signals & Slots API. Raw: docs/api/parameterCatalog.json.

PropertyTypeAccessNotify
parametersQVariantListconstant–
displayParametersQVariantListreaddisplayParametersChanged
groupsQStringListconstant–
Method (call)ReturnsKindNeeds
toDisplay(QString id, QVariant value)QVariantinvokableread
contains(QString id)boolinvokableread
info(QString id)QVariantMapinvokableread

Signals (subscribe): displayParametersChanged().

phoneMirrorManager — PhoneMirrorManager

Hand-written notes: Signals & Slots API. Raw: docs/api/phoneMirrorManager.json.

PropertyTypeAccessNotify
adbPathQStringconstant–
nativeAvailableboolconstant–
serverVersionQStringconstant–
isRunningboolreadisRunningChanged
displaySizeQStringreaddisplaySizeChanged
activeDisplaySizeQStringreadframeSizeChanged
videoSinkQObject*read / write (full)videoSinkChanged
frameWidthintreadframeSizeChanged
frameHeightintreadframeSizeChanged
audioActiveboolreadaudioActiveChanged
audioPlayingboolreadaudioPlayingChanged
phoneAsleepboolreadphoneAsleepChanged
phoneInUseboolreadphoneInUseChanged
wirelessAddressQStringreadwirelessAddressChanged
connectionTypeQStringreadconnectionTypeChanged
wirelessBusyboolreadwirelessBusyChanged
qrPairingRowsQStringListreadqrPairingChanged
qrPairingActiveboolreadqrPairingChanged
currentBitRateintreadcurrentBitRateChanged
mediaAvailableboolreadmediaChanged
mediaPlayingboolreadmediaChanged
mediaTitleQStringreadmediaChanged
mediaArtistQStringreadmediaChanged
mediaAlbumQStringreadmediaChanged
mediaAppQStringreadmediaChanged
mediaDurationintreadmediaChanged
mediaCanSeekboolreadmediaChanged
mediaArtUrlQStringreadmediaArtChanged
mediaActiveboolreadmediaActiveChanged
mediaQueueQVariantListreadmediaQueueChanged
mediaQueueActiveIdqlonglongreadmediaQueueChanged
mediaQueueTitleQStringreadmediaQueueChanged
deviceStateQStringreaddeviceStateChanged
lastErrorKindQStringreadlastErrorKindChanged
sessionStateQStringreadsessionStateChanged
deviceHintQStringreaddeviceStateChanged
devicesQVariantListreaddeviceStateChanged
mirrorNoticeQStringreadmirrorNoticeChanged
Method (call)ReturnsKindNeeds
setVolume(float volume)–slotphone
setMuted(bool muted)–slotphone
setAudioGain(float gain)–slotphone
setAudioDuckEnabled(bool enabled)–slotphone
setAudioDuckLevel(float level)–slotphone
setAudioOutputDevice(QString id)–slotphone
setDisplaySize(QString size)–slotphone
setViewSize(int width, int height)–slotphone
setDisplayDpi(int dpi)–slotphone
setBitRateUsb(int mbps)–slotphone
setBitRateWifi(int mbps)–slotphone
setBitRateAuto(bool enabled)–slotphone
setAutoWifi(bool enabled)–slotphone
setPhoneScreenOff(bool off)–slotphone
wakePhone()–slotphone
resumeMirroring()–slotphone
environmentOk()boolslotread
getInstallInstructions()QStringslotread
getDeviceState()QStringslotread
refreshDeviceState()–slotphone
setViewActive(bool active)–slotphone
describeDeviceState(QString state)QStringslotread
hasConnectedDevice()boolslotread
selectDevice(QString serial)–slotphone
dismissNotice()–slotphone
injectTouch(int pointerId, int action, float relX, float relY)–slotphone
injectKey(int keycode)–slotphone
pressHome()–slotphone
pressBack()–slotphone
pressAppSwitch()–slotphone
startScrcpy()–slotphone
stopScrcpy()–slotphone
cleanup()–slotfull
setWirelessAddress(QString address)–slotphone
forgetWireless()–slotphone
startQrPairing()–slotphone
cancelQrPairing()–slotphone
mediaPosition()intslotphone
mediaPlayPause()–slotphone
mediaPlay()–slotphone
mediaPause()–slotphone
mediaNext()–slotphone
mediaPrevious()–slotphone
mediaSeek(int positionMs)–slotphone
mediaSkipToQueueItem(qlonglong id)–slotphone
releaseMedia(bool pausePhone)–slotphone

Signals (subscribe): scrcpyStarted(int handle), scrcpyStopped(), scrcpyError(QString message), lastErrorKindChanged(), sessionStateChanged(), isRunningChanged(), displaySizeChanged(), frameSizeChanged(int width, int height), frameReady(), videoSinkChanged(), audioActiveChanged(bool active), audioPlayingChanged(bool playing), audioPlayed(QByteArray pcm, int bufferedMs), phoneAsleepChanged(bool asleep), phoneInUseChanged(bool inUse), duckingChanged(float factor), wirelessAddressChanged(QString address), connectionTypeChanged(), wirelessBusyChanged(), wirelessResult(bool ok, QString message), qrPairingChanged(), currentBitRateChanged(), mediaChanged(), mediaTrackChanged(), mediaArtChanged(), mediaQueueChanged(), mediaActiveChanged(bool active), deviceStateChanged(), mirrorNoticeChanged().

settingsManager — SettingsManager

Hand-written notes: Signals & Slots API. Raw: docs/api/settingsManager.json.

PropertyTypeAccessNotify
deviceNameQStringreaddeviceNameChanged
fontSettingQStringreadfontSettingChanged
themeSettingQStringreadthemeSettingChanged
uiScalefloatreaduiScaleChanged
colorTransitionMsintreadcolorTransitionMsChanged
songLengthTransitionboolreadsongLengthTransitionChanged
showClockboolreadshowClockChanged
clockFormat24HourboolreadclockFormatChanged
clockShowSecondsboolreadclockShowSecondsChanged
clockSizeintreadclockSizeChanged
clockSizeAutoboolreadclockSizeAutoChanged
backgroundGridQStringreadbackgroundGridChanged
screenWidthintreadscreenWidthChanged
screenHeightintreadscreenHeightChanged
backgroundBlurRadiusintreadbackgroundBlurRadiusChanged
bottomBarOrientationQStringreadbottomBarOrientationChanged
showBottomBarMediaControlsboolreadshowBottomBarMediaControlsChanged
settingsLayoutStyleQStringreadsettingsLayoutStyleChanged
albumArtColorsQVariantMapreadalbumArtColorsChanged
settingsMenuVisibilityQStringreadsettingsMenuVisibilityChanged
startUpVolumefloatreadstartUpVolumeChanged
currentVolumeintreadcurrentVolumeChanged
mediaFolderQStringreadmediaFolderChanged
autoPlayOnStartupboolreadautoPlayOnStartupChanged
persistShuffleStateboolreadpersistShuffleStateChanged
lastShuffleStateboolreadlastShuffleStateChanged
lastPlayedSongQStringreadlastPlayedSongChanged
lastPlayedPositionintreadlastPlayedPositionChanged
lastPlayedPlaylistQStringreadlastPlayedPlaylistChanged
musicButtonDefaultPageQStringreadmusicButtonDefaultPageChanged
returnToLibraryAfterSelectionboolreadreturnToLibraryAfterSelectionChanged
showWaveformVisualizerboolreadshowWaveformVisualizerChanged
show3DButtonTiltboolreadshow3DButtonTiltChanged
show3DAlbumPreviewboolreadshow3DAlbumPreviewChanged
roundedAlbumArtboolreadroundedAlbumArtChanged
albumArtCornerRadiusintreadalbumArtCornerRadiusChanged
showAlbumArtShadowboolreadshowAlbumArtShadowChanged
vinylRecordModeboolreadvinylRecordModeChanged
albumArtTransitionQStringreadalbumArtTransitionChanged
audioOutputDeviceQStringreadaudioOutputDeviceChanged
backgroundOverlayOpacityintreadbackgroundOverlayOpacityChanged
sideCardOpacitydoublereadsideCardOpacityChanged
sideCardAngleintreadsideCardAngleChanged
buttonTiltDurationintreadbuttonTiltDurationChanged
textScrollSpeedintreadtextScrollSpeedChanged
obdBluetoothPortQStringreadobdBluetoothPortChanged
obdSavedAdaptersQVariantListreadobdSavedAdaptersChanged
obdFastModeboolreadobdFastModeChanged
obdCardStyleCircularboolreadobdCardStyleCircularChanged
gaugeTempUnitQStringreadgaugeTempUnitChanged
gaugeSpeedUnitQStringreadgaugeSpeedUnitChanged
obdAutoReconnectAttemptsintreadobdAutoReconnectAttemptsChanged
fuelTankCapacityfloatreadfuelTankCapacityChanged
blackBoxEnabledboolreadblackBoxEnabledChanged
blackBoxSweepAllboolreadblackBoxSweepAllChanged
blackBoxMaxMBintreadblackBoxMaxMBChanged
homeOBDParametersQVariantListreadhomeOBDParametersChanged
maxHomeObdParametersintconstant–
customThemesQVariantListreadcustomThemesChanged
customThemeDataQVariantMapreadcustomThemesChanged
nowPlayingPresetsQVariantListconstant–
directoryHistoryQVariantListreaddirectoryHistoryChanged
windowStateQStringreadwindowStateChanged
lastSettingsSectionQStringreadlastSettingsSectionChanged
androidAutoEnabledboolreadandroidAutoEnabledChanged
phoneMirrorEnabledboolreadphoneMirrorEnabledChanged
scrcpyDisplaySizeQStringreadscrcpyDisplaySizeChanged
scrcpyAudioGaindoublereadscrcpyAudioGainChanged
scrcpyAudioGainDbdoublereadscrcpyAudioGainChanged
scrcpyAudioDuckLevelDbdoublereadscrcpyAudioDuckLevelChanged
scrcpyAudioDuckEnabledboolreadscrcpyAudioDuckEnabledChanged
scrcpyAudioDuckLeveldoublereadscrcpyAudioDuckLevelChanged
scrcpyPhoneScreenOffboolreadscrcpyPhoneScreenOffChanged
scrcpyDisplayDpiintreadscrcpyDisplayDpiChanged
scrcpyBitRateUsbintreadscrcpyBitRateUsbChanged
scrcpyBitRateWifiintreadscrcpyBitRateWifiChanged
scrcpyAutoWifiboolreadscrcpyAutoWifiChanged
scrcpyBitRateAutoboolreadscrcpyBitRateAutoChanged
scrcpyWirelessAddressQStringreadscrcpyWirelessAddressChanged
esp32VolumeEnabledboolreadesp32VolumeEnabledChanged
esp32VolumePortQStringreadesp32VolumePortChanged
esp32VolumeStepSizedoublereadesp32VolumeStepSizeChanged
esp32AutoReconnectboolreadesp32AutoReconnectChanged
esp32LedSleepEnabledboolreadesp32LedSleepEnabledChanged
esp32LedColorModeQStringreadesp32LedColorModeChanged
esp32LedStaticColorQStringreadesp32LedStaticColorChanged
imuEnabledboolreadimuEnabledChanged
sensorEmitRateintreadsensorEmitRateChanged
sensorDecimalPlacesintreadsensorDecimalPlacesChanged
sensorTempUnitQStringreadsensorTempUnitChanged
sensorAltitudeUnitQStringreadsensorAltitudeUnitChanged
sensorCardsQVariantMapreadsensorCardsChanged
gestureSensorEnabledboolreadgestureSensorEnabledChanged
gestureVolumeStepintreadgestureVolumeStepChanged
gestureCooldownintreadgestureCooldownChanged
pinnedSettingsQVariantListreadpinnedSettingsChanged
Method (call)ReturnsKindNeeds
save_device_name(QString name)–slotsettings
save_font_setting(QString font)–slotsettings
save_theme_setting(QString theme)–slotsettings
save_ui_scale(float scale)–slotsettings
save_color_transition_ms(int ms)–slotsettings
save_song_length_transition(bool enabled)–slotsettings
save_show_clock(bool show)–slotsettings
save_clock_format(bool is24hour)–slotsettings
save_clock_show_seconds(bool show)–slotsettings
save_clock_size(int size)–slotsettings
save_clock_size_auto(bool autoSize)–slotsettings
save_background_grid(QString grid)–slotsettings
save_screen_width(int width)–slotsettings
save_screen_height(int height)–slotsettings
save_background_blur_radius(int radius)–slotsettings
save_bottom_bar_orientation(QString orientation)–slotsettings
save_show_bottom_bar_media_controls(bool show)–slotsettings
save_settings_layout_style(QString style)–slotsettings
set_album_art_colors(QString colorsJson)–slotfull
save_start_volume(float volume)–slotsettings
setCurrentVolume(int volume)–slotfull
save_media_folder(QString folderPath)boolslotsettings
save_media_folder_url(QUrl url)boolslotsettings
save_auto_play_on_startup(bool enabled)–slotsettings
save_persist_shuffle_state(bool enabled)–slotsettings
save_last_shuffle_state(bool enabled)–slotsettings
save_last_played_song(QString filename)–slotsettings
save_last_played_position(int positionMs)–slotsettings
save_last_played_playlist(QString playlistName)–slotsettings
save_playback_state(QString song, int positionMs, QString playlist)–slotsettings
save_music_button_default_page(QString page)–slotsettings
save_return_to_library_after_selection(bool returnToLibrary)–slotsettings
save_show_waveform_visualizer(bool enabled)–slotsettings
save_show_3d_button_tilt(bool enabled)–slotsettings
save_show_3d_album_preview(bool enabled)–slotsettings
save_rounded_album_art(bool enabled)–slotsettings
save_album_art_corner_radius(int radius)–slotsettings
save_show_album_art_shadow(bool enabled)–slotsettings
save_vinyl_record_mode(bool enabled)–slotsettings
save_album_art_transition(QString transition)–slotsettings
save_audio_output_device(QString id)–slotsettings
save_background_overlay_opacity(int opacity)–slotsettings
save_side_card_opacity(double opacity)–slotsettings
save_side_card_angle(int angle)–slotsettings
save_button_tilt_duration(int duration)–slotsettings
save_text_scroll_speed(int speed)–slotsettings
save_obd_bluetooth_port(QString port)–slotsettings
add_obd_saved_adapter(QString name, QString mac)–slotsettings
remove_obd_saved_adapter(QString mac)–slotsettings
save_obd_fast_mode(bool enabled)–slotsettings
save_obd_card_style_circular(bool circular)–slotsettings
save_gauge_temp_unit(QString unit)–slotsettings
save_gauge_speed_unit(QString unit)–slotsettings
save_obd_auto_reconnect_attempts(int attempts)–slotsettings
save_fuel_tank_capacity(float capacity)–slotsettings
save_black_box_enabled(bool enabled)–slotsettings
save_black_box_sweep_all(bool enabled)–slotsettings
save_black_box_max_mb(int megabytes)–slotsettings
save_obd_parameter_enabled(QString parameter, bool enabled)–slotsettings
save_supported_obd_parameters(QVariantList parameters)–slotsettings
save_home_obd_parameters(QVariantList parameters)–slotsettings
add_home_obd_parameter(QString id, int index)boolslotsettings
add_home_obd_parameter(QString id)boolslotsettings
remove_home_obd_parameter(QString id)boolslotsettings
move_home_obd_parameter(int from, int to)boolslotsettings
save_to_directory_history(QString folderPath)–slotsettings
remove_from_directory_history(QString folderPath)–slotsettings
save_custom_theme(QString name, QVariantMap theme, QString albumArtSource)–slotsettings
save_custom_theme(QString name, QVariantMap theme)–slotsettings
delete_custom_theme(QString name)–slotsettings
save_window_state(QString state)–slotsettings
set_last_settings_section(QString section)–slotsettings
save_settings_section_visibility(QString section, bool visible)–slotsettings
save_android_auto_enabled(bool enabled)–slotsettings
save_phone_mirror_enabled(bool enabled)–slotsettings
save_scrcpy_display_size(QString size)–slotsettings
save_scrcpy_audio_gain(double gain)–slotsettings
save_scrcpy_audio_duck_enabled(bool enabled)–slotsettings
save_scrcpy_audio_duck_level(double level)–slotsettings
save_scrcpy_audio_gain_db(double db)–slotsettings
save_scrcpy_audio_duck_level_db(double db)–slotsettings
save_scrcpy_phone_screen_off(bool off)–slotsettings
save_scrcpy_display_dpi(int dpi)–slotsettings
save_scrcpy_bit_rate_usb(int mbps)–slotsettings
save_scrcpy_bit_rate_wifi(int mbps)–slotsettings
save_scrcpy_auto_wifi(bool enabled)–slotsettings
save_scrcpy_bit_rate_auto(bool enabled)–slotsettings
save_scrcpy_wireless_address(QString address)–slotsettings
save_esp32_volume_enabled(bool enabled)–slotsettings
save_esp32_volume_port(QString port)–slotsettings
save_esp32_volume_step_size(double stepSize)–slotsettings
save_esp32_auto_reconnect(bool enabled)–slotsettings
save_esp32_led_sleep_enabled(bool enabled)–slotsettings
save_esp32_led_color_mode(QString mode)–slotsettings
save_esp32_led_static_color(QString color)–slotsettings
save_imu_enabled(bool enabled)–slotsettings
save_sensor_emit_rate(int hz)–slotsettings
save_sensor_decimal_places(int places)–slotsettings
save_sensor_temp_unit(QString unit)–slotsettings
save_sensor_altitude_unit(QString unit)–slotsettings
save_sensor_card_visible(QString card, bool visible)–slotsettings
save_gesture_sensor_enabled(bool enabled)–slotsettings
save_gesture_action(QString gesture, QString action)–slotsettings
save_gesture_mapping(QVariantMap mapping)–slotsettings
reset_gesture_mapping()–slotsettings
save_gesture_volume_step(int step)–slotsettings
save_gesture_cooldown(int ms)–slotsettings
toggle_pin_setting(QString settingId)–slotsettings
reset_to_defaults()–slotsettings
save_setting(QString key, QVariant value)–slotsettings
apply_settings(QVariantMap values)QVariantMapslotsettings
applyNowPlayingPreset(QString label)boolslotsettings
get_setting(QString key)QVariantslotread
get_setting_with_default(QString key, QVariant defaultValue)QVariantslotread
get_obd_parameter_enabled(QString parameter, bool defaultVal)boolslotread
get_obd_parameter_enabled(QString parameter)boolslotread
get_supported_obd_parameters()QVariantListslotread
get_directory_history()QVariantListslotread
get_home_obd_parameters()QVariantListslotread
get_auto_play_on_startup()boolslotread
get_persist_shuffle_state()boolslotread
get_last_shuffle_state()boolslotread
get_last_played_song()QStringslotread
get_last_played_position()intslotread
get_last_played_playlist()QStringslotread
get_last_settings_section()QStringslotread
get_window_state()QStringslotread
get_music_button_default_page()QStringslotread
get_return_to_library_after_selection()boolslotread
flushPendingSave()–slotsettings
get_android_auto_enabled()boolslotread
get_phone_mirror_enabled()boolslotread
get_scrcpy_display_size()QStringslotread
get_scrcpy_audio_gain()doubleslotread
get_scrcpy_audio_duck_enabled()boolslotread
get_scrcpy_audio_duck_level()doubleslotread
get_scrcpy_phone_screen_off()boolslotread
get_scrcpy_display_dpi()intslotread
get_scrcpy_bit_rate_usb()intslotread
get_scrcpy_bit_rate_wifi()intslotread
get_scrcpy_auto_wifi()boolslotread
get_scrcpy_bit_rate_auto()boolslotread
get_scrcpy_wireless_address()QStringslotread
get_esp32_volume_enabled()boolslotread
get_esp32_volume_port()QStringslotread
get_esp32_volume_step_size()doubleslotread
get_esp32_auto_reconnect()boolslotread
get_esp32_led_sleep_enabled()boolslotread
get_esp32_led_color_mode()QStringslotread
get_esp32_led_static_color()QStringslotread
get_show_waveform_visualizer()boolslotread
get_imu_enabled()boolslotread
get_gesture_sensor_enabled()boolslotread
get_gesture_mapping()QStringslotread
get_gesture_mapping_dict()QVariantMapslotread
is_setting_pinned(QString settingId)boolslotread
get_settings_registry()QStringslotread
get_pinned_settings_metadata()QStringslotread
get_settings_menu_visibility()QStringslotread
is_settings_section_visible(QString section)boolslotread
get_git_commit_hash()QStringslotread
get_git_commit_date()QStringslotread
get_git_commit_message()QStringslotread

Signals (subscribe): deviceNameChanged(QString value), fontSettingChanged(QString value), themeSettingChanged(QString value), uiScaleChanged(float value), colorTransitionMsChanged(int value), songLengthTransitionChanged(bool value), showClockChanged(bool value), clockFormatChanged(bool value), clockShowSecondsChanged(bool value), clockSizeChanged(int value), clockSizeAutoChanged(bool value), backgroundGridChanged(QString value), screenWidthChanged(int value), screenHeightChanged(int value), backgroundBlurRadiusChanged(int value), bottomBarOrientationChanged(QString value), showBottomBarMediaControlsChanged(bool value), settingsLayoutStyleChanged(QString value), albumArtColorsChanged(), settingsMenuVisibilityChanged(), startUpVolumeChanged(QString value), currentVolumeChanged(int value), mediaFolderChanged(QString value), autoPlayOnStartupChanged(bool value), persistShuffleStateChanged(bool value), lastShuffleStateChanged(bool value), lastPlayedSongChanged(QString value), lastPlayedPositionChanged(int value), lastPlayedPlaylistChanged(QString value), musicButtonDefaultPageChanged(QString value), returnToLibraryAfterSelectionChanged(bool value), showWaveformVisualizerChanged(bool value), show3DButtonTiltChanged(bool value), show3DAlbumPreviewChanged(bool value), roundedAlbumArtChanged(bool value), albumArtCornerRadiusChanged(int value), showAlbumArtShadowChanged(bool value), vinylRecordModeChanged(bool value), albumArtTransitionChanged(QString value), audioOutputDeviceChanged(QString value), backgroundOverlayOpacityChanged(int value), sideCardOpacityChanged(double value), sideCardAngleChanged(int value), buttonTiltDurationChanged(int value), textScrollSpeedChanged(int value), obdBluetoothPortChanged(QString value), obdSavedAdaptersChanged(), obdFastModeChanged(bool value), obdCardStyleCircularChanged(bool value), gaugeTempUnitChanged(), gaugeSpeedUnitChanged(), obdAutoReconnectAttemptsChanged(int value), fuelTankCapacityChanged(float value), blackBoxEnabledChanged(bool value), blackBoxSweepAllChanged(bool value), blackBoxMaxMBChanged(int value), obdParametersChanged(), homeOBDParametersChanged(), supportedOBDParametersChanged(), directoryHistoryChanged(), customThemesChanged(), windowStateChanged(QString value), lastSettingsSectionChanged(QString value), androidAutoEnabledChanged(bool value), phoneMirrorEnabledChanged(bool value), scrcpyDisplaySizeChanged(QString value), scrcpyAudioGainChanged(double value), scrcpyAudioDuckEnabledChanged(bool value), scrcpyAudioDuckLevelChanged(double value), scrcpyPhoneScreenOffChanged(bool value), scrcpyDisplayDpiChanged(int value), scrcpyBitRateUsbChanged(int value), scrcpyBitRateWifiChanged(int value), scrcpyAutoWifiChanged(bool value), scrcpyBitRateAutoChanged(bool value), scrcpyWirelessAddressChanged(QString value), esp32VolumeEnabledChanged(bool value), esp32VolumePortChanged(QString value), esp32VolumeStepSizeChanged(double value), esp32AutoReconnectChanged(bool value), esp32LedSleepEnabledChanged(bool value), esp32LedColorModeChanged(QString value), esp32LedStaticColorChanged(QString value), imuEnabledChanged(bool value), sensorEmitRateChanged(int value), sensorDecimalPlacesChanged(int value), sensorTempUnitChanged(QString value), sensorAltitudeUnitChanged(QString value), sensorCardsChanged(), gestureSensorEnabledChanged(bool value), gestureMappingChanged(), gestureVolumeStepChanged(int value), gestureCooldownChanged(int value), pinnedSettingsChanged(), genericSettingChanged(QString key).

shiftLightManager — ShiftLightManager

Hand-written notes: Signals & Slots API. Raw: docs/api/shiftLightManager.json.

PropertyTypeAccessNotify
enabledboolreadsettingsChanged
showOnHomeCardboolreadsettingsChanged
maxRpmintreadsettingsChanged
fullScreenFlashOpacitydoublereadsettingsChanged
lampSizedoublereadsettingsChanged
glowSizedoublereadsettingsChanged
glowIntensitydoublereadsettingsChanged
colorTransitionSpeedintreadsettingsChanged
pulseEnabledboolreadsettingsChanged
flagsQVariantListreadflagsChanged
rpmdoublereadrpmChanged
activeboolreadactiveFlagChanged
activeIndexintreadactiveFlagChanged
activeFlagQVariantMapreadactiveFlagChanged
litboolreadlitChanged
suppressedboolread / write (vehicle)suppressedChanged
Method (call)ReturnsKindNeeds
setRpm(double rpm)–slotfull
setFlags(QVariantList flags)–slotvehicle

Signals (subscribe): settingsChanged(), flagsChanged(), rpmChanged(), activeFlagChanged(), litChanged(), suppressedChanged().

sim — Simulator

Experimental: this object may change or go in any release.

Hand-written notes: Signals & Slots API. Raw: docs/api/sim.json.

PropertyTypeAccessNotify
activeboolreadactiveChanged
Method (call)ReturnsKindNeeds
setThrottle(double percent)boolinvokablevehicle
setBrake(double percent)boolinvokablevehicle
rev(double intensity)boolinvokablevehicle
setEngineOn(bool on)boolinvokablevehicle
toggleEngine()boolinvokablevehicle
setGear(int gear)boolinvokablevehicle
upshift()boolinvokablevehicle
downshift()boolinvokablevehicle
setSpeed(double mph)boolinvokablevehicle
setRpm(double rpm)boolinvokablevehicle
setRealistic(bool on)boolinvokablevehicle
scenario(QString name)boolinvokablevehicle
setDropouts(bool on)boolinvokablevehicle
dropoutNow()boolinvokablevehicle
setFailureRate(double rate)boolinvokablevehicle
setLinkUp(bool up)boolinvokablevehicle
setImu(bool on)boolinvokablevehicle
setVideo(bool on)boolinvokablevehicle
pairingCode()QVariantMapinvokablefull
status()QVariantMapinvokableread

Signals (subscribe): activeChanged().

themeCatalog — ThemeCatalog

Hand-written notes: Signals & Slots API. Raw: docs/api/themeCatalog.json.

PropertyTypeAccessNotify
themesQVariantMapconstant–
themeNamesQStringListconstant–
lightThemeNamesQStringListconstant–
darkThemeNamesQStringListconstant–
activeThemeNameQStringreadactiveThemeChanged
activeThemeQVariantMapreadactiveThemeChanged

Signals (subscribe): activeThemeChanged().

tripRecorder — TripRecorder

Hand-written notes: Signals & Slots API. Raw: docs/api/tripRecorder.json.

PropertyTypeAccessNotify
enabledboolreadenabledChanged
storeReadyboolreadstoreReadyChanged
recordingboolreadrecordingChanged
currentTripIdqlonglongreadrecordingChanged
currentTripStartMsqlonglongreadrecordingChanged
currentSampleCountintreadcurrentSampleCountChanged
currentTripElapsedSintreadcurrentTripElapsedSChanged
tripsQVariantListreadtripsChanged
historyDirQStringreadhistoryDirChanged
tripsDirQStringreadhistoryDirChanged
storageBytesqlonglongreadstorageBytesChanged
canOpenFolderboolconstant–
lastExportPathQStringreadlastExportPathChanged
lastErrorQStringreadlastErrorChanged
Method (call)ReturnsKindNeeds
recordSample(QString paramId, float value)–slotfull
setConnected(bool connected)–slotfull
setVehicleParameters(QStringList ids)–slotfull
setVehicleIdentity(QString vin, QString make, int modelYear)–slotfull
noteEvent(QString kind, QString detail)–slotfull
setEnabled(bool enabled)–slotfiles
endTripNow()–slotfiles
refresh()–slotread
requestDetail(qlonglong id)–slotread
requestSeries(qlonglong id, QString paramId, int maxPoints, double fromS, double toS)–slotread
requestSeries(qlonglong id, QString paramId, int maxPoints, double fromS)–slotread
requestSeries(qlonglong id, QString paramId, int maxPoints)–slotread
requestSeries(qlonglong id, QString paramId)–slotread
requestHealthTrends(int days)–slotread
requestHealthTrends()–slotread
requestParamTrend(QString paramId, int days)–slotread
requestParamTrend(QString paramId)–slotread
deleteTrip(qlonglong id)–slotfiles
clearHistory()–slotfiles
exportTrip(qlonglong id)–slotfiles
openHistoryFolder()boolslotsystem

Signals (subscribe): enabledChanged(bool enabled), storeReadyChanged(), recordingChanged(), currentSampleCountChanged(), currentTripElapsedSChanged(), liveTripChanged(qlonglong id), tripsChanged(), historyDirChanged(), storageBytesChanged(), lastExportPathChanged(), lastErrorChanged(), tripStarted(qlonglong id), tripEnded(qlonglong id, QVariantMap summary), detailReady(qlonglong id, QVariantMap detail), seriesReady(qlonglong id, QString paramId, QVariantList points), exportFinished(qlonglong id, QString path), healthTrendsReady(int days, QVariantMap result), paramTrendReady(QString paramId, int days, QVariantList rows).

units — Units

Hand-written notes: Signals & Slots API. Raw: docs/api/units.json.

Method (call)ReturnsKindNeeds
formatDuration(double ms)QStringinvokableread
formatSeconds(double s)QStringinvokableread
cardinal(double headingDeg)QStringinvokableread
cToF(double c)doubleinvokableread
mToFt(double m)doubleinvokableread
mphToKph(double mph)doubleinvokableread
linearToDb(double x)doubleinvokableread
dbToLinear(double db)doubleinvokableread

volumeController — VolumeController

Hand-written notes: Signals & Slots API. Raw: docs/api/volumeController.json.

PropertyTypeAccessNotify
percentintreadpercentChanged
mutedboolread / write (media)mutedChanged
effectivelyMutedboolreadeffectivelyMutedChanged
Method (call)ReturnsKindNeeds
applyVolume(int percent)–slotmedia
setMuted(bool muted)–slotmedia
toggleMute()–slotmedia
toLinear(float percent)floatslotread
toPercent(float linear)intslotread

Signals (subscribe): volumeApplied(int percent, float linear), percentChanged(int percent), mutedChanged(bool muted), effectivelyMutedChanged().

Parameters

Every OBD PID and IMU reading (129), the keys of paramStore (docs/api/parameters.json). Values are in the native unit; parameterCatalog.toDisplay(id, value) converts to the user's units.

IdTitleNative unitRangeKindSource
SPEEDSpeedMPH0 – 160numericobd
RPMEngine RPMRPM0 – 8000numericobd
COOLANT_TEMPCoolant Temp°C0 – 120temperatureobd
OIL_TEMPOil Temp°C0 – 150temperatureobd
COMMANDED_EQUIV_RATIOAir-Fuel Ratio:110 – 18numericobd
ENGINE_LOADEngine Load%0 – 100percentageobd
THROTTLE_POSThrottle%0 – 100percentageobd
FUEL_LEVELFuel Level%0 – 100percentageobd
SHORT_FUEL_TRIM_1Short Fuel Trim 1%-25 – 25bidirectionalobd
LONG_FUEL_TRIM_1Long Fuel Trim 1%-25 – 25bidirectionalobd
INTAKE_TEMPIntake Temp°C0 – 80temperatureobd
INTAKE_PRESSUREIntake PressurekPa0 – 255pressureobd
MAFMass Air Flowg/s0 – 100numericobd
TIMING_ADVANCETiming Advance°-35 – 35bidirectionalobd
CONTROL_MODULE_VOLTAGESystem VoltageV10 – 15voltageobd
O2_B1S1O2 Bank 1 Sensor 1V0 – 1voltageobd
FUEL_PRESSUREFuel PressurekPa0 – 765pressureobd
IGNITION_TIMING (alias of TIMING_ADVANCE)Ignition Timing°-10 – 60bidirectionalobd
RUN_TIMERun Timesec0 – 65535numericobd
DISTANCE_W_MILDistance w/ MILkm0 – 65535numericobd
FUEL_RAIL_PRESSURE_VACFuel Rail PressurekPa0 – 5177pressureobd
FUEL_RAIL_PRESSURE_DIRECTFuel Rail DirectkPa0 – 655350pressureobd
BAROMETRIC_PRESSUREBarometrickPa0 – 255pressureobd
AMBIANT_AIR_TEMPAmbient Air°C-40 – 215temperatureobd
RELATIVE_THROTTLE_POSRel. Throttle%0 – 100percentageobd
THROTTLE_POS_BThrottle Pos B%0 – 100percentageobd
ACCELERATOR_POS_DAccel. Pedal%0 – 100percentageobd
CATALYST_TEMP_B1S1Cat Temp B1S1°C0 – 6513temperatureobd
CATALYST_TEMP_B1S2Cat Temp B1S2°C0 – 6513temperatureobd
EVAP_VAPOR_PRESSUREEVAP PressurePa-8192 – 8191bidirectionalobd
SHORT_FUEL_TRIM_2Short Fuel Trim 2%-25 – 25bidirectionalobd
LONG_FUEL_TRIM_2Long Fuel Trim 2%-25 – 25bidirectionalobd
O2_B1S2O2 Bank 1 Sensor 2V0 – 1voltageobd
O2_B2S1O2 Bank 2 Sensor 1V0 – 1voltageobd
O2_B2S2O2 Bank 2 Sensor 2V0 – 1voltageobd
DISTANCE_SINCE_DTC_CLEARDist Since Clearkm0 – 65535numericobd
WARMUPS_SINCE_DTC_CLEARWarmups Since Clear–0 – 255numericobd
ABSOLUTE_LOADAbsolute Load%0 – 25700numericobd
COMMANDED_EGRCommanded EGR%0 – 100percentageobd
EGR_ERROREGR Error%-100 – 100bidirectionalobd
ETHANOL_PERCENTEthanol %%0 – 100percentageobd
O2_B1S3O2 Bank 1 Sensor 3V0 – 1voltageobd
O2_B1S4O2 Bank 1 Sensor 4V0 – 1voltageobd
O2_B2S3O2 Bank 2 Sensor 3V0 – 1voltageobd
O2_B2S4O2 Bank 2 Sensor 4V0 – 1voltageobd
O2_S1_WR_VOLTAGEO2 S1 WR VoltageV0 – 5voltageobd
O2_S2_WR_VOLTAGEO2 S2 WR VoltageV0 – 5voltageobd
O2_S3_WR_VOLTAGEO2 S3 WR VoltageV0 – 5voltageobd
O2_S4_WR_VOLTAGEO2 S4 WR VoltageV0 – 5voltageobd
O2_S5_WR_VOLTAGEO2 S5 WR VoltageV0 – 5voltageobd
O2_S6_WR_VOLTAGEO2 S6 WR VoltageV0 – 5voltageobd
O2_S7_WR_VOLTAGEO2 S7 WR VoltageV0 – 5voltageobd
O2_S8_WR_VOLTAGEO2 S8 WR VoltageV0 – 5voltageobd
O2_S1_WR_CURRENTO2 S1 WR CurrentmA-128 – 128bidirectionalobd
O2_S2_WR_CURRENTO2 S2 WR CurrentmA-128 – 128bidirectionalobd
O2_S3_WR_CURRENTO2 S3 WR CurrentmA-128 – 128bidirectionalobd
O2_S4_WR_CURRENTO2 S4 WR CurrentmA-128 – 128bidirectionalobd
O2_S5_WR_CURRENTO2 S5 WR CurrentmA-128 – 128bidirectionalobd
O2_S6_WR_CURRENTO2 S6 WR CurrentmA-128 – 128bidirectionalobd
O2_S7_WR_CURRENTO2 S7 WR CurrentmA-128 – 128bidirectionalobd
O2_S8_WR_CURRENTO2 S8 WR CurrentmA-128 – 128bidirectionalobd
CATALYST_TEMP_B2S1Cat Temp B2S1°C0 – 6513temperatureobd
CATALYST_TEMP_B2S2Cat Temp B2S2°C0 – 6513temperatureobd
THROTTLE_POS_CThrottle Pos C%0 – 100percentageobd
ACCELERATOR_POS_EAccel. Pos E%0 – 100percentageobd
ACCELERATOR_POS_FAccel. Pos F%0 – 100percentageobd
THROTTLE_ACTUATORThrottle Actuator%0 – 100percentageobd
EVAPORATIVE_PURGEEVAP Purge%0 – 100percentageobd
FUEL_RAIL_PRESSURE_ABSFuel Rail AbskPa0 – 655350pressureobd
FUEL_INJECT_TIMINGFuel Inject Timing°-210 – 302bidirectionalobd
FUEL_RATEFuel RateL/h0 – 3212numericobd
RUN_TIME_MILRun Time w/ MILmin0 – 65535numericobd
TIME_SINCE_DTC_CLEAREDTime Since Clearmin0 – 65535numericobd
MAX_MAFMax MAFg/s0 – 2550numericobd
FUEL_TYPEFuel Type–0 – 23numericobd
EVAP_VAPOR_PRESSURE_ABSEVAP Pressure AbskPa0 – 327pressureobd
EVAP_VAPOR_PRESSURE_ALTEVAP Pressure AltPa-32768 – 32767bidirectionalobd
SHORT_O2_TRIM_B1Short O2 Trim B1%-100 – 100bidirectionalobd
LONG_O2_TRIM_B1Long O2 Trim B1%-100 – 100bidirectionalobd
SHORT_O2_TRIM_B2Short O2 Trim B2%-100 – 100bidirectionalobd
LONG_O2_TRIM_B2Long O2 Trim B2%-100 – 100bidirectionalobd
RELATIVE_ACCEL_POSRel. Accel Pos%0 – 100percentageobd
HYBRID_BATTERY_REMAININGHybrid Battery%0 – 100percentageobd
ELM_VOLTAGEELM VoltageV0 – 65voltageobd
DEMAND_ENGINE_TORQUEDemand Torque%-125 – 130bidirectionalobd
ACTUAL_ENGINE_TORQUEActual Torque%-125 – 130bidirectionalobd
ENGINE_FRICTION_TORQUEFriction Torque%-125 – 130bidirectionalobd
REFERENCE_TORQUEReference TorqueNm0 – 2000numericobd
BOOST_PRESSURE_ABoost Pressure (abs)kPa0 – 300pressureobd
BOOST_PRESSURE_A_COMMANDEDBoost Commanded (abs)kPa0 – 300pressureobd
WASTEGATE_AWastegate Position%0 – 100percentageobd
WASTEGATE_A_COMMANDEDWastegate Commanded%0 – 100percentageobd
MAF_SENSOR_AMAF Sensor Ag/s0 – 655numericobd
MAF_SENSOR_BMAF Sensor Bg/s0 – 655numericobd
INTAKE_TEMP_B1S1Intake Temp B1S1°C-20 – 100temperatureobd
INTAKE_TEMP_B1S2Intake Temp B1S2°C-20 – 100temperatureobd
INTAKE_TEMP_B2S1Intake Temp B2S1°C-20 – 100temperatureobd
MANIFOLD_SURFACE_TEMPManifold Surface Temp°C-40 – 215temperatureobd
COOLANT_TEMP_SENSOR_1Coolant Temp 1°C0 – 130temperatureobd
COOLANT_TEMP_SENSOR_2Coolant Temp 2°C0 – 130temperatureobd
THROTTLE_POS_GThrottle Pos G%0 – 100percentageobd
THROTTLE_ACTUATOR_A_COMMANDEDThrottle A Commanded%0 – 100percentageobd
RELATIVE_THROTTLE_ARel. Throttle A%0 – 100percentageobd
EGR_A_COMMANDEDEGR A Commanded%0 – 100percentageobd
EGR_A_ACTUALEGR A Actual%0 – 100percentageobd
EGR_A_ERROREGR A Error%-100 – 100bidirectionalobd
FUEL_RAIL_PRESSURE_AFuel Rail Pressure AkPa0 – 250000pressureobd
FUEL_RAIL_PRESSURE_A_COMMANDEDFuel Rail A CommandedkPa0 – 250000pressureobd
FUEL_RAIL_TEMP_AFuel Rail Temp A°C-40 – 150temperatureobd
ENGINE_FUEL_RATE_GSEngine Fuel Rateg/s0 – 100numericobd
VEHICLE_FUEL_RATE_GSVehicle Fuel Rateg/s0 – 100numericobd
CYLINDER_FUEL_RATECylinder Fuel Ratemg/stroke0 – 200numericobd
EXHAUST_FLOW_RATEExhaust Flowkg/h0 – 2000numericobd
TRANSMISSION_GEAR_RATIOGear Ratio:10 – 6numericobd
RECOMMENDED_GEARRecommended Gear–0 – 10numericobd
ODOMETEROdometerkm0 – 1000000numericobd
ENGINE_RUN_TIME_TOTALTotal Engine Run Timesec0 – 360000000numericobd
ENGINE_IDLE_TIME_TOTALTotal Idle Timesec0 – 360000000numericobd
HYBRID_BATTERY_VOLTAGEHybrid Battery VoltageV0 – 900voltageobd
HYBRID_BATTERY_CURRENTHybrid Battery CurrentA-500 – 500bidirectionalobd
EV_BATTERY_HEALTHEV Battery Health%0 – 100percentageobd
PITCHPitch°-90 – 90bidirectionalimu
ROLLRoll°-180 – 180bidirectionalimu
HEADINGHeading°0 – 360numericimu
ALTITUDEAltitudem0 – 3000numericimu
ACCEL_MAGG Magnitudeg0 – 3numericimu
LATERAL_GLateral Gg-2 – 2bidirectionalimu
LONGITUDINAL_GLongitudinal Gg-2 – 2bidirectionalimu
BARO_TEMPCabin Baro Temp°C-20 – 60temperatureimu