UDS over Custom Network

This part of the documentation guides how to use this package’s features for networks that are either not implemented or implemented for other network managers that you plan to use.

To use features of this package, you have to have following implementation prepared in line with the guidelines of this document:

• Addressing

• Packet

• Segmentation

• Transport Interface

For example, if you want to create UDS over CAN implementation for your own (e.g. in-house implemented) CAN network manager, all you have to do, is to implement concrete class of CAN Transport Interface (AbstractCanTransportInterface).

For network types that are not fully implemented (networks implementation status) yet, you must provide your own implementation.

See also

User guide for Diagnostic over CAN and CAN implementation (uds.can).

Addressing

Network specific addressing related implementation is restricted to defining concrete Addressing Information class. Addressing Information classes define containers for Addressing related parameters. Properly defined object stores all parameters required for both distinguishing incoming and outgoing packets (for both addressing types).

AbstractAddressingInformation

AbstractAddressingInformation defines common API and contains common code for all addressing information storages. It is located in uds.addressing.abstract_addressing_information.

Attributes:

• rx_physical_params

• tx_physical_params

• rx_functional_params

• tx_functional_params

Methods:

• validate_addressing_params()

• is_input_packet()

• get_other_end()

Requires implementation in concrete classes (abstract attributes and methods):

• _validate_addressing_information()

• validate_addressing_params()

• is_input_packet()

Warning

A user shall not use AbstractAddressingInformation directly as this is an abstract class.

See also

Addressing implementation for CAN - uds.can.addressing

Packet

Abstract implementation for Packet feature is located in uds.packet. It contains following abstract classes:

• AbstractPacketType

• AbstractPacket,

• AbstractPacketRecord

AbstractPacketType

AbstractPacketType is an enum with all possible Network Protocol Control Information (N_PCI) values. It is located uds.packet.abstract_packet_type.

Methods:

• is_initial_packet_type()

Requires implementation in concrete classes (abstract attributes and methods):

• attributes for each possible Network Protocol Control Information (N_PCI) value

• is_initial_packet_type()

See also

Packet types defined for CAN - CanPacketType

AbstractPacket

AbstractPacket class defines a common structure for packets. It is located uds.packet.abstract_packet.

Attributes:

• raw_frame_data

• packet_type

• data_length

• addressing_type

• payload

Methods:

• __str__()

Requires implementation in concrete classes (abstract attributes and methods):

• raw_frame_data

• packet_type

• data_length

• addressing_type

• payload

Note

Each network type would require additional attributes defined.

See also

Packets implementation for CAN:

• __init__

• AbstractCanPacketContainer

• CanPacket

AbstractPacketRecord

AbstractPacketRecord class defines a common structure for packet records (storage for information about packets that were either transmitted or received). It is located uds.packet.abstract_packet.

Attributes:

• frame

• direction

• transmission_time

• raw_frame_data

• packet_type

• data_length

• addressing_type

• payload

Methods:

• _validate_frame()

• _validate_attributes()

• __init__()

• __str__()

Requires implementation in concrete classes (abstract attributes and methods):

• frame

• direction

• transmission_time

• raw_frame_data

• packet_type

• data_length

• addressing_type

• payload

• _validate_frame()

• _validate_attributes()

Note

Each network type would require additional attributes defined.

See also

Packet records implementation for CAN - AbstractPacketRecord

Segmentation

Abstract segmentation implementation is located in uds.segmentation. Each concrete segmenter shall be able to handle exactly one network type.

AbstractSegmenter

AbstractSegmenter defines common API and contains common code for all segmenter classes.

Attributes:

• supported_addressing_information_class

• supported_packet_class

• supported_packet_record_class

• addressing_information

Methods:

• is_supported_packet_type()

• is_supported_packets_sequence_type()

• is_input_packet()

• is_desegmented_message()

• segmentation()

• desegmentation()

• __init__()

Requires implementation in concrete classes (abstract attributes and methods):

• supported_addressing_information_class

• supported_packet_class

• supported_packet_record_class

• is_desegmented_message()

• segmentation()

• desegmentation()

Warning

A user shall not use AbstractSegmenter directly as this is an abstract class.

See also

Segmentation implementation for CAN - uds.can.segmenter

Transport Interface

Transport interfaces are meant to handle Physical (layer 1), Data (layer 2), Network (layer 3) and Transport (layer 4) layers of UDS OSI model which are unique for every communication bus/network. First two layers (Physical and Data Link) are handled by some external packages. The implementation that is common for all Transport Interfaces is located in uds.transport_interface sub-package.

AbstractTransportInterface

Abstract API that is common for all Transport Interfaces (and therefore buses/networks) is defined in AbstractTransportInterface class. There shall be exactly one concrete class created for each supported network manager.

Attributes:

• segmenter

• addressing_information

• network_manager

Methods:

• is_supported_network_manager()

• send_packet()

• async_send_packet()

• receive_packet()

• async_receive_packet()

• send_message()

• async_send_message()

• receive_message()

• async_receive_message()

Requires implementation in concrete classes (abstract attributes and methods):

• segmenter

• is_supported_network_manager()

• send_packet()

• async_send_packet()

• receive_packet()

• async_receive_packet()

• send_message()

• async_send_message()

• receive_message()

• async_receive_message()

Warning

A user shall not use AbstractTransportInterface directly as this is an abstract class.

See also

Abstract CAN Transport Interface (common implementation for Transport Interfaces dedicated for CAN network) - uds.can.transport_interface.common.AbstractCanTransportInterface.

CAN Transport Interface integrated with python-can package - uds.can.transport_interface.python_can.PythonCanTransportInterface