4.5 KiB
title, description, ha_category, ha_release, ha_quality_scale, ha_domain, ha_codeowners, ha_integration_type, related
| title | description | ha_category | ha_release | ha_quality_scale | ha_domain | ha_codeowners | ha_integration_type | related | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Event | Instructions on how to use event entities in Home Assistant. |
|
2023.8 | internal | event |
|
entity |
|
Events are signals that are emitted when something happens, for example, when a user presses a physical button like a doorbell or when a button on a remote control is pressed.
These events do not capture a state in the traditional sense. For example, a doorbell does not have a state such as "on" or "off" but instead is momentarily pressed. Some events can have variations in the type of event that is emitted. For example, maybe your remote control is capable of emitting a single press, a double press, or a long press.
The event entity can capture these events in the physical world and makes them available in Home Assistant as an entity.
{% include integrations/building_block_integration.md %}
The state of an event entity
The event entity does not capture a state such as on or off. Instead, an event entity keeps track of the timestamp when the emitted event has last been detected.
Event entity with a timestamp value in state and event type "pressed".
Because the state of an event entity in Home Assistant is a timestamp, it means we can use it in our automations. For example:
trigger:
- platform: state
entity_id: event.doorbell
action:
- action: notify.frenck
data:
message: "Ding Dong! Someone is at the door!"
Event types
Besides the timestamp of the last event, the event entity also keeps track of the event type that has last been emitted. This can be used in automations to trigger different actions based on the type of event.
This allows you, for example, to trigger a different action when the button on a remote control is pressed once or twice, if your remote control is capable of emitting these different types of events.
When combining that with the choose action script, you can assign multiple different actions to a single event entity. In the following example, short- or long-pressing the button on the remote will trigger a different scene:
trigger:
- platform: state
entity_id: event.hue_remote_control
action:
- alias: "Choose an action based on the type of event"
choose:
- conditions:
- alias: "Normal evening scene if the button was pressed"
condition: state
entity_id: event.hue_remote_control_on_button
attribute: "event_type"
state: "short_release"
sequence:
- scene: scene.living_room_evening
- conditions:
- alias: "Scene for watching a movie if the button was long-pressed"
condition: state
entity_id: event.hue_remote_control_on_button
attribute: "event_type"
state: "long_release"
sequence:
- scene: scene.living_room_movie
When creating automations in the automation editor in the UI, the event types are available as a dropdown list, depending on the event entity you are using. This means you don't have to remember the different event types and can easily select them.
Device class
{% include integrations/device_class_intro.md %}
The screenshot shows different icons representing device classes of the event entity:
Example of different icons representing device classes of the event entity.
The following device classes are supported by event entities:
- None: Generic event. This is the default and doesn't need to be set.
- button: For remote control buttons.
- doorbell: Specifically for buttons that are used as a doorbell.
- motion: For motion events detected by a motion sensor.
Video tutorial
This comprehensive video tutorial explains how events work in Home Assistant and how you can set up Emulated Roku to control a media player using a physical remote control.