Metadata-Version: 1.1
Name: canlib
Version: 1.2.163
Summary: Python wrapper for Kvaser CANlib
Home-page: https://github.com/Kvaser/python-canlib
Author: Kvaser AB
Author-email: support@kvaser.com
License: MIT
Description: ===========================================
        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 libraries
        -------------------
        The following libraries are currently supported.
        
        =============  ====================  ===================  =============
        Library         Class                Windows              Linux
        =============  ====================  ===================  =============
        CANlib         canlib.canlib         canlib32.dll         libcanlib.so
        kvaMemoLibXML  canlib.kvaMemoLibXml  kvaMemoLibXML.dll    not supported
        kvrlib         canlib.kvrlib         kvrlib.dll,          not supported
                                             irisdll.dll,
                                             irisflash.dll,
                                             libxml2.dll
        kvmlib         canlib.kvmlib         kvaMemoLib0600.dll,  not supported
                                             kvaMemoLib0700.dll,
                                             kvaMemoLib.dll,
                                             kvmlib.dll
        kvlclib        canlib.kvlclib        kvlclib.dll [1]_     not supported
        =============  ====================  ===================  =============
        
        .. [1] The kvlclib.dll depends on dll files from matlab wich are installed alongside kvlclib.dll.
        
        
        What's new
        ------------
        For a complete set of release notes, see `Release Notes <Relnotes.html>`__.
        
        
        Installation
        ------------
        Install the Python package using e.g. ``pip``:
        
        .. code-block:: bash
        
            $ pip install canlib-x.y.z.zip
        
        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/. 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 the kvmlib wrapper is to be used. This will install ``kvaMemoLib0600.dll``, ``kvaMemoLib0700.dll``, ``kvaMemoLib.dll`` and ``kvmlib.dll``.
        
        
        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/.
        
        Currently, only Kvaser CANlib is supported on Linux.
        
        Usage
        -----
        
        Example of using canlib to list connected Kvaser devices:
        
        .. code-block:: Python
        
                import canlib.canlib as canlib
        
                cl = canlib.canlib()
                num_channels = cl.getNumberOfChannels()
                print("Found %d channels" % num_channels)
                for ch in range(0, num_channels):
                    print("%d. %s (%s / %s)" % (ch, cl.getChannelData_Name(ch),
                                                cl.getChannelData_EAN(ch),
                                                cl.getChannelData_Serial(ch)))
        
        Which may result in:
        
        .. code-block:: Python
        
                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 http://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: http://www.kvaser.com/developer/canlib-sdk/
          * Description of CANlib SDK library contents: http://www.kvaser.com/developer-blog/get-hardware-kvaser-sdk-libraries/
        
Keywords: development
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.4
