Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.wake_word.WakeWordDetectionEntity Class Reference
Inheritance diagram for homeassistant.components.wake_word.WakeWordDetectionEntity:
[legend]
Collaboration diagram for homeassistant.components.wake_word.WakeWordDetectionEntity:
[legend]

Public Member Functions

None async_internal_added_to_hass (self)
 
DetectionResult|None async_process_audio_stream (self, AsyncIterable[tuple[bytes, int]] stream, str|None wake_word_id)
 
list[WakeWordget_supported_wake_words (self)
 
str|None state (self)
 
- Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_added_to_hass (self)
 
None async_device_update (self, bool warning=True)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool available (self)
 
dict[str, Any]|None capability_attributes (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
Mapping[str, Any]|None extra_state_attributes (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 

Static Public Attributes

 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Private Member Functions

DetectionResult|None _async_process_audio_stream (self, AsyncIterable[tuple[bytes, int]] stream, str|None wake_word_id)
 

Private Attributes

 __last_detected
 

Static Private Attributes

 _attr_entity_category = EntityCategory.DIAGNOSTIC
 
bool _attr_should_poll = False
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Detailed Description

Represent a single wake word provider.

Definition at line 80 of file __init__.py.

Member Function Documentation

◆ _async_process_audio_stream()

DetectionResult | None homeassistant.components.wake_word.WakeWordDetectionEntity._async_process_audio_stream (   self,
AsyncIterable[tuple[bytes, int]]  stream,
str | None   wake_word_id 
)
private
Try to detect wake word(s) in an audio stream with timestamps.

Audio must be 16Khz sample rate with 16-bit mono PCM samples.

Reimplemented in homeassistant.components.wyoming.wake_word.WyomingWakeWordProvider.

Definition at line 98 of file __init__.py.

◆ async_internal_added_to_hass()

None homeassistant.components.wake_word.WakeWordDetectionEntity.async_internal_added_to_hass (   self)
Call when the entity is added to hass.

Reimplemented from homeassistant.helpers.restore_state.RestoreEntity.

Definition at line 121 of file __init__.py.

◆ async_process_audio_stream()

DetectionResult | None homeassistant.components.wake_word.WakeWordDetectionEntity.async_process_audio_stream (   self,
AsyncIterable[tuple[bytes, int]]  stream,
str | None   wake_word_id 
)
Try to detect wake word(s) in an audio stream with timestamps.

Audio must be 16Khz sample rate with 16-bit mono PCM samples.

Definition at line 106 of file __init__.py.

◆ get_supported_wake_words()

list[WakeWord] homeassistant.components.wake_word.WakeWordDetectionEntity.get_supported_wake_words (   self)
Return a list of supported wake words.

Reimplemented in homeassistant.components.wyoming.wake_word.WyomingWakeWordProvider.

Definition at line 94 of file __init__.py.

◆ state()

str | None homeassistant.components.wake_word.WakeWordDetectionEntity.state (   self)
Return the state of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 89 of file __init__.py.

Member Data Documentation

◆ __last_detected

homeassistant.components.wake_word.WakeWordDetectionEntity.__last_detected
private

Definition at line 116 of file __init__.py.

◆ _attr_entity_category

homeassistant.components.wake_word.WakeWordDetectionEntity._attr_entity_category = EntityCategory.DIAGNOSTIC
staticprivate

Definition at line 83 of file __init__.py.

◆ _attr_should_poll

bool homeassistant.components.wake_word.WakeWordDetectionEntity._attr_should_poll = False
staticprivate

Definition at line 84 of file __init__.py.

◆ None

homeassistant.components.wake_word.WakeWordDetectionEntity.None
static

Definition at line 85 of file __init__.py.


The documentation for this class was generated from the following file: