Android Companion 2022.2: Local Push Notifications!

Blog
1

Hey Everyone! It’s time for the next Android release and we are really excited to get this one out. Lots of changes for all versions of the app, including Wear OS and Quest devices.

Breaking Changes

We have a pretty big release this month with a lot of changes going on. Some of these changes are noticeable as soon as you update the app, so let’s cover those first.

Local Push Notifications

The first major change that we want to cover is for Local Push Notifications. Before this release, all notifications were routed via Google. Now notifications can be delivered directly from your Home Assistant server if you have remote access set up. These notifications do not count towards the rate limit and are shown on the device immediately, every time.

So what’s the breaking change? The app needs to establish and maintain a constant connection to your Home Assistant server with WebSockets. In order to do this, we have to create a persistent notification and this can be upsetting to some users.

A persistent notification lets Android know the app has important ongoing tasks where we do not want the background process stopped. The purpose of this notification is identical to our Sensor Worker, which allows the app to continue sending sensor updates while in the background. Just like Sensor Worker, our WebSockets notification also has its own notification channel to allow you to customize the appearance. You are free to minimize (or silence) this notification to hide the icon from appearing in your status bar.

You may also decide to turn off the channel. While there is nothing preventing you from turning it off, if you run into connection issues you will be asked to turn the channel back on.

The persistent notification will contain an actionable button taking you directly to the settings page. From here you can adjust the WebSocket connection behavior and modify the notification channel. The persistent notification will only be present when an active connection to your server is being maintained.

If you are on the minimal version of the app will have the default WebSocket connection set to “Always” as this is the only way the app can receive notifications from your server. If not, you will have the default setting “While Screen On”, where the app will continue to receive notifications from Firebase when the WebSocket connection is not active. If you are on the minimal version you will need to be on Home Assistant Core 2022.2 or later in order to use this feature.

We have seen varying reports from users who either do not notice much of a change in terms of battery usage while others have noticed a big difference. Please feel free to adjust the settings based on your usage and desire for the feature. Some of us developers have opted to keep the option set to “Always” and do not notice much of a change in battery usage. Personally, I keep mine on “Always” and I have not had to change my daily charging habits to enjoy this feature, your experience may be different.

A big thank you to JBassett for kicking off this feature and working hard to solve all the reported beta issues! Thank you to jpelgrom, SkechyWolf and dshokouhi for helping out in finalizing the user experience.

Sensor Changes

The remaining breaking changes in this release are related to 2 sensors offered by all versions of the app.

  • Do Not Disturb Sensor - No longer available on devices running Android 5 or lower. This sensor, which was previously offered to all supported Android versions, has been updated to use the official Android API instead of the undocumented one. The Android API is only available on devices running Android 6+. Older devices will no longer see this sensor in the Manage Sensors screen.
  • Last Used App Sensor - This sensor previously reported its state as the application label. We realized that this is not always unique, multiple apps can have the exact same name. The state has changed to report the package id which is guaranteed to be unique. The application name is now available as an attribute.

In-App Changelog

This next feature of the release is also going to be immediately noticeable upon updating as all users will be presented with a changelog once they open the app after an update. This changelog will only be shown after the app has received an update. Some users may only see this once a month while others may see it weekly based on the beta release schedule. The changelog is also accessible under Companion App.

The changelog prompt will be maintained by contributors of the app as we do not think it will be user friendly to show GitHub commit messages. This allows us to highlight the above breaking changes to all users so they no longer have surprises going forward. Thank you to dshokouhi for adding this feature.

Wear OS Updates

The Wear OS app continues to grow with more features each release and this month we have some welcomed additions!

  • Breaking Change: The Wear OS app has a breaking change this release to hide non-primary entities from the home screen. The entities will still be accessible if you add them as a favorite and also under the “All entities” screen. This change was done to match the behavior of the autogenerated dashboard of the Home Assistant frontend, thank you jpelgrom.
  • A new tile was added by leroyboerefijn that allows you to render any template in the tile. You will need to use the phone app to setup the template tile as the Wear OS keyboard is missing some important keys that are required for templates. You can also set the refresh interval for the tile in settings as well.

  • Multi-Factor Authentication is now supported when logging into the watch, thank you jpelgrom
  • Areas were added to allow you to view entities by the selected area, thank you jpelgrom
  • The shortcuts tile got an enhancement to show the entity friendly name around the icon. If you do not change your entity icons to custom ones you will want to enable this feature. Look in the settings screen to enable this feature, thank you leroyboerefijn.
  • A new “Sign in on phone” button was added to the Wear OS login screen so you no longer have to enter those long passwords on a small screen. Thank you jpelgrom

  • button, cover, fan and input_button domains have been added to the Wear OS app by jpelgrom

Other Changes

  • A new In Use sensor for Quest devices was added by SkechyWolf. This new sensor turns on only when the headset is worn by the user. It is a bit more precise than using the interactive sensor, which was previously mentioned for this use case.
  • Device controls were updated to add support for button and input_button domains. The climate domain was enhanced for supported HVAC modes and proper temperature increments. The More Info pop-up, when a tile is long pressed, is now more reliable. Thanks for these improvements jpelgrom.
  • dshokouhi and jpelgrom worked together to remove additional Google Service dependencies from the minimal version
  • A new settings page was added by dshokouhi to allow users to easily find Notification Channel settings for the app
  • The Manage Widgets page was updated by dshokouhi and jpelgrom to have a new design based on Jetpack Compose. It is also now possible to add widgets from the settings page to your home screen, if the device supports it.

  • A notification command to update sensors was added by dshokouhi
  • The Manage Shortcuts and Manage Tiles pages had design updates based on Jetpack Compose by dshokouhi
  • Notification commands for command_activity and command_broadcast_intent were updated for more types of intent extras by moritzgloeckl
  • The WiFi state sensor now receives instant updates on devices that did not have instant updates before, thank you dshokouhi
  • JBassett has now made it possible to update the Google Play Store listing directly from GitHub
  • Downloading is now supported in the Home Assistant Frontend, thank you jpelgrom
  • button and input_button domain support was added to quick settings by jpelgrom

Special thank you to all other contributors who have helped in bug fixing and other various under the hood improvements to the code base. Thank you NotWoods, joostlek and chriss158. As always please remember to add your feature requests and bugs to GitHub.

Changelog

This is a companion discussion topic for the original entry at https://www.home-assistant.io/blog/2022/02/11/android-february/
5 Likes
2

Is the ability to use self-signed certificates ever going to be implemented? I have never been able to use the app due to this.

I’ve tried importing the cert on my phone and the app still doesn’t work.

Is there a way that the app can implement an import function to use the cert directly?

3

self-signed certificate should work actually, we do have this troubleshooting step and last I checked it worked for users

We do have a PR coming up for TLS client certificates where after the PR is approved later on there can be an import dialog instead of needing to place the files in a particular location

1 Like
4

It’s been a while since I last tried so I’ll have a other go at it. Thanks for the info.

Being able to import the cert directly from within the app would make things very convenient.

5

Still not working. Oh well. I don’t need the app, but would be nice to able to use it.

6

Will turning off the “show notifications” preference for Websocket have any adverse impact?

I’d choose to not show a persistent notification from HomeAssistant Websockets in my notification section if it can be avoided.

7

I assume you can’t even login right? Can you check the error in logcat to see the cause? Maybe it will give a clue.

We addressed this in the blog, you can do it but if you run into any issues youll be asked to turn it on.

1 Like
8

Correct. The server is discovered and I get this message when trying to connect.

Screenshot_20220212-110009~2
Screenshot_20220212-110009~21080×691 39.7 KB

9

Thanks for the screenshot. So this error gets displayed when the app receives this error message

https://developer.android.com/reference/android/net/http/SslError#SSL_UNTRUSTED

Now when we check the android docs they recommend to accept user added trust anchors which the app does:

https://github.com/home-assistant/android/blob/e133946f1e324f5a4fc9d0103d6b50441e54b825/app/src/main/res/xml/network_security_config.xml#L10

Are you sure the certificate was imported properly? I know the docs link to a google support site but different devices have different ways of doing things.

10

To the best of my knowledge, yes - it shows up in the ‘User Credentials’. I use a Google Pixel 4a, so the instructions are correct on the Google support page.

11

So freakin’ excited to see this. Every time I see an Android Companion feature update, I’ve thought “sounds cool, wish I could use it securely!”, so really glad to see it’ll be an option soon!

12

Looking good but how can i create a template tile to show the temperature like the picture above? All I can fix is “Temperature” so far :slight_smile:

13

Would you consider making the message “Listening to Home Assistant via websocket” customisable (perhaps showing a specific sensor from HA), and likewise making “Websocket Settings” hideable, or at least less prominent?

The pop-up actually makes a handy, quick shortcut to launch HA. But after a month, it’s still always there and highly visible and I don’t expect to continually need to be reminded why it is there — or change those settings frequently.

2 Likes
14

Why don’t you just hide it?

15

Screenshot_20220212-085945_Settings
Screenshot_20220212-085945_Settings1080×1438 135 KB

@mattdm

1 Like
16

I have two Android phones I have updated now to the latest companion app and my Home Assistant OS is updated as of today as well. I enabled the websocket (left the notification channels on, websocket set to Always, app has background access). Seems to work… until I disconnect my Home Assistant node from the internet. The Websocket appears to stay up for maybe 1 minute on one phone and until I toggle wifi off then on for the other (though if I let it sit maybe it would die without toggling wifi), before it dies (but still without internet) I can get notifications.

Is this expected that the websocket goes down eventually without internet?

17

Small feature suggestion: make the in-app changelog less obtrusive. Instead you could show a snackbar “App has been updated” with a button “See changelog” to open the changelog modal.

Reason: My HA app basically replaces both the IKEA Home Smart app and the Android device controls for me. Thanks to how quick the companion app starts up, this is the fastest way for me to dim my lights at home.

Whenever I want to just dim some light I want as few steps, dialogs or clicks in between. Hence the suggestion above :slight_smile:

(The IKEA app, not only being slow to start, sometimes even make me have to read and accept new terms and conditions… I mean, come on, I just wanted to turn off the bedroom lights! :stuck_out_tongue_closed_eyes:)

1 Like
18

Is the local push channel the same as the persistent notification?
I.e. if I put the persistent notif on “silent”, does that silence the local notifications?

Bonus question: It seems obvious to me but not explicit: You have to have the websocket set to “Always” to get local push always, I assume, or is there some magic? :wink:

And finally, what happens to local push if they cannot be delivered (e.g. out of network). Are they retried or just forgotten?

Thanks

19

You can use templates to access the states and attributes of any entity. See some examples here: Templating - Home Assistant

1 Like
20

Not sure, but a second restart of my HA instance cleared the spotify erros in logbook