interface ObdSignalProperty

Language	Type name
.NET	`Amazon.CDK.Mixins.Preview.AWS.IoTFleetWise.Mixins.CfnDecoderManifestPropsMixin.ObdSignalProperty`
Go	`github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiotfleetwise/mixins#CfnDecoderManifestPropsMixin_ObdSignalProperty`
Java	`software.amazon.awscdk.mixins.preview.services.iotfleetwise.mixins.CfnDecoderManifestPropsMixin.ObdSignalProperty`
Python	`aws_cdk.mixins_preview.aws_iotfleetwise.mixins.CfnDecoderManifestPropsMixin.ObdSignalProperty`
TypeScript	`@aws-cdk/mixins-preview` » `aws_iotfleetwise` » `mixins` » `CfnDecoderManifestPropsMixin` » `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 { mixins as iotfleetwise_mixins } from '@aws-cdk/mixins-preview/aws-iotfleetwise';
const obdSignalProperty: iotfleetwise_mixins.CfnDecoderManifestPropsMixin.ObdSignalProperty = {
  bitMaskLength: 'bitMaskLength',
  bitRightShift: 'bitRightShift',
  byteLength: 'byteLength',
  isSigned: 'isSigned',
  offset: 'offset',
  pid: 'pid',
  pidResponseLength: 'pidResponseLength',
  scaling: 'scaling',
  serviceMode: 'serviceMode',
  signalValueType: 'signalValueType',
  startByte: 'startByte',
};

Properties

Name	Type	Description
bitMaskLength?	`string`	The number of bits to mask in a message.
bitRightShift?	`string`	The number of positions to shift bits in the message.
byteLength?	`string`	The length of a message.
isSigned?	`string \| boolean \|` `IResolvable`	Determines whether the message is signed ( `true` ) or not ( `false` ).
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.
signalValueType?	`string`	The value type of the signal.
startByte?	`string`	Indicates the beginning of the message.

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

byteLength?

Type: string (optional)

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

isSigned?

Type: string | boolean | IResolvable (optional)

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 .

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