Add support for OpenAssistSettings (#6534)

TimoPtr · Copilot · web-flow · commit f47924910aca · 2026-03-22T22:16:29.000+01:00
* Add support for OpenVoiceDeviceSettings

* Apply suggestions from code review

Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;

* Revert copilot changes

* Adjust name of command to assist/settings

* Adjust Ktlint

---------

Co-authored-by: Copilot &lt;175728472+Copilot@users.noreply.github.com&gt;
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/frontend/FrontendViewModel.kt b/app/src/main/kotlin/io/homeassistant/companion/android/frontend/FrontendViewModel.kt
@@ -321,6 +321,10 @@ internal class FrontendViewModel @VisibleForTesting constructor(
                 _navigationEvents.tryEmit(FrontendNavigationEvent.NavigateToSettings)
             }
 
+            is FrontendHandlerEvent.OpenAssistSettings -> {
+                _navigationEvents.tryEmit(FrontendNavigationEvent.NavigateToAssistSettings)
+            }
+
             is FrontendHandlerEvent.ShowAssist -> {
                 _navigationEvents.tryEmit(
                     FrontendNavigationEvent.NavigateToAssist(
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/frontend/externalbus/incoming/IncomingExternalBusMessage.kt b/app/src/main/kotlin/io/homeassistant/companion/android/frontend/externalbus/incoming/IncomingExternalBusMessage.kt
@@ -90,13 +90,21 @@ data class ConnectionStatusPayload(val event: String) {
 data class ConfigGetMessage(override val id: Int? = null) : IncomingExternalBusMessage
 
 /**
- * Message requesting the app's to open its settings.
+ * Message requesting the app to open its settings.
  * No response is expected for this message
  */
 @Serializable
 @SerialName("config_screen/show")
 data class OpenSettingsMessage(override val id: Int? = null) : IncomingExternalBusMessage
 
+/**
+ * Message requesting the app to open its assist settings
+ * No response is expected for this message
+ */
+@Serializable
+@SerialName("assist/settings")
+data class OpenAssistSettingsMessage(override val id: Int? = null) : IncomingExternalBusMessage
+
 /**
  * Message indicating that the frontend theme has changed.
  *
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/frontend/externalbus/outgoing/OutgoingExternalBusMessage.kt b/app/src/main/kotlin/io/homeassistant/companion/android/frontend/externalbus/outgoing/OutgoingExternalBusMessage.kt
@@ -72,6 +72,7 @@ data class ConfigResult(
     val downloadFileSupported: Boolean = true,
     val appVersion: String,
     val hasEntityAddTo: Boolean = true,
+    val hasAssistSettings: Boolean = true,
 ) {
     companion object {
         fun create(
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/frontend/handler/FrontendHandlerEvent.kt b/app/src/main/kotlin/io/homeassistant/companion/android/frontend/handler/FrontendHandlerEvent.kt
@@ -30,6 +30,11 @@ sealed interface FrontendHandlerEvent {
      */
     data object OpenSettings : FrontendHandlerEvent
 
+    /**
+     * User tapped the companion app assist settings button in the frontend.
+     */
+    data object OpenAssistSettings : FrontendHandlerEvent
+
     /**
      * User triggered the voice assistant from the frontend.
      */
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/frontend/handler/FrontendMessageHandler.kt b/app/src/main/kotlin/io/homeassistant/companion/android/frontend/handler/FrontendMessageHandler.kt
@@ -13,6 +13,7 @@ import io.homeassistant.companion.android.frontend.externalbus.incoming.ConfigGe
 import io.homeassistant.companion.android.frontend.externalbus.incoming.ConnectionStatusMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.IncomingExternalBusMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.OpenAssistMessage
+import io.homeassistant.companion.android.frontend.externalbus.incoming.OpenAssistSettingsMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.OpenSettingsMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.ThemeUpdateMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.UnknownIncomingMessage
@@ -164,6 +165,11 @@ class FrontendMessageHandler @Inject constructor(
                 FrontendHandlerEvent.OpenSettings
             }
 
+            is OpenAssistSettingsMessage -> {
+                Timber.d("Open assist settings request received with id: ${message.id}")
+                FrontendHandlerEvent.OpenAssistSettings
+            }
+
             is OpenAssistMessage -> {
                 Timber.d("Open assist request received with id: ${message.id}")
                 FrontendHandlerEvent.ShowAssist(
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/frontend/navigation/FrontendNavigation.kt b/app/src/main/kotlin/io/homeassistant/companion/android/frontend/navigation/FrontendNavigation.kt
@@ -18,6 +18,7 @@ import io.homeassistant.companion.android.frontend.FrontendScreen
 import io.homeassistant.companion.android.frontend.FrontendViewModel
 import io.homeassistant.companion.android.frontend.FrontendViewState
 import io.homeassistant.companion.android.launch.HAStartDestinationRoute
+import io.homeassistant.companion.android.settings.SettingsActivity
 import io.homeassistant.companion.android.util.getActivity
 import io.homeassistant.companion.android.webview.WebViewActivity
 import kotlinx.coroutines.flow.SharedFlow
@@ -60,7 +61,7 @@ internal fun NavController.navigateToFrontend(
 internal fun NavGraphBuilder.frontendScreen(
     navController: NavController,
     onOpenExternalLink: suspend (Uri) -> Unit = {},
-    onNavigateToSettings: () -> Unit,
+    onNavigateToSettings: (SettingsActivity.Deeplink?) -> Unit,
     onSecurityLevelHelpClick: suspend () -> Unit,
     onOpenLocationSettings: () -> Unit,
     onConfigureHomeNetwork: (serverId: Int) -> Unit,
@@ -90,7 +91,7 @@ internal fun NavGraphBuilder.frontendScreen(
                 viewModel = viewModel,
                 onOpenExternalLink = onOpenExternalLink,
                 onBlockInsecureHelpClick = onSecurityLevelHelpClick,
-                onOpenSettings = onNavigateToSettings,
+                onOpenSettings = { onNavigateToSettings(null) },
                 onOpenLocationSettings = onOpenLocationSettings,
                 onConfigureHomeNetwork = onConfigureHomeNetwork,
                 onSecurityLevelHelpClick = onSecurityLevelHelpClick,
@@ -117,14 +118,18 @@ internal fun NavGraphBuilder.frontendScreen(
 @VisibleForTesting
 internal fun FrontendNavigationHandler(
     navigationEvents: SharedFlow<FrontendNavigationEvent>,
-    onNavigateToSettings: () -> Unit,
+    onNavigateToSettings: (SettingsActivity.Deeplink?) -> Unit,
     onNavigateToAssist: (serverId: Int, pipelineId: String?, startListening: Boolean) -> Unit,
 ) {
     LaunchedEffect(Unit) {
         navigationEvents.collect { event ->
             when (event) {
                 is FrontendNavigationEvent.NavigateToSettings -> {
-                    onNavigateToSettings()
+                    onNavigateToSettings(null)
+                }
+
+                is FrontendNavigationEvent.NavigateToAssistSettings -> {
+                    onNavigateToSettings(SettingsActivity.Deeplink.AssistSettings)
                 }
 
                 is FrontendNavigationEvent.NavigateToAssist -> {
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/frontend/navigation/FrontendNavigationEvent.kt b/app/src/main/kotlin/io/homeassistant/companion/android/frontend/navigation/FrontendNavigationEvent.kt
@@ -14,6 +14,9 @@ sealed interface FrontendNavigationEvent {
     /** Navigate to the app settings screen */
     data object NavigateToSettings : FrontendNavigationEvent
 
+    /** Navigate to the assist settings screen */
+    data object NavigateToAssistSettings : FrontendNavigationEvent
+
     /** Navigate to the voice assistant (Assist) screen */
     data class NavigateToAssist(val serverId: Int, val pipelineId: String?, val startListening: Boolean) :
         FrontendNavigationEvent
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/settings/SettingsActivity.kt b/app/src/main/kotlin/io/homeassistant/companion/android/settings/SettingsActivity.kt
@@ -22,6 +22,7 @@ import io.homeassistant.companion.android.R
 import io.homeassistant.companion.android.authenticator.Authenticator
 import io.homeassistant.companion.android.common.R as commonR
 import io.homeassistant.companion.android.common.data.servers.ServerManager
+import io.homeassistant.companion.android.settings.assist.AssistSettingsFragment
 import io.homeassistant.companion.android.settings.developer.DeveloperSettingsFragment
 import io.homeassistant.companion.android.settings.notification.NotificationHistoryFragment
 import io.homeassistant.companion.android.settings.qs.ManageTilesFragment
@@ -68,6 +69,7 @@ class SettingsActivity : BaseActivity() {
         data class QSTile(val tileId: String) : Deeplink
         data class Sensor(val sensorId: String) : Deeplink
         data object Websocket : Deeplink
+        data object AssistSettings : Deeplink
     }
 
     override fun onCreate(savedInstanceState: Bundle?) {
@@ -107,6 +109,7 @@ class SettingsActivity : BaseActivity() {
                             Deeplink.NotificationHistory -> NotificationHistoryFragment::class.java
                             is Deeplink.Sensor -> SensorDetailFragment::class.java
                             is Deeplink.QSTile -> ManageTilesFragment::class.java
+                            Deeplink.AssistSettings -> AssistSettingsFragment::class.java
                             else -> SettingsFragment::class.java
                         },
                         when (settingsNavigation) {
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/settings/navigation/SettingsNavigation.kt b/app/src/main/kotlin/io/homeassistant/companion/android/settings/navigation/SettingsNavigation.kt
@@ -1,21 +1,11 @@
 package io.homeassistant.companion.android.settings.navigation
 
 import androidx.navigation.NavController
-import androidx.navigation.NavGraphBuilder
-import androidx.navigation.NavOptions
-import androidx.navigation.activity
 import io.homeassistant.companion.android.settings.SettingsActivity
-import kotlinx.serialization.Serializable
 
-@Serializable
-internal data object SettingsRoute
-
-internal fun NavGraphBuilder.settingsScreen() {
-    activity<SettingsRoute> {
-        activityClass = SettingsActivity::class
-    }
-}
-
-fun NavController.navigateToSettings(navOptions: NavOptions? = null) {
-    navigate(SettingsRoute, navOptions)
+/**
+ * Navigates to the [SettingsActivity], optionally deep linking to a specific settings screen.
+ */
+fun NavController.navigateToSettings(deeplink: SettingsActivity.Deeplink? = null) {
+    context.startActivity(SettingsActivity.newInstance(context, deeplink))
 }
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/util/compose/HANavHost.kt b/app/src/main/kotlin/io/homeassistant/companion/android/util/compose/HANavHost.kt
@@ -28,7 +28,6 @@ import io.homeassistant.companion.android.onboarding.sethomenetwork.navigation.n
 import io.homeassistant.companion.android.onboarding.sethomenetwork.navigation.setHomeNetworkScreen
 import io.homeassistant.companion.android.onboarding.wearOnboarding
 import io.homeassistant.companion.android.settings.navigation.navigateToSettings
-import io.homeassistant.companion.android.settings.navigation.settingsScreen
 
 /**
  * Navigation host for the main application.
@@ -108,7 +107,7 @@ internal fun HANavHost(
                     navController.navigateToUri(uri.toString(), onShowSnackbar)
                 },
                 onNavigateToSettings = {
-                    navController.navigateToSettings()
+                    navController.navigateToSettings(it)
                 },
                 onSecurityLevelHelpClick = {
                     navController.navigateToUri(URL_SECURITY_LEVEL_DOCUMENTATION, onShowSnackbar)
@@ -129,7 +128,7 @@ internal fun HANavHost(
                     navController.navigateToUri(URL_SECURITY_LEVEL_DOCUMENTATION, onShowSnackbar)
                 },
             )
-            settingsScreen()
+
             if (isAutomotive) {
                 carAppActivity(navController)
             }
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/webview/WebViewActivity.kt b/app/src/main/kotlin/io/homeassistant/companion/android/webview/WebViewActivity.kt
@@ -926,6 +926,13 @@ class WebViewActivity :
                                     )
                                 }
 
+                                "assist/settings" -> startActivity(
+                                    SettingsActivity.newInstance(
+                                        this@WebViewActivity,
+                                        SettingsActivity.Deeplink.AssistSettings,
+                                    ),
+                                )
+
                                 "config_screen/show" ->
                                     startActivity(
                                         SettingsActivity.newInstance(this@WebViewActivity),
@@ -986,6 +993,7 @@ class WebViewActivity :
                                 "theme-update" -> getAndSetStatusBarNavigationBarColors()
                                 "entity/add_to/get_actions" -> getActions(json)
                                 "entity/add_to" -> addEntityTo(json)
+
                                 else -> presenter.onExternalBusMessage(json)
                             }
                         }
@@ -1502,9 +1510,11 @@ class WebViewActivity :
 
     override fun loadUrl(url: Uri, keepHistory: Boolean, openInApp: Boolean, serverHandleInsets: Boolean) {
         Timber.d(
-            "Loading ${sensitive(
-                url.toString(),
-            )} (keepHistory $keepHistory, openInApp $openInApp, serverHandleInsets $serverHandleInsets)",
+            "Loading ${
+                sensitive(
+                    url.toString(),
+                )
+            } (keepHistory $keepHistory, openInApp $openInApp, serverHandleInsets $serverHandleInsets)",
         )
         this.serverHandleInsets.value = serverHandleInsets
         if (openInApp) {
diff --git a/app/src/main/kotlin/io/homeassistant/companion/android/webview/externalbus/ExternalBusMessage.kt b/app/src/main/kotlin/io/homeassistant/companion/android/webview/externalbus/ExternalBusMessage.kt
@@ -76,6 +76,7 @@ class ExternalConfigResponse(
         "downloadFileSupported" to true,
         "appVersion" to appVersion.value,
         "hasEntityAddTo" to true,
+        "hasAssistSettings" to true,
     ).toJsonObject(),
     callback = {
         Timber.d("Callback from external config (id=$id): $it")
diff --git a/app/src/test/kotlin/io/homeassistant/companion/android/frontend/FrontendViewModelTest.kt b/app/src/test/kotlin/io/homeassistant/companion/android/frontend/FrontendViewModelTest.kt
@@ -493,6 +493,29 @@ class FrontendViewModelTest {
             assertTrue(navigationEvents.any { it is FrontendNavigationEvent.NavigateToSettings })
             job.cancel()
         }
+
+        @Test
+        fun `Given open assist settings message result when collected then navigation event is emitted`() = runTest {
+            val messageFlow = MutableSharedFlow<FrontendHandlerEvent>()
+            every { externalBusHandler.messageResults() } returns messageFlow
+            every { urlManager.serverUrlFlow(any(), any()) } returns flowOf(
+                UrlLoadResult.Success(url = testUrlWithAuth, serverId = serverId),
+            )
+
+            val viewModel = createViewModel()
+
+            // Collect navigation events
+            val navigationEvents = mutableListOf<FrontendNavigationEvent>()
+            val job = backgroundScope.launch { viewModel.navigationEvents.collect { navigationEvents.add(it) } }
+
+            advanceTimeBy(CONNECTION_TIMEOUT - 1.seconds)
+
+            messageFlow.emit(FrontendHandlerEvent.OpenAssistSettings)
+            advanceUntilIdle()
+
+            assertTrue(navigationEvents.any { it is FrontendNavigationEvent.NavigateToAssistSettings })
+            job.cancel()
+        }
     }
 
     @Nested
diff --git a/app/src/test/kotlin/io/homeassistant/companion/android/frontend/externalbus/incoming/IncomingExternalBusMessageTest.kt b/app/src/test/kotlin/io/homeassistant/companion/android/frontend/externalbus/incoming/IncomingExternalBusMessageTest.kt
@@ -53,6 +53,16 @@ class IncomingExternalBusMessageTest {
         assertEquals(5, (message as OpenSettingsMessage).id)
     }
 
+    @Test
+    fun `Given assist-settings JSON then parses to OpenAssistSettingsMessage`() {
+        val json = """{"type":"assist/settings","id":5}"""
+
+        val message = frontendExternalBusJson.decodeFromString<IncomingExternalBusMessage>(json)
+
+        assertInstanceOf(OpenAssistSettingsMessage::class.java, message)
+        assertEquals(5, (message as OpenAssistSettingsMessage).id)
+    }
+
     @Test
     fun `Given assist-show JSON then parses to OpenAssistMessage with payload`() {
         val json = """{"type":"assist/show","id":7,"payload":{"pipeline_id":"abc","start_listening":false}}"""
diff --git a/app/src/test/kotlin/io/homeassistant/companion/android/frontend/externalbus/outgoing/OutgoingExternalBusMessageTest.kt b/app/src/test/kotlin/io/homeassistant/companion/android/frontend/externalbus/outgoing/OutgoingExternalBusMessageTest.kt
@@ -26,7 +26,7 @@ class OutgoingExternalBusMessageTest {
             ),
         )
         assertEquals(
-            """{"type":"result","id":1,"success":true,"result":{"hasSettingsScreen":true,"canWriteTag":true,"hasExoPlayer":true,"canCommissionMatter":true,"canImportThreadCredentials":true,"hasAssist":true,"hasBarCodeScanner":0,"canSetupImprov":true,"downloadFileSupported":true,"appVersion":"1.0.0 (1)","hasEntityAddTo":true},"error":null}""",
+            """{"type":"result","id":1,"success":true,"result":{"hasSettingsScreen":true,"canWriteTag":true,"hasExoPlayer":true,"canCommissionMatter":true,"canImportThreadCredentials":true,"hasAssist":true,"hasBarCodeScanner":0,"canSetupImprov":true,"downloadFileSupported":true,"appVersion":"1.0.0 (1)","hasEntityAddTo":true,"hasAssistSettings":true},"error":null}""",
             json,
         )
     }
@@ -47,5 +47,6 @@ class OutgoingExternalBusMessageTest {
         assertTrue(config.canSetupImprov)
         assertTrue(config.downloadFileSupported)
         assertTrue(config.hasEntityAddTo)
+        assertTrue(config.hasAssistSettings)
     }
 }
diff --git a/app/src/test/kotlin/io/homeassistant/companion/android/frontend/handler/FrontendMessageHandlerTest.kt b/app/src/test/kotlin/io/homeassistant/companion/android/frontend/handler/FrontendMessageHandlerTest.kt
@@ -13,6 +13,7 @@ import io.homeassistant.companion.android.frontend.externalbus.incoming.Connecti
 import io.homeassistant.companion.android.frontend.externalbus.incoming.ConnectionStatusPayload
 import io.homeassistant.companion.android.frontend.externalbus.incoming.OpenAssistMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.OpenAssistPayload
+import io.homeassistant.companion.android.frontend.externalbus.incoming.OpenAssistSettingsMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.OpenSettingsMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.ThemeUpdateMessage
 import io.homeassistant.companion.android.frontend.externalbus.incoming.UnknownIncomingMessage
@@ -231,6 +232,18 @@ class FrontendMessageHandlerTest {
         }
     }
 
+    @Test
+    fun `Given open assist settings message when messageResults then emits OpenAssistSettings`() = runTest {
+        val message = OpenAssistSettingsMessage(id = 1)
+        every { externalBusRepository.incomingMessages() } returns flowOf(message)
+
+        handler.messageResults().test {
+            val result = awaitItem()
+            assertTrue(result is FrontendHandlerEvent.OpenAssistSettings)
+            expectNoEvents()
+        }
+    }
+
     @Test
     fun `Given theme update message when messageResults then emits ThemeUpdated`() = runTest {
         val message = ThemeUpdateMessage(id = null)
diff --git a/app/src/test/kotlin/io/homeassistant/companion/android/frontend/navigation/FrontendNavigationTest.kt b/app/src/test/kotlin/io/homeassistant/companion/android/frontend/navigation/FrontendNavigationTest.kt
diff --git a/app/src/test/kotlin/io/homeassistant/companion/android/util/compose/HAAppTest.kt b/app/src/test/kotlin/io/homeassistant/companion/android/util/compose/HAAppTest.kt
