Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions source/_docs/automation/trigger.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,6 @@ automation:
mood: happy
```

<div class='note warning'>

Starting 0.42, it is no longer possible to listen for event `homeassistant_start`. Use the 'homeassistant' platform below instead.

</div>

### Home Assistant trigger

Triggers when Home Assistant starts up or shuts down.
Expand Down
69 changes: 28 additions & 41 deletions source/_docs/configuration/events.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,62 +8,49 @@ The core of Home Assistant is the event bus. The event bus allows any integratio

Home Assistant contains a few built-in events that are used to coordinate between various components.

### Event `homeassistant_start`
Event `homeassistant_start` is fired when all integrations from the configuration have been initialized. This is the event that will start the timer firing off `time_changed` events.

<div class='note warning'>

Starting 0.42, it is no longer possible to listen for event `homeassistant_start`. Use the 'homeassistant' [platform](/docs/automation/trigger) instead.

</div>

### Event `homeassistant_stop`
Event `homeassistant_stop` is fired when Home Assistant is shutting down. It should be used to close any open connection or release any resources.


### Event `state_changed`
Event `state_changed` is fired when a state changes. Both `old_state` and `new_state` are state objects. [Documentation about state objects.](/topics/state_object/)

Field | Description
----- | -----------
`entity_id` | Entity ID of the changed entity. Example: `light.kitchen`
`old_state` | The previous state of the entity before it changed. This field is omitted if the entity is new.
`new_state` | The new state of the entity. This field is omitted if the entity is removed from the state machine.
| Field | Description |
| ----------- | --------------------------------------------------------------------------------------------------- |
| `entity_id` | Entity ID of the changed entity. Example: `light.kitchen` |
| `old_state` | The previous state of the entity before it changed. This field is omitted if the entity is new. |
| `new_state` | The new state of the entity. This field is omitted if the entity is removed from the state machine. |


### Event `time_changed`
Event `time_changed` is fired every second by the timer and contains the current time.

Field | Description
----- | -----------
`now` | A [datetime object](https://docs.python.org/3.4/library/datetime.html#datetime.datetime) containing the current time in UTC.
| Field | Description |
| ----- | ---------------------------------------------------------------------------------------------------------------------------- |
| `now` | A [datetime object](https://docs.python.org/3.4/library/datetime.html#datetime.datetime) containing the current time in UTC. |


### Event `service_registered`
Event `service_registered` is fired when a new service has been registered within Home Assistant.

Field | Description
----- | -----------
`domain` | Domain of the service. Example: `light`.
`service` | The service to call. Example: `turn_on`
| Field | Description |
| --------- | ---------------------------------------- |
| `domain` | Domain of the service. Example: `light`. |
| `service` | The service to call. Example: `turn_on` |


### Event `call_service`
Event `call_service` is fired to call a service.

Field | Description
----- | -----------
`domain` | Domain of the service. Example: `light`.
`service` | The service to call. Example: `turn_on`
`service_data` | Dictionary with the service call parameters. Example: `{ 'brightness': 120 }`.
`service_call_id` | String with a unique call id. Example: `23123-4`.
| Field | Description |
| ----------------- | ------------------------------------------------------------------------------ |
| `domain` | Domain of the service. Example: `light`. |
| `service` | The service to call. Example: `turn_on` |
| `service_data` | Dictionary with the service call parameters. Example: `{ 'brightness': 120 }`. |
| `service_call_id` | String with a unique call id. Example: `23123-4`. |

### Event `service_executed`
Event `service_executed` is fired by the service handler to indicate the service is done.

Field | Description
----- | -----------
`service_call_id` | String with the unique call id of the service call that was executed. Example: `23123-4`.
| Field | Description |
| ----------------- | ----------------------------------------------------------------------------------------- |
| `service_call_id` | String with the unique call id of the service call that was executed. Example: `23123-4`. |

<div class='note warning'>

Expand All @@ -75,15 +62,15 @@ Field | Description

Event `platform_discovered` is fired when a new platform has been discovered by the [`discovery`](/integrations/discovery/) component.

Field | Description
----- | -----------
`service` | The platform that is discovered. Example: `zwave`.
`discovered` | Dictionary containing discovery information. Example: `{ "host": "192.168.1.10", "port": 8889}`.
| Field | Description |
| ------------ | ------------------------------------------------------------------------------------------------ |
| `service` | The platform that is discovered. Example: `zwave`. |
| `discovered` | Dictionary containing discovery information. Example: `{ "host": "192.168.1.10", "port": 8889}`. |


### Event `component_loaded`
Event `component_loaded` is fired when a new integration has been loaded and initialized.

Field | Description
----- | -----------
`component` | Domain of the integration that has just been initialized. Example: `light`.
| Field | Description |
| ----------- | --------------------------------------------------------------------------- |
| `component` | Domain of the integration that has just been initialized. Example: `light`. |