4.3 KiB
| title | description |
|---|---|
| Service Calls | Instructions on how to call services in Home Assistant. |
Various integrations allow calling services when a certain event occurs. The most common one is calling a service when an automation trigger happens. But a service can also be called from a script, a Lovelace dashboard or via voice command devices such as Amazon Echo.
The configuration options to call a configuration are the same between all integrations and are described on this page.
Examples on this page will be given as part of an automation integration configuration but different approaches can be used for other integrations too.
The basics
Call the service homeassistant.turn_on on the entity group.living_room. This will turn all members of group.living_room on. You can also use entity_id: all and it will turn on all possible entities.
service: homeassistant.turn_on
entity_id: group.living_room
Targeting areas and devices
Instead of targeting an entity, you can also target an area or device. Or a combination of these.
This is done with the target key.
A target is a map that contains at least one of the following: area_id, device_id, entity_id.
Each of these can be a list.
When the service is called, the areas and devices will be resolved to entities.
service: homeassistant.turn_on
target:
area_id: livingroom
device_id:
- ff22a1889a6149c5ab6327a8236ae704
- 52c050ca1a744e238ad94d170651f96b
entity_id:
- light.hallway
- light.landing
Passing data to the service call
You can also specify other parameters beside the entity to target. For example, the light.turn_on service allows specifying the brightness.
service: light.turn_on
entity_id: group.living_room
data:
brightness: 120
rgb_color: [255, 0, 0]
A full list of the parameters for a service can be found on the documentation page of each component, in the same way as it's done for the light.turn_on service.
Use templates to decide which service to call
You can use templating support to dynamically choose which service to call. For example, you can call a certain service based on if a light is on.
{% raw %}
service: >
{% if states('sensor.temperature') | float > 15 %}
switch.turn_on
{% else %}
switch.turn_off
{% endif %}
entity_id: switch.ac
{% endraw %}
Using the Services Developer Tool
You can use the Services Developer Tool to test data to pass in a service call. For example, you may test turning on or off a 'group' (See [groups] for more info)
To turn a group on or off, pass the following info:
- Domain:
homeassistant - Service:
turn_on - Service Data:
{ "entity_id": "group.kitchen" }
Use templates to determine the attributes
Templates can also be used for the data that you pass to the service call.
{% raw %}
service: thermostat.set_temperature
target:
entity_id: >
{% if is_state('device_tracker.paulus', 'home') %}
thermostat.upstairs
{% else %}
thermostat.downstairs
{% endif %}
data:
temperature: "{{ 22 - distance(states.device_tracker.paulus) }}"
{% endraw %}
homeassistant services
There are four homeassistant services that aren't tied to any single domain, these are:
homeassistant.turn_on- Turns on an entity (that supports being turned on), for example anautomation,switch, etc.homeassistant.turn_off- Turns off an entity (that supports being turned off), for example anautomation,switch, etc.homeassistant.toggle- Turns off an entity that is on, or turns on an entity that is off (that supports being turned on and off)homeassistant.update_entity- Request the update of an entity, rather than waiting for the next scheduled update, for example Google travel time sensor, a template sensor, or a light
Complete service details and examples can be found on the Home Assistant integration page.