mirror of
https://github.com/bastienwirtz/homer.git
synced 2025-06-26 12:41:27 +02:00
added documentation for the home assistant custom component
This commit is contained in:
parent
efc9b1e0ad
commit
c53c3957d5
@ -36,6 +36,7 @@ within Homer:
|
|||||||
- [PiAlert](#pialert)
|
- [PiAlert](#pialert)
|
||||||
- [Immich](#immich)
|
- [Immich](#immich)
|
||||||
- [OpenHAB](#openhab)
|
- [OpenHAB](#openhab)
|
||||||
|
- [Home Assistant](#home-assistant)
|
||||||
|
|
||||||
If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
|
If you experiencing any issue, please have a look to the [troubleshooting](troubleshooting.md) page.
|
||||||
|
|
||||||
@ -462,4 +463,20 @@ You need to set the type to OpenHAB, provide an api key and enable cors on OpenH
|
|||||||
items: true # true will query the items API and report total items count. false will skip the call
|
items: true # true will query the items API and report total items count. false will skip the call
|
||||||
```
|
```
|
||||||
To create an API token on OpenHAB, follow the [official documentation here](https://www.openhab.org/docs/configuration/apitokens.html).
|
To create an API token on OpenHAB, follow the [official documentation here](https://www.openhab.org/docs/configuration/apitokens.html).
|
||||||
To enable cors on OpenHAB, edit your services/runtime.cfg and uncomment or add this line: `org.openhab.cors:enable=true`
|
To enable cors on OpenHAB, edit your services/runtime.cfg and uncomment or add this line: `org.openhab.cors:enable=true`
|
||||||
|
|
||||||
|
## Home Assistant
|
||||||
|
|
||||||
|
You need to set the type to HomeAssistant, provide an api key and enable cors on Home Assistant.
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- name: "HomeAssistant"
|
||||||
|
logo: "assets/tools/sample.png" # optional, if none provided logo is taken from the home assistant instance
|
||||||
|
url: "http://192.168.0.151/"
|
||||||
|
type: "HomeAssistant"
|
||||||
|
apikey: "<---insert-api-key-here--->"
|
||||||
|
items: [] # optional, which items to show (and in which order) in the subtitle. Possible values are "name", "version", "entities"
|
||||||
|
separator: " " # optional, how to separate items
|
||||||
|
```
|
||||||
|
To create an API token on HomeAssistant, follow the [official documentation here](https://developers.home-assistant.io/docs/auth_api/#long-lived-access-token).
|
||||||
|
To enable cors on HomeAssistant, edit your `configuration.yml` and add the IP of Homer to `https: cors_allowed_origins`
|
Loading…
x
Reference in New Issue
Block a user