Show / Hide Table of Contents

Interface CfnDecoderManifestPropsMixin.ICanSignalProperty

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

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.IoTFleetWise

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface CfnDecoderManifestPropsMixin.ICanSignalProperty

Syntax (vb)

Public Interface CfnDecoderManifestPropsMixin.ICanSignalProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.IoTFleetWise;

             var canSignalProperty = new CanSignalProperty {
                 Factor = "factor",
                 IsBigEndian = "isBigEndian",
                 IsSigned = "isSigned",
                 Length = "length",
                 MessageId = "messageId",
                 Name = "name",
                 Offset = "offset",
                 SignalValueType = "signalValueType",
                 StartBit = "startBit"
             };

Synopsis

Properties

Factor	A multiplier used to decode the CAN message.
IsBigEndian	Whether the byte ordering of a CAN message is big-endian.
IsSigned	Whether the message data is specified as a signed value.
Length	How many bytes of data are in the message.
MessageId	The ID of the message.
Name	The name of the signal.
Offset	The offset used to calculate the signal value.
SignalValueType	The value type of the signal.
StartBit	Indicates the beginning of the CAN message.

Properties

Factor

A multiplier used to decode the CAN message.

string? Factor { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-factor

IsBigEndian

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

string? IsBigEndian { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-isbigendian

IsSigned

Whether the message data is specified as a signed value.

string? IsSigned { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-issigned

Length

How many bytes of data are in the message.

string? Length { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-length

MessageId

The ID of the message.

string? MessageId { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-messageid

Name

The name of the signal.

string? Name { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-name

Offset

The offset used to calculate the signal value.

string? Offset { get; }

Property Value

Remarks

Combined with factor, the calculation is value = raw_value * factor + offset .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-offset

SignalValueType

The value type of the signal.

string? SignalValueType { get; }

Property Value

Remarks

The default value is INTEGER .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-signalvaluetype

StartBit

Indicates the beginning of the CAN message.

string? StartBit { get; }

Property Value

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-cansignal.html#cfn-iotfleetwise-decodermanifest-cansignal-startbit