Skip to content

SignalDecoder

Source code in docs_src/capo_iotfleetwise/types/signal_decoder.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class SignalDecoder(TypedDict, closed=True):
    fully_qualified_name: (
        "capo_iotfleetwise.types.fully_qualified_name.FullyQualifiedName"
    )
    """<p>The fully qualified name of a signal decoder as defined in a vehicle model.</p>"""
    type: "capo_iotfleetwise.types.signal_decoder_type.SignalDecoderType"
    """<p>The network protocol for the vehicle. For example, <code>CAN_SIGNAL</code> specifies a protocol that defines how data is communicated between electronic control units (ECUs). <code>OBD_SIGNAL</code> specifies a protocol that defines how self-diagnostic data is communicated between ECUs.</p>"""
    interface_id: "capo_iotfleetwise.types.interface_id.InterfaceId"
    """<p>The ID of a network interface that specifies what network protocol a vehicle follows.</p>"""
    can_signal: NotRequired["capo_iotfleetwise.types.can_signal.CanSignal"]
    """<p>Information about signal decoder using the Controller Area Network (CAN) protocol.</p>"""
    obd_signal: NotRequired["capo_iotfleetwise.types.obd_signal.ObdSignal"]
    """<p>Information about signal decoder using the on-board diagnostic (OBD) II protocol.</p>"""
    message_signal: NotRequired["capo_iotfleetwise.types.message_signal.MessageSignal"]
    """<p>The decoding information for a specific message which supports higher order data types. </p>"""
    custom_decoding_signal: NotRequired[
        "capo_iotfleetwise.types.custom_decoding_signal.CustomDecodingSignal"
    ]
    """<p>Information about a <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_CustomDecodingSignal.html">custom signal decoder</a>.</p> <important> <p>Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">Amazon Web Services Region and feature availability</a> in the <i>Amazon Web Services IoT FleetWise Developer Guide</i>.</p> </important>"""

can_signal instance-attribute 

can_signal: NotRequired[CanSignal]

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

custom_decoding_signal instance-attribute 

custom_decoding_signal: NotRequired[CustomDecodingSignal]

Information about a custom signal decoder.

Access to certain Amazon Web Services IoT FleetWise features is currently gated. For more information, see Amazon Web Services Region and feature availability in the Amazon Web Services IoT FleetWise Developer Guide.

fully_qualified_name instance-attribute 

fully_qualified_name: FullyQualifiedName

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

interface_id instance-attribute 

interface_id: InterfaceId

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

message_signal instance-attribute 

message_signal: NotRequired[MessageSignal]

The decoding information for a specific message which supports higher order data types.

obd_signal instance-attribute 

obd_signal: NotRequired[ObdSignal]

Information about signal decoder using the on-board diagnostic (OBD) II protocol.

type instance-attribute 

type: SignalDecoderType

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.