Back to developer Blog

A more object oriented approach on accessing your Kvaser device from Python (3 of 3)

  • April 14, 2015
  • Magnus Carlsson

This blog uses now deprecated functions, see blog “Improved API in Python canlib v1.5” for more information.

This is the last post in a 3-part series about using Python with Kvaser products:

  1. Accessing Kvaser CANlib from Python
  2. Using Python to connect to your remote device
  3. A more object oriented approach on accessing your Kvaser device from Python

Earlier we have seen how to use the canlib.py and kvrlib.py wrappers in Python (currently for v2.7). However, those are primarily just “wrappers” and do not take into account the flexibility we get with an object oriented language as Python (this is equally true for other wrappers like C#).

During testing, the focus is often on a specific device instead of the channel centered CANlib. This is especially true when you are dealing with remote devices such as Kvaser BlackBird v2 and Ethercan that tend to turn up on new CANlib channels when connected remotely. This is now taken care of via the new Python module kvDevice.

To open a specific device, supply the EAN and serial number as shown below.

import os
import sys
sys.path.append("C:/temp/Canlib_SDK_v5.9/Samples/Python")

import kvDevice

device = kvDevice.kvDevice(ean="73-30130-00778-9", serial=1023)
print "\n", device

If we have a device with EAN and serial number that matches we get the following output:

Device: Kvaser Memorator Pro 5xHS (channel 0)
EAN           : 73-30130-00778-9
S/N           : 1023
FW            : v2.5.287
Card          : 1
Drv           : kcany1a
Canlib channel: 3

If we do not specify the serial number, we get the first device that matches the EAN. It is also possible to specify a CANlib channel directly.

device = kvDevice.kvDevice(ean="73-30130-00778-9")
print "\n", device

device = kvDevice.kvDevice(ch=6)
print "\n", device
Device: Kvaser Memorator Pro 5xHS (channel 0)
EAN           : 73-30130-00778-9
S/N           : 1023
FW            : v2.5.287
Card          : 1
Drv           : kcany1a
Canlib channel: 2

Device: Kvaser Memorator Pro 5xHS (channel 4)
EAN           : 73-30130-00778-9
S/N           : 1023
FW            : v2.5.287
Card          : 1
Drv           : kcany1e
Canlib channel: 6

As a final example, if the specified device is not found, we still get a device returned but we do not get any information about it.

devices = kvDevice.kvDevice.allDevices()
print "List all %d devices" % (len(devices))
for dev in devices:
print "\n", dev

print "\n---\nTry and find a non-existing device."
device = kvDevice.kvDevice(ean="73-30130-00778-9", serial=100)
print "\n", device
List all 2 devices

Device: Kvaser Eagle (channel 0)
EAN           : 73-30130-00567-9
S/N           : 71
FW            : v2.5.261
Card          : 0
Drv           : kcany0a
Canlib channel: 0

Device: Kvaser Memorator Pro 5xHS (channel 0)
EAN           : 73-30130-00778-9
S/N           : 1023
FW            : v2.5.287
Card          : 1
Drv           : kcany1a
Canlib channel: 2
---
Try and find a non-existing device.

Device: None
EAN           : 73-30130-00778-9
S/N           : 100
FW            : None
Card          : None
Drv           : None
Canlib channel: None

If you take a look inside the module kvDevice.py, you’ll notice that most of the attributes are stored in names starting with an underscore (_driver, _channel and so on). This tries to denote that these values are the last known values. (In Python, a leading underscore is normally a weak “internal use” indicator.) That is, the device could now have been removed and perhaps also reinserted and thus got renumbered, but the last time the device was opened via kvDevice.py, it was found using those values. (The device was found on CANlib channel _channel using the driver name _driver.)

Hopefully, this overview of how Python can be used to help manage Kvaser devices will help you to be even more productive in your role as a developer.

EDIT 2015-05-22: Stated that the current wrappers are written for Python v2.7.

Comments?  Contact us directly at [email protected].

Author Image

Magnus Carlsson

Magnus Carlsson is a Software Developer for Kvaser AB and has developed firmware and software for Kvaser products since 2007. He has also written a number of articles for Kvaser’s Developer Blog dealing with the popular Python language.

Related posts

KVASER CANlib and Python Part 3: U100 & Python Highlights
In this small guide we will explain how the LEDs on the U100 works and how to use them. Writer: Anton Carlsson,  Software Developer Cowriter: L-G Fredriksson, Field Application Engineer Version: 2021-08-09A Who should read this? This guide is meant for those who want to setup and use a Kvaser CAN interface with CANlib and...
Read more
Kvaser DIN Rail – Remote Device With I/O Pins
In this article, we take a look at the Kvaser DIN Rail and how to control this device using CANlib. Overview HW The Kvaser DIN Rail family is a collection of Ethernet to CAN/CAN FD interfaces with support for I/O ports via add-on modules. The housing has a mounting clip that attaches to a 35...
Read more
Running Python wrapper on Linux
This is an update of an older blog post and is now taking advantage of the Python canlib package v1.6 and later. Today we take a look at how to setup and send a CAN message using Kvasers Python package canlib. For this example we use the Kvaser USBcan Pro 2xHS v2, but any Kvaser...
Read more
Digging deeper into kvmlib
This is the third post in a 4-part series about configuring and reading logged data using a Kvaser Memorator 2nd Generation device through kvmlib: 1 Getting started with kvmlib 2 Adding script and triggers to a configuration 3 Digging deeper into kvmlib 4 Configure an SD card using kvmlib In the first part we showed...
Read more
Adding script and triggers to a configuration
This is the second post in a 4-part series about configuring and reading logged data using a Kvaser Memorator 2nd Generation device through kvmlib: 1 Getting started with kvmlib 2 Adding script and triggers to a configuration 3 Digging deeper into kvmlib 4 Configure an SD card using kvmlib In the first part we showed how...
Read more
Getting started with kvmlib
This is the first post in a 4-part series about configuring and reading logged data using a Kvaser Memorator 2nd Generation device through kvmlib: 1 Getting started with kvmlib 2 Adding script and triggers to a configuration 3 Digging deeper into kvmlib 4 Configure an SD card using kvmlib This first post will give an...
Read more
Improved API in Python canlib v1.5
In version 1.5 of the Python wrapper, a lot of improvements were made. Two new libraries were wrapped; LINlib, which holds the LIN bus API, and kvaDbLib which contains the Database API (and there will be some blog on how to use those in the future). The biggest change was however under the hood were...
Read more
Reading signals from log files
We have seen in earlier blog articles how to create a DBC database and how to use signals from the database while sending and receiving CAN traffic.1 This time we’ll take a look at how we can use the DBC database to show signals from logged data. Configure the logger In order to capture our...
Read more
Send and receive database signals
This is the second post in a 2-part series about how to manage DBC databases using the Kvaser database library (kvadblib) and Python: Handling CAN databases in Python Send and receive database signals   In the first post we created a DBC database and took a peek inside to verify that we got what we...
Read more
Handling CAN databases in Python
This is the first post in a 2-part series about how to manage DBC databases using the Kvaser database library (kvadblib) and Python: Handling CAN databases in Python Send and receive database signals With the release of CANlib SDK v5.22, the database library (kvaDbLib) has been overhauled and the Python canlib wrapper package (v1.5) have...
Read more
RSSCopy Link

Get The Latest news feeds from our RSS