Finally Prototype (#62)

Co-authored-by: e1turin <48864186+e1turin@users.noreply.github.com>
Co-authored-by: Victor Smirnov <53015676+vityaman@users.noreply.github.com>
Co-authored-by: FineGoose <90922868+YuikoSempai@users.noreply.github.com>

.gitignore

@@ -1,3 +1,5 @@
+.idea
+
 # Compiled class file
 *.class
 

.markdownlint.yaml

@@ -1,3 +1,3 @@
 MD013:
-  line_length: 80
+  line_length: 100
   strict: true

README.md

@@ -4,4 +4,5 @@ An IoT service with mobile client and microservices arhitecture.
 
 # Content
 
-- [Technical task](./doc/technical-task.md)
+- [Technical task](./doc/technical-task.md)
+- [Swagger](doc/SWAGGER.md)

common/build.gradle.kts

@@ -8,5 +8,8 @@ kotlin {
 }
 
 dependencies {
+    implementation(libs.redisson)
     implementation(libs.kotlinx.serialization.json)
+    implementation(libs.kotlinx.coroutines.core)
+    implementation(libs.org.eclipse.paho.client.mqttv3)
 }

common/src/main/kotlin/org/vivlaniv/nexohub/ConnectionTask.kt

@@ -5,6 +5,37 @@ import java.util.*
 
 // connection-service tasks
 
+@Serializable
+data class AuthUserTask(
+    override val id: String = UUID.randomUUID().toString(),
+    val username: String,
+    val password: String
+) : Task
+
+@Serializable
+data class AuthUserTaskResult(
+    override val tid: String,
+    override val code: Int = 0,
+    override val errorMessage: String? = null,
+    val token: String? = null
+) : TaskResult
+
+
+@Serializable
+data class RegisterUserTask(
+    override val id: String = UUID.randomUUID().toString(),
+    val username: String,
+    val password: String
+) : Task
+
+@Serializable
+data class RegisterUserTaskResult(
+    override val tid: String,
+    override val code: Int = 0,
+    override val errorMessage: String? = null
+) : TaskResult
+
+
 @Serializable
 data class SearchDevicesTask(
     override val id: String = UUID.randomUUID().toString()
@@ -13,7 +44,9 @@ data class SearchDevicesTask(
 @Serializable
 data class SearchDevicesTaskResult(
     override val tid: String,
-    val devices: List<DeviceInfo>
+    override val code: Int = 0,
+    override val errorMessage: String? = null,
+    val devices: List<DeviceInfo>? = null
 ) : TaskResult
 
 
@@ -76,20 +109,4 @@ data class PutDevicePropertyTaskResult(
     override val code: Int = 0,
     override val errorMessage: String? = null,
     val device: String,
-) : TaskResult
-
-
-@Serializable
-data class SendDeviceSignalTask(
-    override val id: String = UUID.randomUUID().toString(),
-    val device: String,
-    val signal: String,
-    val arguments: List<Int> = listOf()
-) : Task
-
-@Serializable
-data class SendDeviceSignalTaskResult(
-    override val tid: String,
-    override val code: Int = 0,
-    override val errorMessage: String? = null
 ) : TaskResult

common/src/main/kotlin/org/vivlaniv/nexohub/DbTask.kt

@@ -5,6 +5,37 @@ import java.util.*
 
 // db-service tasks
 
+
+@Serializable
+data class FindUserTask(
+    override val id: String = UUID.randomUUID().toString(),
+    val username: String
+) : Task
+
+@Serializable
+data class FindUserTaskResult(
+    override val tid: String,
+    override val code: Int = 0,
+    override val errorMessage: String? = null,
+    val passwordHash: String? = null
+) : TaskResult
+
+
+@Serializable
+data class SaveUserTask(
+    override val id: String = UUID.randomUUID().toString(),
+    val username: String,
+    val passwordHash: String
+) : Task
+
+@Serializable
+data class SaveUserTaskResult(
+    override val tid: String,
+    override val code: Int = 0,
+    override val errorMessage: String? = null
+) : TaskResult
+
+
 @Serializable
 data class GetSavedDevicesTask(
     override val id: String = UUID.randomUUID().toString(),

common/src/main/kotlin/org/vivlaniv/nexohub/Model.kt

@@ -6,15 +6,19 @@ import kotlinx.serialization.Serializable
 enum class Type {
     BOOLEAN,        // 0 or 1
     PERCENT,        // value from 0 to 100
-    BYTE,           // value from 0 to 255
-    TEMPERATURE     // temperature value
+    COLOR,          // color value (empty byte + red + green + blue)
+    TEMPERATURE,    // temperature value
+    HUMIDITY,       // humidity value (percent like in range [10,80])
+    ENUM,           // ordinal of enum value
 }
 
 @Serializable
 data class Schema(
     val type: Type,
     val min: Int? = null,
-    val max: Int? = null
+    val max: Int? = null,
+    val enumValues: List<String>? = null,
+    val isSensor: Boolean? = null,
 )
 
 @Serializable
@@ -25,18 +29,11 @@ data class PropertyInfo(
     val value: Int
 )
 
-@Serializable
-data class SignalInfo(
-    val name: String,
-    val args: List<Schema>
-)
-
 @Serializable
 data class DeviceInfo(
     val id: String,
     val type: String,
     val properties: List<PropertyInfo>,
-    val signals: List<SignalInfo>
 )
 
 @Serializable
@@ -55,5 +52,4 @@ data class SavedDevice(
     val room: String?,
     val alias: String?,
     var properties: List<PropertyInfo>,
-    val signals: List<SignalInfo>
 )

common/src/main/kotlin/org/vivlaniv/nexohub/ModelTask.kt

@@ -68,21 +68,4 @@ data class SetDevicePropertyTaskResult(
     override val tid: String,
     override val code: Int = 0,
     override val errorMessage: String? = null
-) : TaskResult
-
-
-@Serializable
-data class SignalDeviceTask(
-    override val id: String = UUID.randomUUID().toString(),
-    val user: String,
-    val device: String,
-    val name: String,
-    val args: List<Int>
-) : Task
-
-@Serializable
-data class SignalDeviceTaskResult(
-    override val tid: String,
-    override val code: Int = 0,
-    override val errorMessage: String? = null
 ) : TaskResult

common/src/main/kotlin/org/vivlaniv/nexohub/util/Util.kt

@@ -0,0 +1,9 @@
+package org.vivlaniv.nexohub.util
+
+fun colorToRGB(color: Int): Triple<Int, Int, Int> =
+    Triple((color shr 16) and 0xFF, (color shr 8) and 0xFF,  color and 0xFF)
+
+const val colorMask = 0x00FFFFFF
+
+fun RGBToColor(red: Int, green: Int, blue: Int): Int =
+    (((red shl 16) + (green shl 8) + blue) and colorMask)

common/src/main/kotlin/org/vivlaniv/nexohub/util/mqtt/Mqtt.kt

@@ -0,0 +1,33 @@
+package org.vivlaniv.nexohub.util.mqtt
+
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.asCoroutineDispatcher
+import kotlinx.coroutines.launch
+import kotlinx.serialization.encodeToString
+import kotlinx.serialization.json.Json
+import org.eclipse.paho.client.mqttv3.MqttClient
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
+import java.util.concurrent.Executors
+
+val mqttLogger: Logger = LoggerFactory.getLogger("mqtt")
+
+val mqttScope = CoroutineScope(Executors.newFixedThreadPool(32).asCoroutineDispatcher())
+
+inline fun <reified T> MqttClient.subscribe(
+    topic: String,
+    crossinline onReceived: suspend CoroutineScope.(String, T) -> Unit
+) {
+    subscribe(topic, 2) { tpc, msg ->
+        mqttScope.launch {
+            mqttLogger.info("got message on topic $tpc: $msg")
+            onReceived(tpc, Json.decodeFromString<T>(msg.payload.decodeToString()))
+        }
+    }
+}
+
+inline fun <reified T> MqttClient.publish(topic: String, message: T) {
+    val msg = Json.encodeToString(message)
+    mqttLogger.info("send message on topic $topic: $msg")
+    publish(topic, msg.encodeToByteArray(), 2, false)
+}