Help section

This commit is contained in:
estevez-dev 2020-04-29 18:09:34 +03:00
parent 577657ff7e
commit 5e50c09778
22 changed files with 155 additions and 6 deletions

8
ha-client.app.caret Normal file
View File

@ -0,0 +1,8 @@
{
"folders": [
{
"retained": "FE4790AA3F0FC8347BB1FC055FA8137E:ha-client.app",
"path": "/ha-client.app"
}
]
}

View File

@ -0,0 +1,54 @@
# [Help pages](/help) - Additional features
If this documentation was not useful enough for you, feel free to ask any question in [HA Client on Descord](https://discord.gg/nd6FZQ)
{% include in_post.html %}
- [Media players](#media-palyers)
- [Lights](#lights)
- [Log viewer](#log-viewer)
## Media players
### Quick access
There is a quick media players access button in HA Client header. It shows the number of currently active media players and gives you a possibility to quickly jump to one of them. There is also an option to Play some media on any of your players.
![image](/help/images/additional_features003.png)
![image](/help/images/additional_features004.png)
### Play media
You can try to play any media url to any of your media players. There will be an option to use [media extractor](https://www.home-assistant.io/integrations/media_extractor/) if it is enabled on your Home Assistant.
![image](/help/images/additional_features005.png)
### Swicth media
There is an options for each media player to switch media from one to another. It will work not for every media type and media player. HA Client will exatract media url and media type from current media player and will give you a possibility to choose a plyer where to send this data.
![image](/help/images/additional_features006.png)
![image](/help/images/additional_features007.png)
[Back to top](#help-pages---additional-features)
## Lights
You can copy current color of any RGB light and paste it to other light.
![image](/help/images/additional_features008.png)
[Back to top](#help-pages---additional-features)
## Log viewer
There is a built in debug messages viewer in the app. You can access it with **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 top right corner that will copy all log entries to clipboard.
![image](/help/images/additional_features001.png)
![image](/help/images/additional_features002.png)
Please note that oldest entries goes first, so to see latest messages you need to scroll this view down.
[Back to top](#help-pages---additional-features)
### [Mobile App Integration](/help/mobile_app_integration) < Previous

View File

@ -1,6 +1,6 @@
# [Help pages](/help) - Connection
If this documentation was not useful enough for you, feel free to ask any question in [HA Client on Descord](https://discord.gg/nd6FZQ)
{% include in_post.html %}
- [Quick start](#quick-start)
- [Advanced](#advanced)
- [Port](#port)

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 153 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

View File

@ -1,10 +1,20 @@
# HA Client help pages
If this documentation was not useful enough for you, feel free to ask any question in [HA Client on Descord](https://discord.gg/nd6FZQ)
{% include in_post.html %}
## Table of content
- [What you need](/help/what_you_need)
- [Home Assistant](/help/what_you_need#home-assistant)
- [Android](/help/what_you_need#android)
- [Connection](/help/connection)
- [Quick start](/help/connection#quick-start)
- [Advanced](/help/connection#advanced)
- [Port](/help/connection#port)
- [HTTP or HTTPS](/help/connection#http-or-https)
- [SSL Certificates](/help/connection#ssl-certificates)
- [Login with long-lived token](/help/connection#login-with-long-lived-token)
- [User interface](/help/user_interface)
- [Supported Lovelace Cards](/help/user_interface#supported-cards)
- [Additional UI tricks](/help/user_interface#additional-ui-tricks)
@ -124,7 +134,7 @@ For now notificationas could only have title and text. No actions supported yet.
```
The `title` is not mandatory, by defauld it will be "HA Client".
Please note: there is a restriction on daily notifications count for each device: **150**.
Please note: there is a restriction on daily notifications count for each device: **150**.
### Location tracking
**(HA Client >= 0.7.0)**
Starting from version 0.7.0 HA Client supports updating `device_tracker` entity with real device GPS location. The app [should be registered in your HA](#mobile-app-integration) and HA need to be restarted to make it work.
@ -154,7 +164,7 @@ Then just open HA Client app. It will check mobile app integration and ask you t
#### Location tracking issues
- If the [issue with duplicate integration](#notification-issues) is not your case but your `device_tracker` location is not updating as intended, please check [location tracking section](#if-you-want-your-location-to-be-updated-with-exact-the-same-intervhals-you-set-in-ha-client) of this guide.
- Also make sure the Location permission is granted for HA Client.
- You can disable background location tracking task and enable it again to resolve possible issues. Go to _Integration settings_ from HA Client main menu and disable Location tracking to cancel backgroud tasks. Then enable it back.
- You can disable background location tracking task and enable it again to resolve possible issues. Go to _Integration settings_ from HA Client main menu and disable Location tracking to cancel backgroud tasks. Then enable it back.
[Back to top](#documentation)
## UI Configuration

View File

@ -0,0 +1,77 @@
# [Help pages](/help) - Mobile app integration
If this documentation was not useful enough for you, feel free to ask any question in [HA Client on Descord](https://discord.gg/nd6FZQ)
{% include in_post.html %}
- [Notifications](#notifications)
- [Location tracking](#location-tracking)
- [Troubleshooting](#troubleshooting)
Home Assistant [Mobile App Integration](https://www.home-assistant.io/integrations/mobile_app/) allows HA Client to handle push notifications and report your device location and battery state.
After successful login HA Client will automatically register itself on your Home Assistant to make notifications and location tracking possible and then will ask you to restart your server.
![image](/help/images/mobile_app_integration004.png)
You can find **Integration settings** in **App settings** from main HA Client menu.
![image](/help/images/mobile_app_integration001.png)
![image](/help/images/mobile_app_integration002.png)
![image](/help/images/mobile_app_integration003.png)
[Back to top](#help-pages---mobile-app-integration)
## Notifications
HA Client supports sending notifications from Home Assistant to the app.
For now notificationas could only have title and text. No actions supported yet. After mobile app will be registered and your Home Assistant will be restarted you'll get a new `notify` like `notify.mobile_app_egor_s_pixel_3_xl`. It can be used to send notifications to HA Client on a specific device. Just call this service with some data:
```yaml
{"title":"Oi!", "message":"Something is moving on your backyard!"}
```
The `title` is not mandatory, by defauld it will be "HA Client".
[Back to top](#help-pages---mobile-app-integration)
## Location tracking
HA Client supports updating `device_tracker` entity with real device GPS location.
Location tracking is implemented with [Andorid Workmanager](https://developer.android.com/topic/libraries/architecture/workmanager). It means that background location tracking is battery friendly and work as intended from OS perspective.
After mobile app will be registered and your Home Assistant will be restarted you'll get a new `device_tracker` entity like `device_tracker.mobile_app_egor_s_pixel_3_xl`. To start sending location to this entity you need to enable Location tracking in HA Client through **Integration settings** in **App settings**
![image](/help/images/mobile_app_integration001.png)
![image](/help/images/mobile_app_integration002.png)
![image](/help/images/mobile_app_integration006.png)
[Back to top](#help-pages---mobile-app-integration)
## Troubleshooting
For now Home Assistant don't have a way to detect was current application on current device already registered or not. That is why if you will reinstall HA Client or clear all app data, the app will be registered once again and **another Integration will be created on your Home Assistant**:
![image](/help/images/mobile_app_integration007.png)
As well as second `notify` service and second `device_tracker` entity. **Notifications will not be handled by HA Client**. To fix this you need to got to *Configuration* - *Integrations* in your Home Assistant and remove any Integration created by HA Client for your device. Then you need to restart Home Assistant server to make all exces entities to be removed.
Then just open HA Client app. It will check mobile app integration and ask you to registrer again.
Removing Mobile App integration can solve some issues even if you don't have duplicate Integrations. Just remove the integration in Home Assistant, restart Home Assistant and open HA Client to make it register again.
### Notification issues
There is a restriction on daily notifications count for each device: **50**.
### Location tracking issues
- Make sure the Location permission is granted for HA Client.
- You can disable background location tracking task and enable it again to resolve possible issues. Go to _Integration settings_ in HA Client and disable Location tracking to cancel backgroud tasks. Then enable it back.
- You can add exception for HA Client in battery saving settings on your Android device to improve background tasks execution. This can help solving some location tracking issues on older Android versions. It can be achieved differently on different Android versions and even on different devices. For example in Android 10 on Pixel phones you need to go to _Settings_ -> _Apps & notifications_ tap _Advanced_ -> _Special app access_ -> _Battery optimization_. Or simply search for _Battery optimization_ on main _Settings_ screen with search field. Inside _Battery optimization_ switch to _All apps_, find _HA Client_ in the list and tap it. On the popup appeared choose _Don't optimize_:
![Battery optimization](/help/images/mobile_app_integration005.png)
[Back to top](#help-pages---mobile-app-integration)
### [User interface](/help/user_interface) < Previous | Next > [Additional features](/help/additional_features)

View File

@ -1,6 +1,6 @@
# [Help pages](/help) - User interface
If this documentation was not useful enough for you, feel free to ask any question in [HA Client on Descord](https://discord.gg/nd6FZQ)
{% include in_post.html %}
- [Supported Lovelace Cards](#supported-cards)
- [Additional UI tricks](#additional-ui-tricks)

View File

@ -1,6 +1,6 @@
# [Help pages](/help) - What You Need
If this documentation was not useful enough for you, feel free to ask any question in [HA Client on Descord](https://discord.gg/nd6FZQ)
{% include in_post.html %}
- [Home Assistant](#home-assistant)
- [Android](#android)