co_usb

‍[!IMPORTANT] Experimental - may be unstable, expect all kind of changes

co_usb

Asynchronous USB library using C++20 coroutines and Boost.Capy to create a lightweight interface for libusb-1.0. It provides minimal necessary abstractions over base libusb to enable efficient and clean concurrent I/O using Boost.Capy's common interfaces for seamless interoperability with wider coroutine ecosystem.

Getting started

This project uses vcpkg as a package manager. To use it in your vcpkg-based projects, do the following:

1. Add portfile and vcpkg.json to your ports directory
2. Copy ./res/ports/boost-capy/ and ./res/ports/libusb/ to your ports dir
3. Provide them as overlay to the vcpkg
4. Add the following to your CMakeLists.txt:

   find_package(co_usb CONFIG REQUIRED)
   target_link_libraries(my_app PRIVATE co_usb::co_usb)

For non-vcpkg projects, you will have to use CMake's FetchContent module and provide Boost.Capy and libusb on your own. This is method of consuming co_usb is not endorsed and may not work.

include(FetchContent)
FetchContent_Declare(co_usb
    GIT_REPOSITORY https://github.com/gubnik/co_usb.git
    GIT_TAG master
    GIT_SHALLOW TRUE)
FetchContent_MakeAvailable(co_usb)
 
target_link_libraries(my_app co_usb::co_usb)

Build from source

To build from source:

git clone https://github.com/gubnik/co_usb.git
cd co_usb
./setup.sh x64-static Debug # or x64-dyn instead of x64-static, or Release instead of Debug

To fully rebuild:

./setup.sh ${PRESET} ${BUILD_TYPE} reset

Documentation

See docs for generated docs

License

Distributed under the Boost Software License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt)