Wake-word detection
A wake-word-detection entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] allows other integrationsIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] or applications to detect wake words in streaming audio.
The wake-word-detection entities cannot be implemented manually, but can be provided by integrations such as Wyoming. The API in Assist Pipelines enables wake-word-detection as part of Assist.
Building block integration
This wake-word detection is a building block integration that cannot be added to your Home Assistant directly but is used and provided by other integrations.
A building block integration differs from the typical integration that connects to a device or service. Instead, other integrations that do integrate a device or service into Home Assistant use this wake-word detection building block to provide entities, services, and other functionality that you can use in your automations or dashboards.
If one of your integrations features this building block, this page documents the functionality the wake-word detection building block offers.
The state of a wake word detection entity
The state of a wake word detection entityAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] is a timestamp showing the date and time when the wake word was last detected.
Screenshot showing the state of a wake word detection entity in the developer tools.
In addition, the entity can have the following states:
- Unavailable: The entity is currently unavailable.
- Unknown: The state is not yet known.