Note how MQTT initialization will block other components from loading until WiFi becomes available.

[MikkoTervala]

Description:

Improve documentation of MQTT when used in combination with improv_serial. Initializing MQTT during boot up will block improv_serial from loading. This documentation explains the behaviour and shows how MQTT can be used with improv_serial effectively.

Related issue (if applicable): fixes https://github.com/esphome/issues/issues/6957

Checklist:

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

• [X] 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.

[netlify[bot]]

✅ Deploy Preview for esphome ready!

Name	Link
🔨 Latest commit	2bebbf3b6e96ded7227b3bf48dc344f9362bb0f7
🔍 Latest deploy log	https://app.netlify.com/sites/esphome/deploys/68080c2c54c4cd0008e43921
😎 Deploy Preview	https://deploy-preview-4838--esphome.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[coderabbitai[bot]]

Walkthrough

The documentation for the MQTT component was updated to provide a more detailed explanation of the enable_on_boot configuration option. The changes clarify that enabling MQTT at boot time causes the initialization process to block the loading of other components until WiFi is available. A cross-reference to additional documentation was added, and a new note explains the impact of this behavior. The note also suggests setting enable_on_boot to false and provides an example of how to manually enable MQTT after boot using an automation.

Changes

File(s)	Change Summary
components/mqtt.rst	Expanded documentation for enable_on_boot, added cross-reference, new note on blocking behavior, and provided an example for manual enabling after boot.

Suggested labels

has-parent

Suggested reviewers

• frenck

---

📜 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 66c87efa64957ac6ec4be320e7f1ab8103ab9763 and 2bebbf3b6e96ded7227b3bf48dc344f9362bb0f7.

📒 Files selected for processing (1)

• components/mqtt.rst (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• components/mqtt.rst

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[esphome[bot]]

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

Learn more about our pull request process.

[github-actions[bot]]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[MikkoTervala]

Closing this PR as I believe a better fix has been implemented in https://github.com/esphome/esphome/pull/8933