libusb documentation

libusb

Python binding for the libusb C library.

Overview

Python libusb module is a low-level binding for libusb C library.

It is an effort to allow python programs full access to the API implemented and provided by the well known *libusb* library.

PyPI record.

Documentation.

libusb is a lightweight Python package, based on the ctypes library.

It is fully compliant implementation of the original C libusb 1.0 API by implementing whole its functionality in a clean Python instead of C.

libusb API 1.0 documentation can be found at:

libusb-1.0 API Reference

libusb uses the underlying libusb C shared library as specified in libusb.cfg (included libusb-X.X.* is the default), but there is also ability to specify it programmatically by one of the following ways:

import libusb
libusb.config(LIBUSB="libusb C shared library absolute path")
# or
libusb.config(LIBUSB=None)  # included libusb-X.X.* will be used

About original libusb:

Borrowed from the original website:

libusb - A cross-platform user library to access USB devices

Overview

libusb is a C library that provides generic access to USB devices. It is intended to be used by developers to facilitate the production of applications that communicate with USB hardware.

It is portable: Using a single cross-platform API, it provides access to USB devices on Linux, OS X, Windows, Android, OpenBSD, etc.

It is user-mode: No special privilege or elevation is required for the application to communicate with a device.

It is version-agnostic: All versions of the USB protocol, from 1.0 to 3.1 (latest), are supported.

What platforms are supported?

Linux, OS X, Windows, Windows CE, Android, OpenBSD/NetBSD, Haiku.

For additional information, please consult the FAQ or the Wiki.

Requirements

• It is a fully independent package.

  All necessary things are installed during the normal installation process.

• ATTENTION: currently works and tested only for Windows.

Installation

Prerequisites:

• Python 3.8 or higher

  • https://www.python.org/

  • with C libusb 1.0.26 is a primary test environment.

• pip and setuptools

  • https://pypi.org/project/pip/

  • https://pypi.org/project/setuptools/

To install run:

python -m pip install --upgrade libusb

Development

Prerequisites:

• Development is strictly based on tox. To install it run:

  python -m pip install --upgrade tox
  

Visit Development page.

Installation from sources:

clone the sources:

git clone https://github.com/karpierz/libusb.git libusb

and run:

python -m pip install ./libusb

or on development mode:

python -m pip install --editable ./libusb

License

Copyright (c) 2016-2024 Adam Karpierz

Licensed under the zlib/libpng License

https://opensource.org/license/zlib

Please refer to the accompanying LICENSE file.

Authors

• Adam Karpierz <adam@karpierz.net>

Contents

• Changelog
  • 1.0.27.post1 (2024-02-08)
  • 1.0.27 (2024-02-05)
  • 1.0.26 (2024-02-05)
  • 1.0.26rc4 (2024-01-25)
  • 1.0.26rc2 (2023-12-20)
  • 1.0.26rc1 (2023-12-15)
  • 1.0.26b5 (2022-09-10)
  • 1.0.26b4 (2022-08-25)
  • 1.0.26b3 (2022-07-25)
  • 1.0.26b2 (2022-07-18)
  • 1.0.24b3 (2022-01-10)
  • 1.0.24b1 (2021-11-10)
  • 1.0.23b7 (2020-11-19)
  • 1.0.23b1 (2020-09-15)
  • 1.0.22b9 (2020-01-17)
  • 1.0.22b8 (2019-11-24)
  • 1.0.22b6 (2019-11-23)
  • 1.0.22b5 (2019-11-14)
  • 1.0.22b4 (2019-02-15)
  • 1.0.22b2 (2018-11-08)
  • 1.0.22b1 (2018-03-30)
  • 1.0.21b4 (2018-02-26)
  • 1.0.21b3 (2018-02-25)
  • 1.0.21b2 (2017-12-18)
  • 1.0.21b1 (2017-10-11)
  • 1.0.21a3 (2017-08-20)
  • 1.0.21a0 (2016-09-24)
  • 0.0.1 (2016-09-23)

Indices and tables

• Index

• Search Page