Merge pull request #22 from mutualmobile/ab_geomagnetic_rotation_vect…

…or_support

feat: Geomagnetic rotation vector sensor Implementation

README.md

@@ -93,7 +93,7 @@ Gyroscope (Uncalibrated) | ⚠️ | WIP
 Significant Motion | — | N/A
 Step Detector | ✅️ | rememberStepDetectorSensorState()
 Step Counter | ✅️ | rememberStepCounterSensorState()
-Geomagnetic Rotation Vector | ⚠️ | WIP
+Geomagnetic Rotation Vector | ✅️️ | rememberGeomagneticRotationVectorSensorState()
 Heart Rate | ✅️ | rememberHeartRateSensorState()
 Pose6DOF | — | N/A
 Stationary Detect | — | N/A

composesensors/src/main/java/com/mutualmobile/composesensors/GeomagneticRotationVectorSensorState.kt

@@ -0,0 +1,88 @@
+package com.mutualmobile.composesensors
+
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.Immutable
+import androidx.compose.runtime.LaunchedEffect
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.remember
+
+/**
+ * Measures the orientation of a device by providing the three elements of the device's rotation vector.
+ * @param vectorX Rotation vector component along the x axis.
+ * @param vectorY Rotation vector component along the y axis.
+ * @param vectorZ Rotation vector component along the z axis.
+ * @param isAvailable Whether the current device has a geomagnetic rotation vector sensor. Defaults to false.
+ * @param accuracy Accuracy factor of the geomagnetic rotation vector sensor. Defaults to 0.
+ */
+@Immutable
+class GeomagneticRotationVectorSensorState internal constructor(
+  val vectorX: Float = 0f,
+  val vectorY: Float = 0f,
+  val vectorZ: Float = 0f,
+  val isAvailable: Boolean = false,
+  val accuracy: Int = 0
+) {
+  override fun toString(): String {
+    return "GeomagneticRotationVectorSensorState(vectorX=$vectorX, " +
+        "vectorY=$vectorY, vectorZ=$vectorZ, isAvailable=$isAvailable, " +
+        "accuracy=$accuracy)"
+  }
+
+  override fun equals(other: Any?): Boolean {
+    if (this === other) return true
+    other as GeomagneticRotationVectorSensorState
+
+    if (vectorX != other.vectorX) return false
+    if (vectorY != other.vectorY) return false
+    if (vectorZ != other.vectorZ) return false
+    if (isAvailable != other.isAvailable) return false
+    if (accuracy != other.accuracy) return false
+
+    return true
+  }
+
+  override fun hashCode(): Int {
+    var result = vectorX.hashCode()
+    result = 31 * result + vectorY.hashCode()
+    result = 31 * result + vectorZ.hashCode()
+    result = 31 * result + isAvailable.hashCode()
+    result = 31 * result + accuracy
+    return result
+  }
+}
+
+/**
+ * Creates and [remember]s instance of [GeomagneticRotationVectorSensorState].
+ * @param sensorDelay The rate at which the raw sensor data should be received.
+ * Defaults to [SensorDelay.Normal].
+ * @param onError Callback invoked on every error state.
+ */
+@Composable
+fun rememberGeomagneticRotationVectorSensorState(
+  sensorDelay: SensorDelay = SensorDelay.Normal,
+  onError: (throwable: Throwable) -> Unit = {},
+): GeomagneticRotationVectorSensorState {
+  val sensorState = rememberSensorState(
+    sensorType = SensorType.GeomagneticRotationVector,
+    sensorDelay = sensorDelay,
+    onError = onError,
+  )
+
+  val geomagneticRotationVectorSensorState =
+    remember { mutableStateOf(GeomagneticRotationVectorSensorState()) }
+
+  LaunchedEffect(key1 = sensorState, block = {
+    val sensorStateValues = sensorState.data
+    if (sensorStateValues.isNotEmpty()) {
+      geomagneticRotationVectorSensorState.value = GeomagneticRotationVectorSensorState(
+        vectorX = sensorStateValues[0],
+        vectorY = sensorStateValues[1],
+        vectorZ = sensorStateValues[2],
+        isAvailable = sensorState.isAvailable,
+        accuracy = sensorState.accuracy
+      )
+    }
+  })
+
+  return geomagneticRotationVectorSensorState.value
+}