Package software.amazon.awscdk.services.iotfleetwise

Interface CfnDecoderManifest.ObdSignalProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDecoderManifest.ObdSignalProperty.Jsii$Proxy

Enclosing class:

CfnDecoderManifest

@Stability(Stable)
public static interface CfnDecoderManifest.ObdSignalProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.iotfleetwise.*;
 ObdSignalProperty obdSignalProperty = ObdSignalProperty.builder()
         .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")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDecoderManifest.ObdSignalProperty.Builder	A builder for CfnDecoderManifest.ObdSignalProperty
static final class	CfnDecoderManifest.ObdSignalProperty.Jsii$Proxy	An implementation for CfnDecoderManifest.ObdSignalProperty

Method Summary

Modifier and Type	Method	Description
static CfnDecoderManifest.ObdSignalProperty.Builder	builder()
default String	getBitMaskLength()	The number of bits to mask in a message.
default String	getBitRightShift()	The number of positions to shift bits in the message.
String	getByteLength()	The length of a message.
default Object	getIsSigned()	Determines whether the message is signed ( true ) or not ( false ).
String	getOffset()	The offset used to calculate the signal value.
String	getPid()	The diagnostic code used to request data from a vehicle for this signal.
String	getPidResponseLength()	The length of the requested data.
String	getScaling()	A multiplier used to decode the message.
String	getServiceMode()	The mode of operation (diagnostic service) in a message.
default String	getSignalValueType()	The value type of the signal.
String	getStartByte()	Indicates the beginning of the message.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getByteLength

@Stability(Stable)
@NotNull
String getByteLength()

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

getOffset

@Stability(Stable)
@NotNull
String getOffset()

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

getPid

@Stability(Stable)
@NotNull
String getPid()

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

getPidResponseLength

@Stability(Stable)
@NotNull
String getPidResponseLength()

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

getScaling

@Stability(Stable)
@NotNull
String getScaling()

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

getServiceMode

@Stability(Stable)
@NotNull
String getServiceMode()

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

getStartByte

@Stability(Stable)
@NotNull
String getStartByte()

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

getBitMaskLength

@Stability(Stable)
@Nullable
default String getBitMaskLength()

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

getBitRightShift

@Stability(Stable)
@Nullable
default String getBitRightShift()

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

getIsSigned

@Stability(Stable)
@Nullable
default Object getIsSigned()

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 .

Returns union: either String or Boolean or IResolvable

See Also:

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

getSignalValueType

@Stability(Stable)
@Nullable
default String getSignalValueType()

The value type of the signal.

The default value is INTEGER .

See Also:

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

builder

@Stability(Stable)
static CfnDecoderManifest.ObdSignalProperty.Builder builder()

Returns:

a CfnDecoderManifest.ObdSignalProperty.Builder of CfnDecoderManifest.ObdSignalProperty