Skip to content

Commit

Permalink
Updated PCAN documentation
Browse files Browse the repository at this point in the history
Fixes #56
  • Loading branch information
Lauszus committed Jul 18, 2018
1 parent abab40a commit 036b6f1
Showing 1 changed file with 25 additions and 5 deletions.
30 changes: 25 additions & 5 deletions doc/interfaces/pcan.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,47 @@
PCAN Basic API
==============

.. warning::
Interface to `Peak-System <https://www.peak-system.com/?&L=1/>`__'s PCAN-Basic API.

This ``PCAN`` documentation is a work in progress. Feedback and revisions are most welcome!
Windows driver: https://www.peak-system.com/Downloads.76.0.html?&L=1

Linux driver: https://www.peak-system.com/fileadmin/media/linux/index.htm

Interface to `Peak-System <http://www.peak-system.com/>`__'s PCAN-Basic API.
Mac driver: http://www.mac-can.com

Configuration
-------------

An example `can.ini` file for windows 7:
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

``state``: (default can.bus.BusState.ACTIVE) BusState of the channel

``bitrate``: (default 500000) Channel bitrate

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.

Bus
---

.. autoclass:: can.interfaces.pcan.PcanBus

0 comments on commit 036b6f1

Please sign in to comment.