reademe update

altavir · altavir · commit e9a37f40fd1d · 2024-12-08T12:15:22.000+03:00
diff --git a/README.md b/README.md
@@ -147,6 +147,15 @@ Automatically checks consistency.
 >
 > **Maturity**: EXPERIMENTAL
 
+### [simulation-kt](simulation-kt)
+> A framework for combination of asynchronous simulations.        
+>
+> **Maturity**: PROTOTYPE
+>
+> **Features:**
+> - [timeline](simulation-kt/#) : Timeline is an ordered discrete history containing TimeLineEvent
+
+
 ### [controls-storage/controls-xodus](controls-storage/controls-xodus)
 > An implementation of controls-storage on top of JetBrains Xodus.
 >
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:controls-constructor:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:controls-constructor:0.4.0-dev-4")
+    implementation("space.kscience:controls-constructor:0.4.0-dev-7")
 }
 ```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:controls-core:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -26,6 +26,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:controls-core:0.4.0-dev-4")
+    implementation("space.kscience:controls-core:0.4.0-dev-7")
 }
 ```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:controls-jupyter:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:controls-jupyter:0.4.0-dev-4")
+    implementation("space.kscience:controls-jupyter:0.4.0-dev-7")
 }
 ```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:controls-magix:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -22,6 +22,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:controls-magix:0.4.0-dev-4")
+    implementation("space.kscience:controls-magix:0.4.0-dev-7")
 }
 ```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:controls-modbus:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -24,6 +24,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:controls-modbus:0.4.0-dev-4")
+    implementation("space.kscience:controls-modbus:0.4.0-dev-7")
 }
 ```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:controls-opcua:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -22,6 +22,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:controls-opcua:0.4.0-dev-4")
+    implementation("space.kscience:controls-opcua:0.4.0-dev-7")
 }
 ```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:controls-pi:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:controls-pi:0.4.0-dev-4")
+    implementation("space.kscience:controls-pi:0.4.0-dev-7")
 }
 ```
diff --git a/controls-plc4x/README.md b/controls-plc4x/README.md
@@ -0,0 +1,21 @@
+# Module controls-plc4x
+
+A plugin for Controls-kt device server on top of plc4x library
+
+## Usage
+
+## Artifact:
+
+The Maven coordinates of this project are `space.kscience:controls-plc4x:0.4.0-dev-7`.
+
+**Gradle Kotlin DSL:**
+```kotlin
+repositories {
+    maven("https://repo.kotlin.link")
+    mavenCentral()
+}
+
+dependencies {
+    implementation("space.kscience:controls-plc4x:0.4.0-dev-7")
+}
+```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:controls-ports-ktor:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:controls-ports-ktor:0.4.0-dev-4")
+    implementation("space.kscience:controls-ports-ktor:0.4.0-dev-7")
 }
 ```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:controls-serial:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:controls-serial:0.4.0-dev-4")
+    implementation("space.kscience:controls-serial:0.4.0-dev-7")
 }
 ```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:controls-server:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:controls-server:0.4.0-dev-4")
+    implementation("space.kscience:controls-server:0.4.0-dev-7")
 }
 ```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:controls-storage:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:controls-storage:0.4.0-dev-4")
+    implementation("space.kscience:controls-storage:0.4.0-dev-7")
 }
 ```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:controls-xodus:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:controls-xodus:0.4.0-dev-4")
+    implementation("space.kscience:controls-xodus:0.4.0-dev-7")
 }
 ```
diff --git a/controls-vision/README.md b/controls-vision/README.md
@@ -6,7 +6,7 @@ Dashboard and visualization extensions for devices
 
 ## Artifact:
 
-The Maven coordinates of this project are `space.kscience:controls-vision:0.4.0-dev-4`.
+The Maven coordinates of this project are `space.kscience:controls-vision:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:controls-vision:0.4.0-dev-4")
+    implementation("space.kscience:controls-vision:0.4.0-dev-7")
 }
 ```
diff --git a/controls-visualisation-compose/README.md b/controls-visualisation-compose/README.md
@@ -6,7 +6,7 @@ Visualisation extension using compose-multiplatform
 
 ## Artifact:
 
-The Maven coordinates of this project are `space.kscience:controls-visualisation-compose:0.4.0-dev-4`.
+The Maven coordinates of this project are `space.kscience:controls-visualisation-compose:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:controls-visualisation-compose:0.4.0-dev-4")
+    implementation("space.kscience:controls-visualisation-compose:0.4.0-dev-7")
 }
 ```
diff --git a/demo/device-collective/README.md b/demo/device-collective/README.md
@@ -1,14 +1,4 @@
 # 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. 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: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`
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:magix-api:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:magix-api:0.4.0-dev-4")
+    implementation("space.kscience:magix-api:0.4.0-dev-7")
 }
 ```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:magix-java-endpoint:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:magix-java-endpoint:0.4.0-dev-4")
+    implementation("space.kscience:magix-java-endpoint:0.4.0-dev-7")
 }
 ```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:magix-mqtt:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:magix-mqtt:0.4.0-dev-4")
+    implementation("space.kscience:magix-mqtt:0.4.0-dev-7")
 }
 ```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:magix-rabbit:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:magix-rabbit:0.4.0-dev-4")
+    implementation("space.kscience:magix-rabbit:0.4.0-dev-7")
 }
 ```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:magix-rsocket:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:magix-rsocket:0.4.0-dev-4")
+    implementation("space.kscience:magix-rsocket:0.4.0-dev-7")
 }
 ```
diff --git 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-4`.
+The Maven coordinates of this project are `space.kscience:magix-server:0.4.0-dev-7`.
 
 **Gradle Kotlin DSL:**
 ```kotlin
@@ -16,6 +16,6 @@ repositories {
 }
 
 dependencies {
-    implementation("space.kscience:magix-server:0.4.0-dev-4")
+    implementation("space.kscience:magix-server:0.4.0-dev-7")
 }
 ```
diff --git a/magix/magix-storage/README.md b/magix/magix-storage/README.md
diff --git a/magix/magix-storage/magix-storage-xodus/README.md b/magix/magix-storage/magix-storage-xodus/README.md
diff --git a/magix/magix-utils/README.md b/magix/magix-utils/README.md
diff --git a/magix/magix-zmq/README.md b/magix/magix-zmq/README.md
diff --git a/simulation-kt/README.md b/simulation-kt/README.md
diff --git a/simulation-kt/build.gradle.kts b/simulation-kt/build.gradle.kts

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ A low-code constructor for composite devices simulation`
`6`	`6`
`7`	`7`	`## Artifact:`
`8`	`8`
`9`		-The Maven coordinates of this project are `space.kscience:controls-constructor:0.4.0-dev-4`.
	`9`	+The Maven coordinates of this project are `space.kscience:controls-constructor:0.4.0-dev-7`.
`10`	`10`
`11`	`11`	`Gradle Kotlin DSL:`
`12`	`12`	```kotlin
`@@ -16,6 +16,6 @@ repositories {`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`dependencies {`
`19`		`- implementation("space.kscience:controls-constructor:0.4.0-dev-4")`
	`19`	`+ implementation("space.kscience:controls-constructor:0.4.0-dev-7")`
`20`	`20`	`}`
`21`	`21`	```
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ Core interfaces for building a device server`
`16`	`16`
`17`	`17`	`## Artifact:`
`18`	`18`
`19`		-The Maven coordinates of this project are `space.kscience:controls-core:0.4.0-dev-4`.
	`19`	+The Maven coordinates of this project are `space.kscience:controls-core:0.4.0-dev-7`.
`20`	`20`
`21`	`21`	`Gradle Kotlin DSL:`
`22`	`22`	```kotlin
`@@ -26,6 +26,6 @@ repositories {`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`dependencies {`
`29`		`- implementation("space.kscience:controls-core:0.4.0-dev-4")`
	`29`	`+ implementation("space.kscience:controls-core:0.4.0-dev-7")`
`30`	`30`	`}`
`31`	`31`	```
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`## Artifact:`
`8`	`8`
`9`		-The Maven coordinates of this project are `space.kscience:controls-jupyter:0.4.0-dev-4`.
	`9`	+The Maven coordinates of this project are `space.kscience:controls-jupyter:0.4.0-dev-7`.
`10`	`10`
`11`	`11`	`Gradle Kotlin DSL:`
`12`	`12`	```kotlin
`@@ -16,6 +16,6 @@ repositories {`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`dependencies {`
`19`		`- implementation("space.kscience:controls-jupyter:0.4.0-dev-4")`
	`19`	`+ implementation("space.kscience:controls-jupyter:0.4.0-dev-7")`
`20`	`20`	`}`
`21`	`21`	```
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ Magix service for binding controls devices (both as RPC client and server)`
`12`	`12`
`13`	`13`	`## Artifact:`
`14`	`14`
`15`		-The Maven coordinates of this project are `space.kscience:controls-magix:0.4.0-dev-4`.
	`15`	+The Maven coordinates of this project are `space.kscience:controls-magix:0.4.0-dev-7`.
`16`	`16`
`17`	`17`	`Gradle Kotlin DSL:`
`18`	`18`	```kotlin
`@@ -22,6 +22,6 @@ repositories {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`dependencies {`
`25`		`- implementation("space.kscience:controls-magix:0.4.0-dev-4")`
	`25`	`+ implementation("space.kscience:controls-magix:0.4.0-dev-7")`
`26`	`26`	`}`
`27`	`27`	```
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ Automatically checks consistency.`
`14`	`14`
`15`	`15`	`## Artifact:`
`16`	`16`
`17`		-The Maven coordinates of this project are `space.kscience:controls-modbus:0.4.0-dev-4`.
	`17`	+The Maven coordinates of this project are `space.kscience:controls-modbus:0.4.0-dev-7`.
`18`	`18`
`19`	`19`	`Gradle Kotlin DSL:`
`20`	`20`	```kotlin
`@@ -24,6 +24,6 @@ repositories {`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`dependencies {`
`27`		`- implementation("space.kscience:controls-modbus:0.4.0-dev-4")`
	`27`	`+ implementation("space.kscience:controls-modbus:0.4.0-dev-7")`
`28`	`28`	`}`
`29`	`29`	```
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ A client and server connectors for OPC-UA via Eclipse Milo`
`12`	`12`
`13`	`13`	`## Artifact:`
`14`	`14`
`15`		-The Maven coordinates of this project are `space.kscience:controls-opcua:0.4.0-dev-4`.
	`15`	+The Maven coordinates of this project are `space.kscience:controls-opcua:0.4.0-dev-7`.
`16`	`16`
`17`	`17`	`Gradle Kotlin DSL:`
`18`	`18`	```kotlin
`@@ -22,6 +22,6 @@ repositories {`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`dependencies {`
`25`		`- implementation("space.kscience:controls-opcua:0.4.0-dev-4")`
	`25`	`+ implementation("space.kscience:controls-opcua:0.4.0-dev-7")`
`26`	`26`	`}`
`27`	`27`	```
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ Utils to work with controls-kt on Raspberry pi`
`6`	`6`
`7`	`7`	`## Artifact:`
`8`	`8`
`9`		-The Maven coordinates of this project are `space.kscience:controls-pi:0.4.0-dev-4`.
	`9`	+The Maven coordinates of this project are `space.kscience:controls-pi:0.4.0-dev-7`.
`10`	`10`
`11`	`11`	`Gradle Kotlin DSL:`
`12`	`12`	```kotlin
`@@ -16,6 +16,6 @@ repositories {`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`dependencies {`
`19`		`- implementation("space.kscience:controls-pi:0.4.0-dev-4")`
	`19`	`+ implementation("space.kscience:controls-pi:0.4.0-dev-7")`
`20`	`20`	`}`
`21`	`21`	```
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ Implementation of byte ports on top os ktor-io asynchronous API`
`6`	`6`
`7`	`7`	`## Artifact:`
`8`	`8`
`9`		-The Maven coordinates of this project are `space.kscience:controls-ports-ktor:0.4.0-dev-4`.
	`9`	+The Maven coordinates of this project are `space.kscience:controls-ports-ktor:0.4.0-dev-7`.
`10`	`10`
`11`	`11`	`Gradle Kotlin DSL:`
`12`	`12`	```kotlin
`@@ -16,6 +16,6 @@ repositories {`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`dependencies {`
`19`		`- implementation("space.kscience:controls-ports-ktor:0.4.0-dev-4")`
	`19`	`+ implementation("space.kscience:controls-ports-ktor:0.4.0-dev-7")`
`20`	`20`	`}`
`21`	`21`	```