Add to dialog (widget, android auto favorite) #5622

TimoPtr · 2025-08-05T13:49:53Z

Summary

We want to make the native features of the companion apps more accessible to the user. When the user is going to click on Add to from the frontend it will display within the more info dialog the list of potential actions. This PR covers the needed change to react to this click on a action but also sending the list of potential actions, inform the frontend that we support this feature and expose a way to add an Android Auto favorite or a widget depending on the domain of the entity. Follow-up PRs are going to add shortcut, tile and watch favorite support.

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.

Screenshots

see home-assistant/frontend#26346

Link to pull request in documentation repositories

User Documentation: home-assistant/companion.home-assistant#1232

Any other notes

This features depends on the frontend, it will only work when this home-assistant/frontend#26346 is going to be merged.

Only the relevant actions based on the entity, are sent to the frontend.

github-actions · 2025-08-05T14:25:55Z

Test Results

0 tests 0 ✅ 0s ⏱️
0 suites 0 💤
0 files 0 ❌

Results for commit 6354781.

♻️ This comment has been updated with latest results.

TimoPtr · 2025-08-05T14:28:18Z

Screenshot are failing most probably because I've generated them on macOS and the verification runs on linux. You can see the diff

Once this PR have been reviewed I will either generate the image on linux or I will update the threshold to make the tests pass.

jpelgrom

IMO you're trying to do a bit too much in one go here. The screenshot test is telling - it includes options that are not implemented - and there are actions with todo's in them.

app/src/main/kotlin/io/homeassistant/companion/android/util/vehicle/DomainChecks.kt

app/src/main/res/xml/changelog_master.xml

app/src/main/kotlin/io/homeassistant/companion/android/webview/addto/AddToAction.kt

TimoPtr · 2025-08-06T13:34:44Z

This PR will be reworked since we are most probably move the UI on the frontend side. All the logic of this PR will be kept except that the frontend will send us an event with the entity_id to get the list of potential actions. Then the frontend will send us the action to execute (like we are doing in the dialog in the current state of this PR).

jpelgrom · 2025-08-06T17:22:01Z

This PR will be reworked since we are most probably move the UI on the frontend side. All the logic of this PR will be kept except that the frontend will send us an event with the entity_id to get the list of potential actions. Then the frontend will send us the action to execute (like we are doing in the dialog in the current state of this PR).

OK, until that is decided (not sure where) and implemented this PR can be drafted then?

TimoPtr · 2025-08-06T17:25:51Z

This PR will be reworked since we are most probably move the UI on the frontend side. All the logic of this PR will be kept except that the frontend will send us an event with the entity_id to get the list of potential actions. Then the frontend will send us the action to execute (like we are doing in the dialog in the current state of this PR).

OK, until that is decided (not sure where) and implemented this PR can be drafted then?

Yes indeed I can't do it on my phone but you can or I'll do it tomorrow.

dshokouhi · 2025-08-06T17:27:04Z

All the logic of this PR will be kept except that the frontend will send us an event with the entity_id to get the list of potential actions. Then the frontend will send us the action to execute (like we are doing in the dialog in the current state of this PR).

This is out of scope for this PR but I always wondered if it was the correct approach for the app and frontend to communicate like so for every action. Open app and it says what can and cannot be supported, then now it looks like even further communication is requested for whats supported at different actions. Would it make more sense for the app to first register with the server what it can and cannot support like in some JSON format so we rely a bit less on external bus for whats supported and keep it strictly for actions (i.e. opening settings, triggering dialogs etc....). The features that are supported are on a per device and app version level so the initial communication when we do (re)registration should contain everything needed up until needing to send an action to the app or vice versa. For example if a device doesnt have NFC then it will never have it, so why ask every time. Unless its a user facing setting some of these things will change very little or only on app update.

jpelgrom · 2025-08-06T17:41:55Z

Yes indeed I can't do it on my phone but you can or I'll do it tomorrow.

Use a browser on your phone 😉 Changed

...in/kotlin/io/homeassistant/companion/android/widgets/camera/CameraWidgetConfigureActivity.kt

...in/kotlin/io/homeassistant/companion/android/widgets/entity/EntityWidgetConfigureActivity.kt

...ssistant/companion/android/widgets/mediaplayer/MediaPlayerControlsWidgetConfigureActivity.kt

TimoPtr · 2025-11-04T12:20:56Z

@jpelgrom I've addressed your comments and the frontend has been updated.

jpelgrom

the frontend has been updated

Frontend PR is still pending review, no?

I'm also still seeing commented out code/unimplemented actions. Let's remove that, there's a lot going on. You already have issues to track them.

...in/kotlin/io/homeassistant/companion/android/widgets/camera/CameraWidgetConfigureActivity.kt

app/src/main/res/xml/changelog_master.xml

jpelgrom · 2025-11-04T19:00:40Z

app/src/main/kotlin/io/homeassistant/companion/android/webview/addto/EntityAddToAction.kt

+     * or on a phone.
+     */
+    @Serializable
+    data object AndroidAutoFavorite : EntityAddToAction {


It's a bit weird to me to have these inside the interface

It's a sealed class, I'm used to writing it like this but we could put it outside 👍. It just needs to be in the same package.

Not a dealbreaker and may just be personal preference, my (limited) experience with sealed classes put it outside like in the official docs. Inside makes me think of enums ;)

I've used sealed class when they first introduced it and it was mostly to "replace" enums. That should be why I'm used to do that 👍🏻 but fine for me, one less indentation.

Wait no, it has a reason ^^ if we don't put it in the sealed class the usage is going to be

val action = Tile

where if it is inside

val action = EntityAddToAction.Tile

I think it's better for context while working with an action, don't you think?
(even if we could make an import that removes the first part)

Now it's a naming question. Changing them so you have TileAddToAction, CameraWidgetAddToAction, etc. would also work in my opinion.

For now fine either way, let's not have the PR get stuck on this discussion.

app/src/test/kotlin/io/homeassistant/companion/android/webview/addto/EntityAddToActionTest.kt

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

app/src/main/kotlin/io/homeassistant/companion/android/webview/addto/EntityAddToAction.kt

...src/main/kotlin/io/homeassistant/companion/android/webview/externalbus/ExternalBusMessage.kt

app/src/test/kotlin/io/homeassistant/companion/android/webview/addto/EntityAddToHandlerTest.kt

TimoPtr · 2025-11-04T19:25:10Z

the frontend has been updated

Frontend PR is still pending review, no?

I'm also still seeing commented out code/unimplemented actions. Let's remove that, there's a lot going on. You already have issues to track them.

It should be merged after the release of Wednesday. I meant that the PR on the frontend has been updated not the frontend itself.

I'll remove the todos.

Co-authored-by: Joris Pelgröm <jpelgrom@users.noreply.github.com>

jpelgrom

Changes now look good to me, also tested with yesterday's frontend branch which looks like it is close enough to final.

home-assistant bot added the cla-signed label Aug 5, 2025

This was referenced Aug 5, 2025

Add support for Add to tile #5623

Open

Add support for Add to watch favorite #5624

Open

Add support for Add to shortcut #5625

Open

Add mention to Add to feature for widget and automotive favorite home-assistant/companion.home-assistant#1232

Open

TimoPtr marked this pull request as ready for review August 5, 2025 14:28

TimoPtr requested review from bgoncal, dshokouhi and jpelgrom August 5, 2025 14:28

jpelgrom reviewed Aug 5, 2025

View reviewed changes

jpelgrom marked this pull request as draft August 6, 2025 17:41

TimoPtr added 8 commits October 30, 2025 11:11

Extract domain into IntegrationDomain and add FOR_ENTITY param to widget

daffa79

Improve AndroidAuto favorites API

7703d02

Extract Config message sent over ExternalBus and add canAddEntityToApp

967eab7

Add AddToDialog when entity/add_to external message is received

5147a4a

Update changelog

f19bb74

Add missing tests

3f4a8fb

Add todo links to issues

758c5bb

Update the logic to match the frontend

6354781

TimoPtr force-pushed the feature/add_to_external_event branch from 3d0650c to 6354781 Compare October 30, 2025 17:11

github-advanced-security bot found potential problems Oct 30, 2025

View reviewed changes

TimoPtr added 2 commits October 30, 2025 18:15

Fix imports after rebase

26dd1d5

Merge branch 'main' into feature/add_to_external_event

ed06b30

TimoPtr added 3 commits November 4, 2025 13:05

Apply comments and refactor to respect single responsability

ae85f2b

Adjust config value

18c6386

Fix after refactor

5c1d0ac

TimoPtr marked this pull request as ready for review November 4, 2025 12:20

TimoPtr requested a review from jpelgrom November 4, 2025 12:20

jpelgrom reviewed Nov 4, 2025

View reviewed changes

TimoPtr mentioned this pull request Nov 5, 2025

Replaced org.json usages with kotlinx serialization #5976

Merged

4 tasks

TimoPtr and others added 4 commits November 5, 2025 12:11

Merge branch 'main' into feature/add_to_external_event

45f1186

Apply suggestions from code review

e5ef66b

Co-authored-by: Joris Pelgröm <jpelgrom@users.noreply.github.com>

Apply PR comments

a83f09f

Address last comments

8b38d59

TimoPtr requested a review from jpelgrom November 5, 2025 15:53

jpelgrom approved these changes Nov 5, 2025

View reviewed changes

Uh oh!

Add to dialog (widget, android auto favorite) #5622

Are you sure you want to change the base?

Add to dialog (widget, android auto favorite) #5622

Conversation

TimoPtr commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Screenshots

Link to pull request in documentation repositories

Any other notes

Uh oh!

github-actions bot commented Aug 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

TimoPtr commented Aug 5, 2025

Uh oh!

jpelgrom left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TimoPtr commented Aug 6, 2025

Uh oh!

jpelgrom commented Aug 6, 2025

Uh oh!

TimoPtr commented Aug 6, 2025

Uh oh!

dshokouhi commented Aug 6, 2025

Uh oh!

jpelgrom commented Aug 6, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TimoPtr commented Nov 4, 2025

Uh oh!

jpelgrom left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jpelgrom Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jpelgrom Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

TimoPtr Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

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

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jpelgrom Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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

Uh oh!

Uh oh!

jpelgrom left a comment

Choose a reason for hiding this comment

TimoPtr commented Aug 5, 2025 •

edited

Loading

github-actions bot commented Aug 5, 2025 •

edited

Loading

TimoPtr Nov 4, 2025 •

edited

Loading

TimoPtr Nov 5, 2025 •

edited

Loading

TimoPtr commented Nov 4, 2025 •

edited

Loading