SignalDecoders

SignalDecoders schema

AutomotiveConnected VehiclesIoTTelematicsVehicle Data
View JSON Schema on GitHub

JSON Schema

iot-fleetwise-signal-decoders-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-signal-decoders-schema.json",
  "title": "SignalDecoders",
  "description": "SignalDecoders schema",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "fullyQualifiedName",
      "type",
      "interfaceId"
    ],
    "properties": {
      "fullyQualifiedName": {
        "allOf": [
          {
            "$ref": "#/components/schemas/FullyQualifiedName"
          },
          {
            "description": "The fully qualified name of a signal decoder as defined in a vehicle model."
          }
        ]
      },
      "type": {
        "allOf": [
          {
            "$ref": "#/components/schemas/SignalDecoderType"
          },
          {
            "description": "The network protocol for the vehicle. For example, <code>CAN_SIGNAL</code> specifies a protocol that defines how data is communicated between electronic control units (ECUs). <code>OBD_SIGNAL</code> specifies a protocol that defines how self-diagnostic data is communicated between ECUs."
          }
        ]
      },
      "interfaceId": {
        "allOf": [
          {
            "$ref": "#/components/schemas/InterfaceId"
          },
          {
            "description": "The ID of a network interface that specifies what network protocol a vehicle follows."
          }
        ]
      },
      "canSignal": {
        "allOf": [
          {
            "$ref": "#/components/schemas/CanSignal"
          },
          {
            "description": "Information about signal decoder using the Controller Area Network (CAN) protocol."
          }
        ]
      },
      "obdSignal": {
        "allOf": [
          {
            "$ref": "#/components/schemas/ObdSignal"
          },
          {
            "description": "Information about signal decoder using the On-board diagnostic (OBD) II protocol."
          }
        ]
      }
    },
    "description": "Information about a signal decoder."
  }
}