TySS-Dev/capod
1
0
Fork 0
mirror of https://github.com/d4rken-org/capod.git synced 2026-09-15 10:46:12 -04:00
Code Issues Packages Projects Releases Wiki Activity

feat(aap): Add new device settings, stem actions, and noise control UI

Browse Source 
Add 8 new AAP writable settings (microphone mode, ear detection toggle, listening mode cycle, allow off, stem config, sleep detection, in-case tone, device rename) and 4 new data reception features (stem press events, connected devices, audio source, EQ data).

Implement stem press action system with per-bud configurable Android actions (play/pause, next/prev track, volume), auto-sent stem config on connection, and dedicated config screen.

Combine ANC mode selector with listening mode cycle visibility into a unified noise control component. Eye icons control which modes appear in the dashboard card and settings. Pro gating with stars icon for upgrade-required features.

Add 64 unit tests covering all new decoders, model feature flags, malformed payloads, and rename byte-length validation.
This commit is contained in:
darken
2026-04-04 11:41:26 +02:00
committed by Matthias Urhahn
parent e014ad8045
commit e356344ba6
32 changed files with 1845 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/src/test/java/eu/darken/capod/pods/core/apple/aap/devices/DefaultAapDeviceProfileNewSettingsTest.kt
+313
View File
@@ -0,0 +1,313 @@
package eu.darken.capod.pods.core.apple.aap.devices
import eu.darken.capod.pods.core.apple.PodModel
import eu.darken.capod.pods.core.apple.aap.protocol.AapCommand
import eu.darken.capod.pods.core.apple.aap.protocol.AapMessage
import eu.darken.capod.pods.core.apple.aap.protocol.AapSetting
import eu.darken.capod.pods.core.apple.aap.protocol.BaseAapSessionTest
import eu.darken.capod.pods.core.apple.aap.protocol.DefaultAapDeviceProfile
import eu.darken.capod.pods.core.apple.aap.protocol.StemPressEvent
import io.kotest.matchers.nulls.shouldBeNull
import io.kotest.matchers.shouldBe
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.assertThrows
class DefaultAapDeviceProfileNewSettingsTest : BaseAapSessionTest() {
override val podModel = PodModel.AIRPODS_PRO2
// ── Microphone Mode (0x01) ──────────────────────────────
@Nested
inner class MicrophoneModeTests {
@Test fun `encode auto`() { profile.encodeCommand(AapCommand.SetMicrophoneMode(AapSetting.MicrophoneMode.Mode.AUTO))[7] shouldBe 0x00.toByte() }
@Test fun `encode always right`() { profile.encodeCommand(AapCommand.SetMicrophoneMode(AapSetting.MicrophoneMode.Mode.ALWAYS_RIGHT))[7] shouldBe 0x01.toByte() }
@Test fun `encode always left`() { profile.encodeCommand(AapCommand.SetMicrophoneMode(AapSetting.MicrophoneMode.Mode.ALWAYS_LEFT))[7] shouldBe 0x02.toByte() }
@Test fun `decode auto`() { decodeSetting<AapSetting.MicrophoneMode>(settingsMessage(0x01, 0x00)).mode shouldBe AapSetting.MicrophoneMode.Mode.AUTO }
@Test fun `decode always right`() { decodeSetting<AapSetting.MicrophoneMode>(settingsMessage(0x01, 0x01)).mode shouldBe AapSetting.MicrophoneMode.Mode.ALWAYS_RIGHT }
@Test fun `decode always left`() { decodeSetting<AapSetting.MicrophoneMode>(settingsMessage(0x01, 0x02)).mode shouldBe AapSetting.MicrophoneMode.Mode.ALWAYS_LEFT }
@Test fun `decode unknown returns null`() { profile.decodeSetting(settingsMessage(0x01, 0x99)).shouldBeNull() }
@Test
fun `round-trip all modes`() {
for (mode in AapSetting.MicrophoneMode.Mode.entries) {
val encoded = profile.encodeCommand(AapCommand.SetMicrophoneMode(mode))
decodeSetting<AapSetting.MicrophoneMode>(AapMessage.parse(encoded)!!).mode shouldBe mode
}
}
}
// ── Ear Detection Toggle (0x0A) ─────────────────────────
@Nested
inner class EarDetectionToggleTests {
@Test fun `encode enabled`() { profile.encodeCommand(AapCommand.SetEarDetectionEnabled(true))[7] shouldBe 0x01.toByte() }
@Test fun `encode disabled`() { profile.encodeCommand(AapCommand.SetEarDetectionEnabled(false))[7] shouldBe 0x02.toByte() }
@Test fun `decode enabled`() { decodeSetting<AapSetting.EarDetectionEnabled>(settingsMessage(0x0A, 0x01)).enabled shouldBe true }
@Test fun `decode disabled`() { decodeSetting<AapSetting.EarDetectionEnabled>(settingsMessage(0x0A, 0x02)).enabled shouldBe false }
@Test fun `decode unknown returns null`() { profile.decodeSetting(settingsMessage(0x0A, 0x00)).shouldBeNull() }
}
// ── Listening Mode Cycle (0x1A) ─────────────────────────
@Nested
inner class ListeningModeCycleTests {
@Test fun `encode mask 0x0F`() { profile.encodeCommand(AapCommand.SetListeningModeCycle(0x0F))[7] shouldBe 0x0F.toByte() }
@Test fun `encode mask 0x06`() { profile.encodeCommand(AapCommand.SetListeningModeCycle(0x06))[7] shouldBe 0x06.toByte() }
@Test fun `decode mask`() { decodeSetting<AapSetting.ListeningModeCycle>(settingsMessage(0x1A, 0x0E)).modeMask shouldBe 0x0E }
@Test fun `decode mask helpers`() {
val cycle = decodeSetting<AapSetting.ListeningModeCycle>(settingsMessage(0x1A, 0x0D))
cycle.includesOff shouldBe true
cycle.includesAnc shouldBe false
cycle.includesTransparency shouldBe true
cycle.includesAdaptive shouldBe true
}
@Test fun `encode single mode`() {
profile.encodeCommand(AapCommand.SetListeningModeCycle(0x01))[7] shouldBe 0x01.toByte()
}
@Test fun `encode zero mask`() {
profile.encodeCommand(AapCommand.SetListeningModeCycle(0x00))[7] shouldBe 0x00.toByte()
}
@Test fun `encode masks out high bits`() {
profile.encodeCommand(AapCommand.SetListeningModeCycle(0xFF))[7] shouldBe 0x0F.toByte()
}
}
// ── Allow Off Option (0x34) ─────────────────────────────
@Nested
inner class AllowOffOptionTests {
@Test fun `encode enabled`() { profile.encodeCommand(AapCommand.SetAllowOffOption(true))[7] shouldBe 0x01.toByte() }
@Test fun `encode disabled`() { profile.encodeCommand(AapCommand.SetAllowOffOption(false))[7] shouldBe 0x02.toByte() }
@Test fun `decode enabled`() { decodeSetting<AapSetting.AllowOffOption>(settingsMessage(0x34, 0x01)).enabled shouldBe true }
@Test fun `decode disabled`() { decodeSetting<AapSetting.AllowOffOption>(settingsMessage(0x34, 0x02)).enabled shouldBe false }
@Test fun `decode unknown returns null`() { profile.decodeSetting(settingsMessage(0x34, 0x00)).shouldBeNull() }
}
// ── Stem Config (0x39) ──────────────────────────────────
@Nested
inner class StemConfigTests {
@Test fun `encode full claim`() { profile.encodeCommand(AapCommand.SetStemConfig(0x0F))[7] shouldBe 0x0F.toByte() }
@Test fun `encode no claim`() { profile.encodeCommand(AapCommand.SetStemConfig(0x00))[7] shouldBe 0x00.toByte() }
@Test fun `encode masks high bits`() { profile.encodeCommand(AapCommand.SetStemConfig(0xFF))[7] shouldBe 0x0F.toByte() }
@Test fun `decode claim mask`() {
val sc = decodeSetting<AapSetting.StemConfig>(settingsMessage(0x39, 0x05))
sc.claimsSinglePress shouldBe true
sc.claimsDoublePress shouldBe false
sc.claimsTriplePress shouldBe true
sc.claimsLongPress shouldBe false
}
}
// ── Sleep Detection (0x35) ──────────────────────────────
@Nested
inner class SleepDetectionTests {
@Test fun `encode enabled`() { profile.encodeCommand(AapCommand.SetSleepDetection(true))[7] shouldBe 0x01.toByte() }
@Test fun `encode disabled`() { profile.encodeCommand(AapCommand.SetSleepDetection(false))[7] shouldBe 0x02.toByte() }
@Test fun `decode enabled`() { decodeSetting<AapSetting.SleepDetection>(settingsMessage(0x35, 0x01)).enabled shouldBe true }
@Test fun `decode disabled`() { decodeSetting<AapSetting.SleepDetection>(settingsMessage(0x35, 0x02)).enabled shouldBe false }
@Test fun `decode unknown returns null`() { profile.decodeSetting(settingsMessage(0x35, 0x00)).shouldBeNull() }
}
// ── In-Case Tone (0x31) ─────────────────────────────────
@Nested
inner class InCaseToneTests {
@Test fun `encode enabled`() { profile.encodeCommand(AapCommand.SetInCaseTone(true))[7] shouldBe 0x01.toByte() }
@Test fun `encode disabled`() { profile.encodeCommand(AapCommand.SetInCaseTone(false))[7] shouldBe 0x02.toByte() }
@Test fun `decode enabled`() { decodeSetting<AapSetting.InCaseTone>(settingsMessage(0x31, 0x01)).enabled shouldBe true }
@Test fun `decode disabled`() { decodeSetting<AapSetting.InCaseTone>(settingsMessage(0x31, 0x02)).enabled shouldBe false }
@Test fun `decode unknown returns null`() { profile.decodeSetting(settingsMessage(0x31, 0x00)).shouldBeNull() }
}
// ── Device Rename (0x1E) ────────────────────────────────
@Nested
inner class DeviceRenameTests {
@Test
fun `encode simple ASCII name`() {
val bytes = profile.encodeCommand(AapCommand.SetDeviceName("MyPods"))
bytes[4] shouldBe 0x1E.toByte()
bytes[6] shouldBe 6.toByte() // length
String(bytes, 8, 6, Charsets.UTF_8) shouldBe "MyPods"
}
@Test
fun `encode multibyte UTF-8 name`() {
val name = "AirPods \uD83C\uDFA7" // headphone emoji
val nameBytes = name.toByteArray(Charsets.UTF_8)
val bytes = profile.encodeCommand(AapCommand.SetDeviceName(name))
bytes[6] shouldBe nameBytes.size.toByte()
String(bytes, 8, nameBytes.size, Charsets.UTF_8) shouldBe name
}
@Test
fun `encode rejects name exceeding 127 bytes`() {
val longName = "A".repeat(128) // 128 ASCII bytes
assertThrows<IllegalArgumentException> { profile.encodeCommand(AapCommand.SetDeviceName(longName)) }
}
@Test
fun `encode accepts 127 byte name`() {
val name = "A".repeat(127)
val bytes = profile.encodeCommand(AapCommand.SetDeviceName(name))
bytes[6] shouldBe 127.toByte()
}
}
// ── Stem Press Events (0x19) ────────────────────────────
@Nested
inner class StemPressEventTests {
@Test fun `decode single left`() {
val event = profile.decodeStemPress(aapMessage("04 00 04 00 19 00 05 01"))!!
event.pressType shouldBe StemPressEvent.PressType.SINGLE
event.bud shouldBe StemPressEvent.Bud.LEFT
}
@Test fun `decode double right`() {
val event = profile.decodeStemPress(aapMessage("04 00 04 00 19 00 06 02"))!!
event.pressType shouldBe StemPressEvent.PressType.DOUBLE
event.bud shouldBe StemPressEvent.Bud.RIGHT
}
@Test fun `decode triple left`() {
val event = profile.decodeStemPress(aapMessage("04 00 04 00 19 00 07 01"))!!
event.pressType shouldBe StemPressEvent.PressType.TRIPLE
event.bud shouldBe StemPressEvent.Bud.LEFT
}
@Test fun `decode long right`() {
val event = profile.decodeStemPress(aapMessage("04 00 04 00 19 00 08 02"))!!
event.pressType shouldBe StemPressEvent.PressType.LONG
event.bud shouldBe StemPressEvent.Bud.RIGHT
}
@Test fun `unknown press type returns null`() {
profile.decodeStemPress(aapMessage("04 00 04 00 19 00 99 01")).shouldBeNull()
}
@Test fun `unknown bud returns null`() {
profile.decodeStemPress(aapMessage("04 00 04 00 19 00 05 03")).shouldBeNull()
}
@Test fun `payload too short returns null`() {
profile.decodeStemPress(aapMessage("04 00 04 00 19 00 05")).shouldBeNull()
}
@Test fun `wrong command type returns null`() {
profile.decodeStemPress(settingsMessage(0x0D, 0x02)).shouldBeNull()
}
}
// ── Connected Devices (0x2E) ────────────────────────────
@Nested
inner class ConnectedDevicesTests {
@Test fun `decode single device`() {
// payload: 2 unknown bytes, count=1, then 6-byte MAC reversed + 2 flags
val msg = aapMessage("04 00 04 00 2E 00 00 00 01 06 05 04 03 02 01 00 00")
val cd = decodeSetting<AapSetting.ConnectedDevices>(msg)
cd.devices.size shouldBe 1
cd.devices[0].mac shouldBe "01:02:03:04:05:06"
}
@Test fun `decode empty list`() {
val msg = aapMessage("04 00 04 00 2E 00 00 00 00")
val cd = decodeSetting<AapSetting.ConnectedDevices>(msg)
cd.devices shouldBe emptyList()
}
@Test fun `payload too short returns null`() {
profile.decodeSetting(aapMessage("04 00 04 00 2E 00 00 00")).shouldBeNull()
}
}
// ── Audio Source (0x0E) ──────────────────────────────────
@Nested
inner class AudioSourceTests {
@Test fun `decode media source`() {
val msg = aapMessage("04 00 04 00 0E 00 06 05 04 03 02 01 02")
val as_ = decodeSetting<AapSetting.AudioSource>(msg)
as_.sourceMac shouldBe "01:02:03:04:05:06"
as_.type shouldBe AapSetting.AudioSource.AudioSourceType.MEDIA
}
@Test fun `decode call source`() {
val msg = aapMessage("04 00 04 00 0E 00 06 05 04 03 02 01 01")
val as_ = decodeSetting<AapSetting.AudioSource>(msg)
as_.type shouldBe AapSetting.AudioSource.AudioSourceType.CALL
}
@Test fun `decode unknown type maps to NONE`() {
val msg = aapMessage("04 00 04 00 0E 00 06 05 04 03 02 01 00")
val as_ = decodeSetting<AapSetting.AudioSource>(msg)
as_.type shouldBe AapSetting.AudioSource.AudioSourceType.NONE
}
@Test fun `payload too short returns null`() {
profile.decodeSetting(aapMessage("04 00 04 00 0E 00 06 05 04 03 02 01")).shouldBeNull()
}
}
// ── Model Feature Flags ─────────────────────────────────
@Nested
inner class ModelFeatureFlags {
@Test fun `Pro 2 has all new flags`() {
val f = PodModel.AIRPODS_PRO2.features
f.hasMicrophoneMode shouldBe true
f.hasEarDetectionToggle shouldBe true
f.hasListeningModeCycle shouldBe true
f.hasAllowOffOption shouldBe true
f.hasStemConfig shouldBe true
f.hasSleepDetection shouldBe true
f.hasInCaseTone shouldBe true
}
@Test fun `Pro 1 has mic and ear detection but no stem config`() {
val f = PodModel.AIRPODS_PRO.features
f.hasMicrophoneMode shouldBe true
f.hasEarDetectionToggle shouldBe true
f.hasListeningModeCycle shouldBe true
f.hasAllowOffOption shouldBe true
f.hasStemConfig shouldBe false
f.hasSleepDetection shouldBe false
f.hasInCaseTone shouldBe false
}
@Test fun `Gen 4 has mic, ear detection, sleep, in-case but no stem config`() {
val f = PodModel.AIRPODS_GEN4.features
f.hasMicrophoneMode shouldBe true
f.hasEarDetectionToggle shouldBe true
f.hasListeningModeCycle shouldBe false
f.hasStemConfig shouldBe false
f.hasSleepDetection shouldBe true
f.hasInCaseTone shouldBe true
}
@Test fun `Max has ear detection toggle only`() {
val f = PodModel.AIRPODS_MAX.features
f.hasMicrophoneMode shouldBe false
f.hasEarDetectionToggle shouldBe true
f.hasStemConfig shouldBe false
}
@Test fun `Gen 1 has no new flags`() {
val f = PodModel.AIRPODS_GEN1.features
f.hasMicrophoneMode shouldBe false
f.hasEarDetectionToggle shouldBe false
f.hasListeningModeCycle shouldBe false
f.hasStemConfig shouldBe false
}
}
}
app/src/test/java/eu/darken/capod/pods/core/apple/aap/devices/DefaultAapDeviceProfileTest.kt
+6 -6
View File
@@ -84,16 +84,16 @@ class DefaultAapDeviceProfileTest : BaseAapSessionTest() {
}
@Test
fun `Pro 2 supports ON, TRANSPARENCY, ADAPTIVE`() {
fun `Pro 2 supports OFF, ON, TRANSPARENCY, ADAPTIVE`() {
ancModesFor(PodModel.AIRPODS_PRO2) shouldContainExactly listOf(
AapSetting.AncMode.Value.ON, AapSetting.AncMode.Value.TRANSPARENCY, AapSetting.AncMode.Value.ADAPTIVE,
AapSetting.AncMode.Value.OFF, AapSetting.AncMode.Value.ON, AapSetting.AncMode.Value.TRANSPARENCY, AapSetting.AncMode.Value.ADAPTIVE,
)
}
@Test
fun `Pro 1 supports ON, TRANSPARENCY only`() {
fun `Pro 1 supports OFF, ON, TRANSPARENCY`() {
ancModesFor(PodModel.AIRPODS_PRO) shouldContainExactly listOf(
AapSetting.AncMode.Value.ON, AapSetting.AncMode.Value.TRANSPARENCY,
AapSetting.AncMode.Value.OFF, AapSetting.AncMode.Value.ON, AapSetting.AncMode.Value.TRANSPARENCY,
)
}
@@ -103,9 +103,9 @@ class DefaultAapDeviceProfileTest : BaseAapSessionTest() {
}
@Test
fun `Max supports ON, TRANSPARENCY only`() {
fun `Max supports OFF, ON, TRANSPARENCY`() {
ancModesFor(PodModel.AIRPODS_MAX) shouldContainExactly listOf(
AapSetting.AncMode.Value.ON, AapSetting.AncMode.Value.TRANSPARENCY,
AapSetting.AncMode.Value.OFF, AapSetting.AncMode.Value.ON, AapSetting.AncMode.Value.TRANSPARENCY,
)
}
}
app/src/test/java/eu/darken/capod/pods/core/apple/aap/devices/airpods/AirPodsPro2UsbcAapSessionTest.kt
+2 -1
View File
@@ -113,6 +113,7 @@ class AirPodsPro2UsbcAapSessionTest : BaseAapSessionTest() {
val anc = decodeSetting<AapSetting.AncMode>("04 00 04 00 09 00 0D 02 00 00 00")
anc.current shouldBe AapSetting.AncMode.Value.ON
anc.supported shouldContainExactly listOf(
AapSetting.AncMode.Value.OFF,
AapSetting.AncMode.Value.ON,
AapSetting.AncMode.Value.TRANSPARENCY,
AapSetting.AncMode.Value.ADAPTIVE
@@ -242,7 +243,7 @@ class AirPodsPro2UsbcAapSessionTest : BaseAapSessionTest() {
@Test
fun `unknown settings IDs return null`() {
val unknownIds = listOf(0x29, 0x2C, 0x2F, 0x33, 0x35, 0x3E)
val unknownIds = listOf(0x29, 0x2C, 0x2F, 0x33, 0x3E)
for (id in unknownIds) {
profile.decodeSetting(settingsMessage(id, 0x02)).shouldBeNull()
}
app/src/test/java/eu/darken/capod/pods/core/apple/aap/devices/airpods/AirPodsPro3AapSessionTest.kt
+2 -1
View File
@@ -106,6 +106,7 @@ class AirPodsPro3AapSessionTest : BaseAapSessionTest() {
val anc = decodeSetting<AapSetting.AncMode>("04 00 04 00 09 00 0D 02 00 00 00")
anc.current shouldBe AapSetting.AncMode.Value.ON
anc.supported shouldContainExactly listOf(
AapSetting.AncMode.Value.OFF,
AapSetting.AncMode.Value.ON,
AapSetting.AncMode.Value.TRANSPARENCY,
AapSetting.AncMode.Value.ADAPTIVE
@@ -236,7 +237,7 @@ class AirPodsPro3AapSessionTest : BaseAapSessionTest() {
@Test
fun `unknown settings IDs return null`() {
val unknownIds = listOf(0x29, 0x2C, 0x2F, 0x33, 0x30, 0x35, 0x3E, 0x37, 0x38, 0x3B)
val unknownIds = listOf(0x29, 0x2C, 0x2F, 0x33, 0x30, 0x3E, 0x37, 0x38, 0x3B)
for (id in unknownIds) {
profile.decodeSetting(settingsMessage(id, 0x01)).shouldBeNull()
}
app/src/test/java/eu/darken/capod/pods/core/apple/aap/devices/airpods/AirPodsProAapSessionTest.kt
+1
View File
@@ -113,6 +113,7 @@ class AirPodsProAapSessionTest : BaseAapSessionTest() {
val anc = decodeSetting<AapSetting.AncMode>("04 00 04 00 09 00 0D 01 00 00 00")
anc.current shouldBe AapSetting.AncMode.Value.OFF
anc.supported shouldContainExactly listOf(
AapSetting.AncMode.Value.OFF,
AapSetting.AncMode.Value.ON,
AapSetting.AncMode.Value.TRANSPARENCY,
)