Skip to content

Conversation

@bharvey88
Copy link
Contributor

@bharvey88 bharvey88 commented Nov 18, 2025

Updates note to be more clear on the limitations imposed by the api timeout when disabling the wifi component.

Clarified note about disabling WiFi and API timeout limitations.

Description:

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable):

  • esphome/esphome#

Checklist:

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • Link added in /components/index.rst when creating new documents for new components or cookbook.

New Component Images

If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.

To generate a component image:

  1. Comment on this pull request with the following command, replacing COMPONENT_NAME with your component name in UPPER_CASE format with underscores (e.g., BME280, SHT3X, DALLAS_TEMP):

    @esphomebot generate image COMPONENT_NAME
    
  2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.

  3. Extract the SVG file and place it in the images/ folder of this repository.

  4. Use the image in your component's index table entry in /components/index.rst.

Example: For a component called "DHT22 Temperature Sensor", use:

@esphomebot generate image DHT22

…imeout when disabling the wifi component.

Clarified note about disabling WiFi and API timeout limitations.
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 18, 2025

Walkthrough

Updated the documentation note for the wifi.disable action in content/components/wifi.md to explicitly mention both the API and WiFi component reboot timeouts and that staying WiFi off beyond either timeout will trigger a reboot.

Changes

Cohort / File(s) Change Summary
Documentation updates
content/components/wifi.md
Expanded the wifi.disable action note to mention both the API and WiFi component reboot timeouts when WiFi is disabled, state that remaining off longer than either timeout triggers a reboot, and reiterate disabling the API timeout as an alternative workaround.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Single documentation file changed; no code or behavioral changes
  • Review focus: wording accuracy and clarity in content/components/wifi.md

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding clarification to the disable action note in the wifi component documentation.
Description check ✅ Passed The description is directly related to the changeset, explaining that the note about disabling WiFi and API timeout limitations has been clarified.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 54814d0 and 9475249.

📒 Files selected for processing (1)
  • content/components/wifi.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • content/components/wifi.md

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@esphome esphome bot marked this pull request as draft November 18, 2025 21:06
@esphome
Copy link

esphome bot commented Nov 18, 2025

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

Co-authored-by: Keith Burzinski <[email protected]>
@esphome esphome bot added the current label Nov 18, 2025
@netlify
Copy link

netlify bot commented Nov 18, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 14d6787
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/691cf79ffbd10000086600f7
😎 Deploy Preview https://deploy-preview-5644--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Updated note to include links for API and WiFi components.
@bharvey88 bharvey88 marked this pull request as ready for review November 18, 2025 22:14
@esphome esphome bot requested a review from kbx81 November 18, 2025 22:14
@kbx81 kbx81 changed the title Updates note to be more clear on the limitations imposed by the api timeout when disabling the wifi component. [wifi] Add clarification to note regarding disable action Nov 18, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1762061 and 54814d0.

📒 Files selected for processing (1)
  • content/components/wifi.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**

⚙️ CodeRabbit configuration file

  • Do not generate or add any sequence diagrams

Files:

  • content/components/wifi.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: jesserockz
Repo: esphome/esphome-docs PR: 4865
File: .github/workflows/needs-docs.yml:0-0
Timestamp: 2025-05-01T03:29:47.922Z
Learning: In the esphome-docs repository, the "current" label is automatically added by a bot to pull requests, making it a reliable indicator for the target branch.
🪛 GitHub Actions: CI
content/components/wifi.md

[error] 332-332: Markdownlint MD027: no-multiple-space-blockquote - Multiple spaces after blockquote symbol [Context: "> either timeout, the device ..."]

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Build
  • GitHub Check: Lint

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Member

@kbx81 kbx81 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 👍🏻

@kbx81 kbx81 enabled auto-merge (squash) November 18, 2025 22:48
@kbx81 kbx81 merged commit cb42082 into esphome:current Nov 18, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants