Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix event documentation example #28402

Merged
merged 1 commit into from
Aug 2, 2023
Merged

Fix event documentation example #28402

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions source/_integrations/event.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Besides the timestamp of the last event, the event entity also keeps track of th

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](/docs/scripts/#choose-a-group-of-actions) script, you can assign multiple different actions to a single event entity. In the following example, pressing the button on the remote once or twice will trigger a different scene:
When combining that with the [choose action](/docs/scripts/#choose-a-group-of-actions) script, you can assign multiple different actions to a single event entity. In the following example, pressing the button on the remote short or long will trigger a different scene:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When combining that with the [choose action](/docs/scripts/#choose-a-group-of-actions) script, you can assign multiple different actions to a single event entity. In the following example, pressing the button on the remote short or long will trigger a different scene:
When combining that with the [choose action](/docs/scripts/#choose-a-group-of-actions) script, you can assign multiple different actions to a single event entity. In the following example, a different scene will be triggered depending on whether you press or press and hold the button:

The MS Style Guide seems to use press and hold / select and hold
https://learn.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/p/press-and-hold

also google:
https://support.google.com/accessibility/android/answer/7650693?hl=en

Alternatively, Apple use the term long-press:
https://developer.apple.com/documentation/uikit/touches_presses_and_gestures/handling_uikit_gestures/handling_long-press_gestures

Copy link
Member Author

@frenck frenck Aug 2, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not in this case, as it is a physical remote, and not an UI button.

As per Microsoft:

CleanShot 2023-08-02 at 09 44 16

This is a hardware button, so matches the guides.


```yaml
trigger:
Expand All @@ -53,19 +53,19 @@ action:
- alias: "Choose an action based on the type of event"
choose:
- conditions:
- alias: "Normal evening scene if the button was pressed once"
- alias: "Normal evening scene if the button was pressed shortly"
condition: state
entity_id: event.hue_remote_control_on_button
attribute: "event_type"
state: "single_press"
state: "short_release"
sequence:
- scene: scene.living_room_evening
- conditions:
- alias: "Move"
- alias: "Scene for watching a movie if the button was pressed long"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- alias: "Scene for watching a movie if the button was pressed long"
- alias: "Scene for watching a movie if the button was pressed and held"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is matching the Hue wording, that is used in the example.

condition: state
entity_id: event.hue_remote_control_on_button
attribute: "event_type"
state: "single_press"
state: "long_release"
sequence:
- scene: scene.living_room_movie
```
Expand Down