Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fpoussin/qtusb
A cross-platform USB Module for Qt.
https://github.com/fpoussin/qtusb
libusb qt qt5 usb
Last synced: about 19 hours ago
JSON representation
A cross-platform USB Module for Qt.
- Host: GitHub
- URL: https://github.com/fpoussin/qtusb
- Owner: fpoussin
- License: lgpl-3.0
- Created: 2014-04-15T08:59:58.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-10-30T17:34:12.000Z (3 months ago)
- Last Synced: 2025-01-25T07:02:29.102Z (8 days ago)
- Topics: libusb, qt, qt5, usb
- Language: C++
- Homepage:
- Size: 1.26 MB
- Stars: 421
- Watchers: 24
- Forks: 166
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QtUsb [](https://badge.fury.io/gh/fpoussin%2Fqtusb)
GCC: [](https://github.com/fpoussin/QtUsb/actions/)
MSVC: [](https://ci.appveyor.com/project/fpoussin/qtusb)
A Cross-platform USB Module for Qt built around libusb-1.0 and libhidapi
Can be used as a library, or included directly into the project
## Features
- Bulk transfer
- Interrupt transfer
- Hotplug detection
- Device enumeration and filtering
- HID
## Install library
**Ubuntu** (stable versions only)
```
sudo add-apt-repository ppa:fpoussin/ppa
sudo apt install libqt5usb5 libqt5usb5-dev
```
**Windows**
Check the [releases](https://github.com/fpoussin/QtUsb/releases) page or [appveyor build artifacts](https://ci.appveyor.com/project/fpoussin/qtusb) for binary archives
## Build
**Unix**
You need `libusb-1.0-0-dev`, `libhidapi-dev` and `pkg-config` packages installed
If using system packages on Ubuntu, you'll need `qt6-base-private-dev` as well.
```shell
mkdir build && cd build
cmake ..
make install
```
Alternatively build as static module (best for portability)
```shell
mkdir build && cd build
cmake -DQTUSB_AS_STATIC_MODULE=ON ..
make install
```
**MSVC**
You need the Windows SDKs to compile libusb
These are available from the Visual Studio Installer
The following script builds and deploys QtUsb into your Qt installation
```
build_msvc.bat 2017|2019 x64|x86 module|static QT_PATH
ie: build_msvc.bat 2017 x64 static C:\Qt\5.14.1\msvc2017_64
```
**Qt Creator**
The module can also be built normally within QT creator regardless of the platform.
All dependencies are built with cmake.
## Using
**Option 1: Using the module (static or dynamic)**
You'll need to add the module to into CMakeLists.txt:
```
find_package(Qt6 REQUIRED COMPONENTS Core Usb)
```
Include headers:
```
#include
#include
```
**Option 2: Importing the code in your project**
This will tie your app to a specific Qt version as it uses private headers
You need to add the QtUsb subdirectoty into CMakeLists.txt:
```
set(QTUSB_MODULE OFF CACHE BOOL "" FORCE)
add_subdirectory(qtusb) # this assumes that QtUsb is cloned into ./qtusb
add_library(Qt::Usb ALIAS ExtUsb)
add_executable(my_program main.cpp)
# (omitting linking with Qt and other libraries)
target_link_libraries(my_program PUBLIC Qt::Usb)
```
Include headers:
```
#include
#include
```
## Documentation
QCH files can be found with each release, they are also included in ubuntu packages.
You have to manually install them in Qt Creator on Windows.
Online documentation can be found [here](https://fpoussin.github.io/doxygen/qtusb/0.7.x/)
## Downloads
[Ubuntu PPA](https://launchpad.net/~fpoussin/+archive/ubuntu/ppa)
Windows binaries are [in the releases section](https://github.com/fpoussin/QtUsb/releases).