mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
Rename Services to Actions in integrations: D (#33809)
* Rename Services to Actions in integrations: D * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
This commit is contained in:
parent
83a6006ff3
commit
bca3f3983b
@ -67,12 +67,12 @@ If this situation applies to you, you may need to adjust your firewall(s) accord
|
||||
|
||||
The `daikin` climate platform integrates Daikin air conditioning systems into Home Assistant, enabling control of setting the following parameters:
|
||||
|
||||
- [**set_hvac_mode**](/integrations/climate/#service-climateset_hvac_mode) (`off`, `heat`, `cool`, `heat_cool`, or `fan_only`)
|
||||
- [**target temperature**](/integrations/climate#service-climateset_temperature)
|
||||
- [**turn on/off**](/integrations/climate#service-climateturn_on)
|
||||
- [**fan mode**](/integrations/climate#service-climateset_fan_mode) (speed)
|
||||
- [**swing mode**](/integrations/climate#service-climateset_swing_mode)
|
||||
- [**set_preset_mode**](/integrations/climate#service-climateset_preset_mode) (away, none)
|
||||
- [**set_hvac_mode**](/integrations/climate/#action-climateset_hvac_mode) (`off`, `heat`, `cool`, `heat_cool`, or `fan_only`)
|
||||
- [**target temperature**](/integrations/climate#action-climateset_temperature)
|
||||
- [**turn on/off**](/integrations/climate#action-climateturn_on)
|
||||
- [**fan mode**](/integrations/climate#action-climateset_fan_mode) (speed)
|
||||
- [**swing mode**](/integrations/climate#action-climateset_swing_mode)
|
||||
- [**set_preset_mode**](/integrations/climate#action-climateset_preset_mode) (away, none)
|
||||
|
||||
Current inside temperature is displayed.
|
||||
|
||||
|
@ -17,17 +17,17 @@ The **Date** {% term integration %} is built for the controlling and monitoring
|
||||
|
||||
If you are looking for a way to create a similar entity, please take a look at the [Date/Time helper](/integrations/input_datetime).
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
### Date services
|
||||
### Date actions
|
||||
|
||||
Available {% term services %}: `date.set_value`
|
||||
Available {% term actions %}: `date.set_value`
|
||||
|
||||
### Service `date.set_value`
|
||||
### Action`date.set_value`
|
||||
|
||||
Set a new value for the date {% term entity %}.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------- |
|
||||
| `entity_id` | no | String or list of strings that point at `entity_id`'s of dates to control.
|
||||
| `date` | no | New date value to set.
|
||||
|
@ -17,17 +17,17 @@ The **Date/Time** {% term integration %} is built for the controlling and monito
|
||||
|
||||
If you are looking for a way to create a Date/Time entity, please take a look at the [Date/Time helper](/integrations/input_datetime).
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
### datetime services
|
||||
### datetime actions
|
||||
|
||||
Available {% term services %}: `datetime.set_value`
|
||||
Available {% term actions %}: `datetime.set_value`
|
||||
|
||||
### Service `datetime.set_value`
|
||||
### Action `datetime.set_value`
|
||||
|
||||
Set a new value for the datetime {% term entity %}.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `entity_id` | no | String or list of strings that point at `entity_id`'s of datetimes to control. |
|
||||
| `datetime` | no | New datetime value to set. If timezone is not included, the Home Assistant instance's timezone will be used. |
|
||||
|
@ -23,7 +23,7 @@ the default library used by Visual Studio Code.
|
||||
|
||||
This is useful in testing changes on a local development install, or connecting
|
||||
to a production server to debug issues. It is possible to load the integration
|
||||
without activating the debugger, but injecting it with a service call. This
|
||||
without activating the debugger, but injecting it with an action. This
|
||||
is particularly useful on a developer's production system as it does not impact
|
||||
performance when not injected.
|
||||
|
||||
@ -53,7 +53,7 @@ port:
|
||||
default: 5678
|
||||
type: integer
|
||||
start:
|
||||
description: "If `true`, the debugger will be injected on start of Home Assistant. Set it to false to inject it on demand using the `debugpy.start` service call."
|
||||
description: "If `true`, the debugger will be injected on start of Home Assistant. Set it to false to inject it on demand using the `debugpy.start` action."
|
||||
required: false
|
||||
default: true
|
||||
type: boolean
|
||||
@ -81,7 +81,7 @@ persistent (production) server, unless absolutely required.
|
||||
|
||||
Alternatively, the integration can be loaded by setting the `start` option
|
||||
to `false`. This will prevent the debugger from being injected, instead,
|
||||
it will be injected on-demand by calling the `debugpy.start` service.
|
||||
it will be injected on-demand by calling the `debugpy.start` action.
|
||||
|
||||
## Waiting at startup
|
||||
|
||||
@ -112,10 +112,10 @@ debugpy:
|
||||
|
||||
This is useful for multi-homed servers, or for localhost only access
|
||||
|
||||
## Service `debugpy.start`
|
||||
## Action `debugpy.start`
|
||||
|
||||
When the `start` option of the integration has been set to `false`, one can
|
||||
use the `debugpy.start` service call to inject and start the remote Python
|
||||
use the `debugpy.start` action to inject and start the remote Python
|
||||
debugger at runtime.
|
||||
|
||||
Please note: There is no way to stop it once started, this would require
|
||||
|
@ -89,15 +89,15 @@ If you are having issues and want to report a problem, always start with making
|
||||
|
||||
If the state of {% term entities %} are only reflected in Home Assistant when the {% term integration %} is loaded (during restart, reload, setup) you probably have an issue with the WebSocket configuration where your deCONZ instance is running. The deCONZ integration uses the WebSocket port provided by the deCONZ REST API. If you're running the deCONZ Docker container make sure that it properly configures the WebSocket port so deCONZ can report what port is exposed outside of the containerized environment. Also, make sure to review firewall rules that might block communication over certain ports.
|
||||
|
||||
## Device services
|
||||
## Device actions
|
||||
|
||||
Available services: `configure`, `deconz.device_refresh` and `deconz.remove_orphaned_entries`.
|
||||
Available actions: `configure`, `deconz.device_refresh` and `deconz.remove_orphaned_entries`.
|
||||
|
||||
### Service `deconz.configure`
|
||||
### Action `deconz.configure`
|
||||
|
||||
Set the attribute of device in deCONZ using [REST-API](https://dresden-elektronik.github.io/deconz-rest-doc/about_rest/).
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | --------------------------------------------------------------------------- |
|
||||
| `field` | No | String representing a specific device in deCONZ. |
|
||||
| `entity` | No | String representing a specific Home Assistant entity of a device in deCONZ. |
|
||||
@ -121,17 +121,21 @@ Either `entity` or `field` must be provided. If both are present, `field` will b
|
||||
{ "field": "/config", "data": {"permitjoin": 60} }
|
||||
```
|
||||
|
||||
### Service `deconz.device_refresh`
|
||||
### Action `deconz.device_refresh`
|
||||
|
||||
Refresh with devices added to deCONZ after Home Assistants latest restart.
|
||||
|
||||
Note: deCONZ automatically signals Home Assistant when new {% term sensors %} are added, but other devices must at this point in time (deCONZ v2.05.35) be added manually using this service or a restart of Home Assistant.
|
||||
{% note %}
|
||||
deCONZ automatically signals Home Assistant when new {% term sensors %} are added, but other devices must at this point in time (deCONZ v2.05.35) be added manually using this action or a restart of Home Assistant.
|
||||
{% endnote %}
|
||||
|
||||
### Service `deconz.remove_orphaned_entries`
|
||||
### Action `deconz.remove_orphaned_entries`
|
||||
|
||||
Remove entries from {% term entity %} and device registry which are no longer provided by deCONZ.
|
||||
|
||||
Note: it is recommended to use this {% term service %} after a restart of Home Assistant Core in order to have deCONZ integration properly mirrored to deCONZ.
|
||||
{% note %}
|
||||
It is recommended to use this {% term action %} after a restart of Home Assistant Core in order to have deCONZ integration properly mirrored to deCONZ.
|
||||
{% endnote %}
|
||||
|
||||
## Remote control devices
|
||||
|
||||
|
@ -150,15 +150,15 @@ A few notes:
|
||||
- To remotely power on Marantz receivers with Home Assistant, the Auto-Standby feature must be enabled in the receiver's settings.
|
||||
- Sound mode: The command to set a specific sound mode is different from the value of the current sound mode reported by the receiver (sound_mode_raw). There is a key-value structure (sound_mode_dict) that matches the raw sound mode to one of the possible commands to set a sound mode (for instance {'MUSIC':['PLII MUSIC']}. If you get a "Not able to match sound mode" warning, please open an issue on the [denonavr library](https://github.com/ol-iver/denonavr), stating which raw sound mode could not be matched so it can be added to the matching dictionary. You can find the current raw sound mode under **Developer Tools** -> **States**.
|
||||
|
||||
#### Service `denonavr.get_command`
|
||||
#### Action `denonavr.get_command`
|
||||
|
||||
Denon AVR receivers support a simple text-based network interface for sending commands to the receiver over the network. You can access this interface via the `denonavr.get_command` service. In addition, IR remote codes can also be sent to this interface.
|
||||
Denon AVR receivers support a simple text-based network interface for sending commands to the receiver over the network. You can access this interface via the `denonavr.get_command` action. In addition, IR remote codes can also be sent to this interface.
|
||||
|
||||
A list of network commands supported by the various Denon AVR receivers can be [found here](https://www.heimkinoraum.de/upload/files/product/IP_Protocol_AVR-Xx100.pdf). A list of IR codes can be [found here](https://assets.denon.com/DocumentMaster/UK/AVR3313_IR_CODE_V01.pdf).
|
||||
|
||||
To use these commands, call the `denonavr.get_command` service and append the specific command to the path `/goform/formiPhoneAppDirect.xml?`:
|
||||
To use these commands, call the `denonavr.get_command` action and append the specific command to the path `/goform/formiPhoneAppDirect.xml?`:
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------- |
|
||||
| `entity_id` | no | Name of entity to send command to. For example `media_player.marantz`|
|
||||
| `command` | no | Command to send to device, e.g., `/goform/formiPhoneAppDirect.xml?VSMONI2`|
|
||||
@ -167,24 +167,24 @@ So for example, the above command `/goform/formiPhoneAppDirect.xml?VSMONI2` will
|
||||
|
||||
{% tip %}
|
||||
|
||||
The denonavr platform supports the standard media player controls such as `turn_on` and `volume_up`. Thus calling the service `media_player.turn_on` is equivalent to calling `denonavr.get_command` with the command `/goform/formiPhoneAppDirect.xml?PWON`. See [media_player](/integrations/media_player/) for more details.
|
||||
The denonavr platform supports the standard media player controls such as `turn_on` and `volume_up`. Thus calling the `media_player.turn_on` action is equivalent to calling `denonavr.get_command` with the command `/goform/formiPhoneAppDirect.xml?PWON`. See [media_player](/integrations/media_player/) for more details.
|
||||
|
||||
{% endtip %}
|
||||
|
||||
#### Service `denonavr.set_dynamic_eq`
|
||||
#### Action `denonavr.set_dynamic_eq`
|
||||
|
||||
Enable or disable DynamicEQ setting.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------- |
|
||||
| `entity_id` | yes | Name of entity to send command to. For example `media_player.marantz`|
|
||||
| `dynamic_eq` | no | True/false for enable/disable.|
|
||||
|
||||
#### Service `denonavr.update_audyssey`
|
||||
#### Action `denonavr.update_audyssey`
|
||||
|
||||
Update Audyssey settings. This can take up to 10 Seconds for some receivers.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------------- |
|
||||
| `entity_id` | yes | Name of entity to send command to. For example `media_player.marantz`|
|
||||
|
||||
|
@ -37,4 +37,4 @@ Known supported devices:
|
||||
|
||||
## Turning off the device
|
||||
|
||||
The media player `turn off` button and the service `media_player.turn_off` will turn off all the devices of the designated system. Exiting OFF mode is only possible by pressing a physical button on each device.
|
||||
The media player `turn off` button and the `media_player.turn_off` action will turn off all the devices of the designated system. Exiting OFF mode is only possible by pressing a physical button on each device.
|
||||
|
@ -103,11 +103,11 @@ In the example above, `devicename` refers to the detected name of the device. F
|
||||
|
||||
The state of your tracked device will be `'home'` if it is in the [home zone](/integrations/zone#home-zone), detected by your network or Bluetooth based presence detection. If you're using a presence detection method that includes coordinates then when it's in a zone the state will be the name of the zone (case sensitive). When a device isn't at home and isn't in any zone, the state will be `'not_home'`.
|
||||
|
||||
## `device_tracker.see` service
|
||||
## `device_tracker.see` action
|
||||
|
||||
The `device_tracker.see` service can be used to manually update the state of a device tracker:
|
||||
The `device_tracker.see` action can be used to manually update the state of a device tracker:
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | --------------------------------------------------------------------------------------- |
|
||||
| `dev_id` | no | The `object_id`, for example `tardis` for `device_tracker.tardis` |
|
||||
| `location_name` | yes | The location, `home`, `not_home`, or the name of the zone |
|
||||
|
@ -32,7 +32,7 @@ There are two Dexcom Share servers, `US` for United States customers, and `OUS`
|
||||
|
||||
### Unit of measurement
|
||||
|
||||
The integrations allows both `mg/dL` and `mmol/l` units of measurement for blood glucose values. To change your preferred unit of measurement, go to **Settings** -> **Devices & Services** in the UI, and click `OPTIONS`.
|
||||
The integrations allow both `mg/dL` and `mmol/l` units of measurement for blood glucose values. To change your preferred unit of measurement, go to **Settings** -> **Devices & services** in the UI, and click `OPTIONS`.
|
||||
|
||||
## Sensor
|
||||
|
||||
|
@ -30,15 +30,15 @@ This is done via series of settings found via **Menu** > **Settings & Help** > *
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
### Media control services
|
||||
### Media control actions
|
||||
|
||||
Available {% term services %}: turn_on, turn_off, media_play, media_pause, media_stop, media_next_track, media_previous_track, play_media
|
||||
Available {% term actions %}: turn_on, turn_off, media_play, media_pause, media_stop, media_next_track, media_previous_track, play_media
|
||||
|
||||
#### Service `media_player.play_media`
|
||||
#### Action `media_player.play_media`
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| -----------------------| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `entity_id` | yes | Target a specific media player. Defaults to all. |
|
||||
| `media_content_id` | no | The channel number to change to. |
|
||||
@ -94,7 +94,7 @@ At the moment, the following buttons are supported:
|
||||
- `dash`
|
||||
- `enter`
|
||||
|
||||
A typical service call for press several buttons looks like this.
|
||||
A typical action for pressing several buttons looks like this.
|
||||
|
||||
```yaml
|
||||
service: remote.send_command
|
||||
|
@ -29,7 +29,7 @@ Once the application is ready, create a [bot](https://discordapp.com/developers/
|
||||
Retrieve the **Application ID** from the 'General Information' section and the (hidden) **Token** of your bot for later.
|
||||
|
||||
{% note %}
|
||||
The name you give your application on the [Discord My Apps page](https://discordapp.com/developers/applications/me) will determine the name of the notify service. For example: if you enter "Discord Chat", the service will be named `notify.discord_chat`.
|
||||
The name you give your application on the [Discord My Apps page](https://discordapp.com/developers/applications/me) will determine the name of the notify action. For example: if you enter "Discord Chat", the action will be named `notify.discord_chat`.
|
||||
{% endnote %}
|
||||
|
||||
### Setting up the bot
|
||||
@ -56,7 +56,7 @@ Once the bot has been added to your server, get the channel ID of the channel yo
|
||||
|
||||
Right click channel name and copy the channel ID (**Copy ID**).
|
||||
|
||||
This channel or a user ID has to be used as the target when calling the notification service. Multiple channel or user IDs can be specified, across multiple servers or direct messages.
|
||||
This channel or a user ID has to be used as the target when calling the notification action. Multiple channel or user IDs can be specified, across multiple servers or direct messages.
|
||||
|
||||
## Add Discord integration to Home Assistant
|
||||
|
||||
@ -86,9 +86,9 @@ You can use standard Discord methods to ping users, roles, and channels within t
|
||||
| `Role` | `<@&roleID>` |
|
||||
| `Channel` | `<#channelID>` |
|
||||
|
||||
## Discord service data
|
||||
## Discord action data
|
||||
|
||||
The following attributes can be placed inside the `data` key of the service call for extended functionality:
|
||||
The following attributes can be placed inside the `data` key of the action for extended functionality:
|
||||
|
||||
| Attribute | Optional | Description |
|
||||
| ------------ | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
@ -111,7 +111,7 @@ To include messages with embedding, use these attributes underneath the `embed`
|
||||
| `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
|
||||
### Example action
|
||||
|
||||
```yaml
|
||||
- service: notify.discord
|
||||
@ -124,7 +124,7 @@ To include messages with embedding, use these attributes underneath the `embed`
|
||||
- "/tmp/garage.jpg"
|
||||
```
|
||||
|
||||
### Example service call with attachments sourced from remote URLs
|
||||
### Example action with attachments sourced from remote URLs
|
||||
|
||||
```yaml
|
||||
- service: notify.discord
|
||||
@ -140,7 +140,7 @@ To include messages with embedding, use these attributes underneath the `embed`
|
||||
|
||||
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
|
||||
### Example embed action
|
||||
|
||||
```yaml
|
||||
- service: notify.discord
|
||||
|
@ -17,13 +17,13 @@ ha_integration_type: integration
|
||||
|
||||
The **DLNA Digital Media Renderer** {% term integration %} allows you to control a [DLNA Digital Media Renderer](https://www.dlna.org/), such as DLNA enabled TVs or radios.
|
||||
|
||||
Please note that some devices, such as Samsung TVs, are rather picky about the source used to play from. The TTS service might not work in combination with these devices. If the play_media service does not work, please try playing from a DLNA/DMS (such as [MiniDLNA](https://sourceforge.net/projects/minidlna/)).
|
||||
Note that some devices, such as Samsung TVs, are rather picky about the source used to play from. The TTS action might not work in combination with these devices. If the play_media action does not work, please try playing from a DLNA/DMS (such as [MiniDLNA](https://sourceforge.net/projects/minidlna/)).
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
## Options
|
||||
|
||||
Options for DLNA DMR devices can be set going to **Settings** > **Devices & Services** > **DLNA Digital Media Renderer** > **Configuration**.
|
||||
Options for DLNA DMR devices can be set by going to **Settings** > **Devices & services** > **DLNA Digital Media Renderer** > **Configuration**.
|
||||
|
||||
{% configuration_basic %}
|
||||
Event listener port:
|
||||
@ -36,9 +36,9 @@ Show incompatible media when browsing:
|
||||
description: "When browsing media, show all media files and links, even if the device reports that it is not compatible with the media type."
|
||||
{% endconfiguration_basic %}
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
DLNA devices can support a range of features. Depending on the device itself, the following [media_player](/integrations/media_player/#services) services may be supported:
|
||||
DLNA devices can support a range of features. Depending on the device itself, the following [media_player](/integrations/media_player/#actions) actions may be supported:
|
||||
|
||||
- `media_player.volume_up`, `media_player.volume_down`, and `media_player.volume_set`
|
||||
- `media_player.volume_mute`
|
||||
|
@ -34,7 +34,7 @@ The `<media_identifier>` can have one of three forms:
|
||||
- `:ObjectID`: Colon followed by a server-assigned ID for an object.
|
||||
- `?query`: Question mark followed by a query string to search for, see [DLNA ContentDirectory SearchCriteria](https://openconnectivity.org/wp-content/uploads/2015/11/UPnP-av-ContentDirectory-v4-Service.pdf) (part 5.3.16 "A_ARG_TYPE_SearchCriteria" on page 65 and part D.5 "Searching" on page 269) for the syntax. The first result found will be used.
|
||||
|
||||
URIs generated while browsing will look like the Object ID form above. However, all three forms will work with the [media_player.play_media](/integrations/media_player/#service-media_playerplay_media) service.
|
||||
URIs generated while browsing will look like the Object ID form above. However, all three forms will work with the [media_player.play_media](/integrations/media_player/#action-media_playerplay_media) action.
|
||||
|
||||
### Examples
|
||||
|
||||
|
@ -35,7 +35,7 @@ dominos:
|
||||
- P12IPAZA
|
||||
```
|
||||
|
||||
Now you can use the Dominos {% term service %} to order pizza within your automations:
|
||||
Now you can use the Dominos {% term action %} to order pizza within your automations:
|
||||
|
||||
```yaml
|
||||
- service: dominos.order
|
||||
|
@ -200,7 +200,7 @@ image_processing:
|
||||
|
||||
## Optimizing resources
|
||||
|
||||
The [Image processing integration](/components/image_processing/) process the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your configuration `scan_interval: 10000` (setting the interval to 10,000 seconds) and then call the `image_processing.scan` service when you actually want to perform processing.
|
||||
The [Image processing integration](/components/image_processing/) processes the image from a camera at a fixed period given by the `scan_interval`. This leads to excessive processing if the image on the camera hasn't changed, as the default `scan_interval` is 10 seconds. You can override this by adding to your configuration `scan_interval: 10000` (setting the interval to 10,000 seconds) and then call the `image_processing.scan` action when you actually want to perform processing.
|
||||
|
||||
```yaml
|
||||
# Example advanced configuration.yaml entry
|
||||
|
@ -70,7 +70,7 @@ notify:
|
||||
|
||||
### Usage
|
||||
|
||||
This is a notify platform and thus can be controlled by calling the notify service [as described here](/integrations/notify/). It will send an SMS notification to a single phone number in the notification **target**.
|
||||
This is a notify platform and thus can be controlled by calling the notify action [as described here](/integrations/notify/). It will send an SMS notification to a single phone number in the notification **target**.
|
||||
|
||||
```yaml
|
||||
# Example automation notification entry
|
||||
|
@ -12,15 +12,15 @@ ha_integration_type: integration
|
||||
ha_config_flow: true
|
||||
---
|
||||
|
||||
The **Downloader** {% term integration %} provides a service to download files. It will raise an error and not continue to set itself up when the download directory does not exist. The directory needs to be writable for the user that is running Home Assistant.
|
||||
The **Downloader** {% term integration %} provides an action to download files. It will raise an error and not continue to set itself up when the download directory does not exist. The directory needs to be writable for the user who is running Home Assistant.
|
||||
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
If the path is not absolute, it’s assumed to be relative to the Home Assistant configuration directory (for example, .homeassistant/downloads).
|
||||
|
||||
### Use the service
|
||||
### Use the action
|
||||
|
||||
Go to the "Developer Tools", then to "Services", and choose `downloader/download_file` from the list of available services. Fill the "Service Data" field as shown in the example below and hit "CALL SERVICE".
|
||||
Go to the "Developer Tools", then to "Actions", and choose `downloader.download_file` from the list of available actions. Fill the "data" field as shown in the example below and select "Perform action".
|
||||
|
||||
```json
|
||||
{"url":"http://domain.tld/path/to/file"}
|
||||
@ -28,7 +28,7 @@ Go to the "Developer Tools", then to "Services", and choose `downloader/download
|
||||
|
||||
This will download the file from the given URL.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ---------------------------------------------- |
|
||||
| `url` | no | The URL of the file to download. |
|
||||
| `subdir` | yes | Download into subdirectory of **download_dir** |
|
||||
|
@ -55,7 +55,7 @@ Assistant.
|
||||
{% details "Manual configuration steps" %}
|
||||
|
||||
- Browse to your Home Assistant instance.
|
||||
- Go to **{% my integrations title="Settings > Devices & Services" %}**.
|
||||
- Go to **{% my integrations title="Settings > Devices & services" %}**.
|
||||
- Set up the new discovered devices.
|
||||
|
||||
{% enddetails %}
|
||||
|
@ -38,7 +38,7 @@ A sensor platform for Belgian, Dutch, Luxembourg and Swedish Smart Meters which
|
||||
|
||||
### Options
|
||||
|
||||
To configure options for DSMR integration go to **Settings** -> **Devices & Services** and press **Options** on the DSMR card.
|
||||
To configure options for DSMR integration go to **Settings** -> **Devices & services** and press **Options** on the DSMR card.
|
||||
|
||||
#### Time between updates
|
||||
|
||||
|
@ -43,10 +43,10 @@ duckdns:
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
||||
## Service `set_txt`
|
||||
## Action `set_txt`
|
||||
|
||||
Set the TXT record of your DuckDNS subdomain.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | --------------------------- |
|
||||
| `txt` | no | Payload for the TXT record. |
|
||||
|
@ -54,9 +54,9 @@ For example, you would go to your kitchen light and turn it on. Now you log into
|
||||
|
||||
The initial process can be a bit time consuming and tedious, but it only has to be done once. Once you are done configuring, it is better to set `autodiscover` to `false`, since there are many "fake" channels and areas that the system uses for internal communication and you do not want to have visible.
|
||||
|
||||
## Services
|
||||
## Actions
|
||||
|
||||
### Service `dynalite.request_area_preset`
|
||||
### Action `dynalite.request_area_preset`
|
||||
|
||||
Send a command on the Dynalite network asking an area to report its currently selected preset. Normally, channel 1 (default) is used, but in some implementation, specific areas will need other channels.
|
||||
|
||||
@ -66,13 +66,13 @@ This does not return the area preset. It sends a network command asking the area
|
||||
|
||||
{% endnote %}
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------------------------------------------------------------------------------------- |
|
||||
| `host` | yes | Which gateway to send the command to. If not specified, sends to all configured gateways. |
|
||||
| `area` | no | Area for the requested channel. |
|
||||
| `channel` | no | Which channel to request. |
|
||||
|
||||
### Service `dynalite.request_channel_level`
|
||||
### Action `dynalite.request_channel_level`
|
||||
|
||||
Send a command on the Dynalite network asking a specific channel in an area to report its current level.
|
||||
|
||||
@ -82,7 +82,7 @@ This does not return the channel level. It sends a network command asking the ch
|
||||
|
||||
{% endnote %}
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
| Data attribute | Optional | Description |
|
||||
| ---------------------- | -------- | ----------------------------------------------------------------------------------------- |
|
||||
| `host` | yes | Which gateway to send the command to. If not specified, sends to all configured gateways. |
|
||||
| `area` | no | Which area to request the preset for. |
|
||||
|
Loading…
x
Reference in New Issue
Block a user