
* Split MQTT documentation * Add more details * Move content to /docs * Enable sidebar * Move content to /docs * Enable sidebar * Move content * Update links * Remove wizard stuff * Enable sidebar * Minor changes * Move MQTT parts to /docs * update links * Update links and sync content * Fix link * Enable sidebar * Remove navigation * Remove navigation and other minor updates * Update links * Add overview page * Make title linkable * Update * Plit content * Update links * Rearrange content * New getting-started section * Add icons for docs * Update for new structure * Update for new structure * Add docs navigation * Add docs overview page * Remove ecosystem navigation * Add docs and remove other collections * Move ecosystem to docs * Remove duplicate files * Re-add ecosystem overview * Move to ecosystem * Fix permission * Update navigation * Remove collection * Move overview to right folder * Move mqtt to upper level * Move notebook to ecosystem * Remove un-used files * Add one more rectangle for iOS * Move two parts back from docs and rename Run step * Remove colon * update getting-started section * Add redirect * Update * Update navigation
4.5 KiB
layout | title | description | date | sidebar | comments | sharing | footer | redirect_from |
---|---|---|---|---|---|---|---|---|
page | Troubleshooting your configuration | Common problems with tweaking your configuration and their solutions. | 2015-01-20 22:36 | true | false | true | true | /getting-started/troubleshooting-configuration/ |
It can happen that you run into trouble while configuring Home Assistant. Perhaps a component is not showing up or is acting strangely. This page will discuss a few of the most common problems.
Before we dive into common issues, make sure you know where your configuration directory is. Home Assistant will print out the configuration directory it is using when starting up.
Whenever a component or configuration option results in a warning, it will be stored in home-assistant.log
in the configuration directory. This file is reset on start of Home Assistant.
{% linkable_title My component does not show up %}
When a component does not show up, many different things can be the case. Before you try any of these steps, make sure to look at the home-assistant.log
file and see if there are any errors related to your component you are trying to set up.
If you have incorrect entries in your configuration files you can use the check_config
script to assist in identifying them: hass --script check_config
.
{% linkable_title Problems with the configuration %}
One of the most common problems with Home Assistant is an invalid configuration.yaml
file.
- You can test your configuration using the command line with:
hass --script check_config
- You can verify your configuration's yaml structure using this online YAML parser or YAML Lint.
- To learn more about the quirks of YAML, read YAML IDIOSYNCRASIES by SaltStack (the examples there are specific to SaltStack, but do explain YAML issues well).
configuration.yaml
does not allow multiple sections to have the same name. If you want to load multiple platforms for one component, you can append a number or string to the name or nest them using this style:
sensor:
- platform: forecast
...
- platform: bitcoin
...
Another common problem is that a required configuration setting is missing. If this is the case, the component will report this to home-assistant.log
. You can have a look at the various component pages for instructions on how to setup the components.
See the logger component for instructions on how to define the level of logging you require for specific modules.
If you find any errors or want to expand the documentation, please let us know.
{% linkable_title Problems with dependencies %}
Almost all components have external dependencies to communicate with your devices and services. Sometimes Home Assistant is unable to install the necessary dependencies. If this is the case, it should show up in home-assistant.log
.
The first step is trying to restart Home Assistant and see if the problem persists. If it does, look at the log to see what the error is. If you can't figure it out, please report it so we can investigate what is going on.
{% linkable_title Problems with components %}
It can happen that some components either do not work right away or stop working after Home Assistant has been running for a while. If this happens to you, please report it so that we can have a look.
{% linkable_title Multiple files %}
If you are using multiple files for your setup, make sure that the pointers are correct and the format of the files is valid.
light: !include devices/lights.yaml
sensor: !include devices/sensors.yaml
Contents of lights.yaml
(notice it does not contain light:
):
- platform: hyperion
host: 192.168.1.98
...
Contents of sensors.yaml
:
- platform: mqtt
name: "Room Humidity"
state_topic: "room/humidity"
- platform: mqtt
name: "Door Motion"
state_topic: "door/motion"
...
Whenever you report an issue, be aware that we are volunteers who do not have access to every single device in the world nor unlimited time to fix every problem out there.