Skip to main content

Telemetry Schema Reference

The Axle Engine accepts vehicle telemetry data in a flexible format. This document covers the standard schema and auto-mapping features.

Quick Reference

Key Takeaway

Only vehicleId is required. The more fields you provide, the better the predictions.

Required Fields

FieldTypeDescriptionExample
vehicleIdstringRequired - Unique vehicle identifier"TRUCK-001", "VIN123ABC"

These 5 fields significantly improve prediction accuracy:

FieldTypeUnitRangeDescription
engine_speednumberRPM0-10,000Engine revolutions per minute
coolantnumber°C-40 to 150Engine coolant temperature
battery_voltagenumberV0-30Battery voltage
fuel_levelnumber%0-100Fuel level percentage
vehicleSpeednumberkm/h0-300Vehicle speed

All Supported Fields

Engine Metrics

FieldTypeUnitDescription
engine_speednumberRPMEngine RPM
coolantnumber°CCoolant temperature
engineOilTempnumber°COil temperature
engineFuelTempnumber°CFuel temperature

Vehicle Metrics

FieldTypeUnitDescription
vehicleSpeednumberkm/hVehicle speed
obdDistancenumberkmOdometer reading
runTimenumbersecondsEngine runtime
current_gearinteger-Current gear

Electrical

FieldTypeUnitDescription
battery_voltagenumberVBattery voltage

Fuel

FieldTypeUnitDescription
fuel_levelnumber%Fuel level
fuel_consumptionnumberL/100kmFuel consumption rate

Environment

FieldTypeUnitDescription
ambient_air_temperaturenumber°COutside temperature

Warning Lamps

FieldTypeValuesDescription
mil_lampstring"LAMP_ON", "LAMP_OFF"Check Engine light
protect_lampstringSame as aboveEngine protection warning
amber_warning_lampstringSame as aboveAmber warning
red_stop_lampstringSame as aboveRed stop warning

Diagnostics

FieldTypeDescriptionExample
dtc_codesarrayActive DTC fault codes["P0301", "P0420"]

GPS (Optional)

FieldTypeRangeDescription
latitudenumber-90 to 90GPS latitude
longitudenumber-180 to 180GPS longitude

Auto-Mapping (Legacy Support)

The Axle Engine automatically maps common alternative field names to the standard schema. This enables zero-config integration with legacy telematics systems.

How It Works

  1. Send data with your existing field names
  2. Axle Engine auto-detects and maps them
  3. Response includes mapping details

Supported Aliases

Standard FieldAlso Accepts
vehicleIdvin, VIN, vehicle_id, fleet_id, asset_id
engine_speedrpm, engine_rpm, engineRPM, motor_speed
coolantcoolant_temp, engine_temp, ect, water_temp
battery_voltagebattery, bat_v, voltage, batt_voltage
vehicleSpeedspeed, vehicle_speed, gps_speed, kph
obdDistanceodometer, odo, mileage, total_km, distance
fuel_levelfuel, tank, fuel_pct, tank_level
dtc_codesdtc, fault_codes, faultCodes, error_codes

Example: Legacy Data

Your Data:

{
"vin": "ABC123XYZ",
"rpm": 2400,
"coolant_temp": 92,
"bat_v": 13.2
}

What Happens:

{
"vehicleId": "ABC123XYZ",
"predictions": { ... },
"_schemaMapping": {
"autoMapped": true,
"mappedFields": {
"rpm": "engine_speed",
"coolant_temp": "coolant",
"bat_v": "battery_voltage"
}
}
}
Best Practice

While auto-mapping works, using standard field names is recommended for:

  • Best prediction accuracy
  • Consistent results
  • Future compatibility

Example Requests

Minimal Request

{
"vehicleId": "TRUCK-001"
}
{
"vehicleId": "TRUCK-001",
"timestamp": "2026-01-13T10:00:00Z",
"engine_speed": 2400,
"coolant": 92,
"battery_voltage": 13.2,
"fuel_level": 75,
"vehicleSpeed": 65
}

Full Request

{
"vehicleId": "TRUCK-001",
"timestamp": "2026-01-13T10:00:00Z",
"engine_speed": 2400,
"coolant": 92,
"engineOilTemp": 95,
"battery_voltage": 13.2,
"vehicleSpeed": 65,
"fuel_level": 75,
"fuel_consumption": 8.5,
"obdDistance": 45000,
"ambient_air_temperature": 28,
"mil_lamp": "LAMP_OFF",
"protect_lamp": "LAMP_OFF",
"dtc_codes": [],
"latitude": 12.9716,
"longitude": 77.5946
}

Schema APIs

Get JSON Schema

GET /v1/schema/input

Returns the full JSON Schema for input validation.

Get Supported Aliases

GET /v1/schema/aliases

Returns all field aliases that are auto-mapped.

Get Processing Statistics

GET /v1/schema/statistics

Returns statistics on schema compliance:

{
"total_processed": 1500,
"fully_standard": 1200,
"required_mapping": 300,
"standard_compliance_rate": 80.0
}

Data Quality Impact

Fields ProvidedPrediction QualityConfidence
Only vehicleId⚠️ BasicLow
+ Core 5 fields✅ GoodMedium
+ All optional fields✅✅ ExcellentHigh
+ Historical data✅✅✅ BestVery High

Next Steps