kscience/controls-kt
8
0
Fork 0
Code Issues Pull Requests 2 Packages Projects Releases 1 Wiki Activity

update device-collective readme

Browse Source
This commit is contained in:
Alexander Nozik 2024-06-17 17:49:12 +03:00
parent eb126a6090
commit 92c4355f48
24 changed files with 66 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -134,6 +134,11 @@ Automatically checks consistency.
> >
> **Maturity**: PROTOTYPE > **Maturity**: PROTOTYPE
### [controls-visualisation-compose](controls-visualisation-compose)
> Visualisation extension using compose-multiplatform
>
> **Maturity**: PROTOTYPE
### [demo](demo) ### [demo](demo)
> >
> **Maturity**: EXPERIMENTAL > **Maturity**: EXPERIMENTAL
@ -159,6 +164,10 @@ Automatically checks consistency.
> >
> **Maturity**: EXPERIMENTAL > **Maturity**: EXPERIMENTAL
### [demo/device-collective](demo/device-collective)
>
> **Maturity**: EXPERIMENTAL
### [demo/echo](demo/echo) ### [demo/echo](demo/echo)
> >
> **Maturity**: EXPERIMENTAL > **Maturity**: EXPERIMENTAL

4
controls-constructor/README.md
View File

@ -6,7 +6,7 @@ A low-code constructor for composite devices simulation
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:controls-constructor:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:controls-constructor:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:controls-constructor:0.4.0-dev-1") implementation("space.kscience:controls-constructor:0.4.0-dev-4")
} }
``` ```

4
controls-core/README.md
View File

@ -16,7 +16,7 @@ Core interfaces for building a device server
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:controls-core:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:controls-core:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -26,6 +26,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:controls-core:0.4.0-dev-1") implementation("space.kscience:controls-core:0.4.0-dev-4")
} }
``` ```

4
controls-jupyter/README.md
View File

@ -6,7 +6,7 @@
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:controls-jupyter:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:controls-jupyter:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:controls-jupyter:0.4.0-dev-1") implementation("space.kscience:controls-jupyter:0.4.0-dev-4")
} }
``` ```

4
controls-magix/README.md
View File

@ -12,7 +12,7 @@ Magix service for binding controls devices (both as RPC client and server)
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:controls-magix:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:controls-magix:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -22,6 +22,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:controls-magix:0.4.0-dev-1") implementation("space.kscience:controls-magix:0.4.0-dev-4")
} }
``` ```

4
controls-modbus/README.md
View File

@ -14,7 +14,7 @@ Automatically checks consistency.
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:controls-modbus:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:controls-modbus:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -24,6 +24,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:controls-modbus:0.4.0-dev-1") implementation("space.kscience:controls-modbus:0.4.0-dev-4")
} }
``` ```

4
controls-opcua/README.md
View File

@ -12,7 +12,7 @@ A client and server connectors for OPC-UA via Eclipse Milo
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:controls-opcua:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:controls-opcua:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -22,6 +22,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:controls-opcua:0.4.0-dev-1") implementation("space.kscience:controls-opcua:0.4.0-dev-4")
} }
``` ```

4
controls-pi/README.md
View File

@ -6,7 +6,7 @@ Utils to work with controls-kt on Raspberry pi
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:controls-pi:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:controls-pi:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:controls-pi:0.4.0-dev-1") implementation("space.kscience:controls-pi:0.4.0-dev-4")
} }
``` ```

4
controls-ports-ktor/README.md
View File

@ -6,7 +6,7 @@ Implementation of byte ports on top os ktor-io asynchronous API
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:controls-ports-ktor:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:controls-ports-ktor:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:controls-ports-ktor:0.4.0-dev-1") implementation("space.kscience:controls-ports-ktor:0.4.0-dev-4")
} }
``` ```

4
controls-serial/README.md
View File

@ -6,7 +6,7 @@ Implementation of direct serial port communication with JSerialComm
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:controls-serial:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:controls-serial:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:controls-serial:0.4.0-dev-1") implementation("space.kscience:controls-serial:0.4.0-dev-4")
} }
``` ```

4
controls-server/README.md
View File

@ -6,7 +6,7 @@ A combined Magix event loop server with web server for visualization.
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:controls-server:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:controls-server:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:controls-server:0.4.0-dev-1") implementation("space.kscience:controls-server:0.4.0-dev-4")
} }
``` ```

4
controls-storage/README.md
View File

@ -6,7 +6,7 @@ An API for stand-alone Controls-kt device or a hub.
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:controls-storage:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:controls-storage:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:controls-storage:0.4.0-dev-1") implementation("space.kscience:controls-storage:0.4.0-dev-4")
} }
``` ```

4
controls-storage/controls-xodus/README.md
View File

@ -6,7 +6,7 @@ An implementation of controls-storage on top of JetBrains Xodus.
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:controls-xodus:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:controls-xodus:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:controls-xodus:0.4.0-dev-1") implementation("space.kscience:controls-xodus:0.4.0-dev-4")
} }
``` ```

6
controls-vision/README.md
View File

@ -2,13 +2,11 @@
Dashboard and visualization extensions for devices Dashboard and visualization extensions for devices
Hello world!
## Usage ## Usage
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:controls-vision:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:controls-vision:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -18,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:controls-vision:0.4.0-dev-1") implementation("space.kscience:controls-vision:0.4.0-dev-4")
} }
``` ```

13
demo/device-collective/README.md Normal file
View File

@ -0,0 +1,13 @@
# Module device-collective
# Running demo from gradle
1. Install JDK 17-21 in the system (for example, from https://sdkman.io/jdks or https://github.com/ScoopInstaller/Java).
2. Clone the repository with Git.
3. Run `./gradlew :demo:device-collective:run` from the project root directory.
# Install distribution
1 and 2 from above.
3. Run `./gradlew :demo:device-collective:packageUberJarForCurrentOS` from the project root directory.
4. Go to `build/compose/jars/device-collective-<your OS>-<version>.jar`. You can copy it and run with `java -jar <full-name>.jar`

4
magix/magix-api/README.md
View File

@ -6,7 +6,7 @@ A kotlin API for magix standard and some zero-dependency magix services
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:magix-api:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:magix-api:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:magix-api:0.4.0-dev-1") implementation("space.kscience:magix-api:0.4.0-dev-4")
} }
``` ```

4
magix/magix-java-endpoint/README.md
View File

@ -6,7 +6,7 @@ Java API to work with magix endpoints without Kotlin
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:magix-java-endpoint:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:magix-java-endpoint:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:magix-java-endpoint:0.4.0-dev-1") implementation("space.kscience:magix-java-endpoint:0.4.0-dev-4")
} }
``` ```

4
magix/magix-mqtt/README.md
View File

@ -6,7 +6,7 @@ MQTT client magix endpoint
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:magix-mqtt:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:magix-mqtt:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:magix-mqtt:0.4.0-dev-1") implementation("space.kscience:magix-mqtt:0.4.0-dev-4")
} }
``` ```

4
magix/magix-rabbit/README.md
View File

@ -6,7 +6,7 @@ RabbitMQ client magix endpoint
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:magix-rabbit:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:magix-rabbit:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:magix-rabbit:0.4.0-dev-1") implementation("space.kscience:magix-rabbit:0.4.0-dev-4")
} }
``` ```

4
magix/magix-rsocket/README.md
View File

@ -6,7 +6,7 @@ Magix endpoint (client) based on RSocket
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:magix-rsocket:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:magix-rsocket:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:magix-rsocket:0.4.0-dev-1") implementation("space.kscience:magix-rsocket:0.4.0-dev-4")
} }
``` ```

4
magix/magix-server/README.md
View File

@ -6,7 +6,7 @@ A magix event loop implementation in Kotlin. Includes HTTP/SSE and RSocket route
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:magix-server:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:magix-server:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:magix-server:0.4.0-dev-1") implementation("space.kscience:magix-server:0.4.0-dev-4")
} }
``` ```

4
magix/magix-storage/README.md
View File

@ -6,7 +6,7 @@ Magix history database API
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:magix-storage:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:magix-storage:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:magix-storage:0.4.0-dev-1") implementation("space.kscience:magix-storage:0.4.0-dev-4")
} }
``` ```

4
magix/magix-storage/magix-storage-xodus/README.md
View File

@ -6,7 +6,7 @@
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:magix-storage-xodus:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:magix-storage-xodus:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:magix-storage-xodus:0.4.0-dev-1") implementation("space.kscience:magix-storage-xodus:0.4.0-dev-4")
} }
``` ```

4
magix/magix-zmq/README.md
View File

@ -6,7 +6,7 @@ ZMQ client endpoint for Magix
## Artifact: ## Artifact:
The Maven coordinates of this project are `space.kscience:magix-zmq:0.4.0-dev-1`. The Maven coordinates of this project are `space.kscience:magix-zmq:0.4.0-dev-4`.
**Gradle Kotlin DSL:** **Gradle Kotlin DSL:**
```kotlin ```kotlin
@ -16,6 +16,6 @@ repositories {
} }
dependencies { dependencies {
implementation("space.kscience:magix-zmq:0.4.0-dev-1") implementation("space.kscience:magix-zmq:0.4.0-dev-4")
} }
``` ```