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-22 08:46:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename Services to Actions in integrations: F (#33811)

Browse Source 
* Rename Services to Actions in integrations: F

* Apply suggestions from code review

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Michael <35783820+mib1185@users.noreply.github.com>

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Michael <35783820+mib1185@users.noreply.github.com>
This commit is contained in:
Franck Nijhof 2024-07-17 06:01:36 +02:00 committed by GitHub
parent bca3f3983b
commit 9162850d6e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
22 changed files with 78 additions and 78 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
source/_integrations/facebook.markdown
View File

@ -33,7 +33,7 @@ page_access_token:
required: true required: true
type: string type: string
name: name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`. description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the `notify.NOTIFIER_NAME` action.
required: false required: false
default: "`notify`" default: "`notify`"
type: string type: string
@ -41,7 +41,7 @@ name:
### Usage ### Usage
With Facebook notify service, you can send your notifications to your Facebook messenger with help of your Facebook page. You have to create a [Facebook Page and App](https://developers.facebook.com/docs/messenger-platform/getting-started/quick-start) for this service. You can control it by calling the notify service [as described here](/integrations/notify/). It will send a message on messenger to user specified by **target** on behalf of your page. See the [quick start](https://developers.facebook.com/docs/messenger-platform/getting-started/quick-start) guide for more information. With Facebook notify action, you can send your notifications to your Facebook messenger with help of your Facebook page. You have to create a [Facebook Page and App](https://developers.facebook.com/docs/messenger-platform/getting-started/quick-start) for this action. You can control it by calling the notify action [as described here](/integrations/notify/). It will send a message on messenger to user specified by **target** on behalf of your page. See the [quick start](https://developers.facebook.com/docs/messenger-platform/getting-started/quick-start) guide for more information.
The phone number used in **target** should be registered with Facebook messenger. Phone number of the recipient should be in +1(212)555-2368 format. If your app is not approved by Facebook then the recipient should by either admin, developer or tester for your Facebook app. [More information](https://developers.facebook.com/docs/messenger-platform/reference/send-api#phone_number) about the phone number. The phone number used in **target** should be registered with Facebook messenger. Phone number of the recipient should be in +1(212)555-2368 format. If your app is not approved by Facebook then the recipient should by either admin, developer or tester for your Facebook app. [More information](https://developers.facebook.com/docs/messenger-platform/reference/send-api#phone_number) about the phone number.
```yaml ```yaml

40
source/_integrations/fan.markdown
View File

@ -15,24 +15,24 @@ The fan integration allows you to control and monitor fan devices.
{% include integrations/building_block_integration.md %} {% include integrations/building_block_integration.md %}
## Services ## Actions
### Fan control services ### Fan control actions
Available services: Available actions:
`fan.set_percentage`, `fan.set_preset_mode`, `fan.set_direction`, `fan.oscillate`, `fan.turn_on`, `fan.turn_off`, `fan.toggle`, `fan.increase_speed`, `fan.decrease_speed` `fan.set_percentage`, `fan.set_preset_mode`, `fan.set_direction`, `fan.oscillate`, `fan.turn_on`, `fan.turn_off`, `fan.toggle`, `fan.increase_speed`, `fan.decrease_speed`
{% note %} {% note %}
Not all fan services may be available for your platform. You can check which services are available for your fan(s) under **Developer Tools** > **Services**. Not all fan actions may be available for your platform. You can check which actions are available for your fan(s) under **Developer Tools** > **Actions**.
{% endnote %} {% endnote %}
### Service `fan.set_percentage` ### Action `fan.set_percentage`
Sets the speed percentage for fan device. Sets the speed percentage for fan device.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. | `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`.
| `percentage` | no | Percentage speed setting | `percentage` | no | Percentage speed setting
@ -52,11 +52,11 @@ automation:
percentage: 33 percentage: 33
``` ```
### Service `fan.set_preset_mode` ### Action `fan.set_preset_mode`
Sets a preset mode for the fan device. Available preset modes are defined by the integration that supplies the fan entity to Home Assistant. For example, the ESPHome [Speed Fan](https://esphome.io/components/fan/speed.html) component provides three available presets by default: `Low`, `Medium`, and `High`. Sets a preset mode for the fan device. Available preset modes are defined by the integration that supplies the fan entity to Home Assistant. For example, the ESPHome [Speed Fan](https://esphome.io/components/fan/speed.html) component provides three available presets by default: `Low`, `Medium`, and `High`.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. | `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`.
| `preset_mode` | no | The preset mode | `preset_mode` | no | The preset mode
@ -76,11 +76,11 @@ automation:
preset_mode: auto preset_mode: auto
``` ```
### Service `fan.set_direction` ### Action `fan.set_direction`
Sets the rotation for fan device. Sets the rotation for fan device.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. | `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`.
| `direction` | no | The direction to rotate. Either `forward` or `reverse` | `direction` | no | The direction to rotate. Either `forward` or `reverse`
@ -100,11 +100,11 @@ automation:
direction: forward direction: forward
``` ```
### Service `fan.oscillate` ### Action `fan.oscillate`
Sets the oscillation for fan device. Sets the oscillation for fan device.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. | `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`.
| `oscillating` | no | Flag to turn on/off oscillation. Either `True` or `False`. | `oscillating` | no | Flag to turn on/off oscillation. Either `True` or `False`.
@ -124,21 +124,21 @@ automation:
oscillating: True oscillating: True
``` ```
### Service `fan.turn_on` ### Action `fan.turn_on`
Turn fan device on. This is only supported if the fan device supports being turned off. See a similar example under `fan.turn_off`. Turn fan device on. This is only supported if the fan device supports being turned off. See a similar example under `fan.turn_off`.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. | `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`.
| `percentage` | yes | Percentage speed setting | `percentage` | yes | Percentage speed setting
| `preset_mode` | yes | The preset mode | `preset_mode` | yes | The preset mode
### Service `fan.turn_off` ### Action `fan.turn_off`
Turn fan device off. This is only supported if the fan device supports being turned on. Turn fan device off. This is only supported if the fan device supports being turned on.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. | `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`.
@ -158,11 +158,11 @@ automation:
speed: low speed: low
``` ```
### Service `fan.increase_speed` ### Action `fan.increase_speed`
Increases the speed of the fan device. Increases the speed of the fan device.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. | `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`.
| `percentage_step` | yes | Increase speed by a percentage. Should be between 0..100. | `percentage_step` | yes | Increase speed by a percentage. Should be between 0..100.
@ -183,11 +183,11 @@ automation:
entity_id: fan.dining_room_fan_by_front_door entity_id: fan.dining_room_fan_by_front_door
``` ```
### Service `fan.decrease_speed` ### Action `fan.decrease_speed`
Decreases the speed of the fan device. Decreases the speed of the fan device.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`. | `entity_id` | yes | String or list of strings that define the entity ID(s) of fan device(s) to control. To target all fan devices, use `all`.
| `percentage_step` | yes | Decrease speed by a percentage. Should be between 0..100. | `percentage_step` | yes | Decrease speed by a percentage. Should be between 0..100.

6
source/_integrations/fan.template.markdown
View File

@ -19,7 +19,7 @@ related:
--- ---
The **Template** {% term integration %} creates fans that combine integrations and provides the The **Template** {% term integration %} creates fans that combine integrations and provides the
ability to run scripts or invoke services for each of the `turn_on`, `turn_off`, `set_percentage`, ability to run scripts or invoke actions for each of the `turn_on`, `turn_off`, `set_percentage`,
`set_preset_mode`, `set_oscillating`, and `set_direction` commands of a fan. `set_preset_mode`, `set_oscillating`, and `set_direction` commands of a fan.
## Configuration ## Configuration
@ -139,7 +139,7 @@ fan:
type: [string, list] type: [string, list]
default: [] default: []
speed_count: speed_count:
description: The number of speeds the fan supports. Used to calculate the percentage step for the `fan.increase_speed` and `fan.decrease_speed` services. description: The number of speeds the fan supports. Used to calculate the percentage step for the `fan.increase_speed` and `fan.decrease_speed` actions.
required: false required: false
type: integer type: integer
default: 100 default: 100
@ -163,7 +163,7 @@ When converting a fan with 3 speeds from the old fan entity model, the following
### Helper fan ### Helper fan
This example uses an input_boolean and an input_number to mimic a fan, and This example uses an input_boolean and an input_number to mimic a fan, and
the example shows multiple service calls for set_percentage. the example shows multiple actions for `set_percentage`.
{% raw %} {% raw %}

2
source/_integrations/fastdotcom.markdown
View File

@ -27,7 +27,7 @@ If you want to measure bandwidth metrics other than download such as ping and up
Enabling this integration will automatically create the Fast.com Sensor. Enabling this integration will automatically create the Fast.com Sensor.
By default, a speed test will be run every hour. The user can manually run a speed test via the `homeassistant.update_entity` service. By default, a speed test will be run every hour. The user can manually run a speed test via the `homeassistant.update_entity` action.
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}

2
source/_integrations/ffmpeg_motion.markdown
View File

@ -18,7 +18,7 @@ The `ffmpeg` {% term integration %} allows you to use any video feed with [FFmpe
{% note %} {% note %}
If the `ffmpeg` process is broken, the sensor will be unavailable. To control the FFmpeg process of sensor, use the service `ffmpeg.start`, `ffmpeg.stop`, `ffmpeg.restart`. If the `ffmpeg` process is broken, the sensor will be unavailable. To control the FFmpeg process of the sensor, use the `ffmpeg.start`, `ffmpeg.stop`, and `ffmpeg.restart` actions.
{% endnote %} {% endnote %}

2
source/_integrations/ffmpeg_noise.markdown
View File

@ -18,7 +18,7 @@ The `ffmpeg` {% term integration %} allows you to use any video or audio feed wi
{% note %} {% note %}
If the `ffmpeg` process is broken, the sensor will be unavailable. To control the FFmpeg process of sensor, use the service `ffmpeg.start`, `ffmpeg.stop`, `ffmpeg.restart`. If the `ffmpeg` process is broken, the sensor will be unavailable. To control the FFmpeg process of sensor, use the `ffmpeg.start`, `ffmpeg.stop`, and `ffmpeg.restart` actions.
{% endnote %} {% endnote %}

2
source/_integrations/file.markdown
View File

@ -31,7 +31,7 @@ After creating a config entry, you can change the entry name, the name of the no
To use notifications in automations or scripts, see the [getting started with automation page](/getting-started/automation/). To use notifications in automations or scripts, see the [getting started with automation page](/getting-started/automation/).
Use the `notify.send_message` entity service to store notification messages. Use the `notify.send_message` entity to store notification messages.
## Sensor ## Sensor

2
source/_integrations/flexit_bacnet.markdown
View File

@ -86,6 +86,6 @@ The consequences of shutting down the unit can be costly and extensive. For exam
If you need to shut down the unit, make sure to take all necessary precautions, such as securing the system with frost protection dampers. If you need to shut down the unit, make sure to take all necessary precautions, such as securing the system with frost protection dampers.
Furthermore, Flexit recommends to unplug the unit from the power socket before replacing a filter. To prevent damage, always initiate a controlled shutdown from the control panel (or, in the future, from a service call in Home Assistant) before unplugging the device. Furthermore, Flexit recommends unplugging the unit from the power socket before replacing a filter. To prevent damage, always initiate a controlled shutdown from the control panel (or, in the future, from an action in Home Assistant) before unplugging the device.
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}

2
source/_integrations/flic.markdown
View File

@ -18,7 +18,7 @@ The `flic` {% term integration %} allows you to receive click events from [flic]
The {% term integration %} does not directly interact with the buttons, *but communicates with a flic service* that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine. The {% term integration %} does not directly interact with the buttons, *but communicates with a flic service* that manages the buttons. The service can run on the same instance as Home Assistant or any other reachable machine.
## Service setup ## Action setup
If you are using the Home Assistant Operating System, you can run the service locally by [installing](/common-tasks/os#installing-third-party-add-ons) the flicd add-on from [pschmitt's repository](https://github.com/pschmitt/home-assistant-addons). If you are using the Home Assistant Operating System, you can run the service locally by [installing](/common-tasks/os#installing-third-party-add-ons) the flicd add-on from [pschmitt's repository](https://github.com/pschmitt/home-assistant-addons).

2
source/_integrations/flo.markdown
View File

@ -29,7 +29,7 @@ There is currently support for the following device types within Home Assistant:
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
## Services ## Actions
### `flo.run_health_test` ### `flo.run_health_test`

2
source/_integrations/flock.markdown
View File

@ -45,7 +45,7 @@ notify:
{% configuration %} {% configuration %}
name: name:
description: "The optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`." description: "The optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the `notify.NOTIFIER_NAME` action."
required: false required: false
type: string type: string
default: notify default: notify

4
source/_integrations/flume.markdown
View File

@ -30,11 +30,11 @@ Flume monitors the real-time status of your home water meter. Allowing the end-u
You can find your Client ID and Client Secret under "API Access" on the [settings page](https://portal.flumewater.com/#settings). You can find your Client ID and Client Secret under "API Access" on the [settings page](https://portal.flumewater.com/#settings).
To add `Flume` to your installation, go to **Settings** -> **Devices & Services** in the UI, click the button with `+` sign and from the list of integrations select **Flume**. To add `Flume` to your installation, go to **Settings** -> **Devices & services** in the UI, click the button with `+` sign and from the list of integrations select **Flume**.
## Notifications ## Notifications
Flume notifications are fetched every 5 minutes and are available via the service `flume.list_notifications`. Some notifications are available via the following binary sensors: Flume notifications are fetched every 5 minutes and are available via the `flume.list_notifications` action. Some notifications are available via the following binary sensors:
- Bridge disconnected - Bridge disconnected
- High flow - High flow

2
source/_integrations/flux.markdown
View File

@ -25,7 +25,7 @@ The value of `sunset_time` is automatically calculated based on the location spe
The color temperature is specified in kelvin, and accepted values are between 1000 and 40000 kelvin. Lower values will seem more red, while higher will look more white. The color temperature is specified in kelvin, and accepted values are between 1000 and 40000 kelvin. Lower values will seem more red, while higher will look more white.
If you want to update at variable intervals, you can leave the switch turned off and use automation rules that call the service `switch.<name>_update` whenever you want the lights updated, where `<name>` equals the `name:` property in the switch configuration. If you want to update at variable intervals, you can leave the switch turned off and use automation rules that use the `switch.<name>_update` action whenever you want the lights updated, where `<name>` equals the `name:` property in the switch configuration.
To use the Flux switch in your installation, add the following to your {% term "`configuration.yaml`" %} file. To use the Flux switch in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %} {% include integrations/restart_ha_after_config_inclusion.md %}

20
source/_integrations/flux_led.markdown
View File

@ -222,11 +222,11 @@ The Magic Home light offers a number of effects which are not included in other
| `random` | Chooses a random color by selecting random values for R, G, and B. | | `random` | Chooses a random color by selecting random values for R, G, and B. |
### Custom effects - service `flux_led.set_custom_effect` ### Custom effects - action `flux_led.set_custom_effect`
The integration offers a custom service to enable you to set the lights to a custom light effect. The integration offers a custom action to enable you to set the lights to a custom light effect.
| Service data attribute | Description | | Data attribute | Description |
| ---------------------- | ----------- | | ---------------------- | ----------- |
| `entity_id` | The entity_id of the LED light to set the effect on. | | `entity_id` | The entity_id of the LED light to set the effect on. |
| `colors` | List of RGB colors to transition between in your effect. (Max 16, Required) | | `colors` | List of RGB colors to transition between in your effect. (Max 16, Required) |
@ -234,7 +234,7 @@ The integration offers a custom service to enable you to set the lights to a cus
| `transition` | The transition effect you would like. Valid options are `gradual`, `jump`, or `strobe`. (Default `gradual`) | | `transition` | The transition effect you would like. Valid options are `gradual`, `jump`, or `strobe`. (Default `gradual`) |
```yaml ```yaml
#Example Service Call #Example action
entity_id: light.led_strip entity_id: light.led_strip
colors: colors:
- [255,0,0] - [255,0,0]
@ -244,11 +244,11 @@ speed_pct: 80
transition: "jump" transition: "jump"
``` ```
### Set zones - service `flux_led.set_zones` ### Set zones - action `flux_led.set_zones`
The Addressable v3 (0xA3) models allow setting a color effect per zone. The length of each zone is the number of pixels per segment divided by the number of colors. If the device is turned off, setting the zones will not turn it on. A separate call to `light.turn_on` is needed to turn on the device. The Addressable v3 (0xA3) models allow setting a color effect per zone. The length of each zone is the number of pixels per segment divided by the number of colors. If the device is turned off, setting the zones will not turn it on. A separate call to `light.turn_on` is needed to turn on the device.
| Service data attribute | Description | | Data attribute | Description |
| ---------------------- | ----------- | | ---------------------- | ----------- |
| `entity_id` | The entity_id of the LED light to set the effect on. | | `entity_id` | The entity_id of the LED light to set the effect on. |
| `colors` | List of colors for each zone (RGB). (Max 2048 Colors) | | `colors` | List of colors for each zone (RGB). (Max 2048 Colors) |
@ -256,7 +256,7 @@ The Addressable v3 (0xA3) models allow setting a color effect per zone. The leng
| `effect` | The effect you would like. Valid options are `static`, `running_water`, `strobe`, `jump`, or `breathing`. (Default `static`) | | `effect` | The effect you would like. Valid options are `static`, `running_water`, `strobe`, `jump`, or `breathing`. (Default `static`) |
```yaml ```yaml
#Example service call #Example action
service: flux_led.set_zones service: flux_led.set_zones
target: target:
entity_id: entity_id:
@ -271,11 +271,11 @@ data:
speed_pct: 80 speed_pct: 80
``` ```
### Set Music Mode - Service `flux_led.set_music_mode` ### Set Music Mode - Action `flux_led.set_music_mode`
The RGB with MIC (0x08), Addressable v2 (0xA2), and Addressable v3 (0xA3) models have a built-in microphone that have multiple music mode settings. The RGB with MIC (0x08), Addressable v2 (0xA2), and Addressable v3 (0xA3) models have a built-in microphone that have multiple music mode settings.
| Service data attribute | Description | | Data attribute | Description |
| ---------------------- | ----------- | | ---------------------- | ----------- |
| `entity_id` | The entity_id of the LED light to set the effect on. | | `entity_id` | The entity_id of the LED light to set the effect on. |
| `sensitivity` | Microphone sensitivity (0-100) | | `sensitivity` | Microphone sensitivity (0-100) |
@ -286,7 +286,7 @@ The RGB with MIC (0x08), Addressable v2 (0xA2), and Addressable v3 (0xA3) models
| `background_color` | The background RGB color (Addressable models only) | | `background_color` | The background RGB color (Addressable models only) |
```yaml ```yaml
#Example Service Call #Example action
service: flux_led.set_music_mode service: flux_led.set_music_mode
target: target:
entity_id: entity_id:

2
source/_integrations/forecast_solar.markdown
View File

@ -133,6 +133,6 @@ To adjust the configuration settings for your Forecast.Solar integration
instance: instance:
1. Browse to your Home Assistant instance. 1. Browse to your Home Assistant instance.
2. Go to **{% my integrations title="Settings > Devices & Services" %}**. 2. Go to **{% my integrations title="Settings > Devices & services" %}**.
3. If multiple instances of {{ name }} are configured, choose the instance you want to configure. 3. If multiple instances of {{ name }} are configured, choose the instance you want to configure.
4. Select **Configure**. 4. Select **Configure**.

8
source/_integrations/foscam.markdown
View File

@ -26,21 +26,21 @@ There seems to be some issues within Foscam with lengthy passwords and passwords
Most Foscam IP Cameras supports two video streams, by default the `Main` stream is the high quality stream while the `Sub` stream is a lower quality stream. These streams can be configured in your camera preferences. Most Foscam IP Cameras supports two video streams, by default the `Main` stream is the high quality stream while the `Sub` stream is a lower quality stream. These streams can be configured in your camera preferences.
### Service `foscam.ptz` ### Action `foscam.ptz`
If your Foscam camera supports <abbr title="pan, tilt, and zoom">PTZ</abbr>, you will be able to pan or tilt your camera. If your Foscam camera supports <abbr title="pan, tilt, and zoom">PTZ</abbr>, you will be able to pan or tilt 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. | | `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
| `movement` | Direction of the movement. Allowed values: `up`, `down`, `left`, `right`, `top_left`, `top_right`, `bottom_left`, `bottom_right` | | `movement` | Direction of the movement. Allowed values: `up`, `down`, `left`, `right`, `top_left`, `top_right`, `bottom_left`, `bottom_right` |
| `travel_time` | (Optional) Travel time in seconds. Allowed values: float from 0 to 1. Default: 0.125 | | `travel_time` | (Optional) Travel time in seconds. Allowed values: float from 0 to 1. Default: 0.125 |
### Service `foscam.ptz_preset` ### Action `foscam.ptz_preset`
If your Foscam camera supports <abbr title="pan, tilt, and zoom">PTZ</abbr> presets, you will be able to move the camera to a predefined preset using the preset name. If your Foscam camera supports <abbr title="pan, tilt, and zoom">PTZ</abbr> presets, you will be able to move the camera to a predefined preset using the preset name.
| 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. | | `entity_id` | String or list of strings that point at `entity_id`s of cameras. Use `entity_id: all` to target all. |
| `preset_name` | The name of the preset to move to. Presets can be created from within the official Foscam apps. | | `preset_name` | The name of the preset to move to. Presets can be created from within the official Foscam apps. |

4
source/_integrations/foursquare.markdown
View File

@ -12,7 +12,7 @@ related:
title: Configuration file title: Configuration file
--- ---
The `foursquare` {% term integration %} accepts pushes from the Foursquare [Real-Time API](https://developer.foursquare.com/overview/realtime) and a service to check users in on Swarm. The `foursquare` {% term integration %} accepts pushes from the Foursquare [Real-Time API](https://developer.foursquare.com/overview/realtime) and an action to check users in on Swarm.
To enable Foursquare, add the following to your {% term "`configuration.yaml`" %} file. To enable Foursquare, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %} {% include integrations/restart_ha_after_config_inclusion.md %}
@ -69,7 +69,7 @@ automation:
### Check ins ### Check ins
To check a user in, use the `foursquare/checkin` service. To check a user in, use the `foursquare/checkin` action.
Parameters: Parameters:

2
source/_integrations/free_mobile.markdown
View File

@ -46,7 +46,7 @@ notify:
{% configuration %} {% configuration %}
name: name:
description: "The optional parameter name allows multiple notifiers to be created. The notifier will bind to the service notify.NOTIFIER_NAME." description: "The optional parameter name allows multiple notifiers to be created. The notifier will bind to the `notify.NOTIFIER_NAME` action."
required: false required: false
type: string type: string
default: notify default: notify

8
source/_integrations/freebox.markdown
View File

@ -61,7 +61,7 @@ You must have set a password for your Freebox router web administration page. En
The first time Home Assistant will connect to your Freebox, you will need to authorize it by pressing the right arrow on the facade of the Freebox when prompted to do so. The first time Home Assistant will connect to your Freebox, you will need to authorize it by pressing the right arrow on the facade of the Freebox when prompted to do so.
To make the Wi-Fi switch and the reboot service working you will have to add "Modification des réglages de la Freebox" permission to Home Assistant application in "Paramètres de la Freebox" > "Gestion des accès" > "Applications". To make the Wi-Fi switch and the reboot action working, you will have to add "Modification des réglages de la Freebox" permission to Home Assistant application in "Paramètres de la Freebox" > "Gestion des accès" > "Applications".
To use cameras from the Freebox Delta, you will have to add "Gestion de l'alarme et maison connectée" permission to Home Assistant application in "Paramètres de la Freebox" > "Gestion des accès" > "Applications". To use cameras from the Freebox Delta, you will have to add "Gestion de l'alarme et maison connectée" permission to Home Assistant application in "Paramètres de la Freebox" > "Gestion des accès" > "Applications".
@ -118,11 +118,11 @@ This integration allows you to view and control the Freebox alarm control panel.
## Service ## Action
### Service `freebox.reboot` ### Action `freebox.reboot`
This service will reboot your Freebox router. It does not take any parameter. Be aware there is no confirmation. This action will reboot your Freebox router. It does not take any parameter. Be aware there is no confirmation.
## Switch ## Switch

10
source/_integrations/fritz.markdown
View File

@ -50,17 +50,17 @@ Both TR-064 and UPnP need to be enabled in the FRITZ!Box ( Home Network -> Netwo
The configuration in the UI asks for a username. Starting from FRITZ!OS 7.24 the FRITZ!Box creates a random username for the admin user if you didn't set one yourself. This can be found after logging into the FRITZ!Box and visiting System -> FRITZ!Box Users -> Users. The username starts with `fritz` followed by four random numbers. Under properties on the right it says `created automatically`. Prior to FRITZ!OS 7.24 the default username was `admin`. The configuration in the UI asks for a username. Starting from FRITZ!OS 7.24 the FRITZ!Box creates a random username for the admin user if you didn't set one yourself. This can be found after logging into the FRITZ!Box and visiting System -> FRITZ!Box Users -> Users. The username starts with `fritz` followed by four random numbers. Under properties on the right it says `created automatically`. Prior to FRITZ!OS 7.24 the default username was `admin`.
## Services ## Actions
Available {% term services %}: `set_guest_wifi_password` Available {% term actions %}: `set_guest_wifi_password`
### Service `set_guest_wifi_password` ### Action `set_guest_wifi_password`
Set a new password for the guest wifi. Set a new password for the guest wifi.
The password must be between 8 and 63 characters long. The password must be between 8 and 63 characters long.
If no password is given, it will be auto-generated. If no password is given, it will be auto-generated.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------- | | ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
| `device_id` | no | Only act on a specific router | | `device_id` | no | Only act on a specific router |
| `password` | yes | New password for the guest wifi | | `password` | yes | New password for the guest wifi |
@ -69,7 +69,7 @@ If no password is given, it will be auto-generated.
## Integration options ## Integration options
It is possible to change some behaviors through the integration options. It is possible to change some behaviors through the integration options.
To change the settings, go to {% my integrations title="**Settings** > **Devices & Services**" %}. Select the **AVM FRITZ!Box Tools** integration, then select **Configure**. To change the settings, go to {% my integrations title="**Settings** > **Devices & services**" %}. Select the **AVM FRITZ!Box Tools** integration, then select **Configure**.
- **Consider home**: Number of seconds that must elapse before considering a disconnected device "not at home". - **Consider home**: Number of seconds that must elapse before considering a disconnected device "not at home".
- **Enable old discovery method**: Needed on some scenarios like no mesh support (fw <= 6.x), mixed brands network devices or LAN switches. - **Enable old discovery method**: Needed on some scenarios like no mesh support (fw <= 6.x), mixed brands network devices or LAN switches.

8
source/_integrations/frontend.markdown
View File

@ -155,14 +155,14 @@ Check our [community forums](https://community.home-assistant.io/c/projects/them
## Setting themes ## Setting themes
There are two themes-related services: There are two themes-related actions:
- `frontend.reload_themes`: Reloads theme configuration from your {% term "`configuration.yaml`" %} file. - `frontend.reload_themes`: Reloads theme configuration from your {% term "`configuration.yaml`" %} file.
- `frontend.set_theme`: Sets backend-preferred theme name. - `frontend.set_theme`: Sets backend-preferred theme name.
### Service `set_theme` ### Action `set_theme`
| Service data attribute | Description | | Data attribute | Description |
| ---------------------- | --------------------------------------------------------------------------------------------------- | | ---------------------- | --------------------------------------------------------------------------------------------------- |
| `name` | Name of the theme to set, `default` for the default theme or `none` to restore to the default. | | `name` | Name of the theme to set, `default` for the default theme or `none` to restore to the default. |
| `mode` | If the theme should be applied in light or dark mode `light` or `dark` (Optional, default `light`). | | `mode` | If the theme should be applied in light or dark mode `light` or `dark` (Optional, default `light`). |
@ -173,7 +173,7 @@ The backend theme settings will be saved and restored on a restart of Home Assis
### Manual theme selection ### Manual theme selection
When themes are enabled in the {% term "`configuration.yaml`" %} file, a new option will show up in the user profile page (accessed by clicking your user account initials at the bottom of the sidebar). You can then choose any installed theme from the dropdown list and it will be applied immediately. When themes are enabled in the {% term "`configuration.yaml`" %} file, a new option will show up in the user profile page (accessed by clicking your user account initials at the bottom of the sidebar). You can then choose any installed theme from the dropdown list and it will be applied immediately.
This will overrule the theme settings set by the above service calls, and will only be applied to the current device. This will overrule the theme settings set by the above actions, and will only be applied to the current device.
<p class='img'> <p class='img'>
<img src='/images/frontend/user-theme.png' /> <img src='/images/frontend/user-theme.png' />

22
source/_integrations/fully_kiosk.markdown
View File

@ -77,7 +77,7 @@ The following is available as image entity:
- Screenshot - Screenshot
The following notify entities that can be passed to `notify.send_message` service are available: The following notify entities that can be passed to `notify.send_message` action are available:
- Text-to-speech - Text-to-speech
- Overlay message - Overlay message
@ -86,13 +86,13 @@ The following notify entities that can be passed to `notify.send_message` servic
The Fully Kiosk Browser app does not provide feedback on the device volume or media playback status, so we are unable to display the current volume level or playback status. The Fully Kiosk Browser app does not provide feedback on the device volume or media playback status, so we are unable to display the current volume level or playback status.
{% endnote %} {% endnote %}
## Services ## Actions
**Service `load_url`** **Action `load_url`**
You can use the service `fully_kiosk.load_url` to have the tablet open the specified URL. You can use the `fully_kiosk.load_url` action to have the tablet open the specified URL.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `device_id` | yes | Device ID (or list of device IDs) to load the URL on. | `device_id` | yes | Device ID (or list of device IDs) to load the URL on.
| `url` | yes | The URL to load. | `url` | yes | The URL to load.
@ -107,11 +107,11 @@ target:
device_id: a674c90eca95eca91f6020415de07713 device_id: a674c90eca95eca91f6020415de07713
``` ```
**Service `set_config`** **Action `set_config`**
You can use the service `fully_kiosk.set_config` to change the many configuration parameters of Fully Kiosk Browser. You can use the `fully_kiosk.set_config` action to change the many configuration parameters of Fully Kiosk Browser.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `device_id` | no | Device ID (or list of device IDs) to load the URL on. | `device_id` | no | Device ID (or list of device IDs) to load the URL on.
| `key` | no | The configuration parameter key. The list of available keys can be found in the Fully Kiosk Browser remote admin panel by clicking the **Show keys** button. | `key` | no | The configuration parameter key. The list of available keys can be found in the Fully Kiosk Browser remote admin panel by clicking the **Show keys** button.
@ -128,11 +128,11 @@ target:
device_id: a674c90eca95eca91f6020415de07713 device_id: a674c90eca95eca91f6020415de07713
``` ```
**Service `start_application`** **Action `start_application`**
You can use the service `fully_kiosk.start_application` to have the tablet launch the specified app. You can use the `fully_kiosk.start_application` action to have the tablet launch the specified app.
| Service data attribute | Optional | Description | | Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- | | ---------------------- | -------- | ----------- |
| `device_id` | yes | Device ID (or list of device IDs) to load the URL on. | `device_id` | yes | Device ID (or list of device IDs) to load the URL on.
| `application` | yes | The package name of the app to load. | `application` | yes | The package name of the app to load.