From c53c3957d5b69afbe0a698608b943fb20574e2c1 Mon Sep 17 00:00:00 2001 From: Emily Wotruba Date: Mon, 20 May 2024 19:47:04 +0200 Subject: [PATCH] added documentation for the home assistant custom component --- docs/customservices.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/docs/customservices.md b/docs/customservices.md index 64ed416..82c4542 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -36,6 +36,7 @@ within Homer: - [PiAlert](#pialert) - [Immich](#immich) - [OpenHAB](#openhab) + - [Home Assistant](#home-assistant) 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 ``` 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` \ No newline at end of file +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` \ No newline at end of file