Add preannounce media url and start conversation to voice assistant announce message #1099

kahrendt · 2025-03-06T13:47:50Z

Modifies the voice assistant announce message:

Adds preannounce_media_id string, intended for a notification beep, to be played before the actual announce message.
Adds start_conversation boolean, to indicate whether the voice assistant should start a new pipeline immediately after the announce message is finished.

Additionally, it adds a new voice assistant feature flag START_CONVERSATION to indicate that it is supported.

Implemented in esphome/home-assistant-voice-pe#347

for more information, see https://pre-commit.ci

coderabbitai · 2025-03-06T13:49:05Z

Important

Review skipped

Review was skipped as selected files did not have any reviewable changes.

💤 Files selected but had no reviewable changes (1)

aioesphomeapi/api_pb2.py

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request adds two new fields to the VoiceAssistantAnnounceRequest message to support pre-announcement media handling and conversation initiation. Changes were made in the proto definition, client method signature, and associated model enumeration. Additionally, the Protobuf runtime version in the API options file is updated with added version validation and adjusted descriptor handling.

Changes

File(s)	Change Summary
`aioesphomeapi/api.proto`, `aioesphomeapi/client.py`, `aioesphomeapi/model.py`	- Proto & Client: Added `string preannounce_media_id` and `bool start_conversation` to `VoiceAssistantAnnounceRequest` and updated `APIClient.send_voice_assistant_announcement_await_response` method signature. - Model: Added a new flag `START_CONVERSATION` to the `VoiceAssistantFeature` enumeration.
`aioesphomeapi/api_options_pb2.py`	- Updated Protobuf Python version from `4.25.5` to `5.29.3`. - Added a new import and runtime version validation. - Updated descriptor handling by replacing `DESCRIPTOR._options` with `DESCRIPTOR._loaded_options`.

Sequence Diagram(s)

sequenceDiagram
    participant C as Client
    participant A as APIClient
    participant S as Server

    C->>A: send_voice_assistant_announcement_await_response(media_id, text, preannounce_media_id, start_conversation)
    A->>A: Create VoiceAssistantAnnounceRequest (with new fields)
    A->>S: Send announcement request
    S-->>A: Return VoiceAssistantAnnounceFinishedModel
    A-->>C: Return response

Possibly related PRs

Adds voice assistant announce #939: Modifications to VoiceAssistantAnnounceRequest in the proto file align with changes introduced here.
Add get/set/config messages for voice assistant #956: Also involves enhancements to the voice assistant request message, focusing on additional voice assistant capabilities.

Suggested labels

new-feature

Suggested reviewers

jesserockz

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2025-03-06T13:49:30Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (ef8bc15) to head (3a55020).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main     #1099   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           17        17           
  Lines         2733      2734    +1     
=========================================
+ Hits          2733      2734    +1

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

codspeed-hq · 2025-03-06T13:49:50Z

CodSpeed Performance Report

Merging #1099 will not alter performance

_{Comparing kahrendt:update-voice-announce-message (3a55020) with main (ef8bc15)}

Summary

✅ 4 untouched benchmarks

kahrendt and others added 4 commits March 6, 2025 08:24

add preannounce media and start conversation to announce request

1449992

lint

36f70d8

gen-protoc

d7afd7f

[pre-commit.ci] auto fixes from pre-commit.com hooks

91683dd

for more information, see https://pre-commit.ci

kahrendt mentioned this pull request Mar 6, 2025

[voice_assistant] - Add support for preannounce media and start conversation to announce message esphome/home-assistant-voice-pe#347

Draft

use latest docker to generate

756d65b

bdraco added the waiting-for-esphome Indicates the PR is waiting for the esphome main repo code approval label Mar 8, 2025

Merge branch 'main' into update-voice-announce-message

3a55020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add preannounce media url and start conversation to voice assistant announce message #1099

Add preannounce media url and start conversation to voice assistant announce message #1099

kahrendt commented Mar 6, 2025 •

edited

Loading

coderabbitai bot commented Mar 6, 2025 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

codecov bot commented Mar 6, 2025 •

edited

Loading

codspeed-hq bot commented Mar 6, 2025 •

edited

Loading

Add preannounce media url and start conversation to voice assistant announce message #1099

Are you sure you want to change the base?

Add preannounce media url and start conversation to voice assistant announce message #1099

Conversation

kahrendt commented Mar 6, 2025 • edited Loading

coderabbitai bot commented Mar 6, 2025 • edited Loading

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

codecov bot commented Mar 6, 2025 • edited Loading

Codecov Report

codspeed-hq bot commented Mar 6, 2025 • edited Loading

CodSpeed Performance Report

Merging #1099 will not alter performance

Summary

kahrendt commented Mar 6, 2025 •

edited

Loading

coderabbitai bot commented Mar 6, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Mar 6, 2025 •

edited

Loading

codspeed-hq bot commented Mar 6, 2025 •

edited

Loading