diff --git a/app/build.gradle.kts b/app/build.gradle.kts index 96b17dd..54c0975 100644 --- a/app/build.gradle.kts +++ b/app/build.gradle.kts @@ -1,7 +1,7 @@ plugins { alias(libs.plugins.android.application) alias(libs.plugins.compose.compiler) - alias(libs.plugins.ksp) + alias(libs.plugins.koin.compiler) } android { @@ -37,6 +37,7 @@ android { } } + dependencies { implementation(libs.androidx.core.ktx) implementation(libs.androidx.appcompat) @@ -56,11 +57,15 @@ dependencies { // Koin implementation(platform(libs.koin.bom)) + implementation(libs.koin.core) + implementation(libs.koin.annotations) implementation(libs.koin.android) implementation(libs.koin.compose) - implementation(libs.koin.annotations) - ksp(libs.koin.compiler) + koinCompiler { + userLogs = true + compileSafety = true + } testImplementation(libs.junit) androidTestImplementation(libs.androidx.junit) androidTestImplementation(libs.androidx.espresso.core) diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml index b2a355b..2af28fc 100644 --- a/app/src/main/AndroidManifest.xml +++ b/app/src/main/AndroidManifest.xml @@ -1,8 +1,8 @@ - + + Log.d("check_state", "$state") + } + } + } } \ No newline at end of file diff --git a/app/src/main/java/dev/jekis/canvacompass/app/CanvaCompassApp.kt b/app/src/main/java/dev/jekis/canvacompass/app/CanvaCompassApp.kt new file mode 100644 index 0000000..afdd28f --- /dev/null +++ b/app/src/main/java/dev/jekis/canvacompass/app/CanvaCompassApp.kt @@ -0,0 +1,16 @@ +package dev.jekis.canvacompass.app + +import android.app.Application +import org.koin.android.ext.koin.androidContext +import org.koin.core.annotation.KoinApplication +import org.koin.plugin.module.dsl.startKoin + +@KoinApplication +class CanvaCompassApp : Application() { + override fun onCreate() { + super.onCreate() + startKoin { + androidContext(this@CanvaCompassApp) + } + } +} \ No newline at end of file diff --git a/app/src/main/java/dev/jekis/canvacompass/data/SensorRepository.kt b/app/src/main/java/dev/jekis/canvacompass/data/SensorRepository.kt deleted file mode 100644 index 098ab2a..0000000 --- a/app/src/main/java/dev/jekis/canvacompass/data/SensorRepository.kt +++ /dev/null @@ -1,4 +0,0 @@ -package dev.jekis.canvacompass.data - -class SensorRepositoryImpl { -} \ No newline at end of file diff --git a/app/src/main/java/dev/jekis/canvacompass/data/SensorRepositoryImpl.kt b/app/src/main/java/dev/jekis/canvacompass/data/SensorRepositoryImpl.kt new file mode 100644 index 0000000..1d6137d --- /dev/null +++ b/app/src/main/java/dev/jekis/canvacompass/data/SensorRepositoryImpl.kt @@ -0,0 +1,120 @@ +package dev.jekis.canvacompass.data + +import android.hardware.SensorManager +import dev.jekis.canvacompass.data.datasource.sensors.AccelerometerSensor +import dev.jekis.canvacompass.data.datasource.sensors.MagnetometerSensor +import dev.jekis.canvacompass.data.datasource.sensors.RotationVectorSensor +import dev.jekis.canvacompass.domain.CompassOrientation +import dev.jekis.canvacompass.domain.SensorAccuracy +import dev.jekis.canvacompass.domain.SensorRepository +import dev.jekis.canvacompass.util.normalizeAzimuth +import kotlinx.coroutines.FlowPreview +import kotlinx.coroutines.flow.Flow +import kotlinx.coroutines.flow.combine +import kotlinx.coroutines.flow.conflate +import kotlinx.coroutines.flow.distinctUntilChanged +import kotlinx.coroutines.flow.filter +import kotlinx.coroutines.flow.map +import kotlinx.coroutines.flow.sample +import org.koin.core.annotation.Single + +private const val DATA_INTERVAL = 40L +@Single +class SensorRepositoryImpl( + private val sensorManager: SensorManager +) : SensorRepository { + @OptIn(FlowPreview::class) + override fun fetchOrientationData(): Flow { + + val accelerometer = AccelerometerSensor(sensorManager) + val magnetometer = MagnetometerSensor(sensorManager) + val rotationVector = RotationVectorSensor(sensorManager) + + val orientationFlow = if (rotationVector.isAvailable()) { + rotationVector.sensorState + .filter { it.values.isNotEmpty() } + .conflate() + .map { fuseFromRotationVector(it.values) } + } else { + combine( + accelerometer.sensorState.filter { it.values.isNotEmpty() }, + magnetometer.sensorState.filter { it.values.isNotEmpty() } + ) { accel, mag -> fuseFromAccelMag(accel.values, mag.values) } + .conflate() + } + + return combine( + orientationFlow, + magnetometer.sensorState + ) { orientation, magState -> + orientation.copy( + accuracy = mapAccuracy(magState.accuracy), + isCalibrated = (magState.accuracy + ?: 0) >= SensorManager.SENSOR_STATUS_ACCURACY_MEDIUM + ) + } + .distinctUntilChanged { old, new -> + old.azimuth == new.azimuth && + old.pitch == new.pitch && + old.roll == new.roll && + old.isCalibrated == new.isCalibrated + } + .sample(DATA_INTERVAL) + } + + private fun fuseFromRotationVector(values: FloatArray): CompassOrientation { + val rotationMatrix = FloatArray(9) + val orientationAngles = FloatArray(3) + + if (values.isNotEmpty()) { + SensorManager.getRotationMatrixFromVector(rotationMatrix, values) + } + SensorManager.getOrientation(rotationMatrix, orientationAngles) + + return CompassOrientation( + azimuth = Math.toDegrees(orientationAngles[0].toDouble()).toFloat().normalizeAzimuth(), + trueAzimuth = null, + pitch = Math.toDegrees(orientationAngles[1].toDouble()).toFloat(), + roll = Math.toDegrees(orientationAngles[2].toDouble()).toFloat(), + accuracy = SensorAccuracy.UNRELIABLE, + magneticDeclination = 0f, + timestamp = System.currentTimeMillis(), + isCalibrated = false + ) + } + + private fun fuseFromAccelMag( + accelValues: FloatArray, + magValues: FloatArray + ): CompassOrientation { + val rotationMatrix = FloatArray(9) + val orientationAngles = FloatArray(3) + + val success = SensorManager.getRotationMatrix(rotationMatrix, null, accelValues, magValues) + if (!success) { + // getRotationMatrix возвращает false, если устройство в свободном падении + // или в near-magnetic-pole сингулярности — нужно решить, что возвращать в этом случае + } + + SensorManager.getOrientation(rotationMatrix, orientationAngles) + + return CompassOrientation( + azimuth = Math.toDegrees(orientationAngles[0].toDouble()).toFloat().normalizeAzimuth(), + trueAzimuth = null, + pitch = Math.toDegrees(orientationAngles[1].toDouble()).toFloat(), + roll = Math.toDegrees(orientationAngles[2].toDouble()).toFloat(), + accuracy = SensorAccuracy.UNRELIABLE, + magneticDeclination = 0f, + timestamp = System.currentTimeMillis(), + isCalibrated = false + ) + } + + private fun mapAccuracy(raw: Int?): SensorAccuracy = when (raw) { + SensorManager.SENSOR_STATUS_ACCURACY_HIGH -> SensorAccuracy.HIGH + SensorManager.SENSOR_STATUS_ACCURACY_MEDIUM -> SensorAccuracy.MEDIUM + SensorManager.SENSOR_STATUS_ACCURACY_LOW -> SensorAccuracy.LOW + else -> SensorAccuracy.UNRELIABLE + } + +} \ No newline at end of file diff --git a/app/src/main/java/dev/jekis/canvacompass/data/datasource/sensors/AbstractSensor.kt b/app/src/main/java/dev/jekis/canvacompass/data/datasource/sensors/AbstractSensor.kt new file mode 100644 index 0000000..5676022 --- /dev/null +++ b/app/src/main/java/dev/jekis/canvacompass/data/datasource/sensors/AbstractSensor.kt @@ -0,0 +1,58 @@ +package dev.jekis.canvacompass.data.datasource.sensors + +import android.hardware.Sensor +import android.hardware.SensorEvent +import android.hardware.SensorEventListener2 +import android.hardware.SensorManager +import kotlinx.coroutines.flow.MutableStateFlow +import kotlinx.coroutines.flow.StateFlow +import kotlinx.coroutines.flow.asStateFlow +import kotlinx.coroutines.flow.update + +abstract class AbstractSensor( + protected val sensorManager: SensorManager, + private val sensorType: Int +) { + private val sensor: Sensor? = sensorManager.getDefaultSensor(sensorType) + private val _sensorState = MutableStateFlow(SensorState(name = sensor?.name)) + val sensorState: StateFlow = _sensorState.asStateFlow() + + private val sensorListener = object : SensorEventListener2 { + override fun onFlushCompleted(sensor: Sensor?) { + } + + override fun onAccuracyChanged(sensor: Sensor?, accuracy: Int) { + _sensorState.update { state -> state.copy(accuracy = accuracy) } + } + + override fun onSensorChanged(event: SensorEvent?) { + event?.let { event -> + _sensorState.update { state -> + state.copy( + values = event.values.clone(), + accuracy = event.accuracy, + timestamp = event.timestamp + ) + } + }?: return + } + } + + init { + startListening() + } + + fun isAvailable(): Boolean = sensor != null + + fun startListening() { + sensor?.let { + sensorManager.registerListener(sensorListener, sensor, SensorManager.SENSOR_DELAY_UI) + } + } + + fun stopListening() { + sensor?.let { + sensorManager.unregisterListener(sensorListener) + } + } +} \ No newline at end of file diff --git a/app/src/main/java/dev/jekis/canvacompass/data/datasource/sensors/AccelerometerSensor.kt b/app/src/main/java/dev/jekis/canvacompass/data/datasource/sensors/AccelerometerSensor.kt new file mode 100644 index 0000000..6db8523 --- /dev/null +++ b/app/src/main/java/dev/jekis/canvacompass/data/datasource/sensors/AccelerometerSensor.kt @@ -0,0 +1,14 @@ +package dev.jekis.canvacompass.data.datasource.sensors + +import android.hardware.Sensor +import android.hardware.SensorManager + +/** + * Реализован датчик магнитного поля (магнитометр). + * Измеряет напряженность окружающего магнитного поля по трем осям. + * Используется для определения ориентации устройства относительно северного магнитного полюса. + * + * @param SensorManager - системный сервис для работы с датчиками Android. + */ +class AccelerometerSensor(sensorManager: SensorManager) : + AbstractSensor(sensorManager, Sensor.TYPE_ACCELEROMETER) \ No newline at end of file diff --git a/app/src/main/java/dev/jekis/canvacompass/data/datasource/sensors/MagnetometerSensor.kt b/app/src/main/java/dev/jekis/canvacompass/data/datasource/sensors/MagnetometerSensor.kt new file mode 100644 index 0000000..7e3fec7 --- /dev/null +++ b/app/src/main/java/dev/jekis/canvacompass/data/datasource/sensors/MagnetometerSensor.kt @@ -0,0 +1,16 @@ +package dev.jekis.canvacompass.data.datasource.sensors + +import android.hardware.Sensor +import android.hardware.SensorManager +import org.koin.core.annotation.Singleton + +/** + * Implementation of a magnetic field sensor (magnetometer). + * Measures the strength of the surrounding magnetic field along three axes. + * Used to determine the orientation of the device relative to magnetic north. + * + * @param SensorManager is a system service for working with Android sensors. + */ +@Singleton +class MagnetometerSensor(sensorManager: SensorManager) : + AbstractSensor(sensorManager, Sensor.TYPE_MAGNETIC_FIELD) \ No newline at end of file diff --git a/app/src/main/java/dev/jekis/canvacompass/data/datasource/sensors/RotationVectorSensor.kt b/app/src/main/java/dev/jekis/canvacompass/data/datasource/sensors/RotationVectorSensor.kt new file mode 100644 index 0000000..a07085c --- /dev/null +++ b/app/src/main/java/dev/jekis/canvacompass/data/datasource/sensors/RotationVectorSensor.kt @@ -0,0 +1,15 @@ +package dev.jekis.canvacompass.data.datasource.sensors + +import android.hardware.Sensor +import android.hardware.SensorManager + +/** + * Implementation of the rotation vector sensor. + * Provides device orientation data as a result of the synthesis of several sensors + * (accelerometer, magnetometer, gyroscope). It is the most accurate way to determine orientation. + * + * @param SensorManager is a system service for working with Android sensors. + */ +class RotationVectorSensor( + sensorManager: SensorManager +): AbstractSensor(sensorManager, Sensor.TYPE_ROTATION_VECTOR) \ No newline at end of file diff --git a/app/src/main/java/dev/jekis/canvacompass/data/datasource/sensors/SensorState.kt b/app/src/main/java/dev/jekis/canvacompass/data/datasource/sensors/SensorState.kt new file mode 100644 index 0000000..3213914 --- /dev/null +++ b/app/src/main/java/dev/jekis/canvacompass/data/datasource/sensors/SensorState.kt @@ -0,0 +1,31 @@ +package dev.jekis.canvacompass.data.datasource.sensors + +data class SensorState( + val name: String?, + val values: FloatArray = floatArrayOf(), + val accuracy: Int? = null, + val timestamp: Long? = 0L +) { + override fun equals(other: Any?): Boolean { + if (this === other) return true + if (javaClass != other?.javaClass) return false + + other as SensorState + + if (accuracy != other.accuracy) return false + if (timestamp != other.timestamp) return false + if (name != other.name) return false + if (!values.contentEquals(other.values)) return false + + return true + } + + override fun hashCode(): Int { + var result = accuracy ?: 0 + result = 31 * result + (timestamp?.hashCode() ?: 0) + result = 31 * result + (name?.hashCode() ?: 0) + result = 31 * result + values.contentHashCode() + return result + } + +} diff --git a/app/src/main/java/dev/jekis/canvacompass/di/KoinModule.kt b/app/src/main/java/dev/jekis/canvacompass/di/KoinModule.kt new file mode 100644 index 0000000..37c5cbc --- /dev/null +++ b/app/src/main/java/dev/jekis/canvacompass/di/KoinModule.kt @@ -0,0 +1,15 @@ +package dev.jekis.canvacompass.di + +import android.content.Context +import android.hardware.SensorManager +import org.koin.core.annotation.ComponentScan +import org.koin.core.annotation.Module +import org.koin.core.annotation.Single + +@Module +@ComponentScan("dev.jekis.canvacompass") +class KoinModule { + @Single + fun sensorManager(context: Context): SensorManager = + context.getSystemService(Context.SENSOR_SERVICE) as SensorManager +} diff --git a/app/src/main/java/dev/jekis/canvacompass/domain/CompasOrientation.kt b/app/src/main/java/dev/jekis/canvacompass/domain/CompasOrientation.kt new file mode 100644 index 0000000..d3ea1b5 --- /dev/null +++ b/app/src/main/java/dev/jekis/canvacompass/domain/CompasOrientation.kt @@ -0,0 +1,41 @@ +package dev.jekis.canvacompass.domain + +/** + * Domain model describing the current device orientation for the compass. + * + * @param azimuth direction to magnetic north in degrees, range 0..360 + * @param trueAzimuth direction to true (geographic) north in degrees, + * adjusted for magnetic declination; null if the user's + * location is unavailable and the correction cannot be computed + * @param pitch forward/backward tilt angle of the device in degrees, range -180..180 + * @param roll left/right tilt angle of the device in degrees, range -90..90 + * @param accuracy current accuracy level of the magnetometer readings + * @param magneticDeclination magnetic declination correction in degrees, + * calculated for the user's current coordinates + * @param timestamp time of the measurement in milliseconds (System.currentTimeMillis()), + * used for smoothing and discarding stale readings + * @param isCalibrated indicates whether the magnetometer is calibrated + * and the readings are reliable + */ +data class CompassOrientation( + val azimuth: Float, + val trueAzimuth: Float?, + val pitch: Float, + val roll: Float, + val accuracy: SensorAccuracy, + val magneticDeclination: Float, + val timestamp: Long, + val isCalibrated: Boolean +) + +/** + * Accuracy level of magnetometer readings, as reported by the Android Sensor Framework. + * + * @property UNRELIABLE readings are unreliable, calibration is required + * @property LOW low accuracy, calibration is recommended + * @property MEDIUM medium accuracy, acceptable for most use cases + * @property HIGH high accuracy, readings are reliable + */ +enum class SensorAccuracy { + UNRELIABLE, LOW, MEDIUM, HIGH +} diff --git a/app/src/main/java/dev/jekis/canvacompass/domain/GetCompassOrientationUseCase.kt b/app/src/main/java/dev/jekis/canvacompass/domain/GetCompassOrientationUseCase.kt new file mode 100644 index 0000000..06d9d94 --- /dev/null +++ b/app/src/main/java/dev/jekis/canvacompass/domain/GetCompassOrientationUseCase.kt @@ -0,0 +1,11 @@ +package dev.jekis.canvacompass.domain + +import kotlinx.coroutines.flow.Flow +import org.koin.core.annotation.Factory + +@Factory +class GetCompassOrientationUseCase( + private val sensorRepository: SensorRepository +) { + operator fun invoke(): Flow = sensorRepository.fetchOrientationData() +} \ No newline at end of file diff --git a/app/src/main/java/dev/jekis/canvacompass/domain/SensorRepository.kt b/app/src/main/java/dev/jekis/canvacompass/domain/SensorRepository.kt index 471f6d7..47cf9c5 100644 --- a/app/src/main/java/dev/jekis/canvacompass/domain/SensorRepository.kt +++ b/app/src/main/java/dev/jekis/canvacompass/domain/SensorRepository.kt @@ -1,4 +1,8 @@ package dev.jekis.canvacompass.domain +import kotlinx.coroutines.flow.Flow + interface SensorRepository { + + fun fetchOrientationData(): Flow } \ No newline at end of file diff --git a/app/src/main/java/dev/jekis/canvacompass/util/NumberFormatter.kt b/app/src/main/java/dev/jekis/canvacompass/util/NumberFormatter.kt new file mode 100644 index 0000000..121efd9 --- /dev/null +++ b/app/src/main/java/dev/jekis/canvacompass/util/NumberFormatter.kt @@ -0,0 +1,7 @@ +package dev.jekis.canvacompass.util + +/* + * the azimuth after getOrientation can be negative, normalize to 0..360 + */ + +fun Float.normalizeAzimuth(): Float = (this + 360) % 360 \ No newline at end of file diff --git a/build.gradle.kts b/build.gradle.kts index b826fe1..c0abc8b 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -2,5 +2,5 @@ plugins { alias(libs.plugins.android.application) apply false alias(libs.plugins.compose.compiler) apply false - alias(libs.plugins.ksp) apply false + alias(libs.plugins.koin.compiler) apply false } diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml index ca3e277..53afd8c 100644 --- a/gradle/libs.versions.toml +++ b/gradle/libs.versions.toml @@ -11,10 +11,9 @@ navigationFragmentKtx = "2.9.7" navigationUiKtx = "2.9.7" lifecycle = "2.10.0" composeBom = "2026.03.01" -kotlin = "2.1.0" -koin = "4.2.2" -koin-ksp = "2.3.1" -ksp = "2.0.21-1.0.28" +kotlin = "2.3.21" +koin = "4.2.1" +koin-plugin = "1.0.0" [libraries] androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" } @@ -34,14 +33,14 @@ androidx-ui-tooling-preview = { group = "androidx.compose.ui", name = "ui-toolin androidx-material3 = { group = "androidx.compose.material3", name = "material3" } androidx-activity-compose = { group = "androidx.activity", name = "activity-compose", version = "1.11.0" } -#Koin +# Koin koin-bom = { group = "io.insert-koin", name = "koin-bom", version.ref = "koin" } +koin-core = { group = "io.insert-koin", name = "koin-core", version.ref = "koin" } koin-annotations = { group = "io.insert-koin", name = "koin-annotations", version.ref = "koin" } koin-android = { group = "io.insert-koin", name = "koin-android", version.ref = "koin" } -koin-compose = { group = "io.insert-koin", name = "koin-androidx-compose", version.ref = "koin" } -koin-compiler = { group = "io.insert-koin", name = "koin-ksp-compiler", version.ref = "koin-ksp" } +koin-compose = { group = "io.insert-koin", name = "koin-androidx-compose", version.ref = "koin" } [plugins] android-application = { id = "com.android.application", version.ref = "agp" } compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" } -ksp = { id = "com.google.devtools.ksp", version.ref = "ksp"} +koin-compiler = { id = "io.insert-koin.compiler.plugin", version.ref = "koin-plugin" } \ No newline at end of file