diff --git a/docs/core/entity/stt.md b/docs/core/entity/stt.md index 85157d79..b8cde52c 100644 --- a/docs/core/entity/stt.md +++ b/docs/core/entity/stt.md @@ -26,7 +26,7 @@ Properties should always only return information from memory and not do I/O (lik ### Process audio stream -The process audio stream method is used send audio to an STT service and get text back. +The process audio stream method is used to send audio to an STT service and get text back. ```python class MySpeechToTextEntity(SpeechToTextEntity): diff --git a/docs/core/entity/wake_word.md b/docs/core/entity/wake_word.md new file mode 100644 index 00000000..b48cdd31 --- /dev/null +++ b/docs/core/entity/wake_word.md @@ -0,0 +1,50 @@ +--- +title: Wake Word Detection Entity +sidebar_label: Wake Word Detection +--- + +A wake word detection entity allows other integrations or applications to detect wake words (also called hotwords) in an audio stream. + +A wake word detection entity is derived from the [`homeassistant.components.wake_word.WakeWordDetectionEntity`](https://github.com/home-assistant/core/blob/dev/homeassistant/components/wake_word/__init__.py). + +## Properties + +:::tip +Properties should always only return information from memory and not do I/O (like network requests). +::: + +| Name | Type | Default | Description | +|----------------------|----------------|--------------|-----------------------------------------------------------------------------------------------------------------------------| +| supported_wake_words | list[WakeWord] | **Required** | The supported wake words of the service with: