can package from PyPi with
pip or similar:
$ pip install python-can
As most likely you will want to interface with some hardware, you may also have to install platform dependencies. Be sure to check any other specifics for your hardware in Hardware Interfaces.
Many interfaces can install their dependencies at the same time as
for instance the interface
serial includes the
pyserial dependency which can
be installed with the
$ pip install python-can[serial]
Reasonably modern Linux Kernels (2.6.25 or newer) have an implementation
socketcan. This version of python-can will directly use socketcan
if called with Python 3.3 or greater, otherwise that interface is used
python-can using the Kvaser CANLib SDK as the backend:
Test that Kvaser’s own tools work to ensure the driver is properly installed and that the hardware is working.
Download and install the latest driver for your interface:
Note that PCANBasic API timestamps count seconds from system startup. To
convert these to epoch times, the uptime library is used. If it is not
available, the times are returned as number of seconds from system
startup. To install the uptime library, run
pip install python-can[pcan].
This library can take advantage of the Python for Windows Extensions library if installed. It will be used to get notified of new messages instead of the CPU intensive polling that will otherwise have be used.
python-can using the IXXAT VCI V3 or V4 SDK as the backend:
Test that IXXAT’s own tools (i.e. MiniMon) work to ensure the driver is properly installed and that the hardware is working.
Download and install the NI-CAN drivers from National Instruments.
Currently the driver only supports 32-bit Python on Windows.
python-can using the XL Driver Library as the backend:
CANtact is supported on Linux, Windows, and macOS.
python-can using the CANtact driver backend:
python3 -m pip install "python-can[cantact]"
python-can is already installed, the CANtact backend can be installed separately:
pip install cantact
Additional CANtact documentation is available at cantact.io.
python-can has support for showing a simple CAN viewer terminal application
python -m can.viewer. On Windows, this depends on the
windows-curses library which can
be installed with:
python -m pip install "python-can[viewer]"
Installing python-can in development mode#
A “development” install of this package allows you to make changes locally or pull updates from the Git repository and use them without having to reinstall. Download or clone the source repository then:
python setup.py develop