2024.11.0
Home ▸ Integrations ▸

Wyoming Protocol

The Wyoming integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] 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
  • Piper
  • 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.

Configuration

To add the Wyoming Protocol service to your Home Assistant instance, use this My button:

Wyoming Protocol can be auto-discovered by Home Assistant. If an instance was found, it will be shown as Discovered. You can then set it up right away.

Manual configuration steps

If it wasn’t discovered automatically, don’t worry! You can set up a manual integration entry:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select Wyoming Protocol.

  • Follow the instructions on screen to complete the setup.

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.