uds.can.normal_addressing_information

Implementation of Normal Addressing Information handlers.

Classes

NormalCanAddressingInformation	Addressing Information of CAN Entity (either server or client) that uses Normal Addressing format.
NormalFixedCanAddressingInformation	Addressing Information of CAN Entity (either server or client) that uses Normal Fixed Addressing format.

Module Contents

class uds.can.normal_addressing_information.NormalCanAddressingInformation(rx_physical, tx_physical, rx_functional, tx_functional)

Bases: uds.can.abstract_addressing_information.AbstractCanAddressingInformation

Addressing Information of CAN Entity (either server or client) that uses Normal Addressing format.

Configure Addressing Information of a CAN Entity.

Parameters:

• rx_physical (InputAIParamsAlias) – Addressing Information parameters used for incoming physically addressed communication.

• tx_physical (InputAIParamsAlias) – Addressing Information parameters used for outgoing physically addressed communication.

• rx_functional (InputAIParamsAlias) – Addressing Information parameters used for incoming functionally addressed communication.

• tx_functional (InputAIParamsAlias) – Addressing Information parameters used for outgoing functionally addressed communication.

AI_DATA_BYTES_NUMBER: int = 0

Number of CAN Frame data bytes that are used to carry Addressing Information.

property addressing_format: uds.can.addressing_format.CanAddressingFormat

CAN Addressing format used.

Return type:

uds.can.addressing_format.CanAddressingFormat

classmethod validate_packet_ai(addressing_type, can_id=None, target_address=None, source_address=None, address_extension=None)

Validate Addressing Information parameters of a CAN packet that uses Normal Addressing format.

Parameters:

• addressing_type (uds.transmission_attributes.AddressingType) – Addressing type to validate.

• can_id (Optional[int]) – CAN Identifier value to validate.

• target_address (Optional[int]) – Target Address value to validate.

• source_address (Optional[int]) – Source Address value to validate.

• address_extension (Optional[int]) – Address Extension value to validate.

Raises:

• InconsistentArgumentsError – Provided CAN ID value is incompatible with Normal 11-bit Addressing format.

• UnusedArgumentError – Provided parameter is not supported by this Addressing format.

Returns:

Normalized dictionary with the provided Addressing Information.

Return type:

uds.can.abstract_addressing_information.PacketAIParamsAlias

static _validate_node_ai(rx_packets_physical_ai, tx_packets_physical_ai, rx_packets_functional_ai, tx_packets_functional_ai)

Validate Node Addressing Information parameters.

Parameters:

• rx_packets_physical_ai (uds.can.abstract_addressing_information.PacketAIParamsAlias) – Addressing Information parameters of incoming physically addressed CAN packets to validate.

• tx_packets_physical_ai (uds.can.abstract_addressing_information.PacketAIParamsAlias) – Addressing Information parameters of outgoing physically addressed CAN packets to validate.

• rx_packets_functional_ai (uds.can.abstract_addressing_information.PacketAIParamsAlias) – Addressing Information parameters of incoming functionally addressed CAN packets to validate.

• tx_packets_functional_ai (uds.can.abstract_addressing_information.PacketAIParamsAlias) – Addressing Information parameters of outgoing functionally addressed CAN packets to validate.

Raises:

InconsistentArgumentsError – Provided values are not consistent with each other.

Return type:

None

class uds.can.normal_addressing_information.NormalFixedCanAddressingInformation(rx_physical, tx_physical, rx_functional, tx_functional)

Bases: uds.can.abstract_addressing_information.AbstractCanAddressingInformation

Addressing Information of CAN Entity (either server or client) that uses Normal Fixed Addressing format.

Configure Addressing Information of a CAN Entity.

Parameters:

• rx_physical (InputAIParamsAlias) – Addressing Information parameters used for incoming physically addressed communication.

• tx_physical (InputAIParamsAlias) – Addressing Information parameters used for outgoing physically addressed communication.

• rx_functional (InputAIParamsAlias) – Addressing Information parameters used for incoming functionally addressed communication.

• tx_functional (InputAIParamsAlias) – Addressing Information parameters used for outgoing functionally addressed communication.

AI_DATA_BYTES_NUMBER: int = 0

Number of CAN Frame data bytes that are used to carry Addressing Information.

property addressing_format: uds.can.addressing_format.CanAddressingFormat

CAN Addressing format used.

Return type:

uds.can.addressing_format.CanAddressingFormat

classmethod validate_packet_ai(addressing_type, can_id=None, target_address=None, source_address=None, address_extension=None)

Validate Addressing Information parameters of a CAN packet that uses Normal Fixed Addressing format.

Parameters:

• addressing_type (uds.transmission_attributes.AddressingType) – Addressing type to validate.

• can_id (Optional[int]) – CAN Identifier value to validate.

• target_address (Optional[int]) – Target Address value to validate.

• source_address (Optional[int]) – Source Address value to validate.

• address_extension (Optional[int]) – Address Extension value to validate.

Raises:

• InconsistentArgumentsError – Provided Target Address, Source Address or CAN ID values are incompatible with each other or Normal Fixed Addressing format.

• UnusedArgumentError – Provided parameter is not supported by this Addressing format.

Returns:

Normalized dictionary with the provided Addressing Information.

Return type:

uds.can.abstract_addressing_information.PacketAIParamsAlias

static _validate_node_ai(rx_packets_physical_ai, tx_packets_physical_ai, rx_packets_functional_ai, tx_packets_functional_ai)

Validate Node Addressing Information parameters.

Parameters:

• rx_packets_physical_ai (uds.can.abstract_addressing_information.PacketAIParamsAlias) – Addressing Information parameters of incoming physically addressed CAN packets to validate.

• tx_packets_physical_ai (uds.can.abstract_addressing_information.PacketAIParamsAlias) – Addressing Information parameters of outgoing physically addressed CAN packets to validate.

• rx_packets_functional_ai (uds.can.abstract_addressing_information.PacketAIParamsAlias) – Addressing Information parameters of incoming functionally addressed CAN packets to validate.

• tx_packets_functional_ai (uds.can.abstract_addressing_information.PacketAIParamsAlias) – Addressing Information parameters of outgoing functionally addressed CAN packets to validate.

Raises:

InconsistentArgumentsError – Provided values are not consistent with each other.

Return type:

None