1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
|
.. _pcandoc:
PCAN Basic API
==============
Interface to `Peak-System <https://www.peak-system.com>`__'s PCAN-Basic API.
Configuration
-------------
Here is an example configuration file for using `PCAN-USB <https://www.peak-system.com/PCAN-USB.199.0.html?&L=1>`_:
::
[default]
interface = pcan
channel = PCAN_USBBUS1
state = can.bus.BusState.PASSIVE
bitrate = 500000
``channel`` (default ``"PCAN_USBBUS1"``)
CAN interface name.
Valid ``channel`` values::
PCAN_ISABUSx
PCAN_DNGBUSx
PCAN_PCIBUSx
PCAN_USBBUSx
PCAN_PCCBUSx
PCAN_LANBUSx
Where ``x`` should be replaced with the desired channel number starting at ``1``.
``state`` (default ``can.bus.BusState.ACTIVE``)
BusState of the channel
``bitrate`` (default ``500000``)
Channel bitrate
.. _pcandoc linux installation:
Linux installation
------------------
Beginning with version 3.4, Linux kernels support the PCAN adapters natively via :doc:`/interfaces/socketcan`, refer to: :ref:`socketcan-pcan`.
Bus
---
.. autoclass:: can.interfaces.pcan.PcanBus
:members:
|