ObdInterface

A network interface that specifies the On-board diagnostic (OBD) II network protocol.

AutomotiveConnected VehiclesIoTTelematicsVehicle Data

Properties

Name Type Description
name object
requestMessageId object
obdStandard object
pidRequestIntervalSeconds object
dtcRequestIntervalSeconds object
useExtendedIds object
hasTransmissionEcu object
View JSON Schema on GitHub

JSON Schema

iot-fleetwise-obd-interface-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-fleetwise/refs/heads/main/json-schema/iot-fleetwise-obd-interface-schema.json",
  "title": "ObdInterface",
  "description": "A network interface that specifies the On-board diagnostic (OBD) II network protocol.",
  "type": "object",
  "properties": {
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ObdInterfaceName"
        },
        {
          "description": "The name of the interface."
        }
      ]
    },
    "requestMessageId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/nonNegativeInteger"
        },
        {
          "description": "The ID of the message requesting vehicle data."
        }
      ]
    },
    "obdStandard": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ObdStandard"
        },
        {
          "description": "The standard OBD II PID."
        }
      ]
    },
    "pidRequestIntervalSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/nonNegativeInteger"
        },
        {
          "description": "The maximum number message requests per second."
        }
      ]
    },
    "dtcRequestIntervalSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/nonNegativeInteger"
        },
        {
          "description": "The maximum number message requests per diagnostic trouble code per second."
        }
      ]
    },
    "useExtendedIds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/boolean"
        },
        {
          "description": "Whether to use extended IDs in the message."
        }
      ]
    },
    "hasTransmissionEcu": {
      "allOf": [
        {
          "$ref": "#/components/schemas/boolean"
        },
        {
          "description": "Whether the vehicle has a transmission control module (TCM)."
        }
      ]
    }
  },
  "required": [
    "name",
    "requestMessageId"
  ]
}