kotlin-usb-client-library

1.0.1indexed

Simplifies access to USB/Serial ports, offering coroutine support and Kotlin data types. Wraps jSerialComm for desktop and Android, excluding iOS support.

AndroidJVM·mcarr823/kotlin-usb-client-library

Stars

Used by

dependents

—

Health

/ 100

Kotlin USB Client Library

What is it?

This library is a KMM (Kotlin Multiplatform Module) which makes it easier to access USB/Serial Ports from Kotlin code.

It wraps around the jSerialComm library on desktop, and either jSerialComm or USB Serial For Android on Android. (iOS is not currently supported)

This library provides:

kotlin data types (eg. ByteArray)
coroutine support, with suspending functions or deferred results

Supported platforms

Requires Java 21 or higher

Usage

// Get available devices
val devices = SerialPortList().get()

// Grab the USB device you want
val device = devices.first()

// Open the device (and close automatically)
device.use{

    // Set the baud rate
    it.setBaudRate(115200)

    // Write some data to the port
    it.write(data, writeTimeoutMilliseconds)

    // Read the response
    val response = it.read(responseSize, readTimeoutMilliseconds)

}

API Documentation

Javadoc can be found here.

Setup

The setup instructions below assume that you're building a gradle project, with a TOML file for dependency management and KTS files for gradle scripts.

The instructions should still work for other setups with minor changes.

Add jitpack to your repositories (only necessary for Android targets):

// settings.gradle.kts

dependencyResolutionManagement {
    repositories {
        // For the android serial library
        maven(url = "https://jitpack.io")
    }
}

Add the library definition and version to your TOML file (if you use one):

# libs.versions.toml

[versions]
usb = "1.0.0"

[libraries]
usb-library-core = { module = "dev.mcarr.usb:library", version.ref = "usb" }
usb-library-jvm = { module = "dev.mcarr.usb:library-jvm", version.ref = "usb" }
usb-library-android = { module = "dev.mcarr.usb:library-android", version.ref = "usb" }

Add the dependency to your app's build.gradle.kts file for any platforms you want to support:

// app (not root) build.gradle.kts

kotlin {
    sourceSets {
        val commonMain by getting {
            dependencies {
                implementation(libs.usb.library.core)
            }
        }
        val jvmMain by getting {
            dependencies {
                implementation(libs.usb.library.jvm)
            }
        }
        val androidMain by getting {
            dependencies {
                implementation(libs.usb.library.android)
            }
        }
    }
}

TODO

add Linux native support
look into web support
test Android version
automate unit test CI
check if timeouts are working properly

Related libraries

Surfaced from shared tags and platforms — no rankings paid for.

moko-network★ 154

icerockdevFacilitates network operations by generating API classes and entities from OpenAPI specifications, supports token-based authentication, error handling, and token refreshment, enhancing networking capabilities.Shared: coroutines

flow-operators★ 151

skydovesEnables creation of restartable, pausable, or one-shot state flow instances, enhancing control over data streams and state management in complex scenarios.Shared: coroutines

kotysa★ 134

ufoss-orgLight ORM enabling type-safe SQL with idiomatic syntax. Supports JDBC, R2DBC, Vertx sqlclient, and various databases including PostgreSQL, MySQL, and SQLite. No annotations or code generation required.Shared: coroutines

stream-result★ 106

GetStreamRailway-oriented library simplifies handling success and failure with a normalized `Result` model. Integrates seamlessly with Retrofit, offering extensions for chaining operations, error handling, and retry policies, enhancing functional programming practices.Shared: coroutines

Paginator★ 105

jamal-wiaPowerful, flexible pagination toolkit with bidirectional navigation, arbitrary jumps, bookmarks, caching, element-level CRUD, capacity/incomplete-page handling, reactive snapshot flows, parallel loading and state serialization.Shared: coroutines

KmpIO★ 86

skolsonLibrary enables cross-platform file I/O, including text, binary, and zip/archive files. Features coroutine support, charset encoding/decoding, bitwise operations, byte buffers with endian support, and customizable zip file handling.Shared: coroutines

Core		dev.mcarr.usb:library
JVM	✓	dev.mcarr.usb:library-jvm
Android	✓	dev.mcarr.usb:library-android
Native	✗
iOS	✗
Web	✗