Improve CarPlay Assist feedback and playback troubleshooting#4613
Merged
Improve CarPlay Assist feedback and playback troubleshooting#4613
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the CarPlay Assist experience by improving voice-control session feedback, adding playback troubleshooting guidance, and exposing new playback/audio-session tuning options via both user-facing CarPlay settings and debug settings.
Changes:
- Added new CarPlay Assist debug/settings model persisted in
SettingsStore, plus UI surfaces in Debug and CarPlay settings. - Updated CarPlay Assist session flow with additional states (idle/error), retry/help actions, audio cues, and alternative TTS playback strategies for troubleshooting.
- Updated project/CI configuration to build/test against newer Xcode/iOS versions and adjusted SwiftLint exclusions.
Reviewed changes
Copilot reviewed 16 out of 17 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| Sources/Shared/Settings/SettingsStore.swift | Persists and resets the new CarPlay Assist debug/settings bundle via UserDefaults. |
| Sources/Shared/Settings/CarPlayAssistDebugSettings.swift | Defines configurable CarPlay Assist audio/TTS settings (categories, modes, strategies, delays). |
| Sources/Shared/Resources/Swiftgen/Strings.swift | Adds new localized string accessors for playback help and debug/settings UI. |
| Sources/Shared/MaterialDesignIcons+CarPlay.swift | Extends CarPlay icon rendering to support a larger “assist state indicator” icon context. |
| Sources/CarPlay/Templates/QuickAccess/CarPlayQuickAccessTemplate.swift | Hooks Assist pipeline taps to start/stop an Assist session (with new availability guard). |
| Sources/CarPlay/Templates/QuickAccess/CarPlayAssistSession.swift | Implements new Assist session state machine, audio session controls, TTS playback strategies, and help UI. |
| Sources/App/Settings/DebugView.swift | Adds navigation into CarPlay debug settings and updates async sleep usage. |
| Sources/App/Settings/CarPlay/CarPlayConfigurationView.swift | Adds an Advanced settings entry and updates review prompt API usage. |
| Sources/App/Settings/CarPlay/CarPlayAssistSettingsView.swift | Adds a user-facing CarPlay “Advanced > Assist” view for selecting TTS playback strategy. |
| Sources/App/Resources/en.lproj/Localizable.strings | Adds English strings for playback help + debug/settings labels/footers. |
| Sources/App/Assist/Audio/AudioRecorder.swift | Adds a switch to let callers opt out of AudioRecorder managing the audio session. |
| HomeAssistant.xcodeproj/project.pbxproj | Wires new Swift files and audio resource into build phases/groups. |
| fastlane/lanes/testing.rb | Updates simulator destination OS for unit tests. |
| .swiftlint.yml | Excludes build/ from SwiftLint scanning. |
| .github/workflows/distribute.yml | Moves CI to newer Xcode/macOS runner and ensures Ruby is set up consistently. |
| .github/workflows/ci.yml | Moves CI to newer Xcode/macOS runner and updates Ruby setup + cache key inputs. |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4613 +/- ##
=======================================
Coverage ? 43.80%
=======================================
Files ? 278
Lines ? 16943
Branches ? 0
=======================================
Hits ? 7422
Misses ? 9521
Partials ? 0 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
• improve CarPlay Assist voice control flow by keeping the template available after playback
• add idle and error states with retry support
• add extra audio cues for processing and error transitions
• add playback troubleshooting help from the CarPlay Assist UI
• expose TTS playback strategy in CarPlay settings and debug settings
Screenshots
Link to pull request in Documentation repository
Documentation: home-assistant/companion.home-assistant#
Any other notes