BangleApps/apps/ha/README.md

64 lines
2.8 KiB
Markdown
Raw Normal View History

2022-06-20 11:36:49 +00:00
# Home Assistant
2022-06-23 18:06:53 +00:00
This app integrates your BangleJs into the HomeAssistant.
2022-06-20 11:36:49 +00:00
2022-06-23 19:03:32 +00:00
# How to use
Click on the left and right side of the screen to select the triggers that you
configured. Click in the middle of the screen to send the trigger to HomeAssistant.
2022-06-24 06:33:44 +00:00
![](screenshot.png)
# First Setup
2022-06-23 18:52:20 +00:00
1.) First of all, make sure that HomeAssistant and the HomeAssistant Android App works.
2022-06-23 18:06:53 +00:00
2022-06-23 18:52:20 +00:00
2.) Open your BangleJs Gadgetbridge App, click on the Settings icon of your BangleJs and enable "Allow Intent Access"
2022-06-23 18:06:53 +00:00
2022-06-23 18:52:20 +00:00
3.) Enable sensor in HomeAssistant Andoird App/Configuration/Companion App/Manage Sensors/LastUpdate Trigger
2022-06-23 18:06:53 +00:00
2022-06-23 18:52:20 +00:00
4.) At the bottom of the same screen click on "Add New Intent" and enter "com.espruino.gadgetbridge.banglejs.HA"
5.) The HomeAssistant Android app must be restarted in order to listen for those actions
-- a "Force Stop" is necessary (through Android App settings) or restart your phone!
This setup must be done only once -- now you are ready to configure your BangleJS to
control some devices or entities in your HomeAssistant :)
2022-06-23 18:06:53 +00:00
# Setup Trigger
2022-06-24 07:29:49 +00:00
1.) Upload the app and all corresponding triggers through the AppStore UI. You must specify
the display name, the trigger as well as an icon.
The following icons are currently supported:
- ha (default)
- light
- door
- fire
2022-06-23 18:52:20 +00:00
2.) Create an "automation" in the HomeAssistant WebUI for each trigger that you created on your BangleJs in order to tell HomeAssistant what you want to control. A sample configuration is shown in the image below -- I use this trigger to open the door:
![](ha_automation.png)
3.) Don't forget to select the action that should be executed at the bottom of each automation.
# Default Trigger
This app also implements two default trigger that can always be used:
- APP_STARTED -- Will be sent whenever the app is started. So you could do some actions already when the app is sarted without the need of any user interaction.
- TRIGGER -- Will be sent whenever some trigger is executed. So you could generically listen to that.
2022-06-23 18:06:53 +00:00
2022-06-24 06:36:08 +00:00
# FAQ
## Sometimes the trigger is not executed
2022-06-23 18:52:20 +00:00
While playing and testing a bit I found that it is very important that you allow the android HomeAssistant app, as well as BangleJs Gadgetbridge app to (1) run in background and (2), disable energy optimizations for both apps.
Otherwise, Android could stop one of both apps and the trigger will never be sent to HomeAssistant...
2022-06-20 11:36:49 +00:00
If you still have problems, you can try another trick:
Install "MacroDroid" from the Android AppStore and start the HomeAssistant App
each time the "com.espruino.gadgetbridge.banglejs.HA" intent is send together
with the extra trigger: APP_STARTED. Then whenever you open the app on your BangleJs
it is ensured that HomeAssistant is running...
2022-06-24 07:29:49 +00:00
## Thanks to
<a href="https://www.flaticon.com/free-icons/" title="Icons">Icons created by Flaticon</a>
2022-06-20 11:36:49 +00:00
## Creator
- [David Peer](https://github.com/peerdavid).