https://github.com/mcarr823/kotlin-usb-client-library
Kotlin Multiplatform Module for accessing Serial Ports from Kotlin code
https://github.com/mcarr823/kotlin-usb-client-library
coroutines kotlin-library kotlin-multiplatform
Last synced: 6 months ago
JSON representation
Kotlin Multiplatform Module for accessing Serial Ports from Kotlin code
- Host: GitHub
- URL: https://github.com/mcarr823/kotlin-usb-client-library
- Owner: mcarr823
- License: gpl-3.0
- Created: 2025-06-19T10:40:46.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-06-19T10:50:39.000Z (6 months ago)
- Last Synced: 2025-06-19T11:45:43.030Z (6 months ago)
- Topics: coroutines, kotlin-library, kotlin-multiplatform
- Language: Kotlin
- Homepage:
- Size: 85.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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](https://github.com/Fazecast/jSerialComm) on desktop, and either jSerialComm or [USB Serial For Android](https://github.com/mik3y/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
| Platform | Supported | Artifact |
|----------|-----------|-------------------------------|
| Core | | dev.mcarr.usb:library |
| JVM | ✓ | dev.mcarr.usb:library-jvm |
| Android | ✓ | dev.mcarr.usb:library-android |
| Native | ✗ | |
| iOS | ✗ | |
| Web | ✗ | |
* Requires Java 21 or higher
## Usage
```Kotlin
// 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](https://mcarr823.github.io/kotlin-usb-client-library).
## 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.
1. Add jitpack to your repositories (only necessary for Android targets):
```Kotlin
// settings.gradle.kts
dependencyResolutionManagement {
repositories {
// For the android serial library
maven(url = "https://jitpack.io")
}
}
```
2. Add the library definition and version to your TOML file (if you use one):
```toml
# 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" }
```
3. Add the dependency to your app's build.gradle.kts file for any platforms you want to support:
```Kotlin
// 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