Pass-Thru API and Connection of Pass-Thru
Software to PEAK CAN Interfaces
User Manual
PCAN-PassThru API
05.00
Document version 1.4.1 (2023-03-16)
PCAN-PassThru API 05.00 – User Manual
2
PCAN® is a registered trademark of PEAK-System Technik GmbH.
Other product names in this document may be the trademarks or registered trademarks of their respective companies. They are not
explicitly marked by ™or ®.
© 2023 PEAK-System Technik GmbH
Duplication (copying, printing, or other forms) and the electronic distribution of this document is only allowed with explicit
permission of PEAK-System Technik GmbH. PEAK-System Technik GmbH reserves the right to change technical data without prior
announcement. The general business conditions and the regulations of the license agreement apply. All rights are reserved.
PEAK-System Technik GmbH
Otto-Röhm-Straße 69
64293 Darmstadt
Germany
Phone: +49 6151 8173-20
Fax: +49 6151 8173-29
www.peak-system.com
info@peak-system.com
Documen
t version 1.4.1 (2023-03-16)
PCAN-PassThru API 05.00 – User Manual
3
Contents
1 Introduction 4
1.1 Features 4
1.2 System Requirements 4
1.3 Scope of Supply 5
2 Installation 6
2.1 Hardware Interface Configuration 6
2.1.1 Additional Options 7
3 Programming Interface 8
3.1 Implementation 8
3.1.1 PassThru Functions 8
3.1.2 Pass-Thru Message Structure 10
3.1.3 PassThruIoctl 11
3.1.4 Other structures 12
3.2 Function Examples on CAN 14
3.2.1 Opening a PassThru Device 14
3.2.2 Connecting a physical channel to CAN 15
3.2.3 Writing Messages 16
3.2.4 Setting a Filter Message 16
3.2.5 Reading Messages 17
3.2.6 Tx Loopback Configuration 17
3.2.7 Periodic Messages 18
3.2.8 Disconnect from the physical channel 18
3.2.9 Close the device 18
3.3 Function Examples on CAN FD and extended messages 19
3.3.1 Opening a PassThru Device 19
3.3.2 Connecting a physical channel to CAN FD 19
3.3.3 Connecting a logical channel 20
3.3.4 Writing an extended message on the logical channel 21
3.3.5 Reading an extended message on the logical channel 21
3.3.6 Disconnect from the logical channel 22
3.3.7 Disconnect from the physical channel 22
3.3.8 Close the device 22
3.4 Technical Notes 23
3.4.1 Rx/Tx Queues 23
3.4.2 Message Filtering 23
4 License Information 24
Appendix A Supported Features from SAE J2534 and GM Extensions 25
A.1 SAE J2534-1 Revised OCT2015 25
A.1.1 Communication Protocols 25
A.1.2 Other Features 25
A.1.3 PASSTHRUIOCTL 25
A.2 SAE J2534-2 Revised JAN2019 27
A.3 GM Extension GMW17753 27
A.4 Supported Bit Rates 28
PCAN-PassThru API 05.00 – User Manual
4
1 Introduction
For the programming of control units (ECU), there are many applications from various manufacturers
which are used in the development and diagnosis of vehicle electronics. The interface for the communi-
cation between these applications and the control units is defined by the international standard SAE
J2534 (Pass-Thru). Thus, the hardware for the connection to the control unit can be selected regardless of
its manufacturer.
PCAN-PassThru allows the use of SAE J2534-based applications with CAN adapters from PEAK-System.
The functions defined by the standard are provided by Windows DLLs for 32 and 64-bit systems. These
can also be used to develop own Pass-Thru applications. The API is thread-safe. It uses mutual exclusion
mechanisms to allow several threads from one or several processes to call functions of the API in a safe
way.
The communication via CAN and OBD-2 (ISO 15765-4) is based on the programming interfaces PCAN-
Basic and PCAN-ISO-TP. PCAN-PassThru is supplied with each PC CAN interface from PEAK-System.
Note: The SAE J2534 protocol is fully described in its norm. It is required for the development of
your own Pass-Thru applications. This manual cannot supersede this API documentation.
1.1 Features
Implementation of the international standard SAE J2534 version 05.00 (Pass-Thru)
Implementation of SAE J2534 extension J2535-2:2019 (adapted to match version 05.00 differences) to
support CAN FD, and General Motors’ extension GMW17753 to support messages extension
Use of SAE J2534 applications with PC CAN interfaces from PEAK-System
Windows DLLs for the development of your own SAE J2534 applications for the platforms Windows®
11 (x64/ARM64), 10 (x86/x64)
Thread-safe API
Physical communication via CAN and OBD-2 (ISO 15765-4) using a CAN interface of the PCAN series
Uses the PCAN-Basic programming interface to access the CAN hardware in the computer
Uses the PCAN-ISO-TP programming interface (ISO 15765-2) for the transfer of data packages up to
4095 (or 32768 with GMW17753 extension) bytes via the CAN bus
1.2 System Requirements
Windows 11 (x64/ARM64), Windows 10 (x64)
For the CAN bus connection: PC CAN interface from PEAK-System
PCAN-Basic API
PCAN-ISO-TP API
Note: The required API PCAN-ISO-TP is installed with the PCAN-PassThru setup. The PCAN-Basic API
must be installed using the PEAK-Drivers Setup.
PCAN-PassThru API 05.00 – User Manual
5
1.3 Scope of Supply
PCAN-PassThru API installation including
• Interface DLLs for Windows (x86/x64) for protocol version 4.04 and 5.00
• Configuration software for Windows
• PCAN-ISO-TP API
Documentation in PDF format
