Skip to main content

Documentation Index

Fetch the complete documentation index at: https://samsara-showcase.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Location (GPS) and speed readings

GPS and Speed

{
  "asset": {
    "externalIds": {},
    "id": "154924973293665"
  },
  "happenedAtTime": "2023-12-19T17:57:21Z",
  "location": {
    "accuracyMeters": 0,
    "address": {
      "city": "New York",
      "country": "USA",
      "neighborhood": "Mission District",
      "pointOfInterest": "The Eiffel Tower",
      "postalCode": "10010",
      "state": "New York",
      "street": "Main Street",
      "streetNumber": "16"
    },
    "geofence": {
      "externalIds": { "additionalProp": "string" },
      "id": "12345"
    },
    "headingDegrees": 102,
    "latitude": 38.253265915,
    "longitude": -80.018465004
  },
  "speed": {
    "gpsSpeedMetersPerSecond": 43.8,
    "ecuSpeedMetersPerSecond": 51.2
  }
}

Speed only

Speed MPH (ECU)
{
  "vehicle": {
    "id": "281474991840886",
    "externalIds": {}
  },
  "ecuSpeedMph": {
    "time": "2024-08-21T22:24:32Z",
    "value": 0
  }
}

Vehicle Diagnostics

AUX Inputs

AUX Input Example
{
  "vehicle": { "id": "281474990577720", "externalIds": {} },
  "auxInput1": {
    "name": "Boom",
    "time": "2020-01-27T07:06:25Z",
    "value": true
  }
}
NFC Card Scan
{
  "vehicle": { "id": "281474990577720", "externalIds": {} },
  "nfcCardScan": {
    "card": { "id": "835063" }
  }
}

Engine Diagnostics

Ambient Air Temp
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "ambientAirTemperatureMilliC": {
    "time": "2024-08-28T20:00:40Z",
    "value": 736094
  }
}
Barometric Pressure
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "barometricPressurePa": {
    "time": "2024-08-21T22:24:24Z",
    "value": 7000
  }
}
Engine Coolant Temp
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "engineCoolantTemperatureMilliC": {
    "time": "2024-08-28T20:04:40Z",
    "value": 185000
  }
}
Engine Oil Pressure
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "engineOilPressureKPa": {
    "time": "2024-08-21T22:24:24Z",
    "value": 56
  }
}
Intake Manifold Temp
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "intakeManifoldTemperatureMilliC": {
    "time": "2024-08-21T22:24:32Z",
    "value": 0
  }
}

Engine Immobilizer

Immobilizer State
{
  "vehicle": { "id": "281474991956423", "externalIds": {} },
  "engineImmobilizer": {
    "connected": false,
    "state": "ignition_enabled",
    "time": "2024-08-20T19:36:47Z"
  }
}

Engine Metrics

Engine Hours (ECU)
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "obdEngineSeconds": {
    "time": "2024-08-28T20:49:49Z",
    "value": 22931460
  }
}
Engine Hours (Synthetic) Engine Load Percent
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "engineLoadPercent": {
    "time": "2024-08-21T22:24:24Z",
    "value": 50
  }
}
Engine RPM
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "engineRpm": {
    "time": "2024-08-21T22:24:24Z",
    "value": 6038
  }
}

Engine States

{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "engineStates": {
    "time": "2024-08-21T22:24:32Z",
    "value": "Off"
  }
}

EV Battery Diagnostics

Battery Avg. Temp (EV)
{
  "vehicle": { "id": "281474990577720", "externalIds": {} },
  "evAverageBatteryTemperatureMilliCelsius": {
    "time": "2020-01-27T07:06:25Z",
    "value": 1000
  }
}
Battery Charging Current (EV)
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "evChargingCurrentMilliAmp": {
    "time": "2024-08-21T19:34:40Z",
    "value": 0
  }
}
Battery Charging Energy (EV)
{
  "vehicle": { "id": "281474991956423", "externalIds": {} },
  "batteryMilliVolts": {
    "time": "2024-08-27T22:48:47Z",
    "value": 9889
  }
}
Battery Charging Status (EV)
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "evChargingStatus": {
    "time": "2024-08-21T22:24:32Z",
    "value": 0
  }
}
Battery Charging Voltage (EV)
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "evChargingVoltageMilliVolt": {
    "time": "2024-08-21T19:34:40Z",
    "value": 0
  }
}
Battery State of Health (EV)
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "evBatteryStateOfHealthMilliPercent": {
    "time": "2024-08-21T22:23:46Z",
    "value": 98800
  }
}
Distance Driven (EV)
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "evDistanceDrivenMeters": {
    "time": "2024-08-21T19:34:44Z",
    "value": 15
  }
}
Regenerated Energy (EV)
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "evRegeneratedEnergyMicroWh": {
    "time": "2024-08-21T22:24:32Z",
    "value": 761502200000
  }
}
Battery Voltage (non-EV)
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "batteryMilliVolts": {
    "time": "2024-08-28T20:40:38Z",
    "value": 11694
  }
}

Exhaust Measures

DEF Level
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "defLevelMilliPercent": {
    "time": "2024-08-21T22:23:15Z",
    "value": 67200
  }
}

Fault Codes

{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "faultCodes": {
    "canBusType": "CANBUS_CAN1_J1939_9PIN_PINS_C_D",
    "j1939": {
      "checkEngineLights": {
        "emissionsIsOn": true,
        "protectIsOn": false,
        "stopIsOn": false,
        "warningIsOn": false
      },
      "diagnosticTroubleCodes": [
        {
          "fmiDescription": "Data Drifted High",
          "fmiId": 20,
          "milStatus": 1,
          "occurrenceCount": 100,
          "sourceAddressName": "Engine #1",
          "spnDescription": "Automatic Gear Shifting Enable Switch",
          "spnId": 1666,
          "txId": 0
        },
        {
          "fmiDescription": "Low—most severe",
          "fmiId": 1,
          "milStatus": 0,
          "occurrenceCount": 50,
          "sourceAddressName": "Suspension - Drive Axle #1",
          "spnDescription": "Aux Valve 0 Retract Port Measured Flow",
          "spnId": 1900,
          "txId": 21
        }
      ]
    },
    "time": "2024-08-21T19:37:12Z"
  }
}

Fuel Levels

{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "fuelPercents": {
    "time": "2024-08-21T22:24:24Z",
    "value": 6
  }
}

Odometer

Odometer meters (OBD)
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "obdOdometerMeters": {
    "time": "2024-08-21T22:24:32Z",
    "value": 2482355
  }
}
Odometer meters (GPS)
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "gpsOdometerMeters": {
    "time": "2024-08-21T22:24:32Z",
    "value": 2482355
  }
}

Seatbelt Statuses

{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "seatbeltDriver": {
    "time": "2024-08-21T22:24:32Z",
    "value": "Unbuckled"
  }
}

Speed

Speed MPH (ECU)
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "ecuSpeedMph": {
    "time": "2024-08-21T22:24:32Z",
    "value": 0
  }
}

Spreader Diagnostics

Spreader Active
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "spreaderActive": {
    "time": "2024-08-15T20:07:16Z",
    "value": "On"
  }
}
Spreader Air Temp
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "spreaderAirTemp": {
    "time": "2024-08-16T19:42:02Z",
    "value": 0
  }
}
Spreader Blast State
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "spreaderBlastState": {
    "time": "2024-08-16T19:42:03Z",
    "value": "Off"
  }
}
Spreader Granular Rate
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "spreaderGranularRate": {
    "time": "2024-08-16T19:42:03Z",
    "value": 0
  }
}
Spreader Liquid Rate
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "spreaderLiquidRate": {
    "time": "2024-08-15T20:10:58Z",
    "value": 0
  }
}
Spreader On State
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "spreaderOnState": {
    "time": "2024-08-28T20:55:59Z",
    "value": "On"
  }
}
Spreader Prewet Name
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "spreaderPrewetName": {
    "time": "2024-08-15T20:07:01Z",
    "value": "PWT"
  }
}
Spreader Prewet Rate
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "spreaderPrewetRate": {
    "time": "2024-08-15T20:10:58Z",
    "value": 28
  }
}

Door Statuses

ECU Door Statuses
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "ecuDoorStatus": {
    "time": "2024-08-15T20:10:58Z",
    "value": "Closed"
  }
}

Temperatures

Spreader Road Temp
{
  "vehicle": { "id": "281474991840886", "externalIds": {} },
  "spreaderRoadTemp": {
    "time": "2024-08-16T19:42:02Z",
    "value": 0
  }
}