Class: Aws::IoTFleetWise::Types::CanSignal

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-iotfleetwise/types.rb

Overview

Information about a single controller area network (CAN) signal and the messages it receives and transmits.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#factorFloat

A multiplier used to decode the CAN message.

Returns:

  • (Float)


423
424
425
426
427
428
429
430
431
432
433
434
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 423

class CanSignal < Struct.new(
  :message_id,
  :is_big_endian,
  :is_signed,
  :start_bit,
  :offset,
  :factor,
  :length,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#is_big_endianBoolean

Whether the byte ordering of a CAN message is big-endian.

Returns:

  • (Boolean)


423
424
425
426
427
428
429
430
431
432
433
434
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 423

class CanSignal < Struct.new(
  :message_id,
  :is_big_endian,
  :is_signed,
  :start_bit,
  :offset,
  :factor,
  :length,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#is_signedBoolean

Whether the message data is specified as a signed value.

Returns:

  • (Boolean)


423
424
425
426
427
428
429
430
431
432
433
434
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 423

class CanSignal < Struct.new(
  :message_id,
  :is_big_endian,
  :is_signed,
  :start_bit,
  :offset,
  :factor,
  :length,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#lengthInteger

How many bytes of data are in the message.

Returns:

  • (Integer)


423
424
425
426
427
428
429
430
431
432
433
434
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 423

class CanSignal < Struct.new(
  :message_id,
  :is_big_endian,
  :is_signed,
  :start_bit,
  :offset,
  :factor,
  :length,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#message_idInteger

The ID of the message.

Returns:

  • (Integer)


423
424
425
426
427
428
429
430
431
432
433
434
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 423

class CanSignal < Struct.new(
  :message_id,
  :is_big_endian,
  :is_signed,
  :start_bit,
  :offset,
  :factor,
  :length,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the signal.

Returns:

  • (String)


423
424
425
426
427
428
429
430
431
432
433
434
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 423

class CanSignal < Struct.new(
  :message_id,
  :is_big_endian,
  :is_signed,
  :start_bit,
  :offset,
  :factor,
  :length,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#offsetFloat

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

Returns:

  • (Float)


423
424
425
426
427
428
429
430
431
432
433
434
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 423

class CanSignal < Struct.new(
  :message_id,
  :is_big_endian,
  :is_signed,
  :start_bit,
  :offset,
  :factor,
  :length,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#start_bitInteger

Indicates the beginning of the CAN signal. This should always be the least significant bit (LSB).

This value might be different from the value in a DBC file. For little endian signals, ‘startBit` is the same value as in the DBC file. For big endian signals in a DBC file, the start bit is the most significant bit (MSB). You will have to calculate the LSB instead and pass it as the `startBit`.

Returns:

  • (Integer)


423
424
425
426
427
428
429
430
431
432
433
434
# File 'lib/aws-sdk-iotfleetwise/types.rb', line 423

class CanSignal < Struct.new(
  :message_id,
  :is_big_endian,
  :is_signed,
  :start_bit,
  :offset,
  :factor,
  :length,
  :name)
  SENSITIVE = []
  include Aws::Structure
end