Interface CfnDecoderManifest.ObdSignalProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnDecoderManifest.ObdSignalProperty extends
Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 ObdSignalProperty obdSignalProperty = ObdSignalProperty.builder()
         // the properties below are optional
  • Method Details

    • getByteLength

      @Stability(Stable) @NotNull String getByteLength()
      The length of a message.
    • 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 .

    • getPid

      @Stability(Stable) @NotNull String getPid()
      The diagnostic code used to request data from a vehicle for this signal.
    • getPidResponseLength

      @Stability(Stable) @NotNull String getPidResponseLength()
      The length of the requested data.
    • getScaling

      @Stability(Stable) @NotNull String getScaling()
      A multiplier used to decode the message.
    • getServiceMode

      @Stability(Stable) @NotNull String getServiceMode()
      The mode of operation (diagnostic service) in a message.
    • getStartByte

      @Stability(Stable) @NotNull String getStartByte()
      Indicates the beginning of the message.
    • getBitMaskLength

      @Stability(Stable) @Nullable default String getBitMaskLength()
      (Optional) The number of bits to mask in a message.
    • getBitRightShift

      @Stability(Stable) @Nullable default String getBitRightShift()
      (Optional) The number of positions to shift bits in the message.
    • builder

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