Updates for 1.0.0
This commit is contained in:
estevez-dev
parent
48281505cc
commit
dedc2a92b2
@ -12,20 +12,20 @@ If this documentation was not useful enough for you, feel free to ask any questi
|
||||
{% include in_post.html %}
|
||||
|
||||
## Quick start
|
||||
The quick and easy whay to connect HA Client with your Home Assistant server is to use [Remote UI](https://www.nabucasa.com/config/remote/). If you alredy had it set up, just open your Home Assistant UI in browser, go to **Configuration** - **Home Assistant Cloud**, find **Remote Control** section and copy the url from **Your instance is available at**.
|
||||
When first launching the app you will be presented with Quick start screen asking you to provide your Home Assistant url and [device name](/help/mobile_app_integration#device-name) for [Mobile App integration](/help/mobile_app_integration).
|
||||
|
||||
|
||||
|
||||
You can just copy your Home Assistant url from browser and use it in the app:
|
||||
|
||||
|
||||
|
||||
The easy and secure way to aceess you Home Assistant from anywhere (not only from your local network at home) is [Remote UI](https://www.nabucasa.com/config/remote/). If you alredy had it set up, just open your Home Assistant UI in browser, go to **Configuration** - **Home Assistant Cloud**, find **Remote Control** section and copy the url from **Your instance is available at**.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Then just go to **App settings** in HA Client, choose **Connection settings**, put copied url to **Home Assistant url** field ignoring all other fields and hit **Apply**.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Now you need to login. And this process will be almost automatic thanks to [Home Assistant Authentication API](https://developers.home-assistant.io/docs/en/auth_api.html). You'll see a login form loaded directly from your Home Assistant instance:
|
||||
|
||||
|
||||
|
||||
BIN
help/images/connection010.png
Normal file
BIN
help/images/connection010.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
BIN
help/images/connection011.png
Normal file
BIN
help/images/connection011.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 50 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 27 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 58 KiB After Width: | Height: | Size: 28 KiB |
@ -1,5 +1,6 @@
|
||||
# [Help pages](/help) - Mobile app integration
|
||||
|
||||
- [Device name](#device-name)
|
||||
- [Notifications](#notifications)
|
||||
- [Location tracking](#location-tracking)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
@ -24,11 +25,16 @@ You can find **Integration settings** in **App settings** from main HA Client me
|
||||
|
||||
[Back to top](#help-pages---mobile-app-integration)
|
||||
|
||||
## Devcie name
|
||||
On [first app start](/help/connection#quick-start) you can choose device name for your integration. All entity names created by this integration will depend on that name.
|
||||
|
||||
If you want to change device name for already created integration, you need to remove *Mobile App: [your device name]* from Home Assistant **Configuration** - **Integrations**, then restart your server and launch HA Client once again. The app will ask you to create new integration allowing to change default device name.
|
||||
|
||||
## 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:
|
||||
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` (depends on [device name](#device-name)). 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!"}
|
||||
@ -44,7 +50,7 @@ HA Client supports updating `device_tracker` entity with real device GPS locatio
|
||||
|
||||
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**
|
||||
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` (depends on [device name](#device-name)). To start sending location to this entity you need to enable Location tracking in HA Client through **Integration settings** in **App settings**
|
||||
|
||||
|
||||
|
||||
@ -55,16 +61,10 @@ After mobile app will be registered and your Home Assistant will be restarted yo
|
||||
[Back to top](#help-pages---mobile-app-integration)
|
||||
|
||||
## Troubleshooting
|
||||
If notifications or location tracking doesn't work, first thing you need to check is entities name you are using. You can check that in **Configuration** - **Integrations** - **Mobile App: [your device name]** in your Home Assistant.
|
||||
|
||||
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**:
|
||||
Also it could be useful to remove Mobile App integration from Home Assistant and restrat server to allow HA Client to create integration once again.
|
||||
|
||||
|
||||
|
||||
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**.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user