yehor/ha-client.app
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs.md

Browse Source
This commit is contained in:
Yegor Vialov 2019-09-03 14:56:32 +03:00 committed by GitHub
parent e88f499100
commit 4bfe883103
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs.md
View File

@ -16,21 +16,14 @@
### 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`, `websocket_api` and `mobile_app` components to be enabled as well as [remote access](https://www.home-assistant.io/docs/configuration/remote/) 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.
To connect to your Home Assistant instance with HA Client you need `mobile_app` components to be enabled. Just add (or check if exist) this line to your `configuration.yaml`:
In other cases changes should be made to you `configuration.yaml`:
```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:
mobile_app:
```
Also to make HA Client work outside of your home network [remote access](https://www.home-assistant.io/docs/configuration/remote/) should be configured or [Remote UI](https://www.nabucasa.com/config/remote/) should be used.
[Back to top](#documentation)
### 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.
@ -39,9 +32,9 @@ If you are accessing your web interface without port, then you need to try port
[Back to top](#documentation)
### 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.
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).
But if you are using ssl (accessing web interface with `https://`) – your certificate should be valid (not self-signed). This is not a restriction of HA Client, but a known issue of Flutter framework.
[Back to top](#documentation)
### SSL Certificates
@ -57,7 +50,7 @@ Minimum supported Android API level is 21. That’s Android 5.0 and higher.
## Authentication
There is two ways to login to Home Assistant with HA Client
### Home Assistant OAuth
HA Client will login through [Home Assistant Authentication API](https://developers.home-assistant.io/docs/en/auth_api.html). You don't need to create and recreate access tokens. 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:
HA Client will login through [Home Assistant Authentication API](https://developers.home-assistant.io/docs/en/auth_api.html). You don't need to create and recreate access tokens. 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 credentials:
![image](/assets/images/oauth.png)
@ -87,10 +80,12 @@ To make HA Client use your generated long-lived token you need:
[Back to top](#documentation)
## Mobile app integration
**(HA Client >= 0.6.0)**
Strating from 0.6.0 `mobile_app` component should be enabled on your Home Assistant server. In nevest versions of HA it is enabled by default. If not, the app will show you an error saying that you need to enable `mobile_app` component on your HA instance. In that case just add this to your `configuration.yaml`:
Strating from 0.6.0 `mobile_app` component should be enabled on your Home Assistant server. If it is disabled, the app will show you an error saying that you need to enable `mobile_app` component on your HA instance. In that case just add this to your `configuration.yaml`:
```yaml
mobile_app:
```
If `mobile_app` component is enabled, you'll see a message about successfull mobile app registration:
![image](/assets/images/mobile_app_registered.png)