home-assistant.io/source/_integrations/homeassistant.markdown

3.9 KiB

title, description, ha_release, ha_quality_scale, ha_codeowners, ha_domain
title description ha_release ha_quality_scale ha_codeowners ha_domain
Home Assistant Core Integration Description of the homeassistant integration. 0.0 internal
@home-assistant/core
homeassistant

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 configuration 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 configuration 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

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

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

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

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

action:
  service: homeassistant.update_entity
  data:
    entity_id:
    - light.living_room
    - switch.coffe_pot