Vehicle Signals
Signals from DIMO-connected vehicles.
Overview
There are two types of query fields that you can use to retrieve vehicle signals from the Telemetry API, depending on if you’re looking for the latest signal data, or if you need to look up historical signal data from the past:
-
The
signalsquery allows you to retrieve signal data from a vehicle for a given time period. It is commonly used to perform look backs with a set interval within a time period for a vehicle. -
The
signalsLatestquery allows you to retrieve the most recent signal data from a vehicle. It returns the latest signals received from the respective data sources.
signals
Arguments
tokenIdInt!RequiredfromTime!RequiredtoTime!RequiredintervalString!RequiredfilterSignalFilterOptionalsignals, be sure to also include the relevant aggregation type.# Sample Telemetry Query
query GetHistoricalSignals{
signals(
tokenId: 12345
from: "2024-05-07T09:21:19Z"
to: "2024-05-10T09:21:19Z"
interval: "24h"
) {
timestamp
speed(agg: MAX)
}
}
signalsLatest
Arguments
tokenIdInt!RequiredfilterSignalFilterOptionalsignalsLatest, be sure to include a value and optionally a timestamp.# Sample Telemetry Query
query GetLatestSignals{
signalsLatest(tokenId: 12345) {
powertrainTransmissionTravelledDistance {
value
}
powertrainFuelSystemRelativeLevel {
value
timestamp
}
}
}
Categories of Data
- Signal: The field name that can be queried for signals or signalsLatest.
- Common Name: A simplified, consumer-friendly naming convention for the signal.
- Aggregation (Agg.) Type: The Aggregation Type as specified for the signals resource.
- Units: The unit returned for the specific signal quieried, if relevant.
- Description: A longer description for the specific signal.
lastSeensignalsLatestavailableSignalstokenId.powertrainTransmissionTravelledDistancevinVCsignals or signalsLatest. Query example: query { vinVCLatest(tokenId: 12345) { vin } }isIgnitionOnVehicle ignition status.
True (1) = Vehicle Ignition On
False (0) = Vehicle Ignition Off
speedangularVelocityYawconnectivityCellularIsJammingDetectedIndicates whether cellular jamming has been detected.
True (1) = Jamming detected
False (0) = No jamming detected
bodyLightsIsAirbagWarningOnIndicates whether the airbag/SRS warning telltale is active.
True (1) = Warning active
False (0) = Warning inactive
bodyLockIsLockedCentral locking status of the vehicle.
True (1) = Locked
False (0) = Unlocked
bodyTrunkFrontIsOpenFront trunk (frunk) open/closed status.
True (1) = Open
False (0) = Closed
bodyTrunkRearIsOpenRear trunk open/closed status.
True (1) = Open
False (0) = Closed
currentLocationCoordinatescurrentLocationApproximateCoordinatescurrentLocationAltitudecurrentLocationHeadingpowertrainTractionBatteryChargingChargeCurrentACpowertrainTractionBatteryChargingChargeLimitpowertrainTractionBatteryChargingChargeVoltageUnknownTypepowertrainTractionBatteryChargingIsChargingTrue (1) - Vehicle is charging.
False (0) - Vehicle is not charging.
powertrainTractionBatteryChargingIsChargingCableConnectedIndicates whether a charging cable is connected to the vehicle.
True (1) = Cable connected
False (0) = Cable not connected
powertrainTractionBatteryChargingPowerpowertrainTractionBatteryCurrentPowerpowertrainTractionBatteryCurrentVoltagepowertrainTractionBatteryGrossCapacitypowertrainTractionBatteryRangepowertrainTractionBatteryStateOfChargeCurrentpowertrainTractionBatteryStateOfChargeCurrentEnergypowertrainTractionBatteryStateOfHealthpowertrainTractionBatteryTemperatureAveragepowertrainTractionBatteryChargingAddedEnergylowVoltageBatteryCurrentVoltageobdDTCListobdStatusDTCCountobdRunTimeobdIntakeTempobdEngineLoadobdBarometricPressureobdMAPobdFuelPressureobdFuelRateobdFuelTypeNameobdOilTemperatureobdCommandedEGRobdCommandedEVAPobdShortTermFuelTrim1obdLongTermFuelTrim1obdO2WRSensor1VoltageobdO2WRSensor2VoltageobdDistanceSinceDTCClearobdDistanceWithMILobdWarmupsSinceDTCClearobdIsEngineBlockedIndicates whether the engine is blocked.
True (1) = Engine blocked
False (0) = Engine not blocked
obdIsPTOActiveTrue (1) = PTO active
False (0) = PTO inactive
obdIsPluggedInIndicates whether the aftermarket OBD device is plugged in.
True (1) = Plugged in
False (0) = Not plugged in
powertrainTypepowertrainRangepowertrainCombustionEngineTPSpowertrainCombustionEngineSpeedpowertrainCombustionEngineMAFpowertrainCombustionEngineTorquepowertrainCombustionEngineTorquePercentpowertrainCombustionEngineEngineOilLevelpowertrainCombustionEngineEngineOilRelativeLevelpowertrainCombustionEngineECTpowertrainCombustionEngineEOPpowertrainCombustionEngineEOTpowertrainCombustionEngineDieselExhaustFluidLevelpowertrainCombustionEngineDieselExhaustFluidCapacitypowertrainTransmissionCurrentGearpowertrainTransmissionSelectedGearpowertrainTransmissionTemperaturepowertrainTransmissionIsClutchSwitchOperatedIndicates whether the clutch switch is currently operated (pressed).
True (1) = Clutch pressed
False (0) = Clutch released
powertrainTransmissionRetarderActualTorquepowertrainTransmissionRetarderTorqueModeexteriorAirTemperaturepowertrainFuelSystemSupportedFuelTypespowertrainFuelSystemRelativeLevelpowertrainFuelSystemAbsoluteLevelpowertrainFuelSystemAccumulatedConsumptionchassisAxleRow1WheelLeftTirePressurechassisAxleRow1WheelRightTirePressurechassisAxleRow2WheelLeftTirePressurechassisAxleRow2WheelRightTirePressurechassisAxleRow1WheelLeftSpeedchassisAxleRow1WheelRightSpeedchassisAxleRow3WeightchassisAxleRow4WeightchassisAxleRow5WeightchassisTireSystemIsWarningOnIndicates whether the Tire Pressure Monitoring System (TPMS) warning is active.
True (1) = Warning active
False (0) = Warning inactive
chassisBrakeIsPedalPressedIndicates whether the brake pedal is currently pressed.
True (1) = Pedal pressed
False (0) = Pedal released
chassisBrakePedalPositionchassisParkingBrakeIsEngagedIndicates whether the parking brake is engaged.
True (1) = Engaged
False (0) = Released
chassisBrakeABSIsWarningOnIndicates whether the Anti-lock Braking System (ABS) warning telltale is active.
True (1) = Warning active
False (0) = Warning inactive
chassisBrakeCircuit1PressurePrimarychassisBrakeCircuit2PressurePrimarycabinSeatRow1DriverSideIsBeltedTrue (1) = Seatbelt fastened.
False (0) = Seatbelt unfastened.
cabinSeatRow1PassengerSideIsBeltedTrue (1) = Seatbelt fastened.
False (0) = Seatbelt unfastened.
cabinSeatRow2DriverSideIsBeltedTrue (1) = Seatbelt fastened.
False (0) = Seatbelt unfastened.
cabinSeatRow2MiddleIsBeltedTrue (1) = Seatbelt fastened.
False (0) = Seatbelt unfastened.
cabinSeatRow2PassengerSideIsBeltedTrue (1) = Seatbelt fastened.
False (0) = Seatbelt unfastened.
cabinSeatRow3DriverSideIsBeltedTrue (1) = Seatbelt fastened.
False (0) = Seatbelt unfastened.
cabinSeatRow3PassengerSideIsBeltedTrue (1) = Seatbelt fastened.
False (0) = Seatbelt unfastened.
cabinDoorRow1DriverSideIsOpenTrue (1) = Fully or partially open.
False (0) = Fully closed.
cabinDoorRow1PassengerSideIsOpenTrue (1) = Fully or partially open.
False (0) = Fully closed.
cabinDoorRow2DriverSideIsOpenTrue (1) = Fully or partially open.
False (0) = Fully closed.
cabinDoorRow2PassengerSideIsOpenTrue (1) = Fully or partially open.
False (0) = Fully closed.
cabinDoorRow1DriverSideWindowIsOpenTrue (1) = Fully or partially open.
False (0) = Fully closed.
cabinDoorRow1PassengerSideWindowIsOpenTrue (1) = Fully or partially open.
False (0) = Fully closed.
cabinDoorRow2DriverSideWindowIsOpenTrue (1) = Fully or partially open.
False (0) = Fully closed.
cabinDoorRow2PassengerSideWindowIsOpenTrue (1) = Fully or partially open.
False (0) = Fully closed.
serviceDistanceToServiceserviceTimeToServiceAdvanced Filtering
currentLocationCoordinates Filters
This is an advanced filter that you can apply on the currentLocationCoordinates field under signals.
It is used to filter by a user-defined geofence that can be set using circles or polygons:
In Circle Filtering
Loading map components...