Changes between Version 39 and Version 40 of WikiStart


Ignore:
Timestamp:
06/03/12 18:07:03 (12 months ago)
Author:
sping
Comment:

Only summarizy API versions on front page and point to new APIs page for detail

Legend:

Unmodified
Added
Removed
Modified
  • WikiStart

    v39 v40  
    66libusb is a C library which gives applications easy access to USB devices on many different operating systems. libusb is an open source project, the code is licensed under the [http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html GNU Lesser General Public License version 2.1]. 
    77 
    8 == Version overview == 
     8== Getting started == 
     9There are two versions of the API, the current API [wiki:libusb-1.0] and its legacy predecessor [wiki:APIs#libusb-0.1legacyAPI libusb-0.1].[[BR]] 
     10For all future development please pick [wiki:libusb-1.0], for a detailed comparison of API versions see the [wiki:APIs APIs page]. 
    911 
    10 There are two libusb API versions: 
    11  * [wiki:libusb-1.0] is the current version, under active development 
    12  * libusb-0.1 is the original version which is deprecated and unmaintained since many years 
    13   * libusb-compat-0.1 is a compatibility library which provides the libusb-0.1 API by using libusb-1.0 
     12||       ||= Download =||= Documentation =|| 
     13||=0.1 (legacy) =|| [http://sourceforge.net/projects/libusb/files/libusb-compat-0.1/ libusb-compat-0.1.xx.tar.bz2] || [http://libusb.sourceforge.net/doc/ 0.1.xx API documention] || 
     14||='''1.0''' =|| [http://sourceforge.net/projects/libusb/files/libusb-1.0/ libusb-1.0.xx.tar.bz2] || [http://libusb.sourceforge.net/api-1.0/ 1.0.xx API documention] || 
    1415 
    15 The different API versions do not conflict, so they can be installed in parallell on a system. However, if you have installed libusb-1.0 then we strongly recommend to use libusb-compat-0.1 instead of the ancient libusb-0.1 code, so that programs which use both the 0.1 API and the 1.0 API in different parts of the program, or in different libraries used by the program, will both end up using libusb-1.0 for actual device access. This is important to avoid potential conflicts between libusb-1.0 and libusb-0.1 being used ''by the same process''. 
    16  
    17 In addition to the above libraries by the libusb project there is also a separate project which provides the libusb-0.1 API on Windows: 
    18  
    19 * [wiki:libusb-win32] (It is a separate project, but several contributors participate in both libusb and libusb-win32.) 
    20  
    21 == Current API version: libusb-1.0 == 
    22  
    23 Daniel Drake adopted the project in January 2008 and worked on the [wiki:libusb-1.0] API and implementation, which adds several features missing in the 0.1 API. libusb-1.0 is the recommended version to use for all new development. Developers are encouraged to port existing applications which use libusb-0.1 to use the new API. 
    24  
    25  * Latest release: '''[http://sourceforge.net/projects/libusb/files/libusb-1.0/libusb-1.0.9/libusb-1.0.9.tar.bz2/download 1.0.9]''' 
    26  * ''See the [wiki:libusb-1.0] page for more detailed information about libusb-1.0'' 
    27  * [api-1.0: libusb-1.0 API documentation] 
    28  * Linux, Mac OS X, [wiki:windows_backend Windows], OpenBSD and NetBSD are currently supported. 
    29  * FreeBSD includes a separate implementation of the libusb-0.1 and libusb-1.0 APIs in the system libc. 
    30  * The [wiki:windows_backend Windows backend] currently depends on the generic USB device driver WinUSB.sys by Microsoft, which is included with all Windows versions starting with Windows Vista. There is [ticket:49 a ticket] about support for the libusb0.sys kernel driver developed by the libusb-win32 project. 
    31  
    32 A device driver which supports libusb must always be used for the device on every operating system. Each operating system has different rules for device drivers. On Mac OS X, if an interface driver included with the OS matches the characteristics of a device, that driver will seize the interface, and the driver cannot be detached by libusb, so libusb will not be able to use that interface. In the case of OpenBSD and NetBSD, libusb-1.0 can be used only for device with ugen driver. For Windows, if you need to read from or write to the USB device, currently only devices with WinUSB driver are supported. 
    33  
    34 libusb is not well suited for accessing HID class devices. It is possible to use libusb with HID device though if the original driver is replaced by a supported driver but this is usually not easy on non-Linux platforms. It is recommended to use [http://www.signal11.us/oss/hidapi/ HIDAPI] instead, for convenient and cross-platform access to HID class devices. 
    35  
    36 == Legacy API: libusb-0.1 == 
    37  
    38 Johannes Erdfelt founded the libusb project and lead development through 2007. By then, libusb-0.1 had stabilized, and was adopted by a wide range of projects. 
    39  
    40  * Last release: [http://sourceforge.net/project/showfiles.php?group_id=1674&package_id=1632&release_id=398442 libusb-0.1.12] 
    41  * Supported operating systems: Linux, FreeBSD, NetBSD, OpenBSD, Darwin, MacOS X (and Windows, through the [wiki:libusb-win32] project). Solaris has a [http://cvs.opensolaris.org/source/xref/userland/src/components/libusb/ wrapper for libusb-0.1] as well. There are also independent implementation efforts for other OS like BeOS and OS/2 which may not be mature enough. 
    42  * Development status: libusb-0.1 is deprecated and will have no further changes or releases 
    43  * Note that [wiki:libusb-win32] is a separate project which still sees active development. The next generation libusb-win32 kernel driver (libusbk.sys) is based on KMDF. The [http://sourceforge.net/projects/libusbk/ libusbk] library will support the existing libusb-win32 API, libusb-1.0 API and WinUSB-like API. libusb-win32 users who are fine with the libusb-win32 API are recommended to keep using it since it will be supported by the libusb-win32 project. libusb-win32 users who are interested in libusb-1.0 will also be supported once the libusbk backend is integrated. Future enhancement of the libusb-1.0 API (say libusb-1.1) may be required to be more suitable for Windows users. 
    44  * [http://sourceforge.net/project/showfiles.php?group_id=1674 Download libusb-0.1 releases here] 
    45  * [doc-0.1: libusb-0.1 API documentation] 
    46  * [libusb-win32:libusbwin32_examples Unofficial bindings] at the libusb-win32 site 
    47  * [libusb-win32:libusbwin32_examples Projects and Examples using libusb-win32] 
    4816 
    4917== Support ==