From 92c4355f483769af77ef0c6e938366428807e1df Mon Sep 17 00:00:00 2001 From: Alexander Nozik Date: Mon, 17 Jun 2024 17:49:12 +0300 Subject: [PATCH] update device-collective readme --- README.md | 9 +++++++++ controls-constructor/README.md | 4 ++-- controls-core/README.md | 4 ++-- controls-jupyter/README.md | 4 ++-- controls-magix/README.md | 4 ++-- controls-modbus/README.md | 4 ++-- controls-opcua/README.md | 4 ++-- controls-pi/README.md | 4 ++-- controls-ports-ktor/README.md | 4 ++-- controls-serial/README.md | 4 ++-- controls-server/README.md | 4 ++-- controls-storage/README.md | 4 ++-- controls-storage/controls-xodus/README.md | 4 ++-- controls-vision/README.md | 6 ++---- demo/device-collective/README.md | 13 +++++++++++++ magix/magix-api/README.md | 4 ++-- magix/magix-java-endpoint/README.md | 4 ++-- magix/magix-mqtt/README.md | 4 ++-- magix/magix-rabbit/README.md | 4 ++-- magix/magix-rsocket/README.md | 4 ++-- magix/magix-server/README.md | 4 ++-- magix/magix-storage/README.md | 4 ++-- magix/magix-storage/magix-storage-xodus/README.md | 4 ++-- magix/magix-zmq/README.md | 4 ++-- 24 files changed, 66 insertions(+), 46 deletions(-) create mode 100644 demo/device-collective/README.md diff --git a/README.md b/README.md index d5baaf9..6b9c9cd 100644 --- a/README.md +++ b/README.md @@ -134,6 +134,11 @@ Automatically checks consistency. > > **Maturity**: PROTOTYPE +### [controls-visualisation-compose](controls-visualisation-compose) +> Visualisation extension using compose-multiplatform +> +> **Maturity**: PROTOTYPE + ### [demo](demo) > > **Maturity**: EXPERIMENTAL @@ -159,6 +164,10 @@ Automatically checks consistency. > > **Maturity**: EXPERIMENTAL +### [demo/device-collective](demo/device-collective) +> +> **Maturity**: EXPERIMENTAL + ### [demo/echo](demo/echo) > > **Maturity**: EXPERIMENTAL diff --git a/controls-constructor/README.md b/controls-constructor/README.md index d388b01..7da4d0b 100644 --- a/controls-constructor/README.md +++ b/controls-constructor/README.md @@ -6,7 +6,7 @@ A low-code constructor for composite devices simulation ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:controls-constructor:0.4.0-dev-1") + implementation("space.kscience:controls-constructor:0.4.0-dev-4") } ``` diff --git a/controls-core/README.md b/controls-core/README.md index 71caf53..26ed618 100644 --- a/controls-core/README.md +++ b/controls-core/README.md @@ -16,7 +16,7 @@ Core interfaces for building a device server ## 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:** ```kotlin @@ -26,6 +26,6 @@ repositories { } dependencies { - implementation("space.kscience:controls-core:0.4.0-dev-1") + implementation("space.kscience:controls-core:0.4.0-dev-4") } ``` diff --git a/controls-jupyter/README.md b/controls-jupyter/README.md index 7d0fc4f..6100ddd 100644 --- a/controls-jupyter/README.md +++ b/controls-jupyter/README.md @@ -6,7 +6,7 @@ ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:controls-jupyter:0.4.0-dev-1") + implementation("space.kscience:controls-jupyter:0.4.0-dev-4") } ``` diff --git a/controls-magix/README.md b/controls-magix/README.md index 8c16ffd..c474221 100644 --- a/controls-magix/README.md +++ b/controls-magix/README.md @@ -12,7 +12,7 @@ Magix service for binding controls devices (both as RPC client and server) ## 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:** ```kotlin @@ -22,6 +22,6 @@ repositories { } dependencies { - implementation("space.kscience:controls-magix:0.4.0-dev-1") + implementation("space.kscience:controls-magix:0.4.0-dev-4") } ``` diff --git a/controls-modbus/README.md b/controls-modbus/README.md index 61e4b60..9705e81 100644 --- a/controls-modbus/README.md +++ b/controls-modbus/README.md @@ -14,7 +14,7 @@ Automatically checks consistency. ## 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:** ```kotlin @@ -24,6 +24,6 @@ repositories { } dependencies { - implementation("space.kscience:controls-modbus:0.4.0-dev-1") + implementation("space.kscience:controls-modbus:0.4.0-dev-4") } ``` diff --git a/controls-opcua/README.md b/controls-opcua/README.md index 03dc32b..6867492 100644 --- a/controls-opcua/README.md +++ b/controls-opcua/README.md @@ -12,7 +12,7 @@ A client and server connectors for OPC-UA via Eclipse Milo ## 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:** ```kotlin @@ -22,6 +22,6 @@ repositories { } dependencies { - implementation("space.kscience:controls-opcua:0.4.0-dev-1") + implementation("space.kscience:controls-opcua:0.4.0-dev-4") } ``` diff --git a/controls-pi/README.md b/controls-pi/README.md index 2873ac2..0afb324 100644 --- a/controls-pi/README.md +++ b/controls-pi/README.md @@ -6,7 +6,7 @@ Utils to work with controls-kt on Raspberry pi ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:controls-pi:0.4.0-dev-1") + implementation("space.kscience:controls-pi:0.4.0-dev-4") } ``` diff --git a/controls-ports-ktor/README.md b/controls-ports-ktor/README.md index 6b23d80..1cb277a 100644 --- a/controls-ports-ktor/README.md +++ b/controls-ports-ktor/README.md @@ -6,7 +6,7 @@ Implementation of byte ports on top os ktor-io asynchronous API ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:controls-ports-ktor:0.4.0-dev-1") + implementation("space.kscience:controls-ports-ktor:0.4.0-dev-4") } ``` diff --git a/controls-serial/README.md b/controls-serial/README.md index a961f55..ce95ee5 100644 --- a/controls-serial/README.md +++ b/controls-serial/README.md @@ -6,7 +6,7 @@ Implementation of direct serial port communication with JSerialComm ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:controls-serial:0.4.0-dev-1") + implementation("space.kscience:controls-serial:0.4.0-dev-4") } ``` diff --git a/controls-server/README.md b/controls-server/README.md index 114f618..896020d 100644 --- a/controls-server/README.md +++ b/controls-server/README.md @@ -6,7 +6,7 @@ A combined Magix event loop server with web server for visualization. ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:controls-server:0.4.0-dev-1") + implementation("space.kscience:controls-server:0.4.0-dev-4") } ``` diff --git a/controls-storage/README.md b/controls-storage/README.md index 64751e8..dd4ab3d 100644 --- a/controls-storage/README.md +++ b/controls-storage/README.md @@ -6,7 +6,7 @@ An API for stand-alone Controls-kt device or a hub. ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:controls-storage:0.4.0-dev-1") + implementation("space.kscience:controls-storage:0.4.0-dev-4") } ``` diff --git a/controls-storage/controls-xodus/README.md b/controls-storage/controls-xodus/README.md index e423c3f..44cdf26 100644 --- a/controls-storage/controls-xodus/README.md +++ b/controls-storage/controls-xodus/README.md @@ -6,7 +6,7 @@ An implementation of controls-storage on top of JetBrains Xodus. ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:controls-xodus:0.4.0-dev-1") + implementation("space.kscience:controls-xodus:0.4.0-dev-4") } ``` diff --git a/controls-vision/README.md b/controls-vision/README.md index cbfc917..ff2b648 100644 --- a/controls-vision/README.md +++ b/controls-vision/README.md @@ -2,13 +2,11 @@ Dashboard and visualization extensions for devices -Hello world! - ## Usage ## 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:** ```kotlin @@ -18,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:controls-vision:0.4.0-dev-1") + implementation("space.kscience:controls-vision:0.4.0-dev-4") } ``` diff --git a/demo/device-collective/README.md b/demo/device-collective/README.md new file mode 100644 index 0000000..5f639a7 --- /dev/null +++ b/demo/device-collective/README.md @@ -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--.jar`. You can copy it and run with `java -jar .jar` diff --git a/magix/magix-api/README.md b/magix/magix-api/README.md index 6228a7e..6f16ac0 100644 --- a/magix/magix-api/README.md +++ b/magix/magix-api/README.md @@ -6,7 +6,7 @@ A kotlin API for magix standard and some zero-dependency magix services ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:magix-api:0.4.0-dev-1") + implementation("space.kscience:magix-api:0.4.0-dev-4") } ``` diff --git a/magix/magix-java-endpoint/README.md b/magix/magix-java-endpoint/README.md index 2db1d42..87359f1 100644 --- a/magix/magix-java-endpoint/README.md +++ b/magix/magix-java-endpoint/README.md @@ -6,7 +6,7 @@ Java API to work with magix endpoints without Kotlin ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:magix-java-endpoint:0.4.0-dev-1") + implementation("space.kscience:magix-java-endpoint:0.4.0-dev-4") } ``` diff --git a/magix/magix-mqtt/README.md b/magix/magix-mqtt/README.md index 7896472..0ee054a 100644 --- a/magix/magix-mqtt/README.md +++ b/magix/magix-mqtt/README.md @@ -6,7 +6,7 @@ MQTT client magix endpoint ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:magix-mqtt:0.4.0-dev-1") + implementation("space.kscience:magix-mqtt:0.4.0-dev-4") } ``` diff --git a/magix/magix-rabbit/README.md b/magix/magix-rabbit/README.md index eee4a21..35b43c7 100644 --- a/magix/magix-rabbit/README.md +++ b/magix/magix-rabbit/README.md @@ -6,7 +6,7 @@ RabbitMQ client magix endpoint ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:magix-rabbit:0.4.0-dev-1") + implementation("space.kscience:magix-rabbit:0.4.0-dev-4") } ``` diff --git a/magix/magix-rsocket/README.md b/magix/magix-rsocket/README.md index ef16b66..9f3a42c 100644 --- a/magix/magix-rsocket/README.md +++ b/magix/magix-rsocket/README.md @@ -6,7 +6,7 @@ Magix endpoint (client) based on RSocket ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:magix-rsocket:0.4.0-dev-1") + implementation("space.kscience:magix-rsocket:0.4.0-dev-4") } ``` diff --git a/magix/magix-server/README.md b/magix/magix-server/README.md index 17bdbdf..8259e0f 100644 --- a/magix/magix-server/README.md +++ b/magix/magix-server/README.md @@ -6,7 +6,7 @@ A magix event loop implementation in Kotlin. Includes HTTP/SSE and RSocket route ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:magix-server:0.4.0-dev-1") + implementation("space.kscience:magix-server:0.4.0-dev-4") } ``` diff --git a/magix/magix-storage/README.md b/magix/magix-storage/README.md index dbb2729..672458e 100644 --- a/magix/magix-storage/README.md +++ b/magix/magix-storage/README.md @@ -6,7 +6,7 @@ Magix history database API ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:magix-storage:0.4.0-dev-1") + implementation("space.kscience:magix-storage:0.4.0-dev-4") } ``` diff --git a/magix/magix-storage/magix-storage-xodus/README.md b/magix/magix-storage/magix-storage-xodus/README.md index 90a0050..2fb495a 100644 --- a/magix/magix-storage/magix-storage-xodus/README.md +++ b/magix/magix-storage/magix-storage-xodus/README.md @@ -6,7 +6,7 @@ ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:magix-storage-xodus:0.4.0-dev-1") + implementation("space.kscience:magix-storage-xodus:0.4.0-dev-4") } ``` diff --git a/magix/magix-zmq/README.md b/magix/magix-zmq/README.md index 6e924db..952e02e 100644 --- a/magix/magix-zmq/README.md +++ b/magix/magix-zmq/README.md @@ -6,7 +6,7 @@ ZMQ client endpoint for Magix ## 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:** ```kotlin @@ -16,6 +16,6 @@ repositories { } dependencies { - implementation("space.kscience:magix-zmq:0.4.0-dev-1") + implementation("space.kscience:magix-zmq:0.4.0-dev-4") } ```