CanSignal - AWS IoT FleetWise

CanSignal

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

Contents

factor

A multiplier used to decode the CAN message.

Type: Double

Required: Yes

isBigEndian

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

Type: Boolean

Required: Yes

isSigned

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.

Type: Boolean

Required: Yes

length

How many bytes of data are in the message.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

messageId

The ID of the message.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

offset

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

Type: Double

Required: Yes

startBit

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.

Type: Integer

Valid Range: Minimum value of 0.

Required: Yes

name

The name of the signal.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

signalValueType

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

Type: String

Valid Values: INTEGER | FLOATING_POINT

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: