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") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDecoderManifest.ObdSignalProperty
static final class
An implementation forCfnDecoderManifest.ObdSignalProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The number of bits to mask in a message.default String
The number of positions to shift bits in the message.The length of a message.The offset used to calculate the signal value.getPid()
The diagnostic code used to request data from a vehicle for this signal.The length of the requested data.A multiplier used to decode the message.The mode of operation (diagnostic service) in a message.Indicates the beginning of the message.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getByteLength
The length of a message.- See Also:
-
getOffset
The offset used to calculate the signal value.Combined with scaling, the calculation is
value = raw_value * scaling + offset
.- See Also:
-
getPid
The diagnostic code used to request data from a vehicle for this signal.- See Also:
-
getPidResponseLength
The length of the requested data.- See Also:
-
getScaling
A multiplier used to decode the message.- See Also:
-
getServiceMode
The mode of operation (diagnostic service) in a message.- See Also:
-
getStartByte
Indicates the beginning of the message.- See Also:
-
getBitMaskLength
The number of bits to mask in a message.- See Also:
-
getBitRightShift
The number of positions to shift bits in the message.- See Also:
-
builder
-