uds.packet.abstract_can_packet_container

Abstract definition of CAN packets container.

Module Contents

Classes

AbstractCanPacketContainer

Abstract definition of CAN Packets containers.

class uds.packet.abstract_can_packet_container.AbstractCanPacketContainer[source]

Bases: abc.ABC

Inheritance diagram of uds.packet.abstract_can_packet_container.AbstractCanPacketContainer

Abstract definition of CAN Packets containers.

abstract property raw_frame_data: uds.utilities.RawBytesTupleAlias

Raw data bytes of a CAN frame that carries this CAN packet.

Return type:

uds.utilities.RawBytesTupleAlias

abstract property can_id: int

CAN Identifier (CAN ID) of a CAN Frame that carries this CAN packet.

Return type:

int

abstract property addressing_format: uds.can.CanAddressingFormat

CAN addressing format used by this CAN packet.

Return type:

uds.can.CanAddressingFormat

abstract property addressing_type: uds.transmission_attributes.AddressingType

Addressing type for which this CAN packet is relevant.

Return type:

uds.transmission_attributes.AddressingType

property dlc: int

Value of Data Length Code (DLC) of a CAN Frame that carries this CAN packet.

Return type:

int

property packet_type: uds.packet.can_packet_type.CanPacketType

Type (N_PCI value) of this CAN packet.

Return type:

uds.packet.can_packet_type.CanPacketType

property target_address: int | None

Target Address (TA) value of this CAN Packet.

Target Address value is used with following addressing formats:

None in other cases.

Return type:

Optional[int]

property source_address: int | None

Source Address (SA) value of this CAN Packet.

Source Address value is used with following addressing formats:

None in other cases.

Return type:

Optional[int]

property address_extension: int | None

Address Extension (AE) value of this CAN Packet.

Address Extension is used with following addressing formats:

None in other cases.

Return type:

Optional[int]

property data_length: int | None

Payload bytes number of a diagnostic message that is carried by this CAN packet.

Data length is only provided by packets of following types:

None in other cases.

Return type:

Optional[int]

property sequence_number: int | None

Sequence Number carried by this CAN packet.

Sequence Number is only provided by packets of following types:

None in other cases.

Return type:

Optional[int]

property payload: uds.utilities.RawBytesTupleAlias | None

Diagnostic message payload carried by this CAN packet.

Payload is only provided by packets of following types:

None in other cases.

Warning

For Consecutive Frames this value might contain additional filler bytes (they are not part of diagnostic message payload) that were added during CAN Frame Data Padding. The presence of filler bytes in Consecutive Frame cannot be determined basing solely on the information contained in this packet object.

Return type:

Optional[uds.utilities.RawBytesTupleAlias]

property flow_status: uds.can.CanFlowStatus | None

Flow Status carried by this CAN packet.

Flow Status is only provided by packets of following types:

None in other cases.

Return type:

Optional[uds.can.CanFlowStatus]

property block_size: int | None

Block Size value carried by this CAN packet.

Block Size is only provided by packets of following types:

None in other cases.

Return type:

Optional[int]

property st_min: int | None

Separation Time minimum (STmin) value carried by this CAN packet.

STmin is only provided by packets of following types:

None in other cases.

Return type:

Optional[int]

get_addressing_information()[source]

Get Addressing Information carried by this packet.

Returns:

Addressing Information decoded from CAN ID and CAN Frame data of this packet.

Return type:

uds.can.CanAddressingInformation.DecodedAIParamsAlias