uds.can.extended_addressing_information
=======================================

.. py:module:: uds.can.extended_addressing_information

.. autoapi-nested-parse::

   Implementation of Extended Addressing Information handler.



Classes
-------

.. autoapisummary::

   uds.can.extended_addressing_information.ExtendedCanAddressingInformation


Module Contents
---------------

.. py:class:: ExtendedCanAddressingInformation(rx_physical, tx_physical, rx_functional, tx_functional)

   Bases: :py:obj:`uds.can.abstract_addressing_information.AbstractCanAddressingInformation`

   .. autoapi-inheritance-diagram:: uds.can.extended_addressing_information.ExtendedCanAddressingInformation
      :parts: 1
      :private-bases:


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

   Configure Addressing Information of a CAN Entity.

   :param rx_physical: Addressing Information parameters used for incoming physically addressed communication.
   :param tx_physical: Addressing Information parameters used for outgoing physically addressed communication.
   :param rx_functional: Addressing Information parameters used for incoming functionally addressed communication.
   :param tx_functional: Addressing Information parameters used for outgoing functionally addressed communication.


   .. py:attribute:: AI_DATA_BYTES_NUMBER
      :type:  int
      :value: 1


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



   .. py:property:: addressing_format
      :type: uds.can.addressing_format.CanAddressingFormat


      CAN Addressing format used.



   .. py:method:: validate_packet_ai(addressing_type, can_id = None, target_address = None, source_address = None, address_extension = None)
      :classmethod:


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

      :param addressing_type: Addressing type to validate.
      :param can_id: CAN Identifier value to validate.
      :param target_address: Target Address value to validate.
      :param source_address: Source Address value to validate.
      :param address_extension: Address Extension value to validate.

      :raise InconsistentArgumentsError: Provided CAN ID value is incompatible with Extended Addressing format.
      :raise UnusedArgumentError: Provided parameter is not supported by this Addressing format.

      :return: Normalized dictionary with the provided Addressing Information.



   .. py:method:: _validate_node_ai(rx_packets_physical_ai, tx_packets_physical_ai, rx_packets_functional_ai, tx_packets_functional_ai)
      :staticmethod:


      Validate Node Addressing Information parameters.

      :param rx_packets_physical_ai: Addressing Information parameters of incoming physically addressed
          CAN packets to validate.
      :param tx_packets_physical_ai: Addressing Information parameters of outgoing physically addressed
          CAN packets to validate.
      :param rx_packets_functional_ai: Addressing Information parameters of incoming functionally addressed
          CAN packets to validate.
      :param tx_packets_functional_ai: Addressing Information parameters of outgoing functionally addressed
          CAN packets to validate.

      :raise InconsistentArgumentsError: Provided values are not consistent with each other.