home-assistant.io/source/_integrations/wyoming.markdown

title, description, ha_category, ha_iot_class, ha_release, ha_codeowners, ha_domain, ha_integration_type, ha_platforms, ha_config_flow, ha_zeroconf

title	description	ha_category	ha_iot_class	ha_release	ha_codeowners	ha_domain	ha_integration_type	ha_platforms	ha_config_flow	ha_zeroconf
Wyoming Protocol	Connect remote voice services to Home Assistant.	Voice	Local Push	2023.5	@balloob @synesthesiam	wyoming	integration	binary_sensor number select stt switch tts	true	true

The Wyoming {% term integration %} connects external voice services to Home Assistant using a small protocol. This enables Assist to use a variety of local speech-to-text, text-to-speech, and wake-word-detection systems, such as:

• Whisper {% my supervisor_addon badge addon="core_whisper" %}
• Piper {% my supervisor_addon badge addon="core_piper" %}
• openWakeWord {% my supervisor_addon badge addon="core_openwakeword" %}

Installing a local voice pipeline

The Wyoming, Piper, and Whisper add-ons are used to create a fully local voice pipeline. To learn how to do this, follow the procedure on installing a local voice pipeline.

{% include integrations/config_flow.md %}

Satellites

Remote voice satellites can be connected to Home Assistant using the Wyoming protocol. These satellites typically run on Raspberry Pi's, and are automatically discovered by Home Assistant through Zeroconf.

Audio Settings

The following settings control audio processing of a satellite's microphone input:

• Noise suppression
  • Level of noise suppression (uses webrtc). Audio distortion may occur as the level increases.
• Auto gain
  • Automatically adjusts volume based on ambient noise (uses webrtc). The setting value is the target dBFS.
• Mic volume
  • Fixed multiplier applied to microphone audio samples. 2.0 doubles the volume, while 0.5 is halves it. Values above 1.0 may increase noise or cause audio distortion.