Expose status of Assist as a sensor by ujjol1234 · Pull Request #6098 · home-assistant/android

ujjol1234 · 2025-11-26T07:19:25Z

Summary

This PR introduces a Assist Sensor in the companion-app that shows whether Assist on the phone is listening.
Documentation PR for this sensor: home-assistant/companion.home-assistant#1270

Checklist

New or updated tests have been added to cover the changes following the testing guidelines.
The code follows the project's code style and best_practices.
The changes have been thoroughly tested, and edge cases have been considered.
Changes are backward compatible whenever feasible. Any breaking changes are documented in the changelog for users and/or in the code for developers depending on the relevance.

home-assistant

Hi @ujjol1234

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

home-assistant · 2025-11-26T07:19:30Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Stale

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt

dshokouhi

Thanks for the contribution!

just a couple things to keep the code in sync with the rest of the project.

I wonder are we able to determine if Assist is properly setup to add a state for that? Or maybe even hide it if not configured in hasSensor ?

app/src/main/kotlin/io/homeassistant/companion/android/HomeAssistantApplication.kt

app/src/main/kotlin/io/homeassistant/companion/android/assist/AssistViewModel.kt

jpelgrom · 2025-11-26T18:48:42Z

Did you test the app with this sensor and is it updating the state as expected (idle > listening > speaking > idle)? Did you also test with keyboard input / interrupting the microphone manually / dismissing the sheet while recording/playing?

This will also need a documentation PR to be accepted.

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt

common/src/main/kotlin/io/homeassistant/companion/android/common/assist/AssistViewModelBase.kt

ujjol1234 · 2025-11-28T19:23:52Z

@dshokouhi @TimoPtr thank you for the feedback. I have implemented the changes.

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt

app/src/main/kotlin/io/homeassistant/companion/android/assist/AssistViewModel.kt

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt

TimoPtr · 2025-12-03T09:23:36Z

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt

+            type = "sensor",
+            name = R.string.sensor_name_assist,
+            descriptionId = R.string.sensor_description_assist,
+            statelessIcon = "mdi:robot",


@jpelgrom @dshokouhi Do you have a preference for the icon?

mdi:account-voice, to match the core sensor for an Assist satellite which is probably the closest thing?

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt

app/src/main/kotlin/io/homeassistant/companion/android/HomeAssistantApplication.kt

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt

app/src/main/kotlin/io/homeassistant/companion/android/assist/AssistViewModel.kt

common/src/main/res/values/strings.xml

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt

TimoPtr · 2025-12-23T12:02:02Z

common/src/main/kotlin/io/homeassistant/companion/android/common/assist/AssistViewModelBase.kt

+            AssistSensorManager.updateState(app, AssistSensorManager.AssistState.SPEAKING)
+            val result = audioUrlPlayer.playAudio(it.toString())
+            AssistSensorManager.updateState(app, AssistSensorManager.AssistState.IDLE)
+            result


FYI I'm currently changing how the playAudio works to support streaming TTS but it shouldn't be hard to adjust.

That's cool. I have taken care of it.

TimoPtr

In order to merge this PR we need two things

merge main and solve the conflict
a PR on the companion doc repo https://github.com/home-assistant/companion.home-assistant to describe this.

TimoPtr · 2025-12-29T11:58:28Z

app/src/main/kotlin/io/homeassistant/companion/android/assist/AssistViewModel.kt

+        val state = when (inputMode) {
+            AssistInputMode.VOICE_ACTIVE -> AssistSensorManager.AssistState.LISTENING
+            AssistInputMode.VOICE_INACTIVE, AssistInputMode.TEXT -> AssistSensorManager.AssistState.IDLE
+            AssistInputMode.BLOCKED -> AssistSensorManager.AssistState.CLOSED


Blocked -> Closed why one or the other? @jpelgrom do you have some takes here?

When I added BLOCKED it was for input options being blocked because the server doesn't support Assist (temporarily), not considering a sensor state.

I'm not sure how we ended up with these states. My first thought would be to model it after the Assist satelite states where possible, which is partly done. However, I think there is a difference between 'input blocked because not supported' and 'dialog closed' that would be useful to have, so unsupported and closed?

TimoPtr

Now that I'm looking at it again. Don't we want also this sensor on the watch? (Should be made in another PR)

TimoPtr · 2025-12-29T11:59:39Z

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt

+        get() = commonR.string.sensor_name_assist
+    override suspend fun getAvailableSensors(context: Context): List<SensorManager.BasicSensor> {


Suggested change

get() = commonR.string.sensor_name_assist

override suspend fun getAvailableSensors(context: Context): List<SensorManager.BasicSensor> {

get() = commonR.string.sensor_name_assist

override suspend fun getAvailableSensors(context: Context): List<SensorManager.BasicSensor> {

TimoPtr · 2025-12-29T12:00:20Z

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt

+            attributes = mapOf(
+                "options" to AssistState.entries.map(AssistState::value),
+            ),
+            mdiIcon = "mdi:robot",


Use a private const to only set the icon once.

Typically we use assistSensor.statelessIcon instead

TimoPtr · 2025-12-29T12:01:44Z

app/src/main/kotlin/io/homeassistant/companion/android/assist/AssistViewModel.kt

+            AssistInputMode.BLOCKED -> AssistSensorManager.AssistState.CLOSED
+            AssistInputMode.TEXT_ONLY -> AssistSensorManager.AssistState.IDLE
+        }
+        AssistSensorManager.updateState(app, state)


You probably also want to set the state in the onCleared of the viewModel to CLOSED?

jpelgrom · 2025-12-30T20:04:40Z

Now that I'm looking at it again. Don't we want also this sensor on the watch? (Should be made in another PR)

As the sensor is in common, I'd expect it to also be for the watch and I was thinking the PR was not yet complete. If it is only for the phone app it should be moved to app.

TimoPtr · 2026-01-02T14:27:17Z

@ujjol1234 I did modify the AssistViewModel to support TTS, you are going to need to adjust your PR to it.
You need to know that now we don't stop the player, but the player expose a Flow that sends the current status of the player (playing or idle mostly).

jpelgrom · 2026-01-14T21:38:43Z

Changing this to draft for now. Once you've rebased on top of/merged the latest changes and addressed all comments, you can mark it as ready for review.

Expose-status-of-assist-as-a-sensor

e336234

home-assistant bot previously requested changes Nov 26, 2025

View reviewed changes

home-assistant bot added the cla-needed label Nov 26, 2025

home-assistant bot marked this pull request as draft November 26, 2025 07:19

ujjol1234 marked this pull request as ready for review November 26, 2025 07:21

ujjol1234 mentioned this pull request Nov 26, 2025

Expose status of Assist as a sensor #5501

Open

home-assistant bot added cla-recheck cla-signed and removed cla-recheck cla-needed labels Nov 26, 2025

github-advanced-security bot found potential problems Nov 26, 2025

View reviewed changes

dshokouhi reviewed Nov 26, 2025

View reviewed changes

app/src/main/kotlin/io/homeassistant/companion/android/HomeAssistantApplication.kt Outdated Show resolved Hide resolved

app/src/main/kotlin/io/homeassistant/companion/android/assist/AssistViewModel.kt Outdated Show resolved Hide resolved

jpelgrom linked an issue Nov 26, 2025 that may be closed by this pull request

Expose status of Assist as a sensor #5501

Open

TimoPtr marked this pull request as draft November 27, 2025 12:16

TimoPtr reviewed Nov 27, 2025

View reviewed changes

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt Outdated Show resolved Hide resolved

TimoPtr reviewed Nov 27, 2025

View reviewed changes

common/src/main/kotlin/io/homeassistant/companion/android/common/assist/AssistViewModelBase.kt Outdated Show resolved Hide resolved

ujjol1234 added 2 commits November 27, 2025 22:35

Expose-status-of-assist-as-a-sensor

618dce2

Expose-status-of-assist-as-a-sensor

a0196f2

ujjol1234 requested a review from TimoPtr December 1, 2025 17:45

TimoPtr reviewed Dec 3, 2025

View reviewed changes

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt Show resolved Hide resolved

TimoPtr reviewed Dec 3, 2025

View reviewed changes

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt Outdated Show resolved Hide resolved

TimoPtr reviewed Dec 3, 2025

View reviewed changes

app/src/main/kotlin/io/homeassistant/companion/android/assist/AssistViewModel.kt Show resolved Hide resolved

TimoPtr reviewed Dec 3, 2025

View reviewed changes

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt Outdated Show resolved Hide resolved

TimoPtr reviewed Dec 3, 2025

View reviewed changes

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt Outdated Show resolved Hide resolved

TimoPtr reviewed Dec 3, 2025

View reviewed changes

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt Show resolved Hide resolved

ujjol1234 requested a review from TimoPtr December 6, 2025 21:46

TimoPtr reviewed Dec 8, 2025

View reviewed changes

app/src/main/kotlin/io/homeassistant/companion/android/HomeAssistantApplication.kt Outdated Show resolved Hide resolved

TimoPtr reviewed Dec 8, 2025

View reviewed changes

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt Show resolved Hide resolved

TimoPtr reviewed Dec 8, 2025

View reviewed changes

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt Show resolved Hide resolved

TimoPtr reviewed Dec 8, 2025

View reviewed changes

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt Outdated Show resolved Hide resolved

TimoPtr reviewed Dec 8, 2025

View reviewed changes

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt Outdated Show resolved Hide resolved

TimoPtr reviewed Dec 8, 2025

View reviewed changes

app/src/main/kotlin/io/homeassistant/companion/android/assist/AssistViewModel.kt Show resolved Hide resolved

TimoPtr reviewed Dec 8, 2025

View reviewed changes

common/src/main/res/values/strings.xml Outdated Show resolved Hide resolved

TimoPtr reviewed Dec 8, 2025

View reviewed changes

common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/AssistSensorManager.kt Outdated Show resolved Hide resolved

expose status of assist as a sensor

76a90e6

ujjol1234 requested a review from TimoPtr December 23, 2025 11:11

TimoPtr reviewed Dec 23, 2025

View reviewed changes

ujjol1234 mentioned this pull request Dec 23, 2025

Add assist_sensor to sensors documentation home-assistant/companion.home-assistant#1270

Draft

7 tasks

ujjol1234 added 2 commits December 23, 2025 23:11

ressolve conflicts

54b2d2d

ressolve conflicts

ce0407d

ujjol1234 marked this pull request as ready for review December 23, 2025 18:04

ujjol1234 requested a review from TimoPtr December 23, 2025 18:04

Merge branch 'main' into feature/Expose-status-of-assist

940592c

TimoPtr reviewed Dec 29, 2025

View reviewed changes

TimoPtr requested a review from jpelgrom December 29, 2025 12:00

TimoPtr reviewed Dec 29, 2025

View reviewed changes

jpelgrom changed the title ~~Expose-status-of-assist-as-a-sensor~~ Expose status of Assist as a sensor Dec 30, 2025

jpelgrom marked this pull request as draft January 14, 2026 21:38

		get() = commonR.string.sensor_name_assist
		override suspend fun getAvailableSensors(context: Context): List<SensorManager.BasicSensor> {

Uh oh!

Conversation

ujjol1234 commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

home-assistant bot left a comment

Choose a reason for hiding this comment

Uh oh!

home-assistant bot commented Nov 26, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dshokouhi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jpelgrom commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ujjol1234 commented Nov 28, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TimoPtr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TimoPtr left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jpelgrom commented Dec 30, 2025

Uh oh!

TimoPtr commented Jan 2, 2026

Uh oh!

jpelgrom commented Jan 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

ujjol1234 commented Nov 26, 2025 •

edited

Loading

jpelgrom commented Nov 26, 2025 •

edited

Loading