controls-kt/controls-modbus/README.md

30 lines
983 B
Markdown
Raw Permalink Normal View History

2023-05-03 11:05:54 +03:00
# Module controls-modbus
A plugin for Controls-kt device server on top of modbus-rtu/modbus-tcp protocols
2023-08-23 16:21:11 +03:00
## Features
- [modbusRegistryMap](src/main/kotlin/space/kscience/controls/modbus/ModbusRegistryMap.kt) : Type-safe modbus registry map. Allows to define both single-register and multi-register entries (using DataForge IO).
Automatically checks consistency.
- [modbusProcessImage](src/main/kotlin/space/kscience/controls/modbus/DeviceProcessImage.kt) : Binding of slave (server) modbus device to Controls-kt device
- [modbusDevice](src/main/kotlin/space/kscience/controls/modbus/ModbusDevice.kt) : A device with additional methods to work with modbus registers.
2023-08-16 18:26:21 +03:00
## Usage
## Artifact:
2024-06-17 17:49:12 +03:00
The Maven coordinates of this project are `space.kscience:controls-modbus:0.4.0-dev-4`.
2023-08-16 18:26:21 +03:00
**Gradle Kotlin DSL:**
```kotlin
repositories {
maven("https://repo.kotlin.link")
mavenCentral()
}
dependencies {
2024-06-17 17:49:12 +03:00
implementation("space.kscience:controls-modbus:0.4.0-dev-4")
2023-08-16 18:26:21 +03:00
}
```