aws-cdk-lib.aws_iotfleetwise.CfnDecoderManifest.ObdSignalProperty

interface ObdSignalProperty

LanguageType name
.NETAmazon.CDK.AWS.IoTFleetWise.CfnDecoderManifest.ObdSignalProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiotfleetwise#CfnDecoderManifest_ObdSignalProperty
Javasoftware.amazon.awscdk.services.iotfleetwise.CfnDecoderManifest.ObdSignalProperty
Pythonaws_cdk.aws_iotfleetwise.CfnDecoderManifest.ObdSignalProperty
TypeScript aws-cdk-lib » aws_iotfleetwise » CfnDecoderManifest » ObdSignalProperty

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotfleetwise as iotfleetwise } from 'aws-cdk-lib';
const obdSignalProperty: iotfleetwise.CfnDecoderManifest.ObdSignalProperty = {
  byteLength: 'byteLength',
  offset: 'offset',
  pid: 'pid',
  pidResponseLength: 'pidResponseLength',
  scaling: 'scaling',
  serviceMode: 'serviceMode',
  startByte: 'startByte',

  // the properties below are optional
  bitMaskLength: 'bitMaskLength',
  bitRightShift: 'bitRightShift',
};

Properties

NameTypeDescription
byteLengthstringThe length of a message.
offsetstringThe offset used to calculate the signal value.
pidstringThe diagnostic code used to request data from a vehicle for this signal.
pidResponseLengthstringThe length of the requested data.
scalingstringA multiplier used to decode the message.
serviceModestringThe mode of operation (diagnostic service) in a message.
startBytestringIndicates the beginning of the message.
bitMaskLength?string(Optional) The number of bits to mask in a message.
bitRightShift?string(Optional) The number of positions to shift bits in the message.

byteLength

Type: string

The length of a message.


offset

Type: string

The offset used to calculate the signal value.

Combined with scaling, the calculation is value = raw_value * scaling + offset .


pid

Type: string

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


pidResponseLength

Type: string

The length of the requested data.


scaling

Type: string

A multiplier used to decode the message.


serviceMode

Type: string

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


startByte

Type: string

Indicates the beginning of the message.


bitMaskLength?

Type: string (optional)

(Optional) The number of bits to mask in a message.


bitRightShift?

Type: string (optional)

(Optional) The number of positions to shift bits in the message.