User Guide

This section of the documentation provides an overview of the package’s key features and practical instructions for getting started.

Table of Contents

• Quickstart
  • Installation
  • Define Addressing Information
  • Create Transport Interface
  • Working with Transport Interface
    • Send and Receive Packets
    • Send and Receive Messages
  • Working with Client
    • Configuration
    • Send Request and Receive Responses
    • Periodic Tester Present
    • Collecting Response Messages
• Diagnostic Messages
  • UDS Message
  • UDS Message Record
  • Service Identifiers
    • RequestSID
    • ResponseSID
    • How to define custom Service
  • Negative Response Codes
• Addressing
  • AddressingType
  • TransmissionDirection
• Client
  • Configuration
  • Sending Requests and Receiving Responses
  • Tester Present
  • Background Receiving
• Diagnostic Messages Translation
  • Translator
  • Translator Definitions
  • Service
  • Service Definitions
    • DiagnosticSessionControl
    • ECUReset
    • ClearDiagnosticInformation
    • ReadDTCInformation
    • ReadDataByIdentifier
    • ReadMemoryByAddress
    • ReadScalingDataByIdentifier
    • SecurityAccess
    • CommunicationControl
    • Authentication
    • ReadDataByPeriodicIdentifier
    • DynamicallyDefineDataIdentifier
    • WriteDataByIdentifier
    • InputOutputControlByIdentifier
    • RoutineControl
    • RequestDownload
    • RequestUpload
    • TransferData
    • RequestTransferExit
    • RequestFileTransfer
    • WriteMemoryByAddress
    • TesterPresent
    • AccessTimingParameter
    • SecuredDataTransmission
    • ControlDTCSetting
    • ResponseOnEvent
    • LinkControl
  • Data Records
    • Abstract Data Record
    • Raw Data Record
    • Mapping Data Record
    • Linear Formula Data Record
    • Custom Formula Data Record
    • Text Data Record
    • Abstract Conditional Data Record
    • Conditional Mapping Data Record
    • Conditional Formula Data Record
• Communication Logging
  • TransportLogger
    • Configuration
    • Activation
      • Decorating Transport Interface class
      • Decorating Transport Interface instance
    • Customization
• Diagnostics over CAN
  • Addressing
    • CanAddressingFormat
    • AbstractCanAddressingInformation
    • NormalCanAddressingInformation
    • NormalFixedCanAddressingInformation
    • ExtendedCanAddressingInformation
    • Mixed11BitCanAddressingInformation
    • Mixed29BitCanAddressingInformation
    • CanAddressingInformation
  • Frame
    • CanIdHandler
    • CanDlcHandler
  • Packet
    • CanPacketType
    • AbstractCanPacketContainer
    • CanPacket
    • CanPacketRecord
    • Single Frame
    • First Frame
    • Consecutive Frame
    • Flow Control
      • CanFlowStatus
      • CanSTminTranslator
      • AbstractFlowControlParametersGenerator
      • DefaultFlowControlParametersGenerator
  • Segmentation
  • CanSegmenter
  • Transport
    • AbstractCanTransportInterface
    • PythonCanTransportInterface
• UDS over Custom Network
  • Addressing
    • AbstractAddressingInformation
  • Packet
    • AbstractPacketType
    • AbstractPacket
    • AbstractPacketRecord
  • Segmentation
    • AbstractSegmenter
  • Transport Interface
    • AbstractTransportInterface