Skip to content

Add troubleshooting section to ESPHome #38615

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 18, 2025
Merged

Add troubleshooting section to ESPHome #38615

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
95e170a
Add troubleshooting section to ESPHome
bdraco Apr 18, 2025
d45ae73
Update esphome.markdown
bdraco Apr 18, 2025
a6d26cd
Merge branch 'current' into bdraco-patch-13
bdraco Apr 18, 2025
dce7d6e
Apply suggestions from code review
bdraco Apr 18, 2025
08c9cb9
Merge branch 'current' into bdraco-patch-13
bdraco Apr 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion source/_integrations/esphome.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,22 @@ sensor:

The entity will be named `Temperature` and will default to having an entity_id of `sensor.temperature`.

## Obtaining logs from the device
## Troubleshooting

### Viewing Live Logs

To troubleshoot your ESPHome devices, you can easily view live logs, whether you're using the [**ESPHome Device Builder Add-on**](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) or the **ESPHome CLI**. The logs contain detailed information such as Wi-Fi connection status, errors, and debug messages, which can help you identify and resolve issues with your device.

#### Using the [**ESPHome Device Builder Add-on**](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon)
1. In the [**ESPHome Device Builder Add-on**](https://my.home-assistant.io/redirect/supervisor_addon/?addon=5c53de3b_esphome&repository_url=https%3A%2F%2Fgithub.com%2Fesphome%2Fhome-assistant-addon) add-on, find the device you're working with.
2. Click the **LOGS** button to open the log view.

#### Using the **ESPHome CLI**
If you're using the **ESPHome CLI**, follow the instructions for the [logs Command](https://esphome.io/guides/cli.html#logs-command) to access the logs.

### Obtaining Logs from the Device

If you want the device to send logs without requiring you to be actively monitoring, follow these steps:

1. To have the device send logs to Home Assistant, in the [options flow](#options), enable `Subscribe to logs from the device`.
- They are logged under the `homeassistant.components.esphome` logger at the equivalent level.
Expand Down