mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-13 12:26:50 +00:00
Add service information to homeassistant integration (#11607)
* Update homeassistant.markdown Add services and descriptions for `homeassistant` * Update service-calls.markdown Add link to homeassistant services information * Update homeassistant.markdown adhere to documentation standards * Apply suggestions from code review Fix heading levels and a copy/paste typo Co-Authored-By: Franck Nijhof <frenck@frenck.nl> * Apply suggestions from code review make entity_id's optional Co-Authored-By: Franck Nijhof <frenck@frenck.nl> Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
parent
ffec20f792
commit
d82aaa88d1
@ -96,7 +96,10 @@ There are four `homeassistant` services that aren't tied to any single domain, t
|
||||
* `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][homeassistant-integration-services] page.
|
||||
|
||||
[templating]: /topics/templating/
|
||||
[google travel time]: /integrations/google_travel_time/
|
||||
[template sensor]: /integrations/template/
|
||||
[light]: /integrations/light/
|
||||
[homeassistant-integration-services]: /integrations/homeassistant#services
|
||||
|
@ -3,6 +3,116 @@ title: "Core integration"
|
||||
description: "Description of the homeassistant integration."
|
||||
logo: home-assistant.png
|
||||
ha_release: 0.0
|
||||
ha_qa_scale: internal
|
||||
---
|
||||
|
||||
The Home Assistant integration provides generic implementations like the generic `homeassistant.turn_on`.
|
||||
|
||||
## Services
|
||||
|
||||
The `homeassistant` integration provides services for controlling Home Assistant itself, as well as generic controls for any entity.
|
||||
|
||||
### Service `homeassistant.check_config`
|
||||
|
||||
Reads the config files and checks them for correctness, but **does not** load them into Home Assistant. Creates a persistent notification and log entry if errors are found.
|
||||
|
||||
### Service `homeassistant.reload_core_config`
|
||||
|
||||
Loads the main config file (`configuration.yaml`) and all linked files. Once loaded the new configuration is applied.
|
||||
|
||||
### Service `homeassistant.restart`
|
||||
|
||||
Restarts the Home Assistant instance (also reloading the configuration on start).
|
||||
|
||||
### Service `homeassistant.stop`
|
||||
|
||||
Stops the Home Assistant instance. Home Assistant must be restarted from the Host device to run again.
|
||||
|
||||
### Service `homeassistant.set_location`
|
||||
|
||||
Update the location of the Home Assistant default zone (usually "Home").
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `latitude` | no | Latitude of your location. |
|
||||
| `longitude` | no | Longitude of your location. |
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
action:
|
||||
service: homeassistant.set_location
|
||||
data:
|
||||
latitude: 32.87336
|
||||
longitude: 117.22743
|
||||
```
|
||||
|
||||
### 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.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | yes | The entity_id of the device to toggle on/off. |
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
action:
|
||||
service: homeassistant.toggle
|
||||
data:
|
||||
entity_id: light.living_room
|
||||
```
|
||||
|
||||
#### 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.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | yes | The entity_id of the device to turn on. |
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
action:
|
||||
service: homeassistant.turn_on
|
||||
data:
|
||||
entity_id: light.living_room
|
||||
```
|
||||
|
||||
### 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.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | yes | The entity_id of the device to turn off. |
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
action:
|
||||
service: homeassistant.turn_off
|
||||
data:
|
||||
entity_id: light.living_room
|
||||
```
|
||||
|
||||
### Service `homeassistant.update_entity`
|
||||
|
||||
Force one or more entities to update its data rather than wait for the next scheduled update.
|
||||
|
||||
| Service data attribute | Optional | Description |
|
||||
|---------------------------|----------|-------------------------------------------------------|
|
||||
| `entity_id` | no | One or multiple entity_ids to update. It can be a list. |
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
action:
|
||||
service: homeassistant.update_entity
|
||||
data:
|
||||
entity_id:
|
||||
- light.living_room
|
||||
- switch.coffe_pot
|
||||
```
|
||||
|
Loading…
x
Reference in New Issue
Block a user