CfnDecoderManifestPropsMixin

class aws_cdk.mixins_preview.aws_iotfleetwise.mixins.CfnDecoderManifestPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates the decoder manifest associated with a model manifest. To create a decoder manifest, the following must be true:.

Every signal decoder has a unique name.
Each signal decoder is associated with a network interface.
Each network interface has a unique ID.
The signal decoders are specified in the model manifest.

For more information, see Decoder manifests in the AWS IoT FleetWise Developer Guide . .. epigraph:

Access to certain AWS IoT FleetWise features is currently gated. For more information, see `AWS Region and feature availability <https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html>`_ in the *AWS IoT FleetWise Developer Guide* .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-decodermanifest.html
CloudformationResource:: AWS::IoTFleetWise::DecoderManifest
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

cfn_decoder_manifest_props_mixin = iotfleetwise_mixins.CfnDecoderManifestPropsMixin(iotfleetwise_mixins.CfnDecoderManifestMixinProps(
    default_for_unmapped_signals="defaultForUnmappedSignals",
    description="description",
    model_manifest_arn="modelManifestArn",
    name="name",
    network_interfaces=[iotfleetwise_mixins.CfnDecoderManifestPropsMixin.NetworkInterfacesItemsProperty(
        can_interface=iotfleetwise_mixins.CfnDecoderManifestPropsMixin.CanInterfaceProperty(
            name="name",
            protocol_name="protocolName",
            protocol_version="protocolVersion"
        ),
        interface_id="interfaceId",
        obd_interface=iotfleetwise_mixins.CfnDecoderManifestPropsMixin.ObdInterfaceProperty(
            dtc_request_interval_seconds="dtcRequestIntervalSeconds",
            has_transmission_ecu="hasTransmissionEcu",
            name="name",
            obd_standard="obdStandard",
            pid_request_interval_seconds="pidRequestIntervalSeconds",
            request_message_id="requestMessageId",
            use_extended_ids="useExtendedIds"
        ),
        type="type"
    )],
    signal_decoders=[iotfleetwise_mixins.CfnDecoderManifestPropsMixin.SignalDecodersItemsProperty(
        can_signal=iotfleetwise_mixins.CfnDecoderManifestPropsMixin.CanSignalProperty(
            factor="factor",
            is_big_endian="isBigEndian",
            is_signed="isSigned",
            length="length",
            message_id="messageId",
            name="name",
            offset="offset",
            signal_value_type="signalValueType",
            start_bit="startBit"
        ),
        fully_qualified_name="fullyQualifiedName",
        interface_id="interfaceId",
        obd_signal=iotfleetwise_mixins.CfnDecoderManifestPropsMixin.ObdSignalProperty(
            bit_mask_length="bitMaskLength",
            bit_right_shift="bitRightShift",
            byte_length="byteLength",
            is_signed="isSigned",
            offset="offset",
            pid="pid",
            pid_response_length="pidResponseLength",
            scaling="scaling",
            service_mode="serviceMode",
            signal_value_type="signalValueType",
            start_byte="startByte"
        ),
        type="type"
    )],
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IoTFleetWise::DecoderManifest.

Parameters:

props (Union[CfnDecoderManifestMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['defaultForUnmappedSignals', 'description', 'modelManifestArn', 'name', 'networkInterfaces', 'signalDecoders', 'status', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CanInterfaceProperty

class CfnDecoderManifestPropsMixin.CanInterfaceProperty(*, name=None, protocol_name=None, protocol_version=None)

Bases: object

A single controller area network (CAN) device interface.

Parameters:

name (Optional[str]) – The unique name of the interface.
protocol_name (Optional[str]) – The name of the communication protocol for the interface.
protocol_version (Optional[str]) – The version of the communication protocol for the interface.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

can_interface_property = iotfleetwise_mixins.CfnDecoderManifestPropsMixin.CanInterfaceProperty(
    name="name",
    protocol_name="protocolName",
    protocol_version="protocolVersion"
)

Attributes

name

The unique name of the interface.

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

protocol_name

The name of the communication protocol for the interface.

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

protocol_version

The version of the communication protocol for the interface.

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

CanNetworkInterfaceProperty

class CfnDecoderManifestPropsMixin.CanNetworkInterfaceProperty(*, can_interface=None, interface_id=None, type=None)

Bases: object

Represents a node and its specifications in an in-vehicle communication network.

All signal decoders must be associated with a network node.

To return this information about all the network interfaces specified in a decoder manifest, use the ListDecoderManifestNetworkInterfaces in the AWS IoT FleetWise API Reference .

Parameters:

can_interface (Union[IResolvable, CanInterfaceProperty, Dict[str, Any], None]) – Information about a network interface specified by the Controller Area Network (CAN) protocol.
interface_id (Optional[str]) – The ID of the network interface.
type (Optional[str]) – The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

can_network_interface_property = iotfleetwise_mixins.CfnDecoderManifestPropsMixin.CanNetworkInterfaceProperty(
    can_interface=iotfleetwise_mixins.CfnDecoderManifestPropsMixin.CanInterfaceProperty(
        name="name",
        protocol_name="protocolName",
        protocol_version="protocolVersion"
    ),
    interface_id="interfaceId",
    type="type"
)

Attributes

can_interface

Information about a network interface specified by the Controller Area Network (CAN) protocol.

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

interface_id

The ID of the network interface.

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

type

The network protocol for the vehicle.

For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

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

CanSignalDecoderProperty

class CfnDecoderManifestPropsMixin.CanSignalDecoderProperty(*, can_signal=None, fully_qualified_name=None, interface_id=None, type=None)

Bases: object

Information about signal decoder using the Controller Area Network (CAN) protocol.

Parameters:

can_signal (Union[IResolvable, CanSignalProperty, Dict[str, Any], None]) – Information about a single controller area network (CAN) signal and the messages it receives and transmits.
fully_qualified_name (Optional[str]) – The fully qualified name of a signal decoder as defined in a vehicle model.
interface_id (Optional[str]) – The ID of a network interface that specifies what network protocol a vehicle follows.
type (Optional[str]) – The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

can_signal_decoder_property = iotfleetwise_mixins.CfnDecoderManifestPropsMixin.CanSignalDecoderProperty(
    can_signal=iotfleetwise_mixins.CfnDecoderManifestPropsMixin.CanSignalProperty(
        factor="factor",
        is_big_endian="isBigEndian",
        is_signed="isSigned",
        length="length",
        message_id="messageId",
        name="name",
        offset="offset",
        signal_value_type="signalValueType",
        start_bit="startBit"
    ),
    fully_qualified_name="fullyQualifiedName",
    interface_id="interfaceId",
    type="type"
)

Attributes

can_signal

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

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

fully_qualified_name

The fully qualified name of a signal decoder as defined in a vehicle model.

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

interface_id

The ID of a network interface that specifies what network protocol a vehicle follows.

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

type

The network protocol for the vehicle.

For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

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

CanSignalProperty

class CfnDecoderManifestPropsMixin.CanSignalProperty(*, factor=None, is_big_endian=None, is_signed=None, length=None, message_id=None, name=None, offset=None, signal_value_type=None, start_bit=None)

Bases: object

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

Parameters:

factor (Optional[str]) – A multiplier used to decode the CAN message.
is_big_endian (Optional[str]) – Whether the byte ordering of a CAN message is big-endian.
is_signed (Optional[str]) – Whether the message data is specified as a signed value.
length (Optional[str]) – How many bytes of data are in the message.
message_id (Optional[str]) – The ID of the message.
name (Optional[str]) – The name of the signal.
offset (Optional[str]) – The offset used to calculate the signal value. Combined with factor, the calculation is value = raw_value * factor + offset .
signal_value_type (Optional[str]) – The value type of the signal. The default value is INTEGER .
start_bit (Optional[str]) – Indicates the beginning of the CAN message.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

can_signal_property = iotfleetwise_mixins.CfnDecoderManifestPropsMixin.CanSignalProperty(
    factor="factor",
    is_big_endian="isBigEndian",
    is_signed="isSigned",
    length="length",
    message_id="messageId",
    name="name",
    offset="offset",
    signal_value_type="signalValueType",
    start_bit="startBit"
)

Attributes

factor

A multiplier used to decode the CAN message.

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

is_big_endian

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

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

is_signed

Whether the message data is specified as a signed value.

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.

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

message_id

The ID of the message.

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.

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.

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

signal_value_type

The value type of the signal.

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

start_bit

Indicates the beginning of the CAN message.

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

NetworkInterfacesItemsProperty

class CfnDecoderManifestPropsMixin.NetworkInterfacesItemsProperty(*, can_interface=None, interface_id=None, obd_interface=None, type=None)

Bases: object

A list of information about available network interfaces.

Parameters:

can_interface (Union[IResolvable, CanInterfaceProperty, Dict[str, Any], None])
interface_id (Optional[str])
obd_interface (Union[IResolvable, ObdInterfaceProperty, Dict[str, Any], None])
type (Optional[str])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

network_interfaces_items_property = iotfleetwise_mixins.CfnDecoderManifestPropsMixin.NetworkInterfacesItemsProperty(
    can_interface=iotfleetwise_mixins.CfnDecoderManifestPropsMixin.CanInterfaceProperty(
        name="name",
        protocol_name="protocolName",
        protocol_version="protocolVersion"
    ),
    interface_id="interfaceId",
    obd_interface=iotfleetwise_mixins.CfnDecoderManifestPropsMixin.ObdInterfaceProperty(
        dtc_request_interval_seconds="dtcRequestIntervalSeconds",
        has_transmission_ecu="hasTransmissionEcu",
        name="name",
        obd_standard="obdStandard",
        pid_request_interval_seconds="pidRequestIntervalSeconds",
        request_message_id="requestMessageId",
        use_extended_ids="useExtendedIds"
    ),
    type="type"
)

Attributes

can_interface

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html#cfn-iotfleetwise-decodermanifest-networkinterfacesitems-caninterface

Type:: see

interface_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html#cfn-iotfleetwise-decodermanifest-networkinterfacesitems-interfaceid

Type:: see

obd_interface

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html#cfn-iotfleetwise-decodermanifest-networkinterfacesitems-obdinterface

Type:: see

type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-decodermanifest-networkinterfacesitems.html#cfn-iotfleetwise-decodermanifest-networkinterfacesitems-type

Type:: see

ObdInterfaceProperty

class CfnDecoderManifestPropsMixin.ObdInterfaceProperty(*, dtc_request_interval_seconds=None, has_transmission_ecu=None, name=None, obd_standard=None, pid_request_interval_seconds=None, request_message_id=None, use_extended_ids=None)

Bases: object

A network interface that specifies the On-board diagnostic (OBD) II network protocol.

Parameters:

dtc_request_interval_seconds (Optional[str]) – The maximum number message requests per diagnostic trouble code per second.
has_transmission_ecu (Optional[str]) – Whether the vehicle has a transmission control module (TCM).
name (Optional[str]) – The name of the interface.
obd_standard (Optional[str]) – The standard OBD II PID.
pid_request_interval_seconds (Optional[str]) – The maximum number message requests per second.
request_message_id (Optional[str]) – The ID of the message requesting vehicle data.
use_extended_ids (Optional[str]) – Whether to use extended IDs in the message.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

obd_interface_property = iotfleetwise_mixins.CfnDecoderManifestPropsMixin.ObdInterfaceProperty(
    dtc_request_interval_seconds="dtcRequestIntervalSeconds",
    has_transmission_ecu="hasTransmissionEcu",
    name="name",
    obd_standard="obdStandard",
    pid_request_interval_seconds="pidRequestIntervalSeconds",
    request_message_id="requestMessageId",
    use_extended_ids="useExtendedIds"
)

Attributes

dtc_request_interval_seconds

The maximum number message requests per diagnostic trouble code per second.

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

has_transmission_ecu

Whether the vehicle has a transmission control module (TCM).

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

name

The name of the interface.

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

obd_standard

The standard OBD II PID.

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

pid_request_interval_seconds

The maximum number message requests per second.

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

request_message_id

The ID of the message requesting vehicle data.

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

use_extended_ids

Whether to use extended IDs in the message.

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

ObdNetworkInterfaceProperty

class CfnDecoderManifestPropsMixin.ObdNetworkInterfaceProperty(*, interface_id=None, obd_interface=None, type=None)

Bases: object

Information about a network interface specified by the On-board diagnostic (OBD) II protocol.

Parameters:

interface_id (Optional[str]) – The ID of the network interface.
obd_interface (Union[IResolvable, ObdInterfaceProperty, Dict[str, Any], None]) – Information about a network interface specified by the On-board diagnostic (OBD) II protocol.
type (Optional[str]) – The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

obd_network_interface_property = iotfleetwise_mixins.CfnDecoderManifestPropsMixin.ObdNetworkInterfaceProperty(
    interface_id="interfaceId",
    obd_interface=iotfleetwise_mixins.CfnDecoderManifestPropsMixin.ObdInterfaceProperty(
        dtc_request_interval_seconds="dtcRequestIntervalSeconds",
        has_transmission_ecu="hasTransmissionEcu",
        name="name",
        obd_standard="obdStandard",
        pid_request_interval_seconds="pidRequestIntervalSeconds",
        request_message_id="requestMessageId",
        use_extended_ids="useExtendedIds"
    ),
    type="type"
)

Attributes

interface_id

The ID of the network interface.

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

obd_interface

Information about a network interface specified by the On-board diagnostic (OBD) II protocol.

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

type

The network protocol for the vehicle.

For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

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

ObdSignalDecoderProperty

class CfnDecoderManifestPropsMixin.ObdSignalDecoderProperty(*, fully_qualified_name=None, interface_id=None, obd_signal=None, type=None)

Bases: object

A list of information about signal decoders.

Parameters:

fully_qualified_name (Optional[str]) – The fully qualified name of a signal decoder as defined in a vehicle model.
interface_id (Optional[str]) – The ID of a network interface that specifies what network protocol a vehicle follows.
obd_signal (Union[IResolvable, ObdSignalProperty, Dict[str, Any], None]) – Information about signal messages using the on-board diagnostics (OBD) II protocol in a vehicle.
type (Optional[str]) – The network protocol for the vehicle. For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

obd_signal_decoder_property = iotfleetwise_mixins.CfnDecoderManifestPropsMixin.ObdSignalDecoderProperty(
    fully_qualified_name="fullyQualifiedName",
    interface_id="interfaceId",
    obd_signal=iotfleetwise_mixins.CfnDecoderManifestPropsMixin.ObdSignalProperty(
        bit_mask_length="bitMaskLength",
        bit_right_shift="bitRightShift",
        byte_length="byteLength",
        is_signed="isSigned",
        offset="offset",
        pid="pid",
        pid_response_length="pidResponseLength",
        scaling="scaling",
        service_mode="serviceMode",
        signal_value_type="signalValueType",
        start_byte="startByte"
    ),
    type="type"
)

Attributes

fully_qualified_name

The fully qualified name of a signal decoder as defined in a vehicle model.

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

interface_id

The ID of a network interface that specifies what network protocol a vehicle follows.

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

obd_signal

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

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

type

The network protocol for the vehicle.

For example, CAN_SIGNAL specifies a protocol that defines how data is communicated between electronic control units (ECUs). OBD_SIGNAL specifies a protocol that defines how self-diagnostic data is communicated between ECUs.

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

ObdSignalProperty

class CfnDecoderManifestPropsMixin.ObdSignalProperty(*, bit_mask_length=None, bit_right_shift=None, byte_length=None, is_signed=None, offset=None, pid=None, pid_response_length=None, scaling=None, service_mode=None, signal_value_type=None, start_byte=None)

Bases: object

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

Parameters:

bit_mask_length (Optional[str]) – The number of bits to mask in a message.
bit_right_shift (Optional[str]) – The number of positions to shift bits in the message.
byte_length (Optional[str]) – The length of a message.
is_signed (Union[str, bool, IResolvable, None]) – 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 .
offset (Optional[str]) – The offset used to calculate the signal value. Combined with scaling, the calculation is value = raw_value * scaling + offset .
pid (Optional[str]) – The diagnostic code used to request data from a vehicle for this signal.
pid_response_length (Optional[str]) – The length of the requested data.
scaling (Optional[str]) – A multiplier used to decode the message.
service_mode (Optional[str]) – The mode of operation (diagnostic service) in a message.
signal_value_type (Optional[str]) – The value type of the signal. The default value is INTEGER .
start_byte (Optional[str]) – Indicates the beginning of the message.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

obd_signal_property = iotfleetwise_mixins.CfnDecoderManifestPropsMixin.ObdSignalProperty(
    bit_mask_length="bitMaskLength",
    bit_right_shift="bitRightShift",
    byte_length="byteLength",
    is_signed="isSigned",
    offset="offset",
    pid="pid",
    pid_response_length="pidResponseLength",
    scaling="scaling",
    service_mode="serviceMode",
    signal_value_type="signalValueType",
    start_byte="startByte"
)

Attributes

bit_mask_length

The number of bits to mask in a message.

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

bit_right_shift

The number of positions to shift bits in the message.

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

byte_length

The length of a message.

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

is_signed

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 .

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

offset

The offset used to calculate the signal value.

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

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

pid

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

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

pid_response_length

The length of the requested data.

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

scaling

A multiplier used to decode the message.

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

service_mode

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

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

signal_value_type

The value type of the signal.

The default value is INTEGER .

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

start_byte

Indicates the beginning of the message.

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

SignalDecodersItemsProperty

class CfnDecoderManifestPropsMixin.SignalDecodersItemsProperty(*, can_signal=None, fully_qualified_name=None, interface_id=None, obd_signal=None, type=None)

Bases: object

Information about a signal decoder.

Parameters:

can_signal (Union[IResolvable, CanSignalProperty, Dict[str, Any], None])
fully_qualified_name (Optional[str])
interface_id (Optional[str])
obd_signal (Union[IResolvable, ObdSignalProperty, Dict[str, Any], None])
type (Optional[str])

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iotfleetwise import mixins as iotfleetwise_mixins

signal_decoders_items_property = iotfleetwise_mixins.CfnDecoderManifestPropsMixin.SignalDecodersItemsProperty(
    can_signal=iotfleetwise_mixins.CfnDecoderManifestPropsMixin.CanSignalProperty(
        factor="factor",
        is_big_endian="isBigEndian",
        is_signed="isSigned",
        length="length",
        message_id="messageId",
        name="name",
        offset="offset",
        signal_value_type="signalValueType",
        start_bit="startBit"
    ),
    fully_qualified_name="fullyQualifiedName",
    interface_id="interfaceId",
    obd_signal=iotfleetwise_mixins.CfnDecoderManifestPropsMixin.ObdSignalProperty(
        bit_mask_length="bitMaskLength",
        bit_right_shift="bitRightShift",
        byte_length="byteLength",
        is_signed="isSigned",
        offset="offset",
        pid="pid",
        pid_response_length="pidResponseLength",
        scaling="scaling",
        service_mode="serviceMode",
        signal_value_type="signalValueType",
        start_byte="startByte"
    ),
    type="type"
)