HomeAssistant: Convert image instructions to code blocks.

Renamed the example screenshot to default image name as well.
This commit is contained in:
Niloth P
2024-12-31 23:25:37 +05:30
committed by Tim Abbott
parent fa0ea2aa2d
commit 51839a72b9
5 changed files with 20 additions and 4 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

View File

@@ -737,7 +737,7 @@ DOC_SCREENSHOT_CONFIG: dict[str, list[BaseScreenshotConfig]] = {
],
"helloworld": [ScreenshotConfig("hello.json")],
"heroku": [ScreenshotConfig("deploy.txt")],
"homeassistant": [ScreenshotConfig("reqwithtitle.json", image_name="003.png")],
"homeassistant": [ScreenshotConfig("reqwithtitle.json")],
"insping": [ScreenshotConfig("website_state_available.json")],
"intercom": [ScreenshotConfig("conversation_admin_replied.json")],
"jira": [ScreenshotConfig("created_v1.json")],

View File

@@ -5,7 +5,13 @@
1. In Home Assistant, you need to add the `notify` service to your
`configuration.yaml` file. This should look something like this:
![](/static/images/integrations/homeassistant/001.png)
```
notify:
- platform: rest
resource: http: {{ external_api_uri }}v1/external/homeassistant?api_key=<API key>
method: POST_JSON
title_param_name: topic
```
1. The `api_key` parameter should correspond to your bot's key. The `stream`
parameter is not necessarily required; if not given, it will default to
@@ -18,7 +24,17 @@
1. Finally, you need to configure a trigger for the service by adding
an automation entry in the HomeAssistant `configuration.yaml` file.
![](/static/images/integrations/homeassistant/002.png)
```
automation:
trigger:
platform: sun
event: sunrise
action:
- service: notify.notify
data:
message: "It will be 30 degrees Celsius out there today!"
title: "Weather forecast"
```
The `data` object takes at least a `message` property and an optional
`title` parameter which will be the conversation topic and which defaults
@@ -26,4 +42,4 @@
{!congrats.md!}
![](/static/images/integrations/homeassistant/003.png)
![](/static/images/integrations/homeassistant/001.png)