mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 00:36:49 +00:00
Fix links to basic settings config variables (#32510)
This commit is contained in:
c0ffeeca7
GitHub
parent
181fbadbba
commit
aef281cf49
@ -144,5 +144,5 @@ tap_action:
|
||||
|
||||
{% endraw %}
|
||||
|
||||
The filename needs to be a path that is writable by Home Assistant in your system. You may need to configure `allowlist_external_dirs` ([documentation](/docs/configuration/basic/)).
|
||||
The filename needs to be a path that is writable by Home Assistant in your system. You may need to configure `allowlist_external_dirs` ([documentation](/integrations/homeassistant/#allowlist_external_dirs)).
|
||||
|
||||
|
||||
@ -39,27 +39,27 @@ Available services: `enable_motion_detection`, `disable_motion_detection`, `play
|
||||
|
||||
Enable the motion detection in a camera.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Name(s) of entities to enable motion detection, e.g., `camera.living_room_camera`. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Name(s) of entities to enable motion detection, e.g., `camera.living_room_camera`. |
|
||||
|
||||
#### Service `disable_motion_detection`
|
||||
|
||||
Disable the motion detection in a camera.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Name(s) of entities to disable motion detection, e.g., `camera.living_room_camera`. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------------------------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Name(s) of entities to disable motion detection, e.g., `camera.living_room_camera`. |
|
||||
|
||||
#### Service `play_stream`
|
||||
|
||||
Play a live stream from a camera to selected media player(s). Requires [`stream`](/integrations/stream) integration to be set up.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | Name of entity to fetch stream from, e.g., `camera.living_room_camera`. |
|
||||
| `media_player` | no | Name of media player to play stream on, e.g., `media_player.living_room_tv`. |
|
||||
| `format` | yes | Stream format supported by `stream` integration and selected `media_player`. Default: `hls` |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------------------------------- |
|
||||
| `entity_id` | no | Name of entity to fetch stream from, e.g., `camera.living_room_camera`. |
|
||||
| `media_player` | no | Name of media player to play stream on, e.g., `media_player.living_room_tv`. |
|
||||
| `format` | yes | Stream format supported by `stream` integration and selected `media_player`. Default: `hls` |
|
||||
|
||||
For example, the following action in an automation would send an `hls` live stream to your chromecast.
|
||||
|
||||
@ -78,14 +78,14 @@ Make a `.mp4` recording from a camera stream. Requires `stream` integration to b
|
||||
|
||||
Both `duration` and `lookback` options are suggestions, but should be consistent per camera. The actual length of the recording may vary. It is suggested that you tweak these settings to fit your needs.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.living_room_camera`. |
|
||||
| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/{{ entity_id.name }}.mp4`{% endraw %}. |
|
||||
| `duration` | yes | Target recording length (in seconds). Default: 30 |
|
||||
| `lookback` | yes | Target lookback period (in seconds) to include in addition to duration. Only available if there is currently an active HLS stream. Default: 0 |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.living_room_camera`. |
|
||||
| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/{{ entity_id.name }}.mp4`{% endraw %}. |
|
||||
| `duration` | yes | Target recording length (in seconds). Default: 30 |
|
||||
| `lookback` | yes | Target lookback period (in seconds) to include in addition to duration. Only available if there is currently an active HLS stream. Default: 0 |
|
||||
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/integrations/homeassistant/#allowlist_external_dirs) section of your `configuration.yaml` file.
|
||||
|
||||
For example, the following action in an automation would take a recording from "yourcamera" and save it to /tmp with a timestamped filename.
|
||||
|
||||
@ -106,12 +106,12 @@ action:
|
||||
|
||||
Take a snapshot from a camera.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.living_room_camera`. |
|
||||
| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id.name }}`{% endraw %}. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
|
||||
| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.living_room_camera`. |
|
||||
| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id.name }}`{% endraw %}. |
|
||||
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/integrations/homeassistant/) section of your `configuration.yaml` file.
|
||||
|
||||
For example, the following action in an automation would take a snapshot from "yourcamera" and save it to /tmp with a timestamped filename.
|
||||
|
||||
@ -132,17 +132,17 @@ action:
|
||||
|
||||
Turn off camera. Not all camera models support this service, please consult individual camera page.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Name(s) of entities to turn off, e.g., `camera.living_room_camera`. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Name(s) of entities to turn off, e.g., `camera.living_room_camera`. |
|
||||
|
||||
#### Service `turn_on`
|
||||
|
||||
Turn on camera. Not all camera models support this service, please consult individual camera page.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Name(s) of entities to turn on, e.g., `camera.living_room_camera`. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------ |
|
||||
| `entity_id` | yes | Name(s) of entities to turn on, e.g., `camera.living_room_camera`. |
|
||||
|
||||
### Test if it works
|
||||
|
||||
|
||||
@ -48,7 +48,7 @@ cast_downstairs_on_kitchen:
|
||||
|
||||
<div class='note'>
|
||||
|
||||
Home Assistant Cast requires your Home Assistant installation to be accessible via `https://`. If you're using Home Assistant Cloud, you don't need to do anything. Otherwise you must make sure that you have configured the `external_url` in your [configuration](/docs/configuration/basic).
|
||||
Home Assistant Cast requires your Home Assistant installation to be accessible via `https://`. If you're using Home Assistant Cloud, you don't need to do anything. Otherwise you must make sure that you have configured the `external_url` in your [configuration](/integrations/homeassistant/#configuration-variables).
|
||||
|
||||
</div>
|
||||
|
||||
@ -58,7 +58,7 @@ Home Assistant Cast requires your Home Assistant installation to be accessible v
|
||||
|
||||
Chromecasts generally ignore DNS servers from DHCP and will instead use Google's DNS servers, 8.8.8.8 and 8.8.4.4. This means media URLs must either be specifying the IP-address of the server directly, e.g. `http://192.168.1.1:8123/movie.mp4`, or be publicly resolvable, e.g. `http://homeassistant.internal.mydomain.com:8123/movie.mp4` where `homeassistant.internal.mydomain.com` resolves to `192.168.1.1`. A hostname which can't be publicly resolved, e.g. `http://homeassistant.local:8123/movie.mp4` will fail to play.
|
||||
|
||||
This is important when casting TTS or local media sources; the cast integration will cast such media from the `external_url` if [configured](/docs/configuration/basic), otherwise from the Home Assistant Cloud if configured, otherwise from the [`internal_url`](/docs/configuration/basic). Note that the Home Assistant Cloud will not be used if an `external_url` is configured.
|
||||
This is important when casting TTS or local media sources; the cast integration will cast such media from the `external_url` if [configured](/integrations/homeassistant/#editing-the-general-settings-in-yaml), otherwise from the Home Assistant Cloud if configured, otherwise from the [`internal_url`](/integrations/homeassistant/#editing-the-general-settings-in-yaml). Note that the Home Assistant Cloud will not be used if an `external_url` is configured.
|
||||
|
||||
</div>
|
||||
|
||||
@ -138,10 +138,10 @@ This app doesn't retrieve its own metadata, so if you want the cast interface or
|
||||
|
||||
Note: Media ID is NOT the 8 digit alphanumeric in the URL, it can be found by right-clicking the playing video. E.g., [this episode](https://www.bbc.co.uk/iplayer/episode/b09w7fd9/bitz-bob-series-1-1-castle-makeover) shows:
|
||||
|
||||
| | |
|
||||
| --- | --- |
|
||||
| | |
|
||||
| -------- | ------------------------------- |
|
||||
| 2908kbps | dash (mf_cloudfront_dash_https) |
|
||||
| b09w70r2 | 960x540 |
|
||||
| b09w70r2 | 960x540 |
|
||||
|
||||
With b09w70r2 being the `media_id`
|
||||
|
||||
@ -343,10 +343,10 @@ To cast media directly from a configured Plex server, set the fields [as documen
|
||||
|
||||
Note: Media ID is NOT the 8 digit alphanumeric in the URL, it can be found by right-clicking the playing audio clip. E.g., [this episode](https://www.bbc.co.uk/sounds/play/p009ycqy) shows:
|
||||
|
||||
| | |
|
||||
| --- | --- |
|
||||
| 128bps | dash (mf_cloudfront_nonbidi_dash_https) |
|
||||
| p009ycqz | |
|
||||
| | |
|
||||
| -------- | --------------------------------------- |
|
||||
| 128bps | dash (mf_cloudfront_nonbidi_dash_https) |
|
||||
| p009ycqz | |
|
||||
|
||||
With p009ycqz being the `media_id`
|
||||
|
||||
|
||||
@ -22,15 +22,15 @@ Because `color_extractor.turn_on` will then call `light.turn_on`, you can pass a
|
||||
|
||||
Passing the key `color_extract_url` to the {% term service %} call will download the linked image and extract the predominant color from it. Passing the key `color_extract_path` to the service call will process the image file from local storage instead. `color_extract_url` and `color_extract_path` are exclusive and cannot be used together.
|
||||
|
||||
|Key | Example | Description |
|
||||
|---------------------|---------------------------------------|-------------------------------------------------------------------------------|
|
||||
|`color_extract_url` | `https://example.com/images/logo.png` | The full URL (including schema, `http://`, `https://`) of the image to process|
|
||||
|`color_extract_path` | `/tmp/album.png` | The full path to the image file on local storage we'll process |
|
||||
|`entity_id` | `light.shelf_leds` | The RGB capable light we'll set the color of |
|
||||
| Key | Example | Description |
|
||||
| -------------------- | ------------------------------------- | ------------------------------------------------------------------------------ |
|
||||
| `color_extract_url` | `https://example.com/images/logo.png` | The full URL (including schema, `http://`, `https://`) of the image to process |
|
||||
| `color_extract_path` | `/tmp/album.png` | The full path to the image file on local storage we'll process |
|
||||
| `entity_id` | `light.shelf_leds` | The RGB capable light we'll set the color of |
|
||||
|
||||
<div class="note">
|
||||
|
||||
Please ensure any [external URLs](/docs/configuration/basic/#allowlist_external_urls) or [external files](/docs/configuration/basic/#allowlist_external_dirs) are authorized for use. You will receive error messages if this {% term integration %} is not allowed access to these external resources.
|
||||
Please ensure any [external URLs](/integrations/homeassistant/#allowlist_external_urls) or [external files](/docs/integrations/homeassistant/#allowlist_external_dirs) are authorized for use. You will receive error messages if this {% term integration %} is not allowed access to these external resources.
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ ha_integration_type: integration
|
||||
|
||||
The **Dialogflow** {% term integration %} is designed to be used with the [webhook](https://cloud.google.com/dialogflow/es/docs/fulfillment-webhook) integration of [Dialogflow](https://cloud.google.com/dialogflow/docs/). After each phrase a user says, Dialogflow sends an action and parameters to the webhook.
|
||||
|
||||
To be able to receive messages from Dialogflow, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/docs/configuration/basic). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
|
||||
To be able to receive messages from Dialogflow, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/integrations/homeassistant/#editing-the-general-settings-in-yaml). Dialogflow will return fallback answers if your server does not answer or takes too long (more than 5 seconds).
|
||||
|
||||
Dialogflow could be [integrated](https://cloud.google.com/dialogflow/es/docs/integrations) with many popular messaging, virtual assistant and IoT platforms.
|
||||
|
||||
|
||||
@ -69,26 +69,26 @@ When adding the Discord integration you will be asked for an API Key. Enter the
|
||||
|
||||
The following attributes can be placed inside the `data` key of the service call for extended functionality:
|
||||
|
||||
| Attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `images` | yes | The file(s) to attach to message.
|
||||
| `urls` | yes | The file(s) to download from a remote URL and attach to message.
|
||||
| `verify_ssl` | yes | A boolean to determine if SSL certs should be verified when calling the remote URLs in the `url` attribute. Defaults to `True`.
|
||||
| `embed` | yes | Array of [Discord embeds](https://discordpy.readthedocs.io/en/latest/api.html#embed). *NOTE*: if using `embed`, `message` is still required.
|
||||
| Attribute | Optional | Description |
|
||||
| ------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `images` | yes | The file(s) to attach to message. |
|
||||
| `urls` | yes | The file(s) to download from a remote URL and attach to message. |
|
||||
| `verify_ssl` | yes | A boolean to determine if SSL certs should be verified when calling the remote URLs in the `url` attribute. Defaults to `True`. |
|
||||
| `embed` | yes | Array of [Discord embeds](https://discordpy.readthedocs.io/en/latest/api.html#embed). *NOTE*: if using `embed`, `message` is still required. |
|
||||
|
||||
To include messages with embedding, use these attributes underneath the `embed` key:
|
||||
|
||||
| Attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `title` | yes | Title of the embed.
|
||||
| `description` | yes | Description of the embed.
|
||||
| `color` | yes | Color code of the embed. This value is an *int*.
|
||||
| `url` | yes | URL of the embed.
|
||||
| `author` | yes | Sets the footer for the embed content.
|
||||
| `footer` | yes | Sets the footer for the embed content.
|
||||
| `thumbnail` | yes | Sets the thumbnail for the embed content.
|
||||
| `image` | yes | Sets the image for the embed content.
|
||||
| `fields` | yes | Adds a field to the embed object. `name` and `value` are *required*, `inline` is *true* by default.
|
||||
| Attribute | Optional | Description |
|
||||
| ------------- | -------- | ---------------------------------------------------------------------------------------------------- |
|
||||
| `title` | yes | Title of the embed. |
|
||||
| `description` | yes | Description of the embed. |
|
||||
| `color` | yes | Color code of the embed. This value is an *int*. |
|
||||
| `url` | yes | URL of the embed. |
|
||||
| `author` | yes | Sets the footer for the embed content. |
|
||||
| `footer` | yes | Sets the footer for the embed content. |
|
||||
| `thumbnail` | yes | Sets the thumbnail for the embed content. |
|
||||
| `image` | yes | Sets the image for the embed content. |
|
||||
| `fields` | yes | Adds a field to the embed object. `name` and `value` are *required*, `inline` is *true* by default. |
|
||||
|
||||
### Example service call
|
||||
|
||||
@ -117,7 +117,7 @@ To include messages with embedding, use these attributes underneath the `embed`
|
||||
- "https://example.com/video.mp4"
|
||||
```
|
||||
|
||||
Note that `verify_ssl` defaults to `True`, and that any remote hosts will need to be in your [`allowlist_external_urls`](/docs/configuration/basic/#allowlist_external_urls) list. Discord limits attachment size to 8MB, so anything exceeding this will be skipped and noted in the error log.
|
||||
Note that `verify_ssl` defaults to `True`, and that any remote hosts will need to be in your [`allowlist_external_urls`](/integrations/homeassistant/#allowlist_external_urls) list. Discord limits attachment size to 8MB, so anything exceeding this will be skipped and noted in the error log.
|
||||
|
||||
### Example embed service call
|
||||
|
||||
|
||||
@ -56,7 +56,7 @@ To use notifications, please see the [getting started with automation page](/get
|
||||
|
||||
## Sensor
|
||||
|
||||
The `file` sensor platform reads the entries from a plain-text file and shows the found value. Only the last line of the file is used. This is similar to do `$ tail -n 1 sensor.txt` on the command-line. Note that file paths must be added to [allowlist_external_dirs](/docs/configuration/basic/).
|
||||
The `file` sensor platform reads the entries from a plain-text file and shows the found value. Only the last line of the file is used. This is similar to do `$ tail -n 1 sensor.txt` on the command-line. Note that file paths must be added to [allowlist_external_dirs](/integrations/homeassistant/#allowlist_external_dirs).
|
||||
|
||||
To enable the `file` sensor, add the following lines to your `configuration.yaml`:
|
||||
|
||||
|
||||
@ -19,7 +19,7 @@ The `filesize` sensor is for displaying the size in MB of a file.
|
||||
|
||||
<div class='note'>
|
||||
|
||||
File paths must also be added to [allowlist_external_dirs](/docs/configuration/basic/) in your `configuration.yaml`.
|
||||
File paths must also be added to [allowlist_external_dirs](/integrations/homeassistant/#allowlist_external_dirs) in your `configuration.yaml`.
|
||||
|
||||
File paths should be absolute paths. For example: `/config/home-assistant_v2.db` to monitor the size of the default database.
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
Sensor for monitoring the contents of a folder. Note that folder paths must be added to [allowlist_external_dirs](/docs/configuration/basic/). Optionally a [wildcard filter](https://docs.python.org/3.6/library/fnmatch.html) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria.
|
||||
Sensor for monitoring the contents of a folder. Note that folder paths must be added to [allowlist_external_dirs](/integrations/homeassistant/#allowlist_external_dirs). Optionally a [wildcard filter](https://docs.python.org/3.6/library/fnmatch.html) can be applied to the files considered within the folder. The state of the sensor is the size in MB of files within the folder that meet the filter criteria.
|
||||
The sensor exposes the number of filtered files in the folder, total size in bytes of those files and a comma separated list of the file paths as attributes.
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -18,7 +18,7 @@ This integration adds [Watchdog](https://pythonhosted.org/watchdog/) file system
|
||||
- `modified`
|
||||
- `moved`
|
||||
|
||||
Configured folders must be added to [allowlist_external_dirs](/docs/configuration/basic/). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored.
|
||||
Configured folders must be added to [allowlist_external_dirs](/integrations/homeassistant/#allowlist_external_dirs). Note that by default folder monitoring is recursive, meaning that the contents of sub-folders are also monitored.
|
||||
|
||||
## Configuration
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ ha_integration_type: integration
|
||||
|
||||
## Prerequisites
|
||||
|
||||
To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/docs/configuration/basic), or use your Nabu Casa account's webhook URL from the IFTTT integration.
|
||||
To be able to receive events from IFTTT, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/integrations/homeassistant/#allowlist_external_urls), or use your Nabu Casa account's webhook URL from the IFTTT integration.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
@ -111,11 +111,11 @@ When your screen looks like this, click the 'call service' button.
|
||||
By default, the trigger is sent to all the API keys from `configuration.yaml`. If you
|
||||
want to send the trigger to a specific key use the `target` field:
|
||||
|
||||
Field | Value
|
||||
----- | -----
|
||||
domain | `ifttt`
|
||||
service | `trigger`
|
||||
Service Data | `{"event": "EventName", "value1": "Hello World", "target": "YOUR_KEY_NAME1"}`
|
||||
| Field | Value |
|
||||
| ------------ | ----------------------------------------------------------------------------- |
|
||||
| domain | `ifttt` |
|
||||
| service | `trigger` |
|
||||
| Service Data | `{"event": "EventName", "value1": "Hello World", "target": "YOUR_KEY_NAME1"}` |
|
||||
|
||||
The `target` field can contain a single key name or a list of key names.
|
||||
|
||||
|
||||
@ -111,7 +111,7 @@ Once all zones are configured you'll be presented with the configuration for add
|
||||
|
||||
**Blink panel LED on when sending state change:** The desired LED behavior for the panel.
|
||||
|
||||
**Override default Home Assistant API host panel URL:** The Konnected Alarm Panel post sensor states back to the Home Assistant API. If this value is unchecked the panel will default postbacks using the URL [configured](/docs/configuration/basic) in Home Assistant. By default, the integration will use the internal URL. However, if you check this field and set the **Override API host URL** to your _local_ IP address and port (e.g., `http://192.168.1.101:8123`), it will be used instead of the internal URL.
|
||||
**Override default Home Assistant API host panel URL:** The Konnected Alarm Panel post sensor states back to the Home Assistant API. If this value is unchecked the panel will default postbacks using the URL [configured](/integrations/homeassistant/#allowlist_external_urls) in Home Assistant. By default, the integration will use the internal URL. However, if you check this field and set the **Override API host URL** to your _local_ IP address and port (e.g., `http://192.168.1.101:8123`), it will be used instead of the internal URL.
|
||||
|
||||
**Override API host URL (optional):** The host info to use if you checked **Override default Home Assistant API host panel URL** in the step above. This is ignored if **Override default Home Assistant API host panel URL** is unchecked.
|
||||
|
||||
|
||||
@ -12,7 +12,7 @@ ha_platforms:
|
||||
ha_integration_type: integration
|
||||
---
|
||||
|
||||
To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/docs/configuration/basic)).
|
||||
To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/integrations/homeassistant/#allowlist_external_urls).
|
||||
|
||||
To set it up, go to the integrations page in the configuration screen and find Mailgun. Click on configure. Follow the instructions on the screen to configure Mailgun.
|
||||
|
||||
|
||||
@ -218,7 +218,7 @@ action:
|
||||
|
||||
<div class='note'>
|
||||
|
||||
If you need to include a file from an external folder in your notifications, you will have to [list the source folder as allowed](/docs/configuration/basic/).
|
||||
If you need to include a file from an external folder in your notifications, you will have to [list the source folder as allowed](/integrations/homeassistant/#allowlist_external_dirs).
|
||||
|
||||
```yaml
|
||||
configuration.yaml
|
||||
|
||||
@ -99,4 +99,4 @@ data:
|
||||
media_content_id: "media-source://media_source/local/videos/favourites/Epic Sax Guy 10 Hours.mp4"
|
||||
```
|
||||
|
||||
[basic-configuration]: /docs/configuration/basic/#media_dirs
|
||||
[basic-configuration]: /integrations/homeassistant/#media_dirs
|
||||
@ -14,7 +14,7 @@ ha_integration_type: integration
|
||||
This integration adds interaction with [Minio](https://min.io).
|
||||
It also enables listening for bucket notifications: [see documentation](https://docs.min.io/docs/minio-client-complete-guide.html#watch)
|
||||
|
||||
To download or upload files, folders must be added to [allowlist_external_dirs](/docs/configuration/basic/).
|
||||
To download or upload files, folders must be added to [allowlist_external_dirs](/integrations/homeassistant/#allowlist_external_dirs).
|
||||
|
||||
## Configuration
|
||||
|
||||
@ -133,27 +133,27 @@ These services are provided:
|
||||
|
||||
Download file.
|
||||
|
||||
| Service data attribute | Required | Description |
|
||||
|---------------------------|----------|---------------------------------------------------|
|
||||
| `bucket` | yes | Bucket to use |
|
||||
| `key` | yes | Object key of the file |
|
||||
| `file_path` | yes | File path on the local file system |
|
||||
| Service data attribute | Required | Description |
|
||||
| ---------------------- | -------- | ---------------------------------- |
|
||||
| `bucket` | yes | Bucket to use |
|
||||
| `key` | yes | Object key of the file |
|
||||
| `file_path` | yes | File path on the local file system |
|
||||
|
||||
### Service `minio.put`
|
||||
|
||||
Upload file.
|
||||
|
||||
| Service data attribute | Required | Description |
|
||||
|---------------------------|----------|---------------------------------------------------|
|
||||
| `bucket` | yes | Bucket to use |
|
||||
| `key` | yes | Object key of the file |
|
||||
| `file_path` | yes | File path on the local file system |
|
||||
| Service data attribute | Required | Description |
|
||||
| ---------------------- | -------- | ---------------------------------- |
|
||||
| `bucket` | yes | Bucket to use |
|
||||
| `key` | yes | Object key of the file |
|
||||
| `file_path` | yes | File path on the local file system |
|
||||
|
||||
### Service `minio.remove`
|
||||
|
||||
Delete file.
|
||||
|
||||
| Service data attribute | Required | Description |
|
||||
|---------------------------|----------|---------------------------------------------------|
|
||||
| `bucket` | yes | Bucket to use |
|
||||
| `key` | yes | Object key of the file |
|
||||
| Service data attribute | Required | Description |
|
||||
| ---------------------- | -------- | ---------------------- |
|
||||
| `bucket` | yes | Bucket to use |
|
||||
| `key` | yes | Object key of the file |
|
||||
|
||||
@ -116,10 +116,10 @@ Set the heating schedule.
|
||||
|
||||
Set the preset mode for a Netatmo climate device. The preset mode must match a preset mode configured at Netatmo.
|
||||
|
||||
| Service data attribute | Required | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------------- |
|
||||
| Service data attribute | Required | Description |
|
||||
| ---------------------- | -------- | ----------------------------------------------------------- |
|
||||
| `preset_mode` | Yes | Climate preset mode such as Schedule, Away, or Frost Guard. |
|
||||
| `end_datetime` | Yes | Date & time until which the preset will be active. |
|
||||
| `end_datetime` | Yes | Date & time until which the preset will be active. |
|
||||
|
||||
### Set temperature with end date & time
|
||||
|
||||
@ -138,9 +138,9 @@ Sets the target temperature for a Netatmo climate device with an end date & time
|
||||
|
||||
Sets the target temperature for a Netatmo climate device as well as the time period during which this target temperature applies.
|
||||
|
||||
| Service data attribute | Required | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------ |
|
||||
| `target_temperature` | Yes | The target temperature for the device. |
|
||||
| Service data attribute | Required | Description |
|
||||
| ---------------------- | -------- | ----------------------------------------------------------- |
|
||||
| `target_temperature` | Yes | The target temperature for the device. |
|
||||
| `time_period` | Yes | Time period during which the target temperature is applied. |
|
||||
|
||||
### Clear temperature setting
|
||||
@ -187,7 +187,7 @@ It is therefore recommended to use [an individual development account](#developm
|
||||
|
||||
</div>
|
||||
|
||||
To be able to receive events from [Netatmo](https://www.netatmo.com/), your Home Assistant instance needs to be accessible from the web over port `443`. To achieve this you can either use your Nabu Casa account or for example Duck DNS ([Home Assistant instructions](/addons/duckdns/)). You also need to have the external URL configured in the Home Assistant [configuration](/docs/configuration/basic).
|
||||
To be able to receive events from [Netatmo](https://www.netatmo.com/), your Home Assistant instance needs to be accessible from the web over port `443`. To achieve this you can either use your Nabu Casa account or for example Duck DNS ([Home Assistant instructions](/addons/duckdns/)). You also need to have the external URL configured in the Home Assistant [configuration](/integrations/homeassistant/#allowlist_external_urls).
|
||||
|
||||
Events coming in from Netatmo will be available as an event in Home Assistant and are fired as `netatmo_event`, along with their data. You can use these events to trigger automations.
|
||||
|
||||
@ -297,7 +297,7 @@ Sign in using your username and password from your regular Netatmo account.
|
||||
|
||||
<div class='note warning'>
|
||||
|
||||
In your Netatmo Application configuration, do not enter a 'redirect URI' or a 'webhook URI'. The 'webhook URI' is automatically registered by this integration based on the external URL configured in the Home Assistant [configuration](/docs/configuration/basic).
|
||||
In your Netatmo Application configuration, do not enter a 'redirect URI' or a 'webhook URI'. The 'webhook URI' is automatically registered by this integration based on the external URL configured in the Home Assistant [configuration](/integrations/homeassistant/#editing-the-general-settings-in-yaml).
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@ -60,12 +60,12 @@ The Pushbullet notification platform sends messages to [Pushbullet](https://www.
|
||||
|
||||
Pushbullet is a notify platform and thus can be controlled by calling the notify service [as described here](/integrations/notify/). It will send a notification to all devices registered in the Pushbullet account. An optional **target** parameter can be given to Pushbullet to specify specific account's devices, contacts or channels.
|
||||
|
||||
Type | Prefix | Suffix | Example
|
||||
---- | ------ | ------ | -------
|
||||
Device | `device/` | Device nickname | `device/iphone`
|
||||
Channel | `channel/` | Channel tag | `channel/my_home`
|
||||
Email | `email/` | Contact's email address | `email/email@example.com`
|
||||
SMS | `sms/` | Contact's phone number | `sms/0612345678`
|
||||
| Type | Prefix | Suffix | Example |
|
||||
| ------- | ---------- | ----------------------- | ------------------------- |
|
||||
| Device | `device/` | Device nickname | `device/iphone` |
|
||||
| Channel | `channel/` | Channel tag | `channel/my_home` |
|
||||
| Email | `email/` | Contact's email address | `email/email@example.com` |
|
||||
| SMS | `sms/` | Contact's phone number | `sms/0612345678` |
|
||||
|
||||
If using targets, your own account's email address functions as 'send to all devices'. All targets are verified (if exists) before sending, except email.
|
||||
|
||||
@ -141,6 +141,6 @@ action:
|
||||
|
||||
<div class='note'>
|
||||
|
||||
Don't forget to [allowlist external directories](/docs/configuration/basic/), so Home Assistant has access to them.
|
||||
Don't forget to [allowlist external directories](/integrations/homeassistant/#allowlist_external_dirs), so Home Assistant has access to them.
|
||||
|
||||
</div>
|
||||
|
||||
@ -87,4 +87,4 @@ file_path:
|
||||
default: A temporary file is used.
|
||||
{% endconfiguration %}
|
||||
|
||||
The given **file_path** must be an existing file because the camera platform setup performs a writeable check on it. Also, keep in mind that the path should be [whitelisted](/docs/configuration/basic/).
|
||||
The given **file_path** must be an existing file because the camera platform setup performs a writeable check on it. Also, keep in mind that the path should be [whitelisted](/integrations/homeassistant/#allowlist_external_dirs).
|
||||
|
||||
@ -131,7 +131,7 @@ action:
|
||||
|
||||
### Text message with an attachment from a URL
|
||||
|
||||
To attach files from outside of Home Assistant, the URLs must be added to the [`allowlist_external_urls`](/docs/configuration/basic/#allowlist_external_urls) list.
|
||||
To attach files from outside of Home Assistant, the URLs must be added to the [`allowlist_external_urls`](/integrations/homeassistant/#allowlist_external_urls) list.
|
||||
|
||||
Note there is a 50MB size limit for attachments retrieved via URLs. You can also set `verify_ssl` to `false` to ignore SSL errors (default `true`).
|
||||
|
||||
|
||||
@ -137,30 +137,30 @@ One sensor entity will be created:
|
||||
|
||||
The following attributes can be placed inside the `data` key of the service call for extended functionality:
|
||||
|
||||
| Attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `username` | yes | The username of the Slack bot.
|
||||
| `icon` | yes | The icon of the Slack bot.
|
||||
| `file` | yes | A file to include with the message; see below.
|
||||
| `blocks` | yes | Array of [Slack blocks](https://api.slack.com/messaging/composing/layouts). *NOTE*: if using `blocks`, they are shown **in place of** the `message` within Slack apps. The message field will be used as notification text and anywhere else Slack is unable to display blocks. `message` is required regardless of whether this field is used.
|
||||
| `blocks_template` | yes | The same as `blocks`, but able to support [templates](https://www.home-assistant.io/docs/configuration/templating).
|
||||
| `thread_ts` | yes | Sends the message as a reply to a specified parent message.
|
||||
| Attribute | Optional | Description |
|
||||
| ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `username` | yes | The username of the Slack bot. |
|
||||
| `icon` | yes | The icon of the Slack bot. |
|
||||
| `file` | yes | A file to include with the message; see below. |
|
||||
| `blocks` | yes | Array of [Slack blocks](https://api.slack.com/messaging/composing/layouts). *NOTE*: if using `blocks`, they are shown **in place of** the `message` within Slack apps. The message field will be used as notification text and anywhere else Slack is unable to display blocks. `message` is required regardless of whether this field is used. |
|
||||
| `blocks_template` | yes | The same as `blocks`, but able to support [templates](https://www.home-assistant.io/docs/configuration/templating). |
|
||||
| `thread_ts` | yes | Sends the message as a reply to a specified parent message. |
|
||||
|
||||
Note that using `file` will ignore all usage of `blocks` and `blocks_template` (as Slack does not support those frameworks in messages that accompany uploaded files).
|
||||
|
||||
To include a local file with the Slack message, use these attributes underneath the `file` key:
|
||||
|
||||
| Attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `path` | no | A local filepath that has been [whitelisted](/docs/configuration/basic/#allowlist_external_dirs).
|
||||
| Attribute | Optional | Description |
|
||||
| --------- | -------- | --------------------------------------------------------------------------------------------------- |
|
||||
| `path` | no | A local filepath that has been [whitelisted](/integrations/homeassistant/#allowlist_external_dirs). |
|
||||
|
||||
To include a remote file with the Slack message, use these attributes underneath the `file` key:
|
||||
|
||||
| Attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `url` | no | A URL that has been [whitelisted](/docs/configuration/basic/#allowlist_external_urls).
|
||||
| `username` | yes | An optional username if the URL is protected by HTTP Basic Auth.
|
||||
| `password` | yes | An optional password if the URL is protected by HTTP Basic Auth.
|
||||
| Attribute | Optional | Description |
|
||||
| ---------- | -------- | ---------------------------------------------------------------------------------------- |
|
||||
| `url` | no | A URL that has been [whitelisted](/integrations/homeassistant/#allowlist_external_urls). |
|
||||
| `username` | yes | An optional username if the URL is protected by HTTP Basic Auth. |
|
||||
| `password` | yes | An optional password if the URL is protected by HTTP Basic Auth. |
|
||||
|
||||
### Obtaining a member ID
|
||||
|
||||
|
||||
@ -64,7 +64,7 @@ The PAT is used to create a Home Assistant SmartApp in your SmartThings account
|
||||
This integration requires an internet accessible incoming webhook to receive push updates from SmartThings. The preferred approach is to subscribe to [Home Assistant Cloud (Nabu Casa)](https://www.nabucasa.com/) and the integration will configure and use a cloudhook automatically. Alternatively, you will have to configure and setup an internet accessible webhook in Home Assistant as described below:
|
||||
|
||||
1. Setup [remote access](/docs/configuration/remote/) via a domain name secured with SSL. *Self-signed SSL certificates are not supported by the SmartThings Cloud API.*
|
||||
2. Set the external URL in the Home Assistant [configuration](/docs/configuration/basic) to the URL that Home Assistant is available on the internet (this must start with `https://`). If you do not use Nabu Casa you must configure your network to allow TCP traffic from the internet to reach the IP address and port of the device running Home Assistant.
|
||||
2. Set the external URL in the Home Assistant [configuration](/integrations/homeassistant/#external_url) to the URL that Home Assistant is available on the internet (this must start with `https://`). If you do not use Nabu Casa you must configure your network to allow TCP traffic from the internet to reach the IP address and port of the device running Home Assistant.
|
||||
|
||||
## Setup instructions
|
||||
|
||||
@ -115,7 +115,7 @@ The integration will trigger an event when a device with the [button](https://de
|
||||
| `component_id` | Describes which integration of the device triggered the event. `main` represents the parent device. For devices with child-devices, this attribute identifies the child that raised the event. For multi-button devices, the current SmartThings API will no longer pass the ButtonNumber but use a child component_id for each button. The device handler installed on SmartThings must be able to create those child components. |
|
||||
| `device_id` | The unique id of the device in SmartThings. This can be located in the Home Assistant device registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/). |
|
||||
| `location_id` | The unique id of the location the device is part of. This can be found in the configuration entry registry or in the [SmartThings Developer Workspace](https://smartthings.developer.samsung.com/workspace/). |
|
||||
| `value` | Describes the action taken on the button. See the [button](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#button) capability reference for a list of possible values (not all are supported by every device). |
|
||||
| `value` | Describes the action taken on the button. See the [button](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#button) capability reference for a list of possible values (not all are supported by every device). |
|
||||
| `name` | The name given to the device in SmartThings. |
|
||||
|
||||
Event data payloads are logged at the debug level, see [debugging](#debugging) for more information.
|
||||
@ -140,8 +140,8 @@ Support for additional platforms will be added in the future.
|
||||
|
||||
The SmartThings binary sensor platform lets you view devices that have binary sensor-related capabilities. A binary sensor entity will be created for each attribute (below) supported by the device.
|
||||
|
||||
| Capability | Attribute | On-Value |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ---------- |
|
||||
| Capability | Attribute | On-Value |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------- | -------------- | ---------- |
|
||||
| [`accelerationSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#accelerationSensor) | `acceleration` | `active` |
|
||||
| [`contactSensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#contactSensor) | `contact` | `open` |
|
||||
| [`filterStatus`](https://developer.smartthings.com/docs/devices/capabilities/proposed#filterStatus) | `filterStatus` | `replace` |
|
||||
@ -159,8 +159,8 @@ The SmartThings Climate platform lets you control devices that have air conditio
|
||||
|
||||
For a SmartThings Air Conditioner to be represented by the climate platform, it must have all of the following required capabilities:
|
||||
|
||||
| Capability | Climate Features |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Capability | Climate Features |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [`airConditionerMode`](https://developer.smartthings.com/docs/devices/capabilities/proposed#airConditionerMode) (required) | `hvac mode`, `hvac action` |
|
||||
| [`airConditionerFanMode`](https://developer.smartthings.com/docs/devices/capabilities/proposed#airConditionerFanMode) (required) | `fan mode` |
|
||||
| [`temperatureMeasurement`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#temperatureMeasurement) (required) | `temperature` |
|
||||
@ -171,8 +171,8 @@ For a SmartThings Air Conditioner to be represented by the climate platform, it
|
||||
|
||||
For a SmartThings thermostat to be represented by the climate platform, it must have all the capabilities from either "set a" _or_ "set b":
|
||||
|
||||
| Capability | Climate Features |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| Capability | Climate Features |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
|
||||
| [`thermostat`](https://developer.smartthings.com/docs/devices/capabilities/deprecated#thermostat) (set a) | `hvac mode`, `hvac action`, `target temp high`, `target temp low` and `fan mode` |
|
||||
| [`thermostatMode`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatMode) (set b) | `hvac mode` |
|
||||
| [`thermostatCoolingSetpoint`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#thermostatCoolingSetpoint) (seb b) | `target temp low` |
|
||||
@ -186,29 +186,29 @@ For a SmartThings thermostat to be represented by the climate platform, it must
|
||||
|
||||
The SmartThings Cover platform lets you control devices that have open/close related capabilities. For a device to be represented by the cover platform, it must have one of the capabilities from "set a" below.
|
||||
|
||||
| Capability | Cover Features |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
|
||||
| [`doorControl`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#doorControl) (set a) | `open` and `close` |
|
||||
| [`garageDoorControl`](https://developer.smartthings.com/docs/devices/capabilities/deprecated#garageDoorControl) (seb a) | `open` and `close` |
|
||||
| [`windowShade`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#windowShade) (set a) | `open` and `close` |
|
||||
| [`switchLevel`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#switchLevel) | `position` |
|
||||
| [`windowShadeLevel`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference/#windowShadeLevel) | `position` |
|
||||
| [`battery`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#battery) | `battery_level` (state attribute) |
|
||||
| Capability | Cover Features |
|
||||
| -------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
|
||||
| [`doorControl`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#doorControl) (set a) | `open` and `close` |
|
||||
| [`garageDoorControl`](https://developer.smartthings.com/docs/devices/capabilities/deprecated#garageDoorControl) (seb a) | `open` and `close` |
|
||||
| [`windowShade`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#windowShade) (set a) | `open` and `close` |
|
||||
| [`switchLevel`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#switchLevel) | `position` |
|
||||
| [`windowShadeLevel`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference/#windowShadeLevel) | `position` |
|
||||
| [`battery`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#battery) | `battery_level` (state attribute) |
|
||||
|
||||
### Fan
|
||||
|
||||
The SmartThings Fan platform lets you control devices that have fan-related capabilities. For a SmartThings device to be represented by the fan platform, it must have one or more of the capabilities below in addition to the [`switch`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Switch) capability.
|
||||
|
||||
| Capability | Fan Features |
|
||||
| ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
|
||||
| Capability | Fan Features |
|
||||
| --------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
|
||||
| [`fanSpeed`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#fanSpeed) | `speed` (`off`, `low`, `medium`, and `high`) |
|
||||
|
||||
### Light
|
||||
|
||||
The SmartThings Light platform lets you control devices that have light-related capabilities. For a SmartThings device to be represented by the light platform, it must have one or more of the capabilities below in addition to the [`switch`](https://smartthings.developer.samsung.com/develop/api-ref/capabilities.html#Switch) capability.
|
||||
|
||||
| Capability | Light Features |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
|
||||
| Capability | Light Features |
|
||||
| ------------------------------------------------------------------------------------------------------------------------- | ----------------------------- |
|
||||
| [`switchLevel`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#switchLevel) | `brightness` and `transition` |
|
||||
| [`colorControl`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#colorControl) | `color` |
|
||||
| [`colorTemperature`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#colorTemperature) | `color_temp` |
|
||||
@ -221,8 +221,8 @@ The SmartThings Lock platform lets you control devices that have the [`lock`](ht
|
||||
|
||||
The SmartThings Sensor platform lets your view devices that have sensor-related capabilities. A Sensor entity is created for each attribute (below) supported by the device.
|
||||
|
||||
| Capability | Attributes |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| Capability | Attributes |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| [`activityLightingMode`](https://developer.smartthings.com/docs/devices/capabilities/proposed#activityLightingMode) | `lightingMode` |
|
||||
| [`airConditionerMode`](https://developer.smartthings.com/docs/devices/capabilities/proposed#airConditionerMode) | `airConditionerMode` |
|
||||
| [`airQualitySensor`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#airQualitySensor) | `airQuality` |
|
||||
@ -286,8 +286,8 @@ The SmartThings Scene platform lets you activate scenes defined in SmartThings w
|
||||
|
||||
The SmartThings Switch platform lets you control devices that have the [`switch`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#switch) capability that are not already represented by a more specific platform. The following optional capabilities will provide energy and power utilization information:
|
||||
|
||||
| Capability | Switch Features |
|
||||
| ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| Capability | Switch Features |
|
||||
| --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| [`energyMeter`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#energyMeter) | energy consumption (`today_energy_kwh` state attribute) |
|
||||
| [`powerMeter`](https://developer.smartthings.com/docs/devices/capabilities/capabilities-reference#powerMeter) | power consumption (`current_power_w` state attribute) |
|
||||
|
||||
|
||||
@ -134,7 +134,7 @@ The optional `images` field adds image attachments to the email. If `html` is de
|
||||
|
||||
<div class='note info'>
|
||||
|
||||
When adding images, make sure the folders containing the attachments are added to `allowlist_external_dirs`.<br>See: [Setup basic documentation](/docs/configuration/basic/)
|
||||
When adding images, make sure the folders containing the attachments are added to `allowlist_external_dirs`.<br>See: [Setup basic documentation](/integrations/homeassistant/#allowlist_external_dirs)
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@ -265,7 +265,7 @@ inline_keyboard:
|
||||
|
||||
<div class='note'>
|
||||
|
||||
Since Home Assistant version 0.48 you have to [whitelist the source folder](/docs/configuration/basic/) of the file you want to include in the notification.
|
||||
Since Home Assistant version 0.48 you have to [whitelist the source folder](/integrations/homeassistant/#allowlist_external_dirs) of the file you want to include in the notification.
|
||||
|
||||
```yaml
|
||||
configuration.yaml
|
||||
|
||||
@ -10,7 +10,7 @@ ha_domain: telegram_bot
|
||||
|
||||
Telegram chatbot webhooks implementation as described in the Telegram [documentation](https://core.telegram.org/bots/webhooks).
|
||||
|
||||
By default this integration sets your bot's webhook URL automatically to `https://<external_url>/api/telegram_webhooks` with the external_url of your Home Assistant [configuration](/docs/configuration/basic/) using Telegrams `setWebhook` method.
|
||||
By default this integration sets your bot's webhook URL automatically to `https://<external_url>/api/telegram_webhooks` with the external_url of your Home Assistant [configuration](/integrations/homeassistant/#external_url) using Telegrams `setWebhook` method.
|
||||
|
||||
This is one of two bot implementations supported by Telegram. Described by Telegram as the preferred implementation but requires your Home Assistant instance to be exposed to the internet.
|
||||
The other implementation method is [Telegram polling](/integrations/telegram_polling/), for which your Home Assistant instance does not have to be exposed to the internet.
|
||||
@ -48,7 +48,7 @@ proxy_url:
|
||||
required: false
|
||||
type: string
|
||||
url:
|
||||
description: Allow to overwrite the external URL from the Home Assistant [configuration](/docs/configuration/basic/) for different setups (`https://<public_url>:<port>`).
|
||||
description: Allow to overwrite the external URL from the Home Assistant [configuration](/integrations/homeassistant/#editing-the-general-settings-in-yaml) for different setups (`https://<public_url>:<port>`).
|
||||
required: false
|
||||
type: string
|
||||
trusted_networks:
|
||||
|
||||
@ -84,40 +84,40 @@ All Transmission services require integration `entry_id`. To find it, go to Deve
|
||||
|
||||
### Service `add_torrent`
|
||||
|
||||
Adds a new torrent to download. It can either be a URL (HTTP, HTTPS or FTP), magnet link or a local file (make sure that the path is [white listed](/docs/configuration/basic/#allowlist_external_dirs)).
|
||||
Adds a new torrent to download. It can either be a URL (HTTP, HTTPS or FTP), magnet link or a local file (make sure that the path is [white listed](/integrations/homeassistant/#allowlist_external_dirs)).
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entry_id` | no | The integration entry_id
|
||||
| `torrent` | no | Torrent to download
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------ |
|
||||
| `entry_id` | no | The integration entry_id |
|
||||
| `torrent` | no | Torrent to download |
|
||||
|
||||
### Service `remove_torrent`
|
||||
|
||||
Removes a torrent from the client.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entry_id` | no | The integration entry_id
|
||||
| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors
|
||||
| `delete_data` | yes | Delete torrent data (Default: false)
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------------------------------- |
|
||||
| `entry_id` | no | The integration entry_id |
|
||||
| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors |
|
||||
| `delete_data` | yes | Delete torrent data (Default: false) |
|
||||
|
||||
### Service `start_torrent`
|
||||
|
||||
Starts a torrent.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entry_id` | no | The integration entry_id
|
||||
| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------------------------------- |
|
||||
| `entry_id` | no | The integration entry_id |
|
||||
| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors |
|
||||
|
||||
### Service `stop_torrent`
|
||||
|
||||
Stops a torrent.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entry_id` | no | The integration entry_id
|
||||
| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------------------------------- |
|
||||
| `entry_id` | no | The integration entry_id |
|
||||
| `id` | no | ID of the torrent, can be found in the `torrent_info` attribute of the `*_torrents` sensors |
|
||||
|
||||
## Templating
|
||||
|
||||
|
||||
@ -133,7 +133,7 @@ $ curl -X POST -H "Authorization: Bearer <ACCESS TOKEN>" \
|
||||
|
||||
<div class='note'>
|
||||
|
||||
Depending on your setup, you might need to set an external URL (`external_url`) inside the [configuration](/docs/configuration/basic/).
|
||||
Depending on your setup, you might need to set an external URL (`external_url`) inside the [configuration](/integrations/homeassistant/#external_url).
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
@ -41,7 +41,7 @@ auth_token:
|
||||
|
||||
After configuring the base Twilio integration, add and configure either or both of the [Twilio SMS](/integrations/twilio_sms) and [Twilio Phone](/integrations/twilio_call) integrations to utilize the notification functionality.
|
||||
|
||||
To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/docs/configuration/basic) in Home Assistant.
|
||||
To be able to receive events from Twilio, your Home Assistant instance needs to be accessible from the web and you need to have the external URL [configured](/integrations/homeassistant/#external_url) in Home Assistant.
|
||||
|
||||
To set it up, go to the integrations page in the configuration screen and find Twilio. Click on configure. Follow the instructions on the screen to configure Twilio.
|
||||
|
||||
|
||||
@ -108,11 +108,11 @@ Available services: `enable_motion_detection`, `disable_motion_detection`, `snap
|
||||
|
||||
Play a live stream from a camera to selected media player(s). Requires [`stream`](/integrations/stream) {% term integration %} to be set up.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | Name of {% term entity %} to fetch stream from, e.g., `camera.front_door_camera`. |
|
||||
| `media_player` | no | Name of media player to play stream on, e.g., `media_player.living_room_tv`. |
|
||||
| `format` | yes | Stream format supported by `stream` {% term integration %} and selected `media_player`. Default: `hls` |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------ |
|
||||
| `entity_id` | no | Name of {% term entity %} to fetch stream from, e.g., `camera.front_door_camera`. |
|
||||
| `media_player` | no | Name of media player to play stream on, e.g., `media_player.living_room_tv`. |
|
||||
| `format` | yes | Stream format supported by `stream` {% term integration %} and selected `media_player`. Default: `hls` |
|
||||
|
||||
For example, the following action in an automation would send an `hls` live stream to your chromecast.
|
||||
|
||||
@ -129,28 +129,28 @@ action:
|
||||
|
||||
Enable motion detection in a camera. Currently, this will enable the first event configured on the camera.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Name(s) of entities to enable motion detection, e.g., `camera.front_door_camera`. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | --------------------------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Name(s) of entities to enable motion detection, e.g., `camera.front_door_camera`. |
|
||||
|
||||
#### Service `disable_motion_detection`
|
||||
|
||||
Disable the motion detection in a camera. Currently, this will disable the first event configured on the camera.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | yes | Name(s) of entities to disable motion detection, e.g., `camera.front_door_camera`. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Name(s) of entities to disable motion detection, e.g., `camera.front_door_camera`. |
|
||||
|
||||
#### Service `snapshot`
|
||||
|
||||
Take a snapshot from a camera.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.front_door_camera`. |
|
||||
| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}`{% endraw %}. |
|
||||
| Service data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
|
||||
| `entity_id` | no | Name(s) of entities to create a snapshot from, e.g., `camera.front_door_camera`. |
|
||||
| `filename` | no | Template of a file name. Variable is `entity_id`, e.g., {% raw %}`/tmp/snapshot_{{ entity_id }}`{% endraw %}. |
|
||||
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/docs/configuration/basic/) section of your `configuration.yaml` file.
|
||||
The path part of `filename` must be an entry in the `allowlist_external_dirs` in your [`homeassistant:`](/integrations/homeassistant/#allowlist_external_dirs) section of your `configuration.yaml` file.
|
||||
|
||||
For example, the following action is an automation that would take a snapshot from "front_door_camera" and save it to /tmp with a timestamped filename.
|
||||
|
||||
|
||||
@ -256,6 +256,7 @@ layout: null
|
||||
# Redirect for the QR Codes on the S3 Box
|
||||
/s3-box-no-wifi /voice_control/troubleshooting_the_s3_box/#error-unable-to-connect-to-wi-fi
|
||||
/s3-box-no-ha /voice_control/troubleshooting_the_s3_box/#error-no-home-assistant
|
||||
|
||||
/docs/assist/troubleshooting/ /voice_control/troubleshooting/
|
||||
/docs/assist/worlds-most-private-voice-assistant/ /voice_control/worlds-most-private-voice-assistant/
|
||||
/projects/worlds-most-private-voice-assistant/ /voice_control/worlds-most-private-voice-assistant/
|
||||
@ -263,6 +264,9 @@ layout: null
|
||||
/draw_assist /voice_control/s3-box-customize/#to-draw-your-own-images
|
||||
/projects/thirteen-usd-voice-remote/ /voice_control/thirteen-usd-voice-remote/
|
||||
/docs/backend/updater /integrations/analytics
|
||||
/docs/configuration/basic/#allowlist_external_urls /integrations/homeassistant/#allowlist_external_urls
|
||||
/docs/configuration/basic/#allowlist_external_dirs /integrations/homeassistant/#allowlist_external_dirs
|
||||
/docs/configuration/basic/#external_urls /integrations/homeassistant/#external_urls
|
||||
/docs/configuration/customizing-devices/#device-class /integrations/homeassistant/#device-class
|
||||
/docs/configuration/customizing-devices/#customizing-entities /integrations/homeassistant/#editing-the-entity-settings-in-yaml
|
||||
/docs/ecosystem/ios/ https://companion.home-assistant.io/
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user