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.

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

Add Assist timers #117199

Merged
merged 19 commits into from May 14, 2024
Merged

Add Assist timers #117199

merged 19 commits into from May 14, 2024

Conversation

synesthesiam
Copy link
Contributor

Proposed change

Adds support for timers to Assist. These timers are internal to Assist and do not persist across HA restarts.

Sentences have not been added yet, just intents!

Capabilities

The following capabilities for timers are supported:

  • Starting a timer with hours/minutes/seconds and an optional name
  • Pausing and unpausing
  • Adding and removing time
  • Cancelling
  • Getting the status
  • Attaching an Assist command for when the timer finishes (more below)

Targeting Timers

When performing an action on a timer, such as pausing or cancelling, the timer must be targeted with constraints. Multiple timers cannot be targeted, so the constraints must result in one timer.

The following explicit constraints are supported:

  • Name - "cancel pizza timer"
  • Start time - "pause 5 second timer"
  • Ordinal - "add a minute to the 2nd 10 minute timer"

There are also implicit constraints when timers are set with a device_id. In this case, timers in the same area are prioritized, followed by timers on the same floor.

Attaching Assist Commands

User data may be attached to a timer when started and forwarded to consumers of timer events. A special data.assist_command key allows a text command to be executed when the timer is finished.

This feature enables sentences like "open the garage door in 5 minutes" and "turn off all lights in an hour".

Implementation

Assist timers are implemented using events and asyncio.sleep in background tasks. Timer events include:

  • intent.timer_started - fired when a timer starts
  • intent.timer_updated - fired when a timer is paused/unpaused or time is added/removed
  • intent.timer_cancelled - fired when a timer is cancelled
  • intent.timer_finished - fired when a timer finishes successfully (not cancelled)

Using events makes it very easy for other integrations to make use of Assist timers, and makes it possible to users to create automations with them.

All information about the timer, including the device it was set on and language used to set it, are included with each event.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (conversation) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of conversation can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign conversation Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@home-assistant
Copy link

Hey there @home-assistant/core, mind taking a look at this pull request as it has been labeled with an integration (intent) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of intent can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign intent Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@synesthesiam synesthesiam requested a review from balloob May 10, 2024 15:28
@synesthesiam synesthesiam marked this pull request as ready for review May 10, 2024 16:12
@synesthesiam synesthesiam requested a review from a team as a code owner May 10, 2024 16:12
"""Number of seconds the timer should run as given by the user."""

created_at: int
"""Timestamp when timer was created (time.monotonic_ns)"""
Copy link
Member

Choose a reason for hiding this comment

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

the downside of not using UTC seconds is that we cannot share this info with other consumers. Not sure if we want this? I guess we can add it later.

Copy link
Member

@balloob balloob left a comment

Choose a reason for hiding this comment

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

Looks good! Can be merged if my final comments addressed

@balloob balloob force-pushed the synesthesiam-20240508-timers branch from 6d45a49 to bc174f9 Compare May 14, 2024 18:20
@balloob balloob merged commit add6ffa into dev May 14, 2024
34 checks passed
@balloob balloob deleted the synesthesiam-20240508-timers branch May 14, 2024 18:42
@github-actions github-actions bot locked and limited conversation to collaborators May 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants