Merge pull request #9 from SciProgCentre/dev

0.2.0

Author: SPC-code

CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+## Unreleased
+
+### Added
+- Core interfaces for building a device server
+- Magix service for binding controls devices (both as RPC client and server)
+- A plugin for Controls-kt device server on top of modbus-rtu/modbus-tcp protocols
+- A client and server connectors for OPC-UA via Eclipse Milo
+- Implementation of byte ports on top os ktor-io asynchronous API
+- Implementation of direct serial port communication with JSerialComm
+- A combined Magix event loop server with web server for visualization.
+- An API for stand-alone Controls-kt device or a hub.
+- An implementation of controls-storage on top of JetBrains Xodus.
+- A kotlin API for magix standard and some zero-dependency magix services
+- Java API to work with magix endpoints without Kotlin
+- MQTT client magix endpoint
+- RabbitMQ client magix endpoint
+- Magix endpoint (client) based on RSocket
+- A magix event loop implementation in Kotlin. Includes HTTP/SSE and RSocket routes.
+- Magix history database API
+- ZMQ client endpoint for Magix
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+### Security

README.md

@@ -43,143 +43,158 @@ Example view of a demo:
 
 
 ### [controls-core](controls-core)
-> 
+> Core interfaces for building a device server
 >
 > **Maturity**: EXPERIMENTAL
 >
 > **Features:**
 > - [device](controls-core/src/commonMain/kotlin/space/kscience/controls/api/Device.kt) : Device API with subscription (asynchronous and pseudo-synchronous properties)
 > - [deviceMessage](controls-core/src/commonMain/kotlin/space/kscience/controls/api/DeviceMessage.kt) : Specification for messages used to communicate between Controls-kt devices.
 > - [deviceHub](controls-core/src/commonMain/kotlin/space/kscience/controls/api/DeviceHub.kt) : Grouping of devices into local tree-like hubs.
+> - [deviceSpec](controls-core/src/commonMain/kotlin/space/kscience/controls/spec) : Mechanics and type-safe builders for devices. Including separation of device specification and device state.
+> - [deviceManager](controls-core/src/commonMain/kotlin/space/kscience/controls/manager) : DataForge DI integration for devices. Includes device builders.
+> - [ports](controls-core/src/commonMain/kotlin/space/kscience/controls/ports) : Working with asynchronous data sending and receiving raw byte arrays
 
 
-### [controls-ktor-tcp](controls-ktor-tcp)
-> 
+### [controls-magix](controls-magix)
+> Magix service for binding controls devices (both as RPC client and server)
 >
 > **Maturity**: EXPERIMENTAL
-
-### [controls-magix-client](controls-magix-client)
-> 
 >
-> **Maturity**: EXPERIMENTAL
+> **Features:**
+> - [controlsMagix](controls-magix/src/commonMain/kotlin/space/kscience/controls/client/controlsMagix.kt) : Connect a `DeviceManage` with one or many devices to the Magix endpoint
+> - [DeviceClient](controls-magix/src/commonMain/kotlin/space/kscience/controls/client/DeviceClient.kt) : A remote connector to Controls-kt device via Magix
+
 
 ### [controls-modbus](controls-modbus)
-> 
+> A plugin for Controls-kt device server on top of modbus-rtu/modbus-tcp protocols
 >
 > **Maturity**: EXPERIMENTAL
+>
+> **Features:**
+> - [modbusRegistryMap](controls-modbus/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](controls-modbus/src/main/kotlin/space/kscience/controls/modbus/DeviceProcessImage.kt) : Binding of slave (server) modbus device to Controls-kt device
+> - [modbusDevice](controls-modbus/src/main/kotlin/space/kscience/controls/modbus/ModbusDevice.kt) : A device with additional methods to work with modbus registers.
+
 
 ### [controls-opcua](controls-opcua)
-> 
+> A client and server connectors for OPC-UA via Eclipse Milo
+>
+> **Maturity**: EXPERIMENTAL
+>
+> **Features:**
+> - [opcuaClient](controls-opcua/src/main/kotlin/space/kscience/controls/opcua/client) : Connect a Controls-kt as a client to OPC UA server
+> - [opcuaServer](controls-opcua/src/main/kotlin/space/kscience/controls/opcua/server) : Create an OPC UA server on top of Controls-kt device (or device hub)
+
+
+### [controls-pi](controls-pi)
+> Utils to work with controls-kt on Raspberry pi
 >
 > **Maturity**: EXPERIMENTAL
 
+### [controls-ports-ktor](controls-ports-ktor)
+> Implementation of byte ports on top os ktor-io asynchronous API
+>
+> **Maturity**: PROTOTYPE
+
 ### [controls-serial](controls-serial)
-> 
+> Implementation of direct serial port communication with JSerialComm
 >
 > **Maturity**: EXPERIMENTAL
 
 ### [controls-server](controls-server)
-> 
+> A combined Magix event loop server with web server for visualization.
 >
-> **Maturity**: EXPERIMENTAL
+> **Maturity**: PROTOTYPE
 
 ### [controls-storage](controls-storage)
-> 
+> An API for stand-alone Controls-kt device or a hub.
 >
 > **Maturity**: PROTOTYPE
 
 ### [demo](demo)
-> 
 >
 > **Maturity**: EXPERIMENTAL
 
 ### [magix](magix)
-> 
 >
 > **Maturity**: EXPERIMENTAL
 
 ### [controls-storage/controls-xodus](controls-storage/controls-xodus)
-> 
+> An implementation of controls-storage on top of JetBrains Xodus.
 >
 > **Maturity**: PROTOTYPE
 
 ### [demo/all-things](demo/all-things)
-> 
 >
 > **Maturity**: EXPERIMENTAL
 
 ### [demo/car](demo/car)
-> 
 >
 > **Maturity**: EXPERIMENTAL
 
 ### [demo/echo](demo/echo)
-> 
 >
 > **Maturity**: EXPERIMENTAL
 
 ### [demo/magix-demo](demo/magix-demo)
-> 
 >
 > **Maturity**: EXPERIMENTAL
 
 ### [demo/many-devices](demo/many-devices)
-> 
 >
 > **Maturity**: EXPERIMENTAL
 
 ### [demo/mks-pdr900](demo/mks-pdr900)
-> 
 >
 > **Maturity**: EXPERIMENTAL
 
 ### [demo/motors](demo/motors)
-> 
 >
 > **Maturity**: EXPERIMENTAL
 
 ### [magix/magix-api](magix/magix-api)
-> 
+> A kotlin API for magix standard and some zero-dependency magix services
 >
 > **Maturity**: EXPERIMENTAL
 
-### [magix/magix-java-client](magix/magix-java-client)
-> 
+### [magix/magix-java-endpoint](magix/magix-java-endpoint)
+> Java API to work with magix endpoints without Kotlin
 >
 > **Maturity**: EXPERIMENTAL
 
 ### [magix/magix-mqtt](magix/magix-mqtt)
-> 
+> MQTT client magix endpoint
 >
 > **Maturity**: PROTOTYPE
 
 ### [magix/magix-rabbit](magix/magix-rabbit)
-> 
+> RabbitMQ client magix endpoint
 >
 > **Maturity**: PROTOTYPE
 
 ### [magix/magix-rsocket](magix/magix-rsocket)
-> 
+> Magix endpoint (client) based on RSocket
 >
 > **Maturity**: EXPERIMENTAL
 
 ### [magix/magix-server](magix/magix-server)
-> 
+> A magix event loop implementation in Kotlin. Includes HTTP/SSE and RSocket routes.
 >
 > **Maturity**: EXPERIMENTAL
 
 ### [magix/magix-storage](magix/magix-storage)
-> 
+> Magix history database API
 >
-> **Maturity**: EXPERIMENTAL
+> **Maturity**: PROTOTYPE
 
 ### [magix/magix-zmq](magix/magix-zmq)
-> 
+> ZMQ client endpoint for Magix
 >
 > **Maturity**: EXPERIMENTAL
 
 ### [magix/magix-storage/magix-storage-xodus](magix/magix-storage/magix-storage-xodus)
-> 
 >
 > **Maturity**: PROTOTYPE
 

build.gradle.kts

@@ -6,14 +6,14 @@ plugins {
     id("space.kscience.gradle.project")
 }
 
-val dataforgeVersion: String by extra("0.6.1")
+val dataforgeVersion: String by extra("0.6.2-dev-3")
 val ktorVersion: String by extra(space.kscience.gradle.KScienceVersions.ktorVersion)
 val rsocketVersion by extra("0.15.4")
 val xodusVersion by extra("2.0.1")
 
 allprojects {
     group = "space.kscience"
-    version = "0.2.0-dev-1"
+    version = "0.2.0"
     repositories{
         maven("https://maven.pkg.jetbrains.space/spc/p/sci/dev")
     }
@@ -29,10 +29,9 @@ ksciencePublish {
         if (isInDevelopment) {
             "https://maven.pkg.jetbrains.space/spc/p/sci/dev"
         } else {
-            "https://maven.pkg.jetbrains.space/spc/p/sci/release"
+            "https://maven.pkg.jetbrains.space/spc/p/sci/maven"
         }
     )
-    space("https://maven.pkg.jetbrains.space/spc/p/controls/maven")
 }
 
 readme.readmeTemplate = file("docs/templates/README-TEMPLATE.md")

controls-core/README.md

@@ -0,0 +1,33 @@
+# Module controls-core
+
+Core interfaces for building a device server
+
+## 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.
+ - [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
+
+
+## Usage
+
+## Artifact:
+
+The Maven coordinates of this project are `space.kscience:controls-core:0.2.0`.
+
+**Gradle Kotlin DSL:**
+```kotlin
+repositories {
+    maven("https://repo.kotlin.link")
+    //uncomment to access development builds
+    //maven("https://maven.pkg.jetbrains.space/spc/p/sci/dev")
+    mavenCentral()
+}
+
+dependencies {
+    implementation("space.kscience:controls-core:0.2.0")
+}
+```