Documentation

Table of content

Requirements

Home Assistant general

To check if you are using right configuration for app, try to access your Home Assistant web interface with the same protocol (http:// or https://), the same domain or IP and port. If it is not loading – the app will not work as well.

To connect to your Home Assistant instance with HA Client you need http and websocket_api components to be enabled as well as remote access configured. If you are using frontend component (Home Assistant web interface actually) websocket_api is enabled by default and http component is already configured on your server, but still you need to double check.

In other cases changes should be made to you configuration.yaml:

http:
  api_password: #some password here
  base_url: #your domain for Home Assistant instance
  ssl_certificate: /ssl/fullchain.pem #ssl configuration to access your HA by https
  ssl_key: /ssl/privkey.pem 

websocket_api:

Back to top

Port

By default your Home Assistant is using port number 8123. But to access your instance from outside of your home network, probably you configured some port forwarding rules on you router. If you forward some other port from outside to 8123 port on Home Assistant IP, you need to use that port instead.

If you are accessing your web interface without port, then you need to try port 80 or 443 in app.

Back to top

HTTP or HTTPS

It is not required to use secure connection. Just remember: if you are accessing your web interface with http, you need to switch “Use ssl” off in app settings as well.

But if you are using ssl (accessing web interface with https://) – your certificate should be valid (not self-signed).

Back to top

SSL Certificates

The main requirement is that your SSL Certificate should not be self-signed. Most certificates from providers like Let’s Encrypt will work. There is known issue with RapidSSL certificate, but this problem is common not only for HA Client.

Using of self-signed certificate is not possible for now and this is a restriction of Flutter’s WebSocket implementation. To stay up to date with this issue solving or possible workarounds please follow this issue in GitHub.

Back to top

Android

Minimum supported Android API level is 21. That’s Android 5.0 and higher.

Back to top

Authentication

Prior HA Client 0.6.0

Starting from Home Assistant 0.78.0 api_password is a deprecated way to authenticate third party apps and services. You should use long-lived access tokens instead. To make HA Client use access token to authenticate you need:

  1. Go to your Home Assistant web interface and open your profile settings (just click on your user picture in the top part of left menu)

image

  1. Scroll down to Long-lived access tokens section and click Create token

image

  1. Give it a name HA Client as it will be used only for HA Client app (it is recommended to use different access tokens for different apps and services)
  2. Click Ok and copy newly generated access token somewhere in a safe place or directly to Connection settings of HA Client

image

Back to top

HA Client 0.6.0 and higher

Starting from version 0.6.0 HA Client will be authenticating through Home Assistant Authentication API. You don’t need to create and recreate access tokens any more. For now if HA Client is not authenticated yet or there is some issues logging in, it will ask you to login to your Home Assistant web interface with your credential:

image

After successfull login HA Client will get secure code, request long-lived token from Home Assistant automatically and store it is secure storage of your Android device.

There is also ‘Logout’ option added. It will disconnect from Home Assistant, clear the UI and remove long-lived token from secure storage:

image

Back to top

UI Configuration

By default HA Client UI is based on your Lovelace UI config, so it should display the same views as your Home Assistant web UI. It is still possible to switch off Lovelace UI in app settings. In this case app UI will be based on groups configuration, the same as old Home Assistant UI.

image

Back to top

Log Viewer

There is a built in debug messages viewer in the app. You can access it by Log item in main menu. It will be very helpful if you will attach a copy of this log to your issue report. It is easy to do with button in header (image) that will copy all log entries to clipboard.

image

Please note that oldest entries goes first, so to see latest messages you need to scroll this view down.

Back to top