# Canlib - a Python wrapper for Kvaser CANlib

The Canlib module is a Python wrapper for Kvaser CANlib SDK.

“The CANlib Software Development Kit is your transparent Application Programming Interface for working with all Kvaser hardware platforms.”

## Supported platforms

Windows and Linux using Python v2.7 or v3.4+ (both 32 and 64 bit).

## Supported libraries

The following libraries are currently supported:

Library | Module | Windows | Linux
--- | --- | --- | ---
CANlib | canlib.canlib | canlib32.dll | libcanlib.so
kvaMemoLibXML | canlib.kvamemolibxml | kvaMemoLibXML.dll | libkvamemolibxml.so
kvrlib | canlib.kvrlib | kvrlib.dll, irisdll.dll, irisflash.dll, libxml2.dll | not supported
kvmlib | canlib.kvmlib | kvaMemoLib0600.dll, kvaMemoLib0700.dll, kvaMemoLib.dll, kvmlib.dll | not supported, [2] libkvamemolib0700.so, libkvamemolib.so, libkvmlib.so
kvlclib | canlib.kvlclib | kvlclib.dll [1] | libkvlclib.so
kvaDbLib | canlib.kvadblib | kvaDbLib.dll | libkvadblib.so
LINlib | canlib.linlib | linlib.dll | liblinlib.so

[1] | The kvlclib.dll depends on dll files from matlab wich are installed alongside kvlclib.dll.

[2] | The kvaMemoLib0600.dll, which supports older devices, is not supported under Linux.

## What’s new

For a complete set of release notes, see Release Notes.

## Installation

Install the Python package using e.g. `pip`:

    $ pip install canlib-x.y.z-py2.py3-none-any.whl

The Kvaser CANlib DLLs or shared libraries also needs to be installed:

### Windows

On Windows, first install the `canlib32.dll` by downloading and installing “Kvaser Drivers for Windows” which can be found on the Kvaser Download page https://www.kvaser.com/downloads-kvaser/. This will also install `kvrlib.dll`, `irisdll.dll`, `irisflash.dll` and `libxml2.dll` used by kvrlib.

The “Kvaser CANlib SDK” also needs to be downloaded from the same placed and installed if more then just CANlib will be used. This will install the rest of the supported library dll’s.

The two packages, “Kvaser Drivers for Windows” and “Kvaser CANlib SDK”, contains both 32 and 64 bit versions of the included dll’s.

### Linux

On Linux, first install the `libcanlib.so` by downloading and installing “Kvaser LINUX Driver and SDK” which can be found on the Kvaser Download page https://www.kvaser.com/downloads-kvaser/.

If more than just CANlib will be used, the rest of the supported libraries will be available by downloading and installing `kvlibsdk.tar.gz`.

## Usage

Example of using canlib to list connected Kvaser devices:

    from canlib import canlib

    num_channels = canlib.getNumberOfChannels()
    print("Found %d channels" % num_channels)
    for ch in range(0, num_channels):
        chdata = canlib.ChannelData(ch)
        print("%d. %s (%s / %s)" % (ch, chdata.device_name,
                                    chdata.card_upc_no,
                                    chdata.card_serial_no))

Which may result in:

    Found 4 channels
    0. Kvaser Memorator Professional HS/HS (channel 0) (73-30130-00351-4 / 12377)
    1. Kvaser Memorator Professional HS/HS (channel 1) (73-30130-00351-4 / 12377)
    2. Kvaser Virtual CAN Driver (channel 0) (00-00000-00000-0 / 0)
    3. Kvaser Virtual CAN Driver (channel 1) (00-00000-00000-0 / 0)

## Support

You are invited to visit the Kvaser web pages at https://www.kvaser.com/support/. If you don’t find what you are looking for, you can obtain support on a time-available basis by sending an e-mail to support@kvaser.com.

Bug reports, contributions, suggestions for improvements, and similar things are much appreciated and can be sent by e-mail to support@kvaser.com.

## References

> - Kvaser CANlib SDK Page: https://www.kvaser.com/developer/canlib-sdk/
> - Description of CANlib SDK library contents: https://www.kvaser.com/developer-blog/get-hardware-kvaser-sdk-libraries/

## Wrapped libraries

- canlib.canlib
- canlib.kvadblib
- canlib.kvamemolibxml
- canlib.kvlclib
- canlib.kvmlib
- canlib.kvrlib
- canlib.linlib

## Additional helper modules

- canlib.ean
- canlib.exceptions
- canlib.frame
- canlib.kvDevice
- canlib.kvMemoConfig
- canlib.versionnumber