README.md

python-can-cvector

---

Table of Contents

• Description
• Installation
• Usage
• Test
• Build
• License

Description

This package provides a Cython based version of the python-can VectorBus. can_cvector.CVectorBus is a subclass of can.interfaces.vector.VectorBus which reimplements the send() and recv() methods for improved performance.

Installation

pip install python-can-cvector

Usage

The class can be used either through the python-can API

from can import Bus
bus = Bus(interface="cvector", serial=100, channel=0)

or instantiated directly

from can_cvector import CVectorBus
bus = CVectorBus(serial=100, channel=0)

Read the python-can documentation to learn more.

Test

pip install pytest
pytest ./tests

Build

To build python-can-cvector from source you need to set the environment variable VXLAPI_DIR which points to the directory which Vector XL Driver Library (e.g. C:\Users\Public\Documents\Vector\XL Driver Library 20.30.14\bin).

pip install build
python -m build .

License

python-can-cvector is distributed under the terms of the LGPL-3.0-or-later license.