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 01:06:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename Services to Actions in integrations: E (#33810)

Browse Source
This commit is contained in:
Franck Nijhof 2024-07-17 07:29:31 +02:00 committed by GitHub
parent 3761877fef
commit c8eb4f4750
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
15 changed files with 114 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_integrations/eafm.md
View File

@ -20,7 +20,7 @@ The UK Environment Agency Flood Monitoring only provides data for England - Nort
## Configuration
Home Assistant offers the flood monitoring integration through **Settings** -> **Devices & Services** -> **Environment Agency Flood Gauges**.
Home Assistant offers the flood monitoring integration through **Settings** -> **Devices & services** -> **Environment Agency Flood Gauges**.
You will be prompted to select a monitoring station. You can find the name of nearby monitoring stations on the Flood information service [website](https://flood-warning-information.service.gov.uk/river-and-sea-levels).

16
source/_integrations/easyenergy.markdown
View File

@ -66,15 +66,15 @@ For the dynamic gas prices, only entities are created that display the
`current` and `next hour` price because the price is always fixed for
24 hours; new prices are published every morning at **05:00 UTC time**.
## Services
## Actions
The energy and gas prices are exposed using [service calls](/docs/scripts/service-calls/). The services populate [response data](/docs/scripts/service-calls#use-templates-to-handle-response-data) with price data.
The energy and gas prices are exposed using [actions](/docs/scripts/service-calls/). The actions populate [response data](/docs/scripts/service-calls#use-templates-to-handle-response-data) with price data.
### Service `easyenergy.get_gas_prices`
### Action `easyenergy.get_gas_prices`
Fetches the hourly prices for gas.
| Service data attribute | Optional | Description | Example |
| Data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | --------|
| `config_entry` | no | Config entry to use. | 013713c172577bada2874a32dbe44feb
| `incl_vat` | no | Defines whether the prices include or exclude VAT. Defaults to True | False
@ -100,11 +100,11 @@ The response data is a dictionary with the gas timestamps and prices as string a
}
```
### Service `easyenergy.get_energy_usage_prices`
### Action `easyenergy.get_energy_usage_prices`
Fetches the hourly prices for energy that you use (buy).
| Service data attribute | Optional | Description | Example |
| Data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | --------|
| `config_entry` | no | Config entry to use. | 013713c172577bada2874a32dbe44feb
| `incl_vat` | no | Defines whether the prices include or exclude VAT. Defaults to True | False
@ -130,11 +130,11 @@ The response data is a dictionary with the energy timestamps as strings and pric
}
```
### Service `easyenergy.get_energy_return_prices`
### Action `easyenergy.get_energy_return_prices`
Fetches the hourly prices for energy that you return (sell).
| Service data attribute | Optional | Description | Example |
| Data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | --------|
| `config_entry` | no | Config entry to use. | 013713c172577bada2874a32dbe44feb
| `start` | yes | Start time to get prices. Defaults to today 00:00:00 | 2023-01-01 00:00:00

38
source/_integrations/ecobee.markdown
View File

@ -59,7 +59,7 @@ Your new application will now appear on the left. Upon clicking on the applicati
## Configuration
1. In the **Settings** -> **Devices & Services** menu, click **+** and then select "ecobee" from the pop-up menu.
1. In the **Settings** -> **Devices & services** menu, click **+** and then select "ecobee" from the pop-up menu.
2. In the pop-up box, enter the API key you obtained from ecobee's [developer portal](https://ecobee.com/developers).
3. In the next pop-up box, you will be presented with a unique 8 character code separated by a dash (format: XXXX-XXXX), which you will need to authorize in the [ecobee consumer portal](https://www.ecobee.com/consumerportal/index.html). You can do this by logging in, selecting **My Apps** from the hamburger menu, clicking **Add Application** on the left, entering the PIN code from Home Assistant, clicking **Validate** and then **Add Application** in the bottom right.
4. After authorizing the app with ecobee, return to Home Assistant and click **Submit**. If the authorization was successful, a configuration entry will be created and your thermostats, ventilators and sensors will be available in Home Assistant.
@ -87,13 +87,13 @@ api_key:
<img src='/images/screenshots/ecobee-thermostat-card.png' />
</p>
You must [restart Home Assistant](/docs/configuration/#reloading-changes) for the changes to take effect. After restarting, go to {% my integrations title="**Settings** > **Devices & Services**" %} and select the integration. Then, select **Configure** and continue to authorize the app according to the above **Automatic Configuration**, starting at step 2.
You must [restart Home Assistant](/docs/configuration/#reloading-changes) for the changes to take effect. After restarting, go to {% my integrations title="**Settings** > **Devices & services**" %} and select the integration. Then, select **Configure** and continue to authorize the app according to the above **Automatic Configuration**, starting at step 2.
## Notifications
The `ecobee` notify platform allows you to send notifications to an ecobee thermostat. For each thermostat found, a `notify` entity will be added.
Example service call:
Example action:
```yaml
service: notify.send_message
@ -156,9 +156,9 @@ The `ventilator 20 min` switch is behaving like the switch in the physical ecobe
| `ventilator_min_on_time_home` | The minimum amount of time (in minutes) that the ventilator will run per hour, when you are home. This is determined by the minimum ventilator runtime setting which can be changed in the ecobee app or on the thermostat itself. |
| `ventilator_min_on_time_away` | The minimum amount of time (in minutes) that the ventilator will run per hour, when you are away. This is determined by the minimum ventilator runtime setting which can be changed in the ecobee app or on the thermostat itself. |
## Services
## Actions
Besides the standard services provided by the Home Assistant [Climate](/integrations/climate/) integration, the following extra services are provided by the ecobee integration:
Besides the standard actions provided by the Home Assistant [Climate](/integrations/climate/) integration, the following extra actions are provided by the ecobee integration:
- `ecobee.create_vacation`
- `ecobee.delete_vacation`
@ -168,11 +168,11 @@ Besides the standard services provided by the Home Assistant [Climate](/integrat
- `ecobee.set_mic_mode`
- `ecobee.set_occupancy_modes`
### Service `ecobee.create_vacation`
### Action `ecobee.create_vacation`
Creates a vacation on the selected ecobee thermostat.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| `entity_id` | no | ecobee thermostat on which to create the vacation |
| `vacation_name` | no | Name of the vacation to create. Must be unique on the thermostat |
@ -185,56 +185,56 @@ Creates a vacation on the selected ecobee thermostat.
| `fan_mode` | yes | Fan mode of the thermostat during the vacation (auto or on) (auto if not provided) |
| `fan_min_on_time` | yes | Minimum number of minutes to run the fan each hour (0 to 60) during the vacation (0 if not provided) |
### Service `ecobee.delete_vacation`
### Action `ecobee.delete_vacation`
Delete a vacation on the selected ecobee thermostat.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------- |
| `entity_id` | no | ecobee thermostat on which to delete the vacation |
| `vacation_name` | no | Name of the vacation to delete |
### Service `ecobee.resume_program`
### Action `ecobee.resume_program`
Resumes the standard active schedule of presets. This cancels any manual temperature settings or selected preset. This will not cancel vacation events, use `delete_vacation`.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`s of climate devices to control. Omit to target all ecobee thermostats. |
| `resume_all` | no | `true` will resume the standard schedule. `false` will only cancel the latest active event, which is not used often. |
### Service `ecobee.set_fan_min_on_time`
### Action `ecobee.set_fan_min_on_time`
Sets the minimum amount of time that the fan will run per hour.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | String or list of strings that point at `entity_id`'s of climate devices to control. Omit to target all ecobee thermostats. |
| `fan_min_on_time` | no | integer (e.g., 5) |
### Service `ecobee.set_dst_mode`
### Action `ecobee.set_dst_mode`
Enable/disable automatic daylight savings time.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------------------------------------------------------------- |
| `entity_id` | yes | ecobee thermostat on which to set daylight savings time mode. Omit to target all ecobee thermostats. |
| `dst_enabled` | no | true or false |
### Service `ecobee.set_mic_mode`
### Action `ecobee.set_mic_mode`
Enable/disable Alexa mic (only for ecobee 4).
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------------------------------- |
| `entity_id` | yes | ecobee thermostat on which to set the mic mode. Omit to target all ecobee thermostats. |
| `mic_enabled` | no | true or false |
### Service `ecobee.set_occupancy_modes`
### Action `ecobee.set_occupancy_modes`
Enable/disable Smart Home/Away and Follow Me modes.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------------------------------------------- |
| `entity_id` | yes | ecobee thermostat on which to set occupancy modes. Omit to target all ecobee thermostats. |
| `auto_away` | yes | true or false |

6
source/_integrations/ecovacs.markdown
View File

@ -141,7 +141,7 @@ Finally, if a vacuum becomes unavailable (usually due to being idle and off its
### Getting device and chargers coordinates
The integration has a `raw_get_positions` service to retrieve device and chargers coordinates.
The integration has a `raw_get_positions` action to retrieve device and chargers coordinates.
Example:
@ -151,8 +151,8 @@ target:
entity_id: vacuum.deebot_n8_plus
```
{% details "Service response example" %}
The service call returns a raw response with a list of coordinates available in `resp -> body -> data` like this:
{% details "Action response example" %}
The action returns a raw response with a list of coordinates available in `resp -> body -> data` like this:
```yaml
vacuum.deebot_n8_plus:

12
source/_integrations/elgato.markdown
View File

@ -60,20 +60,20 @@ If you have a Key Light Mini, Home Assistant will provide an additional
switch that allows the control of the "Studio mode" of your light. When
studio mode is enabled, your battery will not be used and bypassed.
## Services
## Actions
### Service `elgato.identify`
### Action `elgato.identify`
The identify service shortly blinks the Elgato light. Originally meant as
The identify action shortly blinks the Elgato light. Originally meant as
a way to identify which light you are talking to; it can also be used as
a service to create a visual notification.
an action to create a visual notification.
This service also works when the light is turned off and will turn off the
This action also works when the light is turned off and will turn off the
light after the identification sequence has been completed.
{% my developer_call_service badge service="elgato.identify" %}
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | Yes | String or list of Elgato light entity IDs.

50
source/_integrations/elkm1.markdown
View File

@ -441,10 +441,10 @@ The `event_data` contains the following:
- `key_name`: The name of the key that was pressed.
- `key`: The number of the key that was pressed.
## Services
## Actions
Besides the standard Home Assistant services for Alarm control panel, Climate, Light, Scene, Sensor,
and Switch the ElkM1 integration offers these additional services:
Besides the standard Home Assistant actions for Alarm control panel, Climate, Light, Scene, Sensor,
and Switch the ElkM1 integration offers these additional actions:
- `elkm1.alarm_arm_home_instant`
- `elkm1.alarm_arm_night_instant`
@ -460,31 +460,31 @@ and Switch the ElkM1 integration offers these additional services:
- `elkm1.speak_phrase`
- `elkm1.speak_word`
### Services `elkm1.alarm_arm_home_instant`, `elkm1.alarm_arm_night_instant`, and `elkm1.alarm_arm_vacation`
### Actions `elkm1.alarm_arm_home_instant`, `elkm1.alarm_arm_night_instant`, and `elkm1.alarm_arm_vacation`
Arms the ElkM1 area in "home instant", "night instant", or "vacation" modes
respectively.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------- |
| `entity_id` | yes | ElkM1 area which to arm. |
| `code` | no | Alarm code to arm the system (4 or 6 digits). |
### Services `elkm1.alarm_bypass` and `elkm1.alarm_clear_bypass`
### Actions `elkm1.alarm_bypass` and `elkm1.alarm_clear_bypass`
For all zones associated with the specified alarm panel these services respectively
For all zones associated with the specified alarm panel these actions respectively
bypass or clear the bypass the zones.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------------------------------------------------- |
| `entity_id` | yes | ElkM1 area which to bypass or clear bypass. |
| `code` | no | Alarm code to bypass the alarm panel (4 or 6 digits). |
### Service `elkm1.alarm_display_message`
### Action `elkm1.alarm_display_message`
Display text on an area's keypads.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------- |
| `entity_id` | yes | ElkM1 area which to display the message. |
| `clear` | yes | 0=clear message, 1=clear message with * key, 2=Display until timeout; default 2 |
@ -493,66 +493,66 @@ Display text on an area's keypads.
| `line1` | yes | Up to 16 characters of text (truncated if too long). Default blank. |
| `line2` | yes | Up to 16 characters of text (truncated if too long). Default blank. |
### Service `elkm1.sensor_counter_refresh`
### Action `elkm1.sensor_counter_refresh`
Refresh the value of a counter. Note that under certain conditions the
panel does not automatically send a new value under certain
conditions. This service retrieves the current counter value.
conditions. This action retrieves the current counter value.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------- |
| `entity_id` | yes | ElkM1 counter to refresh. |
### Service `elkm1.sensor_counter_set`
### Action `elkm1.sensor_counter_set`
Set counter to value.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------- |
| `entity_id` | yes | ElkM1 counter to refresh. |
| `value` | no | Value to set the counter to Can be 0-65536. |
### Service `elkm1.sensor_zone_bypass`
### Action `elkm1.sensor_zone_bypass`
Bypass a zone. Note that the only mechanism ElkM1 offers to clear the bypass
is to clear all the bypassed zones in a given alarm panel (area).
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------------------------- |
| `entity_id` | yes | ElkM1 zone which to bypass. |
| `code` | no | Alarm code to bypass the zone (4 or 6 digits). |
### Service `elkm1.sensor_zone_trigger`
### Action `elkm1.sensor_zone_trigger`
Cause a zone on the panel to trigger. This command creates a virtual momentary
open condition on the zone as if the EOL hardwired loop had been physically opened.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ---------------------------- |
| `entity_id` | yes | ElkM1 zone which to trigger. |
### Service `elkm1.set_time`
### Action `elkm1.set_time`
Set the time on the panel. Uses the current time on the instance of Home Assistant.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------- |
| `prefix` | yes | Prefix to identify panel when multiple panels configured. |
### Service `elkm1.speak_phrase`
### Action `elkm1.speak_phrase`
Speak a phrase. The list of phrases is defined in the ElkM1 ASCII Protocol documentation.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------- |
| `phrase` | no | Phrase to speak. |
| `prefix` | yes | Prefix to identify panel when multiple panels configured. |
### Service `elkm1.speak_word`
### Action `elkm1.speak_word`
Speak a word. The list of words is defined in the ElkM1 ASCII Protocol documentation.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | --------------------------------------------------------- |
| `word` | no | Word to speak. |
| `prefix` | yes | Prefix to identify panel when multiple panels configured. |

18
source/_integrations/energyzero.markdown
View File

@ -55,15 +55,15 @@ For the dynamic gas prices, only entities are created that display the
`current` and `next hour` price because the price is always fixed for
24 hours; new prices are published every morning at **05:00 UTC time**.
## Services
## Actions
The energy and gas prices are exposed using [service calls](/docs/scripts/service-calls/). The services populate [Response Data](/docs/scripts/service-calls#use-templates-to-handle-response-data) with price data.
The energy and gas prices are exposed using [actions](/docs/scripts/service-calls/). The actions populate [Response Data](/docs/scripts/service-calls#use-templates-to-handle-response-data) with price data.
### Service `energyzero.get_gas_prices`
### Action `energyzero.get_gas_prices`
Fetches the gas prices. The `config_entry` value be found using the Services tab in the Developer Tools, selecting the desired entity and then switching to YAML.
Fetches the gas prices. The `config_entry` value be found using the **Actions** tab in the **Developer Tools**, selecting the desired entity and then switching to YAML.
| Service data attribute | Optional | Description | Example |
| Data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | --------|
| `config_entry` | no | Config entry to use. | 1b4a46c6cba0677bbfb5a8c53e8618b0
| `incl_vat` | no | Defines whether the prices include or exclude VAT. | false
@ -94,13 +94,13 @@ The response data is a dictionary with the gas timestamps and prices as string a
{% endraw %}
### Service `energyzero.get_energy_prices`
### Action `energyzero.get_energy_prices`
Fetches the energy prices. The `config_entry` value be found using the Services tab in the Developer Tools, selecting the desired entity and then switching to YAML.
Fetches the energy prices. The `config_entry` value be found using the **Actions** tab in the **Developer Tools**, selecting the desired entity and then switching to YAML.
| Service data attribute | Optional | Description | Example |
| Data attribute | Optional | Description | Example |
| ---------------------- | -------- | ----------- | --------|
| `config_entry` | no | Config entry to use. Can be found using the Services tab in the Developer Tools and switching to YAML. | 1b4a46c6cba0677bbfb5a8c53e8618b0
| `config_entry` | no | Config entry to use. Can be found using the **Actions** tab in the **Developer Tools** and switching to YAML. | 1b4a46c6cba0677bbfb5a8c53e8618b0
| `incl_vat` | no | Defines whether the prices include or exclude VAT. | false
| `start` | yes | Start time to get prices. Defaults to today 00:00:00 | 2023-01-01 00:00:00
| `end` | yes | End time to get prices. Defaults to today 00:00:00 | 2023-01-01 00:00:00

2
source/_integrations/enphase_envoy.markdown
View File

@ -97,7 +97,7 @@ When the relay mode is set to battery level, the relays will turn on and off bas
## Polling interval
The default polling interval is 60 seconds. To customize the polling interval, refer to [defining a custom polling interval](/common-tasks/general/#defining-a-custom-polling-interval). Specify one single entity from the envoy device as target of the service using the `+ choose entity` button. Updating one entity will update all entities of the Envoy and the related devices like the inverters; there is no need to specify multiple or all entities or add (all) inverter entities. When using multiple Envoys, add one entity for each envoy as targets or create separate custom polling intervals with a single entity as needed.
The default polling interval is 60 seconds. To customize the polling interval, refer to [defining a custom polling interval](/common-tasks/general/#defining-a-custom-polling-interval). Specify one single entity from the envoy device as target of the action using the `+ choose entity` button. Updating one entity will update all entities of the Envoy and the related devices like the inverters; there is no need to specify multiple or all entities or add (all) inverter entities. When using multiple Envoys, add one entity for each envoy as targets or create separate custom polling intervals with a single entity as needed.
## Credentials or device IP address update

8
source/_integrations/environment_canada.markdown
View File

@ -41,7 +41,7 @@ The integration will create the entities listed below. Some of the entities are
### Camera
- Loop of radar imagery from the last 3 hours (disabled by default). Also, by default this entity uses the radar rain layer from 1 April to 30 November and the snow layer from 1 December to 31 March. The rain/snow layer can be changed using the service described below.
- Loop of radar imagery from the last 3 hours (disabled by default). Also, by default, this entity uses the radar rain layer from 1 April to 30 November and the snow layer from 1 December to 31 March. The rain/snow layer can be changed using the action described below.
### Sensors
@ -133,13 +133,13 @@ template:
{% endraw %}
## Services
## Actions
### Service `environment_canada.set_radar_type`
### Action `environment_canada.set_radar_type`
Sets the type of radar to retrieve for the camera.
| Service data attribute | Optional | Description |
| Data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `entity_id` | yes | Camera to set the radar type for.
| `radar_type` | no | One of "Auto", "Rain", or "Snow".

14
source/_integrations/envisalink.markdown
View File

@ -109,7 +109,7 @@ timeout:
default: 10
type: integer
panic_type:
description: "Both DSC and Honeywell boards support a panic alarm. This is used when the alarm_trigger service is called in Home Assistant. This determines which type of panic alarm to raise. Valid values are: Police, Fire, Ambulance."
description: "Both DSC and Honeywell boards support a panic alarm. This is used when the alarm_trigger action is called in Home Assistant. This determines which type of panic alarm to raise. Valid values are: Police, Fire, Ambulance."
required: false
default: Police
type: string
@ -138,9 +138,9 @@ partitions:
type: string
{% endconfiguration %}
## Services
## Actions
The following services are supported by Envisalink and can be used to script or automate the alarm.
The following actions are supported by Envisalink and can be used to script or automate the alarm.
- **alarm_disarm**: Disarms the alarm with the user code provided, or the code specified in the configuration.
- **alarm_arm_home**: Arms the alarm in home mode.
@ -155,8 +155,8 @@ The following services are supported by Envisalink and can be used to script or
The zone status binary sensors have extra attributes representing additional
information about each zone.
| Name | Description |
| ------------------- | --------------------------------------------------------------------- |
| `last_tripped_time` | Last time this zone was tripped. |
| `zone` | Zone number. Can be used in combination with `alarm_keypress` service |
| Name | Description |
| ------------------- | -------------------------------------------------------------------- |
| `last_tripped_time` | Last time this zone was tripped. |
| `zone` | Zone number. Can be used in combination with `alarm_keypress` action |
to issue commands relating to this zone.

2
source/_integrations/ephember.markdown
View File

@ -48,4 +48,4 @@ The supported operation modes map to the ON/OFF period selection of your timeswi
- **Off** The timeswitch is permanently off.
If **All Day** is selected in the EMBER app it will show as **Auto** in Home Assistant.
To **Boost** your heating, you should call the `climate.set_aux_heater` service on your zone entity. This will then **Boost** that zone for 1 hour.
To **Boost** your heating, you should use the `climate.set_aux_heater` action on your zone entity. This will then **Boost** that zone for 1 hour.

4
source/_integrations/esphome.markdown
View File

@ -50,9 +50,9 @@ This integration allows [ESPHome](https://esphome.io) devices to connect directl
{% include integrations/config_flow.md %}
## Home Assistant service calls
## Home Assistant actions
ESPHome devices can make service calls to any [Home Assistant service](https://esphome.io/components/api.html#homeassistant-service-action). This functionality is not enabled by default for newly configured device, but can be turned on the options flow on a per device basis.
ESPHome devices can perform actions to any [Home Assistant action](https://esphome.io/components/api.html#homeassistant-service-action). This functionality is not enabled by default for newly configured device, but can be turned on the options flow on a per device basis.
{% include integrations/option_flow.md %}

2
source/_integrations/everlights.markdown
View File

@ -39,7 +39,7 @@ hosts:
### Effects
EverLights patterns saved to the control box can be activated using the effect parameter to the `light.turn_on` service. If an effect is specified, then the color and brightness are ignored.
EverLights patterns saved to the control box can be activated using the effect parameter to the `light.turn_on` action. If an effect is specified, then the color and brightness are ignored.
### Limitations

16
source/_integrations/evohome.markdown
View File

@ -116,15 +116,15 @@ Some locations have a hidden mode, **AutoWithReset**, that will behave as **Auto
In the Home Assistant schema, all this is done via a combination of `HVAC_MODE` and `PRESET_MODE` (but also see the state attributes `system_mode_status` and `setpoint_status`, below).
## Service calls
## Action calls
This integration provides its own service calls to expose the full functionality of TCC systems beyond the limitations of Home Assistant's standardized schema. Mostly, this relates to specifying the duration of mode changes, after which time the entities revert to **Auto** or **FollowSchedule** (for locations and zones, respectively).
This integration provides its own actions to expose the full functionality of TCC systems beyond the limitations of Home Assistant's standardized schema. Mostly, this relates to specifying the duration of mode changes, after which time the entities revert to **Auto** or **FollowSchedule** (for locations and zones, respectively).
It is recommended to use the native service calls (e.g., `evohome.set_system_mode`) instead of Home Assistant's generic equivalents (e.g., `climate.set_hvac_mode`) whenever possible. However, it may be necessary to use the generic service calls for integration with 3rd party systems such as Amazon Alexa or Google Home.
It is recommended to use the native actions (e.g., `evohome.set_system_mode`) instead of Home Assistant's generic equivalents (e.g., `climate.set_hvac_mode`) whenever possible. However, it may be necessary to use the generic actions for integration with 3rd party systems such as Amazon Alexa or Google Home.
### evohome.set_system_mode
This service call will set the operating `mode` of the system for a specified period of time, after which it will revert to **Auto**. However, if no period of time is provided, then the change is permanent.
This action call will set the operating `mode` of the system for a specified period of time, after which it will revert to **Auto**. However, if no period of time is provided, then the change is permanent.
For **AutoWithEco**, the period of time is a `duration` is up to 24 hours.
@ -148,17 +148,17 @@ For the other modes, such as **Away**, the duration is a `period` of days, where
### evohome.reset_system
This service call will set the operating mode of the system to **AutoWithReset**, and reset all the zones to **FollowSchedule**.
This action will set the operating mode of the system to **AutoWithReset**, and reset all the zones to **FollowSchedule**.
Not all systems support this feature.
### evohome.refresh_system
This service call will immediately pull the latest state data from the vendor's servers rather than waiting for the next `scan_interval`.
This action will immediately pull the latest state data from the vendor's servers rather than waiting for the next `scan_interval`.
### evohome.set_zone_override
This service call will set the `setpoint` of a zone, as identified by its `entity_id`, for a specified period of time (**TemporaryOverride**). However, if no period of time is provided (c.f. a duration of 0, below), then the change is permanent (**PermanentOverride**).
This action will set the `setpoint` of a zone, as identified by its `entity_id`, for a specified period of time (**TemporaryOverride**). However, if no period of time is provided (c.f. a duration of 0, below), then the change is permanent (**PermanentOverride**).
```yaml
- action:
@ -183,7 +183,7 @@ The `duration` can be up to 24 hours, after which the zone mode will revert to s
### evohome.clear_zone_override
This service call is used to set a zone, as identified by its `entity_id`, to **FollowSchedule**.
This action is used to set a zone, as identified by its `entity_id`, to **FollowSchedule**.
## Useful Jinja templates

38
source/_integrations/ezviz.markdown
View File

@ -73,63 +73,63 @@ You can also change the camera options should you need to access a high or low r
- Please note this only works on the camera entities.
### Service `ezviz.alarm_sound`
### Action `ezviz.alarm_sound`
If your EZVIZ camera supports warning sounds, you can use this service to set the intensity.
If your EZVIZ camera supports warning sounds, you can use this action to set the intensity.
| 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. |
| `level` | Set the sound level to 0 for Soft, 1 for Intensive or 2 to disable |
### Service `ezviz.ptz`
### Action `ezviz.ptz`
If your EZVIZ 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. |
| `direction` | Direction of the movement. Allowed values: `up`, `down`, `left`, `right` |
| `speed` | (Optional) Speed to in which to move the camera. Allowed values: int from 1 to 9. Default: 5 |
### Service `ezviz.set_alarm_detection_sensibility`
### Action `ezviz.set_alarm_detection_sensibility`
If your EZVIZ camera supports motion detection, you will be able to set the sensitivity level using this service.
If your EZVIZ camera supports motion detection, you will be able to set the sensitivity level using this action.
| 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. |
| `level` | Sensibility level (1-6) for type 0 (Normal camera) or (1-100) for type 3 (PIR sensor camera). |
| `type_value` | Type of detection. Options : 0 - Camera or 3 - PIR Sensor Camera. |
### Service `ezviz.sound_alarm`
### Action `ezviz.sound_alarm`
If your EZVIZ camera has a built-in siren, you can use this service to make a noise.
If your EZVIZ camera has a built-in siren, you can use this action to make a noise.
| 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. |
| `enable` | Sound the alarm by setting this to 1 or stop the siren by setting this to 0. |
### Service `ezviz.wake_device`
### Action `ezviz.wake_device`
If you have "sleep" mode enabled on your camera, you can use this service to wake it. Especially useful for battery cameras.
If you have "sleep" mode enabled on your camera, you can use this action to wake it. Especially useful for battery cameras.
| 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. |
To enable/disable motion detection, use the Home Assistant built in services.
To enable/disable motion detection, use the Home Assistant built in actions.
### Service `camera.enable_motion_detection`
### Action `camera.enable_motion_detection`
| 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. |
### Service `camera.disable_motion_detection`
### Action `camera.disable_motion_detection`
| 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. |