Class: Aws::IoTFleetWise::Types::ObdSignal

Inherits:

Struct

• Object
• Struct
• Aws::IoTFleetWise::Types::ObdSignal

Defined in:

gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb

Overview

Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #bit_mask_length ⇒ Integer

  The number of bits to mask in a message.

• #bit_right_shift ⇒ Integer

  The number of positions to shift bits in the message.

• #byte_length ⇒ Integer

  The length of a message.

• #is_signed ⇒ Boolean

  Determines whether the message is signed (true) or not (false).

• #offset ⇒ Float

  The offset used to calculate the signal value.

• #pid ⇒ Integer

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

• #pid_response_length ⇒ Integer

  The length of the requested data.

• #scaling ⇒ Float

  A multiplier used to decode the message.

• #service_mode ⇒ Integer

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

• #signal_value_type ⇒ String

  The value type of the signal.

• #start_byte ⇒ Integer

  Indicates the beginning of the message.

Instance Attribute Details

#bit_mask_length ⇒ Integer

The number of bits to mask in a message.

Returns:

• (Integer)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3723

class ObdSignal < Struct.new(
  :pid_response_length,
  :service_mode,
  :pid,
  :scaling,
  :offset,
  :start_byte,
  :byte_length,
  :bit_right_shift,
  :bit_mask_length,
  :is_signed,
  :signal_value_type)
  SENSITIVE = []
  include Aws::Structure
end

#bit_right_shift ⇒ Integer

The number of positions to shift bits in the message.

Returns:

• (Integer)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3723

class ObdSignal < Struct.new(
  :pid_response_length,
  :service_mode,
  :pid,
  :scaling,
  :offset,
  :start_byte,
  :byte_length,
  :bit_right_shift,
  :bit_mask_length,
  :is_signed,
  :signal_value_type)
  SENSITIVE = []
  include Aws::Structure
end

#byte_length ⇒ Integer

The length of a message.

Returns:

• (Integer)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3723

class ObdSignal < Struct.new(
  :pid_response_length,
  :service_mode,
  :pid,
  :scaling,
  :offset,
  :start_byte,
  :byte_length,
  :bit_right_shift,
  :bit_mask_length,
  :is_signed,
  :signal_value_type)
  SENSITIVE = []
  include Aws::Structure
end

#is_signed ⇒ Boolean

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:

• (Boolean)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3723

class ObdSignal < Struct.new(
  :pid_response_length,
  :service_mode,
  :pid,
  :scaling,
  :offset,
  :start_byte,
  :byte_length,
  :bit_right_shift,
  :bit_mask_length,
  :is_signed,
  :signal_value_type)
  SENSITIVE = []
  include Aws::Structure
end

#offset ⇒ Float

The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset.

Returns:

• (Float)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3723

class ObdSignal < Struct.new(
  :pid_response_length,
  :service_mode,
  :pid,
  :scaling,
  :offset,
  :start_byte,
  :byte_length,
  :bit_right_shift,
  :bit_mask_length,
  :is_signed,
  :signal_value_type)
  SENSITIVE = []
  include Aws::Structure
end

#pid ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3723

class ObdSignal < Struct.new(
  :pid_response_length,
  :service_mode,
  :pid,
  :scaling,
  :offset,
  :start_byte,
  :byte_length,
  :bit_right_shift,
  :bit_mask_length,
  :is_signed,
  :signal_value_type)
  SENSITIVE = []
  include Aws::Structure
end

#pid_response_length ⇒ Integer

The length of the requested data.

Returns:

• (Integer)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3723

class ObdSignal < Struct.new(
  :pid_response_length,
  :service_mode,
  :pid,
  :scaling,
  :offset,
  :start_byte,
  :byte_length,
  :bit_right_shift,
  :bit_mask_length,
  :is_signed,
  :signal_value_type)
  SENSITIVE = []
  include Aws::Structure
end

#scaling ⇒ Float

A multiplier used to decode the message.

Returns:

• (Float)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3723

class ObdSignal < Struct.new(
  :pid_response_length,
  :service_mode,
  :pid,
  :scaling,
  :offset,
  :start_byte,
  :byte_length,
  :bit_right_shift,
  :bit_mask_length,
  :is_signed,
  :signal_value_type)
  SENSITIVE = []
  include Aws::Structure
end

#service_mode ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3723

class ObdSignal < Struct.new(
  :pid_response_length,
  :service_mode,
  :pid,
  :scaling,
  :offset,
  :start_byte,
  :byte_length,
  :bit_right_shift,
  :bit_mask_length,
  :is_signed,
  :signal_value_type)
  SENSITIVE = []
  include Aws::Structure
end

#signal_value_type ⇒ String

The value type of the signal. The default value is INTEGER.

Returns:

• (String)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3723

class ObdSignal < Struct.new(
  :pid_response_length,
  :service_mode,
  :pid,
  :scaling,
  :offset,
  :start_byte,
  :byte_length,
  :bit_right_shift,
  :bit_mask_length,
  :is_signed,
  :signal_value_type)
  SENSITIVE = []
  include Aws::Structure
end

#start_byte ⇒ Integer

Indicates the beginning of the message.

Returns:

• (Integer)

# File 'gems/aws-sdk-iotfleetwise/lib/aws-sdk-iotfleetwise/types.rb', line 3723

class ObdSignal < Struct.new(
  :pid_response_length,
  :service_mode,
  :pid,
  :scaling,
  :offset,
  :start_byte,
  :byte_length,
  :bit_right_shift,
  :bit_mask_length,
  :is_signed,
  :signal_value_type)
  SENSITIVE = []
  include Aws::Structure
end