Add troubleshooting section to ESPHome #38615
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Warning Rate limit exceeded@bdraco has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 2 minutes and 19 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe documentation for ESPHome integration has been updated by expanding the section on device logs into a broader "Troubleshooting" section. This new section now includes a dedicated subsection for "Viewing Live Logs," detailing how to access live logs using both the ESPHome Device Builder Add-on and the ESPHome CLI, with a reference link to the CLI documentation. The original instructions for obtaining logs via Home Assistant have been moved under a new subsection, and explanations about adjusting logging levels have been retained with minor formatting improvements. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HomeAssistant
participant ESPHomeAddOn
participant ESPHomeCLI
participant Device
User->>ESPHomeAddOn: Request live logs
ESPHomeAddOn->>Device: Connect and stream logs
Device-->>ESPHomeAddOn: Send live log data
ESPHomeAddOn-->>User: Display live logs
User->>ESPHomeCLI: Run logs command
ESPHomeCLI->>Device: Connect and stream logs
Device-->>ESPHomeCLI: Send live log data
ESPHomeCLI-->>User: Display live logs
User->>HomeAssistant: Enable log subscription
HomeAssistant->>Device: Subscribe to logs
Device-->>HomeAssistant: Send logs (without active monitoring)
HomeAssistant-->>User: Make logs available
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
source/_integrations/esphome.markdown (5)
105-106: ⚙️ Use sentence case for the subheadingFor consistency with other headings (e.g., “Home Assistant actions”), convert to sentence case:
-### Viewing Live Logs +### Viewing live logs
109-112: ⚙️ Remove trailing punctuation and add spacing before the listMarkdown lint flags the trailing colon on the heading and requires a blank line between a heading and its list. Adjust as follows:
-#### Using the **ESPHome Device Builder Add-on**: +#### Using the **ESPHome Device Builder add-on** 1. In the **ESPHome Device Builder** add-on, find the device you're working with. 2. Click the **LOGS** button to open the log view.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
109-109: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
109-109: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
110-110: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
113-115: ⚙️ Remove trailing punctuation and ensure spacingSimilarly, update the CLI subsection heading:
-#### Using the **ESPHome CLI**: +#### 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.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
113-113: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
113-113: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
116-117: ⚙️ Use sentence case for this subheadingAlign with sentence‑case style for headings:
-### Obtaining Logs from the Device +### Obtaining logs from the device
124-126: 🐞 Fix inconsistent internal linkThe logger action link is missing the
/docsprefix. For consistency with other doc links, update like so:- or use the [Developer Tools](/docs/tools/dev-tools/#actions-tab) to call the [`logger.set_level`](/integrations/logger/#action-set_level) action to specify the desired level: + or use the [Developer Tools](/docs/tools/dev-tools/#actions-tab) to call the [logger.set_level action](/docs/integrations/logger/#action-set_level) to specify the desired level:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/esphome.markdown(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/esphome.markdown
109-109: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
109-109: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
110-110: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
113-113: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
113-113: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (2)
source/_integrations/esphome.markdown (2)
103-104: ✅ Approve addition of the Troubleshooting sectionThe new “## Troubleshooting” section cleanly introduces the new content and is well‑placed following existing examples.
120-122: 🔍 Verify the options flow anchorPlease confirm that the link
[options flow](#options)correctly targets the options‑flow section in this document (it may actually be#options-flowor another automatically generated anchor).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
120-120: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
120-120: Link fragments should be valid
null(MD051, link-fragments)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/esphome.markdown (2)
109-112: Fix markdown heading and list formatting
According to markdownlint (MD022, MD026, MD032), this heading should not end with a colon and must be surrounded by blank lines, with the list similarly padded. Please apply:-#### 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): +#### 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. +🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
109-109: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
109-109: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
110-110: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
113-115: Remove trailing punctuation and add blank line after heading
This heading ends with a colon and isn’t surrounded by blank lines. Update to:-#### Using the **ESPHome CLI**: +#### 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.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
113-113: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
113-113: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/esphome.markdown(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/esphome.markdown
109-109: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
109-109: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
110-110: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
113-113: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
113-113: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (4)
source/_integrations/esphome.markdown (4)
103-108: Well-structured introduction to the new Troubleshooting section
The new "Troubleshooting" section and its "Viewing Live Logs" overview are clear, concise, and correctly integrated into the documentation.
116-119: No changes needed in this section.
120-122: Verify internal link anchor
The link to the options flow uses#options. Please confirm that this matches the generated ID of the "Options" section in the rendered HTML to prevent broken links.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
120-120: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
120-120: Link fragments should be valid
null(MD051, link-fragments)
123-132: No changes needed in this section.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_integrations/esphome.markdown (4)
130-133: Refine heading formatting. To satisfy markdownlint rules (MD022, MD026), remove the trailing colon from this subheading and ensure there’s a blank line before and after it. For example:-#### Using the [**ESPHome Device Builder Add-on**]: +#### Using the [**ESPHome Device Builder Add‑on**] 1. In the [**ESPHome Device Builder Add‑on**]...🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
130-130: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
130-130: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
131-131: Lists should be surrounded by blank lines
null(MD032, blanks-around-lists)
134-136: Refine heading formatting for CLI subsection. Apply the same markdownlint fixes here by removing the trailing colon and adding blank lines around the heading:-#### Using the **ESPHome CLI**: +#### Using the **ESPHome CLI**🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
134-134: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
134-134: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
135-136: Consider adding a CLI usage example. To make the CLI instructions more actionable, include a sample command such as:esphome logs <path-to-config>.yaml
144-152: Ensure proper markdown nesting and spacing. For better readability and to satisfy markdownlint (MD032), indent nested list items with four spaces and add a blank line before the YAML code block. For example:-2. To adjust the logging level, there are two options: - - enable [debug logging](/docs/configuration/troubleshooting/#debug-logs-and-diagnostics), - - or use the [Developer Tools](/docs/tools/dev-tools/#actions-tab) to call the [`logger.set_level`](/integrations/logger/#action-set_level) action to specify the desired level: - - ```yaml - action: logger.set_level - data: - homeassistant.components.esphome: debug - ``` +2. To adjust the logging level, there are two options: + - enable [debug logging](/docs/configuration/troubleshooting/#debug-logs-and-diagnostics) + - use the [Developer Tools](/docs/tools/dev-tools/#actions-tab) to call the [`logger.set_level`](/integrations/logger/#action-set_level) action + + ```yaml + action: logger.set_level + data: + homeassistant.components.esphome: debug + ```
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/esphome.markdown(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/esphome.markdown
130-130: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
130-130: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
131-131: Lists should be surrounded by blank lines
null
(MD032, blanks-around-lists)
134-134: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
134-134: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (3)
source/_integrations/esphome.markdown (3)
124-129: Excellent addition of a Troubleshooting section. The new "Troubleshooting" and "Viewing Live Logs" subsections provide clear, step‑by‑step guidance on accessing live logs through both the Device Builder add‑on and the CLI. This will greatly help users diagnose issues with their ESPHome devices.
137-143: Clear instructions for passive log subscription. The "Obtaining Logs from the Device" section effectively explains how to enable log subscription in Home Assistant and adjust log levels via debug logging or thelogger.set_levelaction. This will allow users to capture logs even when they’re not actively monitoring.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
141-141: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
141-141: Link fragments should be valid
null(MD051, link-fragments)
141-143: Verify anchor link for options flow. The link[options flow](#options)must match the actual generated heading ID for the options section. Please confirm that this fragment is correct to avoid users encountering a broken link.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
141-141: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
141-141: Link fragments should be valid
null(MD051, link-fragments)
|
thanks |
Proposed change
Add troubleshooting section to ESPHome
required for quality scale
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit