jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Configuration troubleshooting: Add links to related topics (#32937)

Browse Source
This commit is contained in:
c0ffeeca7 2024-05-24 17:04:36 +02:00 committed by GitHub
parent 2e07ac78cd
commit 39bf8320fc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
source/_docs/configuration/troubleshooting.markdown
View File

@ -1,6 +1,10 @@
---
title: "Troubleshooting your configuration"
description: "Common problems with tweaking your configuration and their solutions."
related:
- docs: /docs/configuration/
- docs: /docs/configuration/customizing-devices/
title: Changing entity name and ID
---
It can happen that you run into trouble while configuring Home Assistant. Perhaps an integration is not showing up or is acting strangely. This page will discuss a few of the most common problems.
@ -98,6 +102,8 @@ The only characters valid in entity names are:
The entity name must not start or end with an underscore. If you create an entity with other characters from the UI, Home Assistant validates the name. If you change the name directly in the YAML file, then Home Assistant may not generate an error for that entity. However, attempts to use that entity will generate errors (or possibly fail silently).
For instructions on how to change an entity name, refer to the section on [changing entity name and entity ID](/docs/configuration/customizing-devices/#changing-entity-name-and-entity-id).
## Debug logs and diagnostics
The first thing you will need before reporting an issue online is debug logs and diagnostics (if available) for the integration giving you trouble. Getting those ahead of time will ensure someone can help resolve your issue in the fastest possible manner.