We use cookies on our website to provide you with the best possible service and to further improve our website. By clicking the "Accept All" button, you agree to the use of all cookies. You can limit the cookies used by clicking on "Accept selection". Further information and an option to revoke your selection can be found in our privacy policy.

Necessary:

These cookies are necessary for basic functionality. This allows you to register on our website and forum or order products with our online shop.

Statistics:

With these cookies, we collect anonymized usage data for our website. For example, we can see which content is interesting for our visitors and which resolutions are used. We use the information to optimize our website to provide you with the best possible user experience.

Necessary
Statistics

show more

PCAN-Basic

API for Connecting to CAN and CAN FD Buses

The PCAN-Basic API (application programming interface) allows easy development of powerful software with CAN and CAN FD support. It includes all of the functions that an application needs in order to communicate with PCAN PC hardware. The cross-operating-system design makes it possible to easily port software projects between platforms.

PCAN-Basic consists of the actual device driver and an interface DLL, which provides the API functions.

As the successor to PCAN-Light, PCAN-Basic offers increased functionality and extended language support. It provides various functions for developers under C++, C#, C++/CLR, Delphi, VB.NET, Java, and Python 3.x.

CAN FD


Beginning with version 4, PCAN-Basic for Windows supports the standard CAN FD (CAN with Flexible Data rate) which is primarily characterized by a higher bandwidth for data transfer.

PCAN-Basic for Linux


PEAK-System provides the PCAN-Basic API to allow the development of your own CAN applications for Linux. Programmers can use the languages C++, Java, and Python 3.x.

  • API for developing applications with CAN and CAN FD connections
  • Support for CAN specifications 2.0 A/B and FD
  • Application development for the platforms Windows® 11 (x64/ARM64), 10 (x86/x64), and Linux
  • Multiple PEAK-System applications and your own can be operated on a physical channel at the same time
  • Use of a single DLL for all supported hardware types
  • Use of up to 16 channels for each hardware type (depending on the PEAK CAN interface used)
  • Simple switching between channels of a PEAK CAN interface
  • Access to the CAN channels of a PCAN-Gateway via the new PCAN-LAN hardware type
  • Driver-internal buffering of up to 32,768 CAN messages per CAN channel
  • Precision of time stamps on received messages up to 1 µs (depending on the PEAK CAN interface used)
  • Supports PEAK-System‘s trace formats version 1.1 and 2.0 (for CAN FD applications)
  • Access to specific hardware parameters, such as listen-only mode
  • Notification of the application through Windows® events when a message is received
  • Support of CAN error frames
  • Confirmation of physical transmission by CAN echo frames
  • Extended system for debugging operations
  • Multilingual debugging output
  • Output language depends on operating system
  • Debugging information can be defined individually
  • Thread-safe API

Note: Parallel port CAN interfaces are only supported on x86 systems.

System requirements


  • Windows® 11 (x64/ARM64), 10 (x64), or Linux
  • For the CAN bus connection: PC CAN interface from PEAK-System

Functions


Connection:

  • Initialize: Initialize CAN hardware, set the bit rate, log on at the driver
  • InitializeFD: Initialize CAN FD hardware
  • Uninitialize: Log off from the driver

Configuration:

  • SetValue: Setup of hardware parameters such as debug log, listen-only, and auto-reset
  • FilterMessages: Register messages to be received

Information:

  • GetValue: Read out DLL and API information
  • GetStatus: Read out CAN bus status information
  • GetErrorText: Get an error code description

CAN communication:

  • Read: Read a CAN message or status incl. time stamp
  • ReadFD: Read a CAN FD message
  • Write: Transmit a CAN message (11/29-bit ID and RTR possible)
  • WriteFD: Transmit a CAN FD message
  • Reset: Clear the transmit and receive buffer
  • PCAN-Basic DLLs d‘interface (x86/x64/ARM64)
  • PCAN-Basic.NET Assembly
  • Examples and header files for all common programming languages
  • Documentation in PDF and HTML Help format

PCAN-Basic API

API for the development of applications with CAN and CAN FD connections for Windows® 11 (x64/ARM64), 10 (x64).

Download

PCAN-Basic API (Linux)

API for the development of applications with CAN connection for Linux.

Download

PCAN-Basic.NET Assembly

The PCAN-Basic.NET Assembly is available as a package in the NuGet Gallery. The online documentation is available on our website.

Documentation NuGet Gallery

Additional information