Create and manage decoder manifests - AWS IoT FleetWise

Create and manage decoder manifests

Decoder manifests contain decoding information that AWS IoT FleetWise uses to transform vehicle data (binary data) into human-readable values and to prepare your data for data analyses. Network interface and decoder signals are the core components that you work with to configure decoder manifests.

Network interface

Contains information about the protocol that the in-vehicle network uses. AWS IoT FleetWise supports the following protocols.

Controller Area Network (CAN bus)

A protocol that defines how data is communicated between electronic control units (ECUs). ECUs can be the engine control unit, airbags, or the audio system.

On-board diagnostic (OBD) II

A further developed protocol that defines how self-diagnostic data is communicated between ECUs. It provides a number of standard diagnostic trouble codes (DTCs) that help identify what is wrong with your vehicle.

Vehicle middleware

The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include Robot Operating System (ROS 2) and Scalable service-Oriented MiddlewarE over IP (SOME/IP).

Note

AWS IoT FleetWise supports ROS 2 middleware for vision system data.

Decoder signal

Provides detailed decoding information for a specific signal. Every signal specified in the vehicle model must be paired with a decoder signal. If the decoder manifest contains CAN network interfaces, it must contain CAN decoder signals. If the decoder manifest contains OBD network interfaces, it must contain OBD decoder signals.

The decoder manifest must contain message decoder signals if it also contains vehicle middleware interfaces.

Each decoder manifest must be associated with a vehicle model. AWS IoT FleetWise uses the associated decoder manifest to decode data from vehicles created based on the vehicle model.

Each decoder manifest has a status field that contains the state of the decoder manifest. The state can be one of the following values:

  • ACTIVE – The decoder manifest is active.

  • DRAFT – The configuration of the decoder manifest isn't saved.

  • VALIDATING – The decoder manifest is under validation for its eligibility. This only applies to decoder manifests that contain at least one vision system data signal.

  • INVALID – The decoder manifest failed validation and can't be activated yet. This only applies to decoder manifests that contain at least one vision system data signal. You can use the ListDecoderManifests and GetDecoderManifest APIs to check the reason for a failed validation.

Important
  • If you use the AWS IoT FleetWise console to create a decoder manifest, AWS IoT FleetWise automatically activates the decoder manifest for you.

  • If you use the CreateDecoderManifest API operation to create a decoder manifest, the decoder manifest stays in the DRAFT state.

  • You can't create vehicles from vehicle models that are associated with a DRAFT decoder manifest. Use the UpdateDecoderManifest API operation to change the decoder manifest to the ACTIVE state.

  • You can't edit decoder manifests that are in the ACTIVE state.