-
Notifications
You must be signed in to change notification settings - Fork 1.8k
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.
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
Add clean_session as configurable option to the MQTT component #4280
Add clean_session as configurable option to the MQTT component #4280
Conversation
WalkthroughThe changes introduce a new optional configuration variable, clean_session, for the MQTT component. This boolean variable specifies whether the MQTT broker should clean the session after a disconnect. The default setting for this variable is Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant MQTT Broker
User->>MQTT Broker: Connect with clean_session = false
MQTT Broker-->>User: Session established
User->>MQTT Broker: Disconnect
MQTT Broker-->>User: Session retained (clean_session = false)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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 (
|
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
components/mqtt.rst (1)
42-43
: LGTM! Consider adding a brief explanation of the implications.The addition of the
clean_session
configuration variable is a valuable improvement, providing users with more control over MQTT session management. The default value offalse
ensures backward compatibility.Consider adding a brief explanation of the implications of setting this to
true
orfalse
. For example:
"When set totrue
, the broker will not store any subscription information or undelivered messages for the client. Whenfalse
, the broker will store them."
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- components/mqtt.rst (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
components/mqtt.rst (1)
Pattern
**
: - Do not generate or add any sequence diagrams
Wow, that coderabbit stuff is cool! |
Woops, I hit merge, but this PR was pointing to the wrong base branch |
Ah, sorry about that. Lack of experience on my part! Thanks for fixing it. |
Description:
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable): esphome/esphome#7501
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
/index.rst
when creating new documents for new components or cookbook.