interface ObdSignalProperty

Language	Type name
.NET	Amazon.CDK.AWS.IoTFleetWise.CfnDecoderManifest.ObdSignalProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsiotfleetwise#CfnDecoderManifest_ObdSignalProperty
Java	software.amazon.awscdk.services.iotfleetwise.CfnDecoderManifest.ObdSignalProperty
Python	aws_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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html

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',
  isSigned: 'isSigned',
  signalValueType: 'signalValueType',
};

Properties

Name	Type	Description
byteLength	string	The length of a message.
offset	string	The offset used to calculate the signal value.
pid	string	The diagnostic code used to request data from a vehicle for this signal.
pidResponseLength	string	The length of the requested data.
scaling	string	A multiplier used to decode the message.
serviceMode	string	The mode of operation (diagnostic service) in a message.
startByte	string	Indicates the beginning of the message.
bitMaskLength?	string	The number of bits to mask in a message.
bitRightShift?	string	The number of positions to shift bits in the message.
isSigned?	string | boolean | IResolvable
signalValueType?	string

---

byteLength

Type: string

The length of a message.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-bytelength

---

offset

Type: string

The offset used to calculate the signal value.

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-offset

---

pid

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-pid

---

pidResponseLength

Type: string

The length of the requested data.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-pidresponselength

---

scaling

Type: string

A multiplier used to decode the message.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-scaling

---

serviceMode

Type: string

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-servicemode

---

startByte

Type: string

Indicates the beginning of the message.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-startbyte

---

bitMaskLength?

Type: string (optional)

The number of bits to mask in a message.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-bitmasklength

---

bitRightShift?

Type: string (optional)

The number of positions to shift bits in the message.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-bitrightshift

---

isSigned?

Type: string | boolean | IResolvable (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-issigned

---

signalValueType?

Type: string (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-obdsignal.html#cfn-iotfleetwise-decodermanifest-obdsignal-signalvaluetype