Reporting issues


If you have an installation, a setup or a configuration issue please use our Forum to get help. We have a big community which will help you if they can.

If you found a bug then please report it in one of our trackers. To help you and our developers to identify the issue quickly, please fill out the provided template. The “weird” content you will see is there to render your entry in a nice format after submitting. It’s just markddown.

Use the command below to get the Home Assistant release you are running from a command-line.

$ hass --version

Otherwise check the About page which is accessible in the Developer tools of the Home Assistant frontend.

First Home Assistant release with the issue

Please provide the release which contains the issue.

Last working Home Assistant release (if known)

If possible, provide the latest release of which you know that the component or platform was working. Home Assistant is evolving very fast and issues may already be addressed or be introduced by a recent change.

Operating environment (Hass.io/Docker/Windows/etc.)

There are many different ways to run Home Assistant. In this section please mention which you are using, e.g. manual installation, Hass.io, Hasbian or as container (Docker). It can help if you mention which operating system you are using because not all are supported on the same level.

Component/platform

Please add the link to the documention of the component/platform in question. E.g.,

Description of problem

Provide a summary of your issue and tell us what’s wrong.

There are components and platform which require additional steps (installing third-party tools, compilers, etc.) to get your setup working. Please describe the steps you took and the ones to reproduce the issue if needed.

Problem-relevant configuration.yaml entries

To exclude configuration issues and allow the developers to quickly test, and perhaps reproduce, your issue, add the relevant part of your configuration.yaml file. This file is located in your configuration folder.

sensor:
  - platform: random

Make sure that you don’t post your username, password, API key, access token or other secrets.

Traceback (if applicable)

If things go wrong there will be a so-called traceback or an error message in other words in your log. Please include this. It starts with Traceback and can contain informations where the error was triggered in the code.

Traceback (most recent call last):
...

Additional information

This section can contain additional details or other observation. Often the little things can help as well.