Skip to content

NetworkInterface

Source code in docs_src/capo_iotfleetwise/types/network_interface.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
class NetworkInterface(TypedDict, closed=True):
    interface_id: "capo_iotfleetwise.types.interface_id.InterfaceId"
    """<p>The ID of the network interface.</p>"""
    type: "capo_iotfleetwise.types.network_interface_type.NetworkInterfaceType"
    """<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>"""
    can_interface: NotRequired["capo_iotfleetwise.types.can_interface.CanInterface"]
    """<p>Information about a network interface specified by the Controller Area Network (CAN) protocol.</p>"""
    obd_interface: NotRequired["capo_iotfleetwise.types.obd_interface.ObdInterface"]
    """<p>Information about a network interface specified by the on-board diagnostic (OBD) II protocol.</p>"""
    vehicle_middleware: NotRequired[
        "capo_iotfleetwise.types.vehicle_middleware.VehicleMiddleware"
    ]
    """<p>The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include <code>ROS2</code> and <code>SOME/IP</code>.</p>"""
    custom_decoding_interface: NotRequired[
        "capo_iotfleetwise.types.custom_decoding_interface.CustomDecodingInterface"
    ]
    """<p>Information about a <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/APIReference/API_CustomDecodingInterface.html">custom network interface</a>.</p>"""

can_interface instance-attribute 

can_interface: NotRequired[CanInterface]

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

custom_decoding_interface instance-attribute 

custom_decoding_interface: NotRequired[CustomDecodingInterface]

Information about a custom network interface.

interface_id instance-attribute 

interface_id: InterfaceId

The ID of the network interface.

obd_interface instance-attribute 

obd_interface: NotRequired[ObdInterface]

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

type instance-attribute 

type: NetworkInterfaceType

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.

vehicle_middleware instance-attribute 

vehicle_middleware: NotRequired[VehicleMiddleware]

The vehicle middleware defined as a type of network interface. Examples of vehicle middleware include ROS2 and SOME/IP.