PCAN-ExpressCard – User Manual
23
An overview of the API functions is located in the header files. You
can find detailed information about the PCAN-Basic API on the
provided DVD in the text and help files (file name extensions
.txt
and
.chm
).
5.2.2
Principle Description of the API
The PCAN-Basic API is the interface between the user application
and device driver. In Windows operating systems this is a DLL
(Dynamic Link Library).
The sequence of accessing the CAN interface is divided into three
phases:
1.
Initialization
2.
Interaction
3.
Completion
Initialization
A channel must be initialized before using it. This is done by the
simple call of the function
CAN_Initialize
for CAN and
CAN_InitializeFD
for CAN-FD. Depending on the type of the CAN
hardware, up to 16 CAN channels can be opened at the same time.
After a successful initialization the CAN channel is ready for
communication with the CAN hardware and the CAN bus. No
further configuration steps are required.
Interaction
For receiving and transmitting messages the functions
CAN_Read
and
CAN_Write
as well as
CAN_ReadFD
and
CAN_WriteFD
are available.
Additional settings can be made, e.g. setting up message filters to
confine to specific CAN IDs or setting the CAN controller to listen-
only mode.
