jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-23 09:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename Services to Actions in integrations: O (#33823)

Browse Source
This commit is contained in:
Franck Nijhof 2024-07-17 06:43:21 +02:00 committed by GitHub
parent 0c3ea85fe1
commit 0a5312d5ed
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 60 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
source/_integrations/ombi.markdown
View File

@ -85,33 +85,33 @@ ombi:
ssl: true
```
## Services
## Actions
### Submit request services
### Submit request actions
Available services: `submit_movie_request`, `submit_music_request`, `submit_tv_request`
Available actions: `submit_movie_request`, `submit_music_request`, `submit_tv_request`
#### Service `submit_movie_request`
#### Action `submit_movie_request`
Searches and requests the closest matching movie.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------- |
| `name` | no | Search parameter. |
#### Service `submit_music_request`
#### Action `submit_music_request`
Searches and requests the closest matching music album.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------- |
| `name` | no | Search parameter. |
#### Service `submit_tv_request`
#### Action `submit_tv_request`
Searches and requests the closest matching TV show.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------ |
| `name` | no | Search parameter. |
| `season` | yes | Which season(s) to request. Must be one of `first`, `latest` or `all`. Defaults to latest. |

4
source/_integrations/onkyo.markdown
View File

@ -107,11 +107,11 @@ onkyo --host 192.168.0.100 volume=query
unknown-model: master-volume = 191
```
### Service `onkyo_select_hdmi_output`
### Action `onkyo_select_hdmi_output`
Changes HDMI output of your receiver
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------- |
| `entity_id` | no | String or list of a single `entity_id` that will change output. |
| `hdmi_output` | no | The desired output code. |

4
source/_integrations/onvif.markdown
View File

@ -85,11 +85,11 @@ To help with development of this integration, enable `info` level logging for `h
If you are running into trouble with this sensor, please refer to the [Troubleshooting section](/integrations/ffmpeg/#troubleshooting).
### Service `onvif.ptz`
### Action `onvif.ptz`
If your ONVIF camera supports <abbr title="pan, tilt, and zoom">PTZ</abbr>, you will be able to pan, tilt or zoom your camera.
| Service data attribute | Description |
| Data attribute | Description |
| -----------------------| ----------- |
| `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
| `tilt` | Tilt direction. Allowed values: `UP`, `DOWN`, `NONE` |

10
source/_integrations/openai_conversation.markdown
View File

@ -77,15 +77,15 @@ Top P:
You can use an OpenAI Conversation integration to [talk to Super Mario and, if desired, have it control devices](/voice_control/assist_create_open_ai_personality/) in your home.
## Services
## Actions
### Service `openai_conversation.generate_image`
### Action `openai_conversation.generate_image`
Allows you to ask OpenAI to generate an image based on a prompt. This service
Allows you to ask OpenAI to generate an image based on a prompt. This action
populates [Response Data](/docs/scripts/service-calls#use-templates-to-handle-response-data)
with the requested image.
| Service data attribute | Optional | Description | Example |
| Data attribute | Optional | Description | Example |
| ---------------------- | -------- | ------------------------------------------------------ | ---------------- |
| `config_entry` | no | Integration entry ID to use. | |
| `prompt` | no | The text to turn into an image. | Picture of a dog |
@ -117,7 +117,7 @@ to generate a new image of New York in the current weather state.
The resulting image entity can be used in, for example, a card on your dashboard.
The *config_entry* is installation specific. To get the value, make sure the integration has been installed.
Then, go to {% my developer_services title="**Developer Tools** > **Services**" %}. Ensure you are in UI mode and enter the following below:
Then, go to {% my developer_services title="**Developer Tools** > **Actions**" %}. Ensure you are in UI mode and enter the following below:
![Open AI Conversation UI Mode](/images/integrations/openai_conversation/openai_developer_tools_ui.png)

9
source/_integrations/openhome.markdown
View File

@ -44,12 +44,13 @@ action:
media_content_type: music
```
## Services
## Actions
### Media control services
Available services: `invoke_pin`
### Media control actions
| Service data attribute | Optional | Description |
Available actions: `invoke_pin`
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------ |
| `entity_id` | yes | The name of the openhome device to invoke the pin on.|
| `pin` | no | Which pin to invoke. |

62
source/_integrations/opentherm_gw.markdown
View File

@ -43,7 +43,7 @@ name:
path or url:
description: "Path to the OpenTherm Gateway device as supported by [PySerial](https://pythonhosted.org/pyserial/url_handlers.html). This is usually either a path to a serial device in `/dev/` if the gateway is connected via serial or USB, or a URL in the form of `socket://[IP address]:[port]` if it is connected over the network.<br/>Examples: `/dev/ttyUSB0`, `socket://192.168.0.250:7686`"
id:
description: "The `gateway_id` for this OpenTherm Gateway. This is used to identify this specific gateway in service calls and to generate the entity IDs for the entities related to this gateway. The entered value will be slugified, i.e. all spaces and special characters will be converted to underscores and any accents will be removed from their characters. The default value is the slugified version of the `name` given above.<br/>Examples: `thermostat`, `living_room`"
description: "The `gateway_id` for this OpenTherm Gateway. This is used to identify this specific gateway in action and to generate the entity IDs for the entities related to this gateway. The entered value will be slugified, i.e. all spaces and special characters will be converted to underscores and any accents will be removed from their characters. The default value is the slugified version of the `name` given above.<br/>Examples: `thermostat`, `living_room`"
{% endconfiguration_basic %}
{% important %}
@ -70,24 +70,24 @@ Floor Temperature:
description: "Some thermostats round all temperatures down to the lower value according to their precision. Default behavior for Home Assistant is to round temperatures to the nearest value. Enable this setting to override this behavior and round to the lower value according to the configured precision."
{% endconfiguration_basic %}
## Services
## Actions
### Service `opentherm_gw.reset_gateway`
### Action `opentherm_gw.reset_gateway`
Reset the OpenTherm Gateway.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------- |
| `gateway_id` | no | The `gateway_id` as specified during configuration. |
### Service `set_central_heating_ovrd`
### Action `set_central_heating_ovrd`
Set the central heating override option on the gateway.
When overriding the control setpoint (via a [set_control_setpoint](#service-opentherm_gwset_control_setpoint) service call with a temperature value other than `0`), the gateway automatically enables the central heating override to start heating. This service can then be used to control the central heating override status.
To return control of the central heating to the thermostat, call the [set_control_setpoint](#service-opentherm_gwset_control_setpoint) service with temperature value `0`.
When overriding the control setpoint (via the [set_control_setpoint](#action-opentherm_gwset_control_setpoint) action with a temperature value other than `0`), the gateway automatically enables the central heating override to start heating. This action can then be used to control the central heating override status.
To return control of the central heating to the thermostat, use the [set_control_setpoint](#action-opentherm_gwset_control_setpoint) action with temperature value `0`.
**You will only need this if you are writing your own software thermostat.**
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------- |
| `gateway_id` | no | The `gateway_id` as specified during configuration. |
| `ch_override` | no | The desired value for the central heating override. Use `0` to disable or `1` to enable. |
@ -96,27 +96,27 @@ To return control of the central heating to the thermostat, call the [set_contro
Please read [this information](http://otgw.tclcode.com/standalone.html) from the designer of the OpenTherm Gateway before considering to write your own software thermostat.
{% endwarning %}
### Service `opentherm_gw.set_clock`
### Action `opentherm_gw.set_clock`
Provide the time and day of week to the OpenTherm Gateway. The value provided here will be forwarded to the thermostat on the next date/time request from the thermostat. The OpenTherm Gateway does not have the ability to accurately keep track of time, so it will only retain the information provided here for a maximum of about 61 seconds.
| Service data attribute | Optional | Default | Description |
| Data attribute | Optional | Default | Description |
| ---------------------- | -------- | ------------ | ------------------------------------------------------------------------ |
| `gateway_id` | no | N/A | The `gateway_id` as specified during configuration. |
| `date` | yes | Today's date | Date from which the day of week will be extracted. Format: `YYYY-MM-DD`. |
| `time` | yes | Current time | Time in 24h format. |
### Service `opentherm_gw.set_control_setpoint`
### Action `opentherm_gw.set_control_setpoint`
{% caution %}
Improper use of this service may continuously keep your central heating system active, resulting in an overheated house and a significant increase in gas and/or electricity consumption.
Improper use of this action may continuously keep your central heating system active, resulting in an overheated house and a significant increase in gas and/or electricity consumption.
{% endcaution %}
Set the central heating control setpoint override on the OpenTherm Gateway.
In a normal situation, the thermostat will calculate and control the central heating setpoint on the boiler. Setting this to any value other than 0 will enable the override and allow the OpenTherm Gateway to control this setting. While the override is active, the OpenTherm Gateway will also request your boiler to activate the central heating circuit. For your boiler's actual maximum and minimum supported setpoint value, please see the `slave_ch_max_setp` and `slave_ch_min_setp` [sensors](#sensors). Due to the potential consequences of leaving this setting enabled for prolonged periods, the override will be disabled when Home Assistant is shut down or restarted.
**You will only need this if you are writing your own software thermostat.**
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `gateway_id` | no | The `gateway_id` as specified during configuration. |
| `temperature` | no | The central heating setpoint. Values between `0.0` and `90.0` are accepted, but your boiler may not support the full range. Set to `0` to disable the override. |
@ -125,7 +125,7 @@ In a normal situation, the thermostat will calculate and control the central hea
Please read [this information](http://otgw.tclcode.com/standalone.html) from the designer of the OpenTherm Gateway before considering to write your own software thermostat.
{% endwarning %}
### Service `opentherm_gw.set_hot_water_ovrd`
### Action `opentherm_gw.set_hot_water_ovrd`
Set the domestic hot water enable option on the OpenTherm Gateway.
Control the domestic hot water enable option. If the boiler has
@ -133,53 +133,53 @@ been configured to let the room unit control when to keep a
small amount of water preheated, this command can influence
that.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `gateway_id` | no | The `gateway_id` as specified during configuration. |
| `dhw_override` | no | The domestic hot water override state. Value should be `0` or `1` to enable the override in off or on state, or `"A"` to disable the override. |
### Service `opentherm_gw.set_hot_water_setpoint`
### Action `opentherm_gw.set_hot_water_setpoint`
Set the domestic hot water setpoint on the OpenTherm Gateway. Not all boilers support this feature.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `gateway_id` | no | The `gateway_id` as specified during configuration. |
| `temperature` | no | The domestic hot water setpoint to set on the gateway. Values between `0` and `90` are accepted, but not all boilers support this range. Check the values of the `slave_dhw_min_setp` and `slave_dhw_max_setp` sensors to see the supported range on your boiler. |
### Service `opentherm_gw.set_gpio_mode`
### Action `opentherm_gw.set_gpio_mode`
Configure the GPIO behavior on the OpenTherm Gateway.
For an explanation of the possible modes, see [GPIO modes](#gpio-modes)
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------- |
| `gateway_id` | no | The `gateway_id` as specified during configuration. |
| `id` | no | The GPIO ID; `A` or `B`. |
| `mode` | no | The GPIO mode to be set. |
### Service `opentherm_gw.set_led_mode`
### Action `opentherm_gw.set_led_mode`
Configure the function of the LEDs on the OpenTherm Gateway.
For a list of possible modes with explanation, see [LED modes](#led-modes)
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------- |
| `gateway_id` | no | The `gateway_id` as specified during configuration. |
| `id` | no | The LED ID, accepted values are `A` through `F`. |
| `mode` | no | The LED mode to be set. |
### Service `opentherm_gw.set_max_modulation`
### Action `opentherm_gw.set_max_modulation`
{% warning %}
Improper use of this service may impair the performance of your central heating system.
Improper use of this action may impair the performance of your central heating system.
{% endwarning %}
Set the maximum modulation level override on the OpenTherm Gateway.
In a normal situation, the thermostat will control the maximum modulation level on the boiler. Setting this to any value other than `-1` will enable the override and allow the OpenTherm Gateway to control this setting. Due to the potential consequences of leaving this setting enabled, the override will be disabled when Home Assistant is shut down or restarted.
**You will only need this if you are writing your own software thermostat.**
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------------- |
| `gateway_id` | no | The `gateway_id` as specified during configuration. |
| `level` | no | The maximum modulation level. Accepted values are `-1` through `100`. Set to `-1` to disable the override. |
@ -188,35 +188,35 @@ In a normal situation, the thermostat will control the maximum modulation level
Please read [this information](http://otgw.tclcode.com/standalone.html) from the designer of the OpenTherm Gateway before considering to write your own software thermostat.
{% endwarning %}
### Service `opentherm_gw.set_outside_temperature`
### Action `opentherm_gw.set_outside_temperature`
Provide the outside temperature to the thermostat.
If your thermostat is unable to display an outside temperature and does not support OTC (Outside Temperature Correction), this has no effect. Note that not all thermostats are able to display the full supported range.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `gateway_id` | no | The `gateway_id` as specified during configuration. |
| `temperature` | no | The outside temperature to provide to the thermostat. Accepted values are `-40.0` through `64.0`. Any value above `64.0` will clear a previously configured value (suggestion: `99`). |
### Service `opentherm_gw.set_setback_temperature`
### Action `opentherm_gw.set_setback_temperature`
Configure the setback temperature on the OpenTherm Gateway.
The value you provide here will be used with the GPIO `home` (5) and `away` (6) modes.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------ |
| `gateway_id` | no | The `gateway_id` as specified during configuration. |
| `temperature` | no | The setback temperature. Accepted values are `0.0` through `30.0`. |
### Service `opentherm_gw.send_transparent_command`
### Action `opentherm_gw.send_transparent_command`
<div class='note warning'>
Improper use of this service may impair the performance of your central heating system.
Improper use of this action may impair the performance of your central heating system.
</div>
Send a transparent [command](https://otgw.tclcode.com/firmware.html) to the OpenTherm Gateway.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------ |
| `gateway_id` | no | The `gateway_id` as specified during configuration. |
| `transp_cmd` | no | The serial command to be sent to the OpenTherm Gateway. |

8
source/_integrations/openuv.markdown
View File

@ -52,14 +52,14 @@ To generate an API key, log in at [the OpenUV website](https://www.openuv.io/).
{% important %}
OpenUV does _not_ automatically update data for its entities! Users must manually
update data via the `homeassistant.update_entity` service.
update data via the `homeassistant.update_entity` action.
{% endimportant %}
Beginning February 1, 2019, the "Limited" plan (which is what new users are given by
default) is limited to 50 API requests per day. Because different API plans and
locations will have different requirements, the OpenUV integration does not automatically
query the API for new data after it initially loads. To request new data, the
`homeassistant.update_entity` service should be used.
`homeassistant.update_entity` action should be used.
Note that in the case of UV and ozone data, selecting any one of:
@ -74,7 +74,7 @@ Note that in the case of UV and ozone data, selecting any one of:
- Skin Type 5 Safe Exposure Time
- Skin Type 6 Safe Exposure Time
...as the target for the `homeassistant.update_entity` service will update the data for
...as the target for the `homeassistant.update_entity` action will update the data for
_all_ of these entities.
To protect against possible API call waste, all calls to `homeassistant.update_entity`
@ -151,7 +151,7 @@ automation:
before: sunset
# The last call will most likely fall before the sunset, leaving the UV index at
# something other than 0 for the remainder of the night; to fix this, we allow
# one more service call after the sun has set:
# one more action after the sun has set:
before_offset: "+00:45:00"
- condition: template
# We check if the last trigger has been 40 minutes or more ago so we don't run

4
source/_integrations/owntracks.markdown
View File

@ -12,13 +12,13 @@ ha_platforms:
ha_integration_type: integration
---
[OwnTracks](https://owntracks.org/) is a free and open source application for iOS and Android that allows you to track your location and send it directly to Home Assistant. OwnTracks can be set up via **{% my integrations title="Settings > Devices & Services" %}**.
[OwnTracks](https://owntracks.org/) is a free and open source application for iOS and Android that allows you to track your location and send it directly to Home Assistant. OwnTracks can be set up via **{% my integrations title="Settings > Devices & services" %}**.
By default, the integration listens for incoming messages from OwnTracks via HTTP. If Home Assistant is configured to use MQTT instead, it listens for MQTT messages. When a location is submitted via HTTP, Home Assistant returns all [Persons](/integrations/person/)' last known locations. Their location will be displayed within the OwnTracks app.
## Configuration
1. To set up OwnTracks in Home Assistant, go to **{% my integrations title="Settings > Devices & Services" %}**.
1. To set up OwnTracks in Home Assistant, go to **{% my integrations title="Settings > Devices & services" %}**.
2. Add the **OwnTracks** integration.
- This will give you the **Webhook** URL as well as the **Encryption key** to use during mobile device configuration (below).