Release: 2.5.2-rc0

Remove microphone detection and add ear detection.

VERSION

@@ -1 +1 @@
-2.5.1-rc0 20501000
+2.5.2-rc0 20502000

app-common/src/main/java/eu/darken/capod/pods/core/PodDevice.kt

@@ -108,13 +108,17 @@ interface PodDevice {
             "AirPods (Gen 1)? \uD83C\uDFAD",
             R.drawable.devic_airpods_gen1_both,
         ),
+        @Json(name = "fakes.generic.airpods.gen3") FAKE_AIRPODS_GEN3(
+            "AirPods (Gen 3)? \uD83C\uDFAD",
+            R.drawable.devic_airpods_gen2_both,
+        ),
         @Json(name = "fakes.varunr.airpodspro") FAKE_AIRPODS_PRO(
             "AirPods Pro? \uD83C\uDFAD",
             R.drawable.devic_airpods_pro2_both,
         ),
-        @Json(name = "fakes.generic.airpods.gen3") FAKE_AIRPODS_GEN3(
-            "AirPods (Gen 3)? \uD83C\uDFAD",
-            R.drawable.devic_airpods_gen2_both,
+        @Json(name = "fakes.generic.airpods.pro2") FAKE_AIRPODS_PRO2(
+            "AirPods Pro2? \uD83C\uDFAD",
+            R.drawable.devic_airpods_pro2_both,
         ),
         @Json(name = "unknown") UNKNOWN(
             "Unknown"

app-common/src/main/java/eu/darken/capod/pods/core/apple/AppleFactoryModule.kt

@@ -10,6 +10,7 @@ import eu.darken.capod.pods.core.apple.beats.*
 import eu.darken.capod.pods.core.apple.misc.FakeAirPodsGen1
 import eu.darken.capod.pods.core.apple.misc.FakeAirPodsGen3
 import eu.darken.capod.pods.core.apple.misc.FakeAirPodsPro
+import eu.darken.capod.pods.core.apple.misc.FakeAirPodsPro2
 
 @InstallIn(SingletonComponent::class)
 @Module
@@ -31,6 +32,7 @@ abstract class AppleFactoryModule {
     @Binds @IntoSet abstract fun powerBeatsPro(factory: PowerBeatsPro.Factory): ApplePodsFactory<out ApplePods>
 
     @Binds @IntoSet abstract fun fakeAirPodsGen1(factory: FakeAirPodsGen1.Factory): ApplePodsFactory<out ApplePods>
-    @Binds @IntoSet abstract fun fakeAirPodsPro(factory: FakeAirPodsPro.Factory): ApplePodsFactory<out ApplePods>
     @Binds @IntoSet abstract fun fakeAirPodsGen3(factory: FakeAirPodsGen3.Factory): ApplePodsFactory<out ApplePods>
+    @Binds @IntoSet abstract fun fakeAirPodsPro(factory: FakeAirPodsPro.Factory): ApplePodsFactory<out ApplePods>
+    @Binds @IntoSet abstract fun fakeAirPodsPro2(factory: FakeAirPodsPro2.Factory): ApplePodsFactory<out ApplePods>
 }

app-common/src/main/java/eu/darken/capod/pods/core/apple/misc/FakeAirPodsGen1.kt

@@ -6,10 +6,7 @@ import eu.darken.capod.common.debug.logging.logTag
 import eu.darken.capod.common.isBitSet
 import eu.darken.capod.common.lowerNibble
 import eu.darken.capod.common.upperNibble
-import eu.darken.capod.pods.core.DualPodDevice
-import eu.darken.capod.pods.core.HasCase
-import eu.darken.capod.pods.core.HasDualMicrophone
-import eu.darken.capod.pods.core.PodDevice
+import eu.darken.capod.pods.core.*
 import eu.darken.capod.pods.core.apple.ApplePods
 import eu.darken.capod.pods.core.apple.ApplePodsFactory
 import eu.darken.capod.pods.core.apple.protocol.ProximityPairing
@@ -31,7 +28,7 @@ data class FakeAirPodsGen1 constructor(
     override val confidence: Float = PodDevice.BASE_CONFIDENCE,
     private val rssiAverage: Int? = null,
     private val cachedBatteryPercentage: Float? = null,
-) : ApplePods, DualPodDevice, HasDualMicrophone, HasCase {
+) : ApplePods, DualPodDevice, HasEarDetectionDual, HasChargeDetectionDual, HasCase {
 
     override val model: PodDevice.Model = PodDevice.Model.FAKE_AIRPODS_GEN1
 
@@ -79,22 +76,32 @@ data class FakeAirPodsGen1 constructor(
             }
         }
 
-    val isThisPodInThecase: Boolean
+    private val isThisPodInThecase: Boolean
         get() = rawStatus.isBitSet(6)
 
-    /**
-     * The data flip bit is set if the left pod is primary.
-     * For the pod that is in the case, this is flipped again though.
-     */
-    override val isLeftPodMicrophone: Boolean
-        get() = rawStatus.isBitSet(5) xor isThisPodInThecase
+    override val isLeftPodInEar: Boolean
+        get() = when (areValuesFlipped xor isThisPodInThecase) {
+            true -> rawStatus.isBitSet(3)
+            false -> rawStatus.isBitSet(1)
+        }
 
-    /**
-     * The data flip bit is UNset if the right pod is primary.
-     * For the pod that is in the case, this is flipped again though.
-     */
-    override val isRightPodMicrophone: Boolean
-        get() = !rawStatus.isBitSet(5) xor isThisPodInThecase
+    override val isRightPodInEar: Boolean
+        get() = when (areValuesFlipped xor isThisPodInThecase) {
+            true -> rawStatus.isBitSet(1)
+            false -> rawStatus.isBitSet(3)
+        }
+
+    override val isLeftPodCharging: Boolean
+        get() = when (areValuesFlipped) {
+            false -> rawFlags.isBitSet(0)
+            true -> rawFlags.isBitSet(1)
+        }
+
+    override val isRightPodCharging: Boolean
+        get() = when (areValuesFlipped) {
+            false -> rawFlags.isBitSet(1)
+            true -> rawFlags.isBitSet(0)
+        }
 
     override val batteryCasePercent: Float?
         get() = when (val value = rawCaseBattery.toInt()) {

app-common/src/main/java/eu/darken/capod/pods/core/apple/misc/FakeAirPodsGen3.kt

@@ -28,7 +28,7 @@ data class FakeAirPodsGen3 constructor(
     override val confidence: Float = PodDevice.BASE_CONFIDENCE,
     private val rssiAverage: Int? = null,
     private val cachedBatteryPercentage: Float? = null,
-) : ApplePods, DualPodDevice, HasDualMicrophone, HasCase, HasChargeDetectionDual {
+) : ApplePods, DualPodDevice, HasEarDetectionDual, HasChargeDetectionDual, HasCase {
 
     override val model: PodDevice.Model = PodDevice.Model.FAKE_AIRPODS_GEN3
 
@@ -88,22 +88,20 @@ data class FakeAirPodsGen3 constructor(
             true -> rawFlags.isBitSet(0)
         }
 
-    val isThisPodInThecase: Boolean
+    private val isThisPodInThecase: Boolean
         get() = rawStatus.isBitSet(6)
 
-    /**
-     * The data flip bit is set if the left pod is primary.
-     * For the pod that is in the case, this is flipped again though.
-     */
-    override val isLeftPodMicrophone: Boolean
-        get() = rawStatus.isBitSet(5) xor isThisPodInThecase
+    override val isLeftPodInEar: Boolean
+        get() = when (areValuesFlipped xor isThisPodInThecase) {
+            true -> rawStatus.isBitSet(3)
+            false -> rawStatus.isBitSet(1)
+        }
 
-    /**
-     * The data flip bit is UNset if the right pod is primary.
-     * For the pod that is in the case, this is flipped again though.
-     */
-    override val isRightPodMicrophone: Boolean
-        get() = !rawStatus.isBitSet(5) xor isThisPodInThecase
+    override val isRightPodInEar: Boolean
+        get() = when (areValuesFlipped xor isThisPodInThecase) {
+            true -> rawStatus.isBitSet(1)
+            false -> rawStatus.isBitSet(3)
+        }
 
     override val batteryCasePercent: Float?
         get() = when (val value = rawCaseBattery.toInt()) {

app-common/src/main/java/eu/darken/capod/pods/core/apple/misc/FakeAirPodsPro.kt

@@ -1,15 +1,14 @@
 package eu.darken.capod.pods.core.apple.misc
 
+import androidx.annotation.DrawableRes
+import eu.darken.capod.common.R
 import eu.darken.capod.common.bluetooth.BleScanResult
 import eu.darken.capod.common.debug.logging.log
 import eu.darken.capod.common.debug.logging.logTag
 import eu.darken.capod.common.isBitSet
 import eu.darken.capod.common.lowerNibble
 import eu.darken.capod.common.upperNibble
-import eu.darken.capod.pods.core.DualPodDevice
-import eu.darken.capod.pods.core.HasCase
-import eu.darken.capod.pods.core.HasDualMicrophone
-import eu.darken.capod.pods.core.PodDevice
+import eu.darken.capod.pods.core.*
 import eu.darken.capod.pods.core.apple.ApplePods
 import eu.darken.capod.pods.core.apple.ApplePodsFactory
 import eu.darken.capod.pods.core.apple.protocol.ProximityPairing
@@ -31,10 +30,26 @@ data class FakeAirPodsPro constructor(
     override val confidence: Float = PodDevice.BASE_CONFIDENCE,
     private val rssiAverage: Int? = null,
     private val cachedBatteryPercentage: Float? = null,
-) : ApplePods, DualPodDevice, HasDualMicrophone, HasCase {
+) : ApplePods, DualPodDevice, HasChargeDetectionDual, HasEarDetectionDual, HasCase {
 
     override val model: PodDevice.Model = PodDevice.Model.FAKE_AIRPODS_PRO
 
+    @get:DrawableRes
+    override val iconRes: Int
+        get() = R.drawable.devic_airpods_pro2_both
+
+    @get:DrawableRes
+    override val caseIcon: Int
+        get() = R.drawable.devic_airpods_pro2_case
+
+    @get:DrawableRes
+    override val leftPodIcon: Int
+        get() = R.drawable.devic_airpods_pro2_left
+
+    @get:DrawableRes
+    override val rightPodIcon: Int
+        get() = R.drawable.devic_airpods_pro2_right
+
     override val rssi: Int
         get() = rssiAverage ?: super<ApplePods>.rssi
 
@@ -79,22 +94,32 @@ data class FakeAirPodsPro constructor(
             }
         }
 
-    val isThisPodInThecase: Boolean
+    override val isLeftPodCharging: Boolean
+        get() = when (areValuesFlipped) {
+            false -> rawFlags.isBitSet(0)
+            true -> rawFlags.isBitSet(1)
+        }
+
+    override val isRightPodCharging: Boolean
+        get() = when (areValuesFlipped) {
+            false -> rawFlags.isBitSet(1)
+            true -> rawFlags.isBitSet(0)
+        }
+
+    private val isThisPodInThecase: Boolean
         get() = rawStatus.isBitSet(6)
 
-    /**
-     * The data flip bit is set if the left pod is primary.
-     * For the pod that is in the case, this is flipped again though.
-     */
-    override val isLeftPodMicrophone: Boolean
-        get() = rawStatus.isBitSet(5) xor isThisPodInThecase
+    override val isLeftPodInEar: Boolean
+        get() = when (areValuesFlipped xor isThisPodInThecase) {
+            true -> rawStatus.isBitSet(3)
+            false -> rawStatus.isBitSet(1)
+        }
 
-    /**
-     * The data flip bit is UNset if the right pod is primary.
-     * For the pod that is in the case, this is flipped again though.
-     */
-    override val isRightPodMicrophone: Boolean
-        get() = !rawStatus.isBitSet(5) xor isThisPodInThecase
+    override val isRightPodInEar: Boolean
+        get() = when (areValuesFlipped xor isThisPodInThecase) {
+            true -> rawStatus.isBitSet(1)
+            false -> rawStatus.isBitSet(3)
+        }
 
     override val batteryCasePercent: Float?
         get() = when (val value = rawCaseBattery.toInt()) {

app-common/src/main/java/eu/darken/capod/pods/core/apple/misc/FakeAirPodsPro2.kt

@@ -0,0 +1,168 @@
+package eu.darken.capod.pods.core.apple.misc
+
+import androidx.annotation.DrawableRes
+import eu.darken.capod.common.R
+import eu.darken.capod.common.bluetooth.BleScanResult
+import eu.darken.capod.common.debug.logging.log
+import eu.darken.capod.common.debug.logging.logTag
+import eu.darken.capod.common.isBitSet
+import eu.darken.capod.common.lowerNibble
+import eu.darken.capod.common.upperNibble
+import eu.darken.capod.pods.core.*
+import eu.darken.capod.pods.core.apple.ApplePods
+import eu.darken.capod.pods.core.apple.ApplePodsFactory
+import eu.darken.capod.pods.core.apple.DualAirPods
+import eu.darken.capod.pods.core.apple.protocol.ProximityPairing
+import java.time.Instant
+import javax.inject.Inject
+
+/**
+ * AirPods Pro2 clone
+ * https://discord.com/channels/548521543039189022/927235844127993866/1060911213539774504
+ */
+data class FakeAirPodsPro2 constructor(
+    override val identifier: PodDevice.Id = PodDevice.Id(),
+    override val seenLastAt: Instant = Instant.now(),
+    override val seenFirstAt: Instant = Instant.now(),
+    override val seenCounter: Int = 1,
+    override val scanResult: BleScanResult,
+    override val proximityMessage: ProximityPairing.Message,
+    override val confidence: Float = PodDevice.BASE_CONFIDENCE,
+    private val rssiAverage: Int? = null,
+    private val cachedBatteryPercentage: Float? = null,
+    private val cachedCaseState: DualAirPods.LidState? = null,
+) : ApplePods, HasChargeDetectionDual, DualPodDevice, HasEarDetectionDual, HasCase {
+
+    override val model: PodDevice.Model = PodDevice.Model.FAKE_AIRPODS_PRO2
+
+    @get:DrawableRes
+    override val iconRes: Int
+        get() = R.drawable.devic_airpods_pro2_both
+
+    @get:DrawableRes
+    override val caseIcon: Int
+        get() = R.drawable.devic_airpods_pro2_case
+
+    @get:DrawableRes
+    override val leftPodIcon: Int
+        get() = R.drawable.devic_airpods_pro2_left
+
+    @get:DrawableRes
+    override val rightPodIcon: Int
+        get() = R.drawable.devic_airpods_pro2_right
+
+    override val rssi: Int
+        get() = rssiAverage ?: scanResult.rssi
+
+    private val areValuesFlipped: Boolean
+        get() = !rawStatus.isBitSet(5)
+
+    override val batteryLeftPodPercent: Float?
+        get() {
+            val value = when (areValuesFlipped) {
+                true -> rawPodsBattery.upperNibble.toInt()
+                false -> rawPodsBattery.lowerNibble.toInt()
+            }
+            return when (value) {
+                15 -> null
+                else -> if (value > 10) {
+                    log { "Left pod: Above 100% battery: $value" }
+                    1.0f
+                } else {
+                    (value / 10f)
+                }
+            }
+        }
+
+    override val batteryRightPodPercent: Float?
+        get() {
+            val value = when (areValuesFlipped) {
+                true -> rawPodsBattery.lowerNibble.toInt()
+                false -> rawPodsBattery.upperNibble.toInt()
+            }
+            return when (value) {
+                15 -> null
+                else -> if (value > 10) {
+                    log { "Right pod: Above 100% battery: $value" }
+                    1.0f
+                } else {
+                    value / 10f
+                }
+            }
+        }
+
+    private val isThisPodInThecase: Boolean
+        get() = rawStatus.isBitSet(6)
+
+    override val isLeftPodInEar: Boolean
+        get() = when (areValuesFlipped xor isThisPodInThecase) {
+            true -> rawStatus.isBitSet(3)
+            false -> rawStatus.isBitSet(1)
+        }
+
+    override val isRightPodInEar: Boolean
+        get() = when (areValuesFlipped xor isThisPodInThecase) {
+            true -> rawStatus.isBitSet(1)
+            false -> rawStatus.isBitSet(3)
+        }
+
+    override val isLeftPodCharging: Boolean
+        get() = when (areValuesFlipped) {
+            false -> rawFlags.isBitSet(0)
+            true -> rawFlags.isBitSet(1)
+        }
+
+    override val isRightPodCharging: Boolean
+        get() = when (areValuesFlipped) {
+            false -> rawFlags.isBitSet(1)
+            true -> rawFlags.isBitSet(0)
+        }
+
+    override val batteryCasePercent: Float?
+        get() = when (val value = rawCaseBattery.toInt()) {
+            15 -> cachedBatteryPercentage
+            else -> if (value > 10) {
+                log { "Case: Above 100% battery: $value" }
+                1.0f
+            } else {
+                value / 10f
+            }
+        }
+
+    override val isCaseCharging: Boolean
+        get() = rawFlags.isBitSet(2)
+
+    class Factory @Inject constructor() : ApplePodsFactory<FakeAirPodsPro2>(TAG) {
+
+        override fun isResponsible(message: ProximityPairing.Message): Boolean = message.run {
+            // Official message length is 19HEX, i.e. binary 25, did they copy this wrong?
+            getModelInfo().full == DEVICE_CODE && length == 19
+        }
+
+        override fun create(scanResult: BleScanResult, message: ProximityPairing.Message): ApplePods {
+            var basic = FakeAirPodsPro2(scanResult = scanResult, proximityMessage = message)
+            val result = searchHistory(basic)
+
+            if (result != null) basic = basic.copy(identifier = result.id)
+            updateHistory(basic)
+
+            if (result == null) return basic
+
+            return basic.copy(
+                identifier = result.id,
+                seenFirstAt = result.seenFirstAt,
+                seenLastAt = scanResult.receivedAt,
+                seenCounter = result.seenCounter,
+                confidence = result.confidence,
+                cachedBatteryPercentage = result.getLatestCaseBattery(),
+                rssiAverage = result.averageRssi(basic.rssi),
+            )
+        }
+
+    }
+
+    companion object {
+        private val DEVICE_CODE = 0x1420.toUShort()
+        private val TAG = logTag("PodDevice", "Apple", "Fake", "AirPods", "Pro2")
+    }
+}

app-common/src/test/java/eu/darken/capod/pods/core/apple/misc/FakeAirPodsGen1Test.kt

@@ -24,6 +24,12 @@ class FakeAirPodsGen1Test : BaseAirPodsTest() {
             batteryLeftPodPercent shouldBe 1.0f
             batteryRightPodPercent shouldBe 1.0f
 
+            isLeftPodInEar shouldBe false
+            isRightPodInEar shouldBe false
+
+            isLeftPodCharging shouldBe true
+            isRightPodCharging shouldBe true
+
             isCaseCharging shouldBe false
 
             batteryCasePercent shouldBe 0.7f

app-common/src/test/java/eu/darken/capod/pods/core/apple/misc/FakeAirPodsGen3Test.kt

@@ -24,6 +24,9 @@ class FakeAirPodsGen3Test : BaseAirPodsTest() {
             batteryLeftPodPercent shouldBe 1f
             batteryRightPodPercent shouldBe 1f
 
+            isLeftPodInEar shouldBe false
+            isRightPodInEar shouldBe false
+
             isCaseCharging shouldBe false
             isLeftPodCharging shouldBe true
             isRightPodCharging shouldBe true

app-common/src/test/java/eu/darken/capod/pods/core/apple/misc/FakeAirPodsPro2Test.kt

@@ -0,0 +1,34 @@
+package eu.darken.capod.pods.core.apple.misc
+
+import eu.darken.capod.pods.core.PodDevice
+import eu.darken.capod.pods.core.apple.BaseAirPodsTest
+import io.kotest.matchers.shouldBe
+import kotlinx.coroutines.test.runTest
+import org.junit.jupiter.api.Test
+
+class FakeAirPodsPro2Test : BaseAirPodsTest() {
+
+    @Test
+    fun `guessed data`() = runTest {
+        create<FakeAirPodsPro2>("07 13 01 14 20 75 AA 58 35 00 10 00 E4 E4 26 00 00 00 00 00 00") {
+            rawPrefix shouldBe 0x01.toUByte()
+            rawDeviceModel shouldBe 0x1420.toUShort()
+            rawStatus shouldBe 0x75.toUByte()
+            rawPodsBattery shouldBe 0xAA.toUByte()
+            rawFlags shouldBe 0x5.toUShort()
+            rawCaseBattery shouldBe 0x8.toUShort()
+            rawCaseLidState shouldBe 0x35.toUByte()
+            rawDeviceColor shouldBe 0x00.toUByte()
+            rawSuffix shouldBe 0x10.toUByte()
+
+            batteryLeftPodPercent shouldBe 1.0f
+            batteryRightPodPercent shouldBe 1.0f
+
+            isCaseCharging shouldBe true
+
+            batteryCasePercent shouldBe 0.8f
+
+            model shouldBe PodDevice.Model.FAKE_AIRPODS_PRO2
+        }
+    }
+}

app-common/src/test/java/eu/darken/capod/pods/core/apple/misc/FakeAirPodsProTest.kt

@@ -24,6 +24,12 @@ class FakeAirPodsProTest : BaseAirPodsTest() {
             batteryLeftPodPercent shouldBe 1.0f
             batteryRightPodPercent shouldBe 1.0f
 
+            isLeftPodCharging shouldBe true
+            isRightPodCharging shouldBe true
+
+            isLeftPodInEar shouldBe false
+            isRightPodInEar shouldBe false
+
             isCaseCharging shouldBe false
 
             batteryCasePercent shouldBe 0.7f

app/src/main/res/layout/widget_pod_dual_layout.xml

@@ -11,8 +11,8 @@
         android:layout_height="wrap_content"
         android:layout_gravity="center"
         android:layout_marginBottom="2dp"
-        android:textStyle="bold"
         android:textSize="12sp"
+        android:textStyle="bold"
         tools:text="AirPods Max" />
 
     <LinearLayout
@@ -24,7 +24,7 @@
         <ImageView
             android:id="@+id/pod_left_icon"
             style="@style/PodInfoItemIcon.Notification"
-            android:src="@drawable/devic_airpods_gen1_left"
+            android:src="@drawable/devic_airpods_pro2_left"
             tools:ignore="ContentDescription" />
 
         <TextView
@@ -58,7 +58,7 @@
         <ImageView
             android:id="@+id/pod_right_icon"
             style="@style/PodInfoItemIcon.Notification"
-            android:src="@drawable/devic_airpods_gen1_right"
+            android:src="@drawable/devic_airpods_pro2_right"
             tools:ignore="ContentDescription" />
 
         <TextView

version.properties

@@ -1,6 +1,6 @@
 ### Updated by release.sh ###
 project.versioning.major=2
 project.versioning.minor=5
-project.versioning.patch=1
+project.versioning.patch=2
 project.versioning.build=0
 #############################