controls-kt/controls-core/README.md

32 lines
1.3 KiB
Markdown
Raw Normal View History

2023-08-18 13:01:46 +03:00
# Module controls-core
2023-08-23 16:21:11 +03:00
Core interfaces for building a device server
2023-08-18 13:01:46 +03:00
## Features
- [device](src/commonMain/kotlin/space/kscience/controls/api/Device.kt) : Device API with subscription (asynchronous and pseudo-synchronous properties)
- [deviceMessage](src/commonMain/kotlin/space/kscience/controls/api/DeviceMessage.kt) : Specification for messages used to communicate between Controls-kt devices.
- [deviceHub](src/commonMain/kotlin/space/kscience/controls/api/DeviceHub.kt) : Grouping of devices into local tree-like hubs.
2023-08-23 16:21:11 +03:00
- [deviceSpec](src/commonMain/kotlin/space/kscience/controls/spec) : Mechanics and type-safe builders for devices. Including separation of device specification and device state.
- [deviceManager](src/commonMain/kotlin/space/kscience/controls/manager) : DataForge DI integration for devices. Includes device builders.
- [ports](src/commonMain/kotlin/space/kscience/controls/ports) : Working with asynchronous data sending and receiving raw byte arrays
2023-08-18 13:01:46 +03:00
## Usage
## Artifact:
2024-05-15 22:49:08 +03:00
The Maven coordinates of this project are `space.kscience:controls-core:0.4.0-dev-1`.
2023-08-18 13:01:46 +03:00
**Gradle Kotlin DSL:**
```kotlin
repositories {
maven("https://repo.kotlin.link")
mavenCentral()
}
dependencies {
2024-05-15 22:49:08 +03:00
implementation("space.kscience:controls-core:0.4.0-dev-1")
2023-08-18 13:01:46 +03:00
}
```