Troubleshooting Assist

This section lists a few steps that may help you troubleshoot issues with Assist.

View debug information

  1. Go to Settings > Voice assistants.
  2. From the list of assistants, select your assistant. Select your assistant
  3. In the dialog, select Debug. Open the debug dialog
  4. At the top of the screen, from the dropdown menu, select the run you are interested in. Debug speech-to-text

Test a sentence per language without voice: without executing commands

If you want to test if a sentence works in a specific language without actually executing the commands, use the sentence parser in the Developer tools.

  1. Go to Developer tools > Assist.
  2. In the sentence parser, select the language and enter the sentence you want to test.
  3. The debug tool shows you the following:
    • The intent triggered.
    • The entities that were targeted.
    • Which of the targeted entities were matched. Open the Assist developer tool sentence parser

Test a sentence per assistant without voice: while executing the commands

If you want to test if a sentence works with a specific assistant while actively executing the commands, use the sentence parser in the Debug view.

  1. Open the debug view.
  2. In the top right corner, select the icon. Open the pipeline debug dialog
  3. Select the assistant you want to test.
  4. Select Run text pipeline. Open the pipeline debug dialog
  5. Enter the phrase you want to test and select Run. Open the pipeline debug dialog
  6. Check if it worked. Open the pipeline debug dialog
    • If the phrase does not work, try a variant. For example, if Turn off the light doesn’t work, try: Turn off the lights in the kitchen.
    • Check if your phrase is supported.
    • Make sure you are using the name of the area as it is defined in Home Assistant. If you have a room called bathroom, the phrase Turning on the lights in the bath won’t work.

I do not see any assistant

If under Settings > Voice assistants you do not see any assistants, you are not using the default configuration. The image below shows the Assist section.

Open the pipeline debug dialog

If the Assist section is missing entirely, you need to add the following to your configuration.yaml file:

# Example configuration.yaml entry

Assist does not understand my question about the weather forecast

The example below shows common pitfalls when enquiring about the weather. While some steps are specific to the weather, the general mechanics apply to other entities as well.

  1. Make sure you have a weather service installed.

    • By default, is installed.
  2. Make sure you have an entity set up for the location you are interested in.

    • For example, if you are interested in the weather in Berlin, add an entity for Berlin.

      Create weather entity

  3. Make sure the entity is exposed to Assist:

    • Under Settings > Devices & services > Entities, select the weather entity for that location.

    • In the details view that opens, select the cogwheel, then select Voice Assistant.

      Select voice assistants

    • Make sure the entity is exposed to Assist.

      Expose entity to Assist

  4. Make sure you use the exact entity name when talking to Assist.

    • To view the entity name, check the list under Settings > Devices & services > Entities.

    • For example, if the entity is called Forecast Berlin, you have to say “What is the weather in forecast Berlin like”.

    • Assist would not recognize it if you ask “What is the weather in Berlin like”.

    • If you want to use Berlin instead of Forecast Berlin, you can create an entity name alias.

      • You can create as many aliases as you like.

      Create alias for entity name

  5. If you just ask “What is the weather” when you have forecast entities for multiple entities, Assist always returns the data for the place that was first added. Currently, there is no way to change that.

Tweaking the Assist audio configuration for your device

You think there is an issue with background noise or speaker volume? In some cases, it can help to tweak settings such as noise suppression and gain of your voice assistant device (such as the S32-S3-BOX-3).

To tweak the Assist audio configuration for your device

  1. Make sure you have the ESPHome add-on installed:

  2. Start the ESPHome add-on, and select Open Web UI.

  3. Adopt your device to the ESPHome add-on:

    • Once the ESPHome add-on is started, you see your device as Discovered.
    • Select Adopt.
    • When prompted, enter the Network credentials of your local 2.4 GHz Wi-Fi network and select Adopt.
  4. If you see a notification that there is an update available for this device, select Update.

  5. Make sure you have access to the configuration file.

    • If you are unsure what method to use, install the File editor add-on.
    • In the File Editor configuration, make sure the Enforce basepath option is disabled.
  6. Edit the general configuration to enable debug mode:

    • Access the config folder and open the configuration.yaml file.

    • Enter the following text:

         debug_recording_dir: /share/assist_pipeline
  7. Save the changes and restart Home Assistant.

  8. Navigate to /share/assist_pipeline.

    • For each voice command you gave, you will find a subfolder with the audio file in .wav format.
  9. Listen to the audio file of interest.

  10. Open the configuration file:

    • In the ESPHome add-on, on your device, select Edit.
    • This lets you edit the configuration file of that device.
  11. To add a section to adjust noise suppression and volume, add the following lines:

       noise_suppression_level: 3
       auto_gain: 31dBFS
       volume_multiplier: 10.0
  12. Adjust the settings:

    • If the audio is too noisy, increase the noise_suppression_level (max. 4).
    • If the audio is too quiet, increase either the auto_gain (max. 31) or the volume_multiplier (no maximum, but a too high value will cause distortion eventually).
  13. Note: Collecting debug recordings impacts your disk space.

    • Once you have found a configuration that works, delete the folder with the audio files.
    • In the configuration.yaml file, delete the assist_pipeline entry and restart Home Assistant.