AWS::IoTFleetWise::DecoderManifest ObdSignal

Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "BitMaskLength" : String,
  "BitRightShift" : String,
  "ByteLength" : String,
  "IsSigned" : String,
  "Offset" : String,
  "Pid" : String,
  "PidResponseLength" : String,
  "Scaling" : String,
  "ServiceMode" : String,
  "SignalValueType" : String,
  "StartByte" : String
}

YAML

  BitMaskLength: String
  BitRightShift: String
  ByteLength: String
  IsSigned: String
  Offset: String
  Pid: String
  PidResponseLength: String
  Scaling: String
  ServiceMode: String
  SignalValueType: String
  StartByte: String

Properties

BitMaskLength

The number of bits to mask in a message.

Required: No

Type: String

Minimum: 1

Maximum: 8

Update requires: No interruption

BitRightShift

The number of positions to shift bits in the message.

Required: No

Type: String

Minimum: 0

Update requires: No interruption

ByteLength

The length of a message.

Required: Yes

Type: String

Minimum: 1

Maximum: 8

Update requires: No interruption

IsSigned

Determines whether the message is signed (true) or not (false). If it's signed, the message can represent both positive and negative numbers. The isSigned parameter only applies to the INTEGER raw signal type, and it doesn't affect the FLOATING_POINT raw signal type. The default value is false.

Required: No

Type: String

Update requires: No interruption

Offset

The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.

Required: Yes

Type: String

Update requires: No interruption

Pid

The diagnostic code used to request data from a vehicle for this signal.

Required: Yes

Type: String

Minimum: 0

Update requires: No interruption

PidResponseLength

The length of the requested data.

Required: Yes

Type: String

Minimum: 1

Update requires: No interruption

Scaling

A multiplier used to decode the message.

Required: Yes

Type: String

Update requires: No interruption

ServiceMode

The mode of operation (diagnostic service) in a message.

Required: Yes

Type: String

Minimum: 0

Update requires: No interruption

SignalValueType

The value type of the signal. The default value is INTEGER.

Required: No

Type: String

Allowed values: INTEGER | FLOATING_POINT

Update requires: No interruption

StartByte

Indicates the beginning of the message.

Required: Yes

Type: String

Minimum: 0

Update requires: No interruption