Add voice-assistant entity and audio-stream support #38
Conversation
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
workaround for missing session_id & AudioConfiguration information
- For abnormal terminations (timeout, remote abort, local abort, error), raise specific exceptions from the iterator. - expose metadata about the end (reason, error) via properties for post- loop inspection. - Exception hierarchy: - `VoiceSessionClosed(Exception)` base with optional fields (reason, error). - `VoiceSessionTimeout(VoiceSessionClosed)` - `VoiceSessionRemoteEnd(VoiceSessionClosed)` - `VoiceSessionLocalEnd(VoiceSessionClosed)` - `VoiceSessionError(VoiceSessionClosed)` - End reason type: - `VoiceEndReason` Enum: `NORMAL`, `TIMEOUT`, `REMOTE`, `LOCAL`, `ERROR`
Verify AudioConfiguration in session from voice_start command. This requires firmware 2.8.2 or newer.
Simplify, too many dicts keeping track of a voice session! Enforce that there's only one session per voice-assistant entity.
Pass the WS connection as an optional command parameter to the client. This allows the client to send directed WS events back. Otherwise, the only option is to use event broadcasts to all connected clients. Implementation is backward compatible to existing clients without the new websocket parameter in the CommandHandler callback, or extending a concrete Entity class. Import cleanup to avoid circular imports through the ucapi definition.
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.
Add voice-assistant entity support.
The binary protobuf audio chunk messages are exposed as an easy to use voice-stream session in integration drivers.
A minimal example is included in
examples/voice.py.Breaking Changes
CommandHandlercallback andEntity.commandmethod to allow clients to send back event messages.Changed
Required for: unfoldedcircle/integration-androidtv#120
Closes #37