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-21 16:27:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adjust homeassistant services description to clarify their purpose (#19035)

Browse Source
This commit is contained in:
Franck Nijhof 2021-08-24 12:44:36 +02:00 committed by GitHub
parent 476abf5ec3
commit 3cd4eb1003
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
source/_integrations/homeassistant.markdown
View File

@ -38,7 +38,7 @@ Reloads the core configuration under `homeassistant:` and all linked files. Once
### Service `homeassistant.restart`
Restarts the Home Assistant instance (also reloading the configuration on start).
Restarts the Home Assistant instance (also reloading the configuration on start).
This will also do a configuration check before doing a restart. If the configuration check fails then Home Assistant will not be restarted, instead a persistent notification with the ID `persistent_notification.homeassistant_check_config` will be created. The logs will show details on what failed the configuration check.
@ -65,9 +65,12 @@ action:
longitude: 117.22743
```
### Service `homeassistant.toggle`
### Service `homeassistant.toggle`
Generic service to toggle devices on/off under any domain. Same usage as the light.turn_on, switch.turn_on, etc. services.
Generic service to toggle devices on/off. Same usage as the
`light.toggle`, `switch.toggle`, etc. services. The difference with this
service compared the others, is that is can be used to mix different domains,
for example, a light and a switch can be toggled in a single service call.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
@ -79,12 +82,17 @@ Generic service to toggle devices on/off under any domain. Same usage as the lig
action:
service: homeassistant.toggle
target:
entity_id: light.living_room
entity_id:
- light.living_room
- switch.tv
```
### Service `homeassistant.turn_on`
### Service `homeassistant.turn_on`
Generic service to turn devices on under any domain. Same usage as the light.turn_on, switch.turn_on, etc. services.
Generic service to toggle devices on. Same usage as the
`light.turn_on`, `switch.turn_on`, etc. services. The difference with this
service compared the others, is that is can be used to mix different domains,
for example, a light and a switch can be turned on in a single service call.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
@ -96,12 +104,17 @@ Generic service to turn devices on under any domain. Same usage as the light.tur
action:
service: homeassistant.turn_on
target:
entity_id: light.living_room
entity_id:
- light.living_room
- switch.tv
```
### Service `homeassistant.turn_off`
Generic service to turn devices off under any domain. Same usage as the light.turn_on, switch.turn_on, etc. services.
Generic service to toggle devices off. Same usage as the
`light.turn_off`, `switch.turn_off`, etc. services. The difference with this
service compared the others, is that is can be used to mix different domains,
for example, a light and a switch can be turned off in a single service call.
| Service data attribute | Optional | Description |
|---------------------------|----------|-------------------------------------------------------|
@ -113,10 +126,12 @@ Generic service to turn devices off under any domain. Same usage as the light.tu
action:
service: homeassistant.turn_off
target:
entity_id: light.living_room
entity_id:
- light.living_room
- switch.tv
```
### Service `homeassistant.update_entity`
### Service `homeassistant.update_entity`
Force one or more entities to update its data rather than wait for the next scheduled update.