Class: Aws::IoTFleetWise::Types::Sensor

Inherits:

Struct

• Object
• Struct
• Aws::IoTFleetWise::Types::Sensor

Includes:

Structure

Defined in:

lib/aws-sdk-iotfleetwise/types.rb

Overview

An input component that reports the environmental condition of a vehicle.

<note markdown=“1”> You can collect data about fluid levels, temperatures, vibrations, or battery voltage from sensors.

</note>

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allowed_values ⇒ Array<String>

  A list of possible values a sensor can take.

• #comment ⇒ String

  A comment in addition to the description.

• #data_type ⇒ String

  The specified data type of the sensor.

• #deprecation_message ⇒ String

  The deprecation message for the node or the branch that was moved or deleted.

• #description ⇒ String

  A brief description of a sensor.

• #fully_qualified_name ⇒ String

  The fully qualified name of the sensor.

• #max ⇒ Float

  The specified possible maximum value of the sensor.

• #min ⇒ Float

  The specified possible minimum value of the sensor.

• #struct_fully_qualified_name ⇒ String

  The fully qualified name of the struct node for a sensor if the data type of the actuator is ‘Struct` or `StructArray`.

• #unit ⇒ String

  The scientific unit of measurement for data collected by the sensor.

Instance Attribute Details

#allowed_values ⇒ Array<String>

A list of possible values a sensor can take.

Returns:

• (Array<String>)

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

class Sensor < Struct.new(
  :fully_qualified_name,
  :data_type,
  :description,
  :unit,
  :allowed_values,
  :min,
  :max,
  :deprecation_message,
  :comment,
  :struct_fully_qualified_name)
  SENSITIVE = []
  include Aws::Structure
end

#comment ⇒ String

A comment in addition to the description.

Returns:

• (String)

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

class Sensor < Struct.new(
  :fully_qualified_name,
  :data_type,
  :description,
  :unit,
  :allowed_values,
  :min,
  :max,
  :deprecation_message,
  :comment,
  :struct_fully_qualified_name)
  SENSITIVE = []
  include Aws::Structure
end

#data_type ⇒ String

The specified data type of the sensor.

Returns:

• (String)

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

class Sensor < Struct.new(
  :fully_qualified_name,
  :data_type,
  :description,
  :unit,
  :allowed_values,
  :min,
  :max,
  :deprecation_message,
  :comment,
  :struct_fully_qualified_name)
  SENSITIVE = []
  include Aws::Structure
end

#deprecation_message ⇒ String

The deprecation message for the node or the branch that was moved or deleted.

Returns:

• (String)

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

class Sensor < Struct.new(
  :fully_qualified_name,
  :data_type,
  :description,
  :unit,
  :allowed_values,
  :min,
  :max,
  :deprecation_message,
  :comment,
  :struct_fully_qualified_name)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A brief description of a sensor.

Returns:

• (String)

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

class Sensor < Struct.new(
  :fully_qualified_name,
  :data_type,
  :description,
  :unit,
  :allowed_values,
  :min,
  :max,
  :deprecation_message,
  :comment,
  :struct_fully_qualified_name)
  SENSITIVE = []
  include Aws::Structure
end

#fully_qualified_name ⇒ String

The fully qualified name of the sensor. For example, the fully qualified name of a sensor might be ‘Vehicle.Body.Engine.Battery`.

Returns:

• (String)

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

class Sensor < Struct.new(
  :fully_qualified_name,
  :data_type,
  :description,
  :unit,
  :allowed_values,
  :min,
  :max,
  :deprecation_message,
  :comment,
  :struct_fully_qualified_name)
  SENSITIVE = []
  include Aws::Structure
end

#max ⇒ Float

The specified possible maximum value of the sensor.

Returns:

• (Float)

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

class Sensor < Struct.new(
  :fully_qualified_name,
  :data_type,
  :description,
  :unit,
  :allowed_values,
  :min,
  :max,
  :deprecation_message,
  :comment,
  :struct_fully_qualified_name)
  SENSITIVE = []
  include Aws::Structure
end

#min ⇒ Float

The specified possible minimum value of the sensor.

Returns:

• (Float)

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

class Sensor < Struct.new(
  :fully_qualified_name,
  :data_type,
  :description,
  :unit,
  :allowed_values,
  :min,
  :max,
  :deprecation_message,
  :comment,
  :struct_fully_qualified_name)
  SENSITIVE = []
  include Aws::Structure
end

#struct_fully_qualified_name ⇒ String

The fully qualified name of the struct node for a sensor if the data type of the actuator is ‘Struct` or `StructArray`. For example, the struct fully qualified name of a sensor might be `Vehicle.ADAS.CameraStruct`.

Returns:

• (String)

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

class Sensor < Struct.new(
  :fully_qualified_name,
  :data_type,
  :description,
  :unit,
  :allowed_values,
  :min,
  :max,
  :deprecation_message,
  :comment,
  :struct_fully_qualified_name)
  SENSITIVE = []
  include Aws::Structure
end

#unit ⇒ String

The scientific unit of measurement for data collected by the sensor.

Returns:

• (String)

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

class Sensor < Struct.new(
  :fully_qualified_name,
  :data_type,
  :description,
  :unit,
  :allowed_values,
  :min,
  :max,
  :deprecation_message,
  :comment,
  :struct_fully_qualified_name)
  SENSITIVE = []
  include Aws::Structure
end