Add support zeroconf #39389

liudger · 2025-06-04T12:11:33Z

Proposed change

update documentation for zeroconfig and add some minor fixes

Type of change

Spelling, grammar or other readability improvements (current branch).
Adjusted missing or incorrect information in the current documentation (current branch).
Added documentation for a new integration I'm adding to Home Assistant (next branch).
- I've opened up a PR to add logos and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase:
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

Checklist

This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the current branch.
- I made a change that is related to an upcoming version of Home Assistant and used the next branch.
The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

Documentation
- Updated integration documentation to reflect support for zeroconf (mDNS) discovery.
- Added details about available sensors ("inside temperature" and "outside temperature") and platforms ("climate" and "water heater").
- Updated tested firmware version and release link to reference the latest recommended firmware for autodiscovery.

netlify · 2025-06-04T12:11:38Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`bc0886e`
🔍 Latest deploy log	https://app.netlify.com/projects/home-assistant-docs/deploys/68403e1fc24244000818c01b
😎 Deploy Preview	https://deploy-preview-39389--home-assistant-docs.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 project configuration.

home-assistant · 2025-06-04T12:12:39Z

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

coderabbitai · 2025-06-04T12:19:16Z

📝 Walkthrough

Walkthrough

The documentation for the BSBLan integration was updated to reflect support for zeroconf discovery, list available sensors and platforms, and specify a newer tested firmware version. The release link was also updated to point to the latest firmware tag.

Changes

File(s)	Change Summary
source/_integrations/bsblan.markdown	Added `ha_zeroconf: true` to metadata, updated firmware version, expanded documentation for sensors and platforms, and updated release link.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant BSBLan Device

    User->>HomeAssistant: Starts integration setup
    HomeAssistant->>BSBLan Device: Discovers via zeroconf (mDNS)
    BSBLan Device-->>HomeAssistant: Responds with device info
    HomeAssistant->>User: Presents available sensors and platforms
    User->>HomeAssistant: Completes configuration

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between cad815f and bc0886e.

📒 Files selected for processing (1)

source/_integrations/bsblan.markdown (2 hunks)

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

source/_integrations/bsblan.markdown

⏰ 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

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

🪧 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 or @coderabbitai title 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.

coderabbitai

Actionable comments posted: 0

🔭 Outside diff range comments (1)

source/_integrations/bsblan.markdown (1)
55-57: ⚠️ Potential issue

Fix version display and punctuation.

The link text still shows “release 3.1” but points to v5.0, and the “For autodiscovery use…” sentence is missing a comma. Please apply:
-The integration is tested with the stable firmware version `5.0.16-20250525002819`. A newer firmware version may not work because the API could have changed.
-For autodiscovery use the latest release. [release 3.1](https://github.com/fredlcore/BSB-LAN/releases/tag/v5.0)
+The integration is tested with the stable firmware version `5.0.16-20250525002819`. A newer firmware version may not work, because the API could have changed.
+For autodiscovery, use the latest release. [release v5.0](https://github.com/fredlcore/BSB-LAN/releases/tag/v5.0)
🧰 Tools

🪛 LanguageTool

[uncategorized] ~56-~56: A comma might be missing here.
Context: ...because the API could have changed. For autodiscovery use the latest release. [release 3.1](h...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

🧹 Nitpick comments (1)

source/_integrations/bsblan.markdown (1)
39-48: Improve formatting of the new sensors/platforms lists.

The bullet items would be clearer if you:

Wrap sensor names in backticks (e.g., inside temperature, outside temperature).

Use the exact platform identifiers in backticks (e.g., climate, water_heater) rather than human-readable text.

Example diff:
 ## Available sensors depending on your heating system

- inside temperature
- outside temperature
+ - `inside temperature`
+ - `outside temperature`

 ## Available platforms depending on your system

- climate
- water heater
+ - `climate`
+ - `water_heater`

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 36f2361 and cad815f.

📒 Files selected for processing (1)

source/_integrations/bsblan.markdown (2 hunks)

🧰 Additional context used

🪛 LanguageTool

source/_integrations/bsblan.markdown

[uncategorized] ~56-~56: A comma might be missing here.
Context: ...because the API could have changed. For autodiscovery use the latest release. [release 3.1](h...

(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)

🔇 Additional comments (1)

source/_integrations/bsblan.markdown (1)

20-20: Approve zeroconf metadata addition.

Adding ha_zeroconf: true correctly enables mDNS discovery for this integration.

…ation

add zeroconf to docs

cad815f

home-assistant bot added the current This PR goes into the current branch label Jun 4, 2025

liudger changed the base branch from current to next June 4, 2025 12:12

home-assistant bot removed the current This PR goes into the current branch label Jun 4, 2025

home-assistant bot assigned liudger Jun 4, 2025

home-assistant bot added in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch next This PR goes into the next branch labels Jun 4, 2025

liudger mentioned this pull request Jun 4, 2025

Add Zeroconf support for bsblan integration home-assistant/core#146137

Merged

19 tasks

home-assistant bot added the has-parent This PR has a parent PR in another repo label Jun 4, 2025

liudger marked this pull request as ready for review June 4, 2025 12:17

coderabbitai bot reviewed Jun 4, 2025

View reviewed changes

liudger added 2 commits June 4, 2025 12:36

Update BSB-Lan integration documentation for clarity and accuracy

dfd2a8a

Fix formatting of available sensors and platforms in BSB-Lan document…

bc0886e

…ation

home-assistant bot added the parent-merged The parent PR has been merged already label Jul 14, 2025

silamon approved these changes Jul 15, 2025

View reviewed changes

silamon merged commit 4d2870a into home-assistant:next Jul 15, 2025
7 checks passed

home-assistant bot removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch in-progress This PR/Issue is currently being worked on parent-merged The parent PR has been merged already labels Jul 15, 2025

github-actions bot locked and limited conversation to collaborators Jul 16, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add support zeroconf #39389

Add support zeroconf #39389

Uh oh!

liudger commented Jun 4, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

netlify bot commented Jun 4, 2025 •

edited

Loading

Uh oh!

home-assistant bot commented Jun 4, 2025

Uh oh!

coderabbitai bot commented Jun 4, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Uh oh!

Add support zeroconf #39389

Add support zeroconf #39389

Uh oh!

Conversation

liudger commented Jun 4, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

Uh oh!

netlify bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for home-assistant-docs ready!

Uh oh!

home-assistant bot commented Jun 4, 2025

Uh oh!

coderabbitai bot commented Jun 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

liudger commented Jun 4, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Jun 4, 2025 •

edited

Loading

coderabbitai bot commented Jun 4, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)