feat: Add Sensor platform to BSBLan integration #34626
Conversation
home-assistant
bot
added
current
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Warning Rate limit exceeded@c0ffeeca7 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 39 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. WalkthroughWalkthroughThe pull request introduces various enhancements and updates across multiple integrations and documentation files in Home Assistant. Key changes include the addition of new features, modifications to existing configurations, and clarifications in documentation. Notable updates involve new sensors, actions, and entity types, along with adjustments to metadata and user instructions, ensuring a comprehensive understanding of the integrations and their functionalities. Changes
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 (
|
liudger
force-pushed
the
update-bsblan-docs
branch
from
2908fac to
56ac2df
Compare
liudger
requested review from
joostlek,
bdraco,
Ernst79,
jjlawren,
farmio,
marvin-w and
cgarwood
as code owners
home-assistant
bot
removed
current
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Inline review comments failed to post
Actionable comments posted: 10
Outside diff range, codebase verification and nitpick comments (4)
source/_integrations/seventeentrack.markdown (1)
95-110: Well-documented new action with a clear example.The addition of the
seventeentrack.archive_packageaction is well-documented. The parameters are clearly defined, and the example is practical and easy to understand.Consider adding a brief explanation of what happens when a package is archived, such as whether it is removed from the user's active package list or just marked as archived, to enhance user understanding.
source/_integrations/august.markdown (1)
125-125: Integration Details Approved, Suggest EnhancementThe detailed explanation of the Yale Access Bluetooth integration is clear and informative. It effectively outlines the requirements and functionality, which is crucial for users.
Consider adding a brief example or a link to a more detailed guide to help users further understand how to set up and troubleshoot the integration.
source/_integrations/yale.markdown (1)
1-156: Documentation Approved with a Minor Grammar SuggestionThe documentation for the Yale integration is comprehensive and well-structured. It effectively covers device support, setup instructions, and troubleshooting, which will be beneficial for users setting up their Yale devices with Home Assistant.
Consider adding a comma after "sensors" in line 93 for better readability:
- Not all models include motion sensors and support for locks with built-in doorbells is limited to Yale Doorman models type 7 and 10. + Not all models include motion sensors, and support for locks with built-in doorbells is limited to Yale Doorman models type 7 and 10.Tools
LanguageTool
[uncategorized] ~93-~93: Possible missing comma found.
Context: ...- Motion Not all models include motion sensors and support for locks with built-in doo...(AI_HYDRA_LEO_MISSING_COMMA)
source/_integrations/google_photos.markdown (1)
1-81: Documentation Approved with Style EnhancementsThe documentation for the Google Photos integration is detailed and provides clear, step-by-step instructions that will assist users in setting up the integration effectively.
Consider addressing the following style enhancements for improved clarity and professionalism:
- Line 47: Use a more expressive alternative for "To do this," such as "Proceed by selecting."
- Line 48: Similarly, replace "To do this" with "Proceed by entering."
- Line 57: Replace "To do this" with "Proceed by selecting."
- Line 69: Add a comma before "and" for better readability:
- ... app has not been verified and you will need to acknowledge that in order to proceed. + ... app has not been verified, and you will need to acknowledge that in order to proceed.
- Line 75: Simplify "return back" to "return":
- You may close the window, and return back to Home Assistant where you should see ... + You may close the window, and return to Home Assistant where you should see ...Tools
LanguageTool
[style] ~47-~47: Consider a more expressive alternative.
Context: ... need to select a Support email. To do this, from the dropdown menu, select yo...(DO_ACHIEVE)
[style] ~48-~48: Consider a more expressive alternative.
Context: ...: Developer contact information. To do this, enter your email address (the sam...(DO_ACHIEVE)
[style] ~57-~57: Consider a more expressive alternative.
Context: ...PI** has been automatically enabled. To do this, select Library from the menu,...(DO_ACHIEVE)
[uncategorized] ~69-~69: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...g you that the app has not been verified and you will need to acknowledge that in or...(COMMA_COMPOUND_SENTENCE)
[style] ~69-~69: Consider a shorter alternative to avoid wordiness.
Context: ...d and you will need to acknowledge that in order to proceed. 3. You can now see the detail...(IN_ORDER_TO_PREMIUM)
[style] ~75-~75: Consider using just “return”.
Context: ...nt**. 5. You may close the window, and return back to Home Assistant where you should see ...(RETURN_BACK)
Comments failed to post (10)
source/_integrations/azure_devops.markdown (1)
36-36: Remove trailing space.
There is a trailing space at the end of line 36. It's a good practice to remove trailing spaces to maintain clean and professional-looking documentation.
Apply this diff to remove the trailing space:
- Latest build URL - The URL to the latest build. + Latest build URL - The URL to the latest build.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.- Latest build URL - The URL to the latest build.Tools
Markdownlint
36-36: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
source/_integrations/youtube.markdown (1)
23-23: Add blank lines around the list.
The list starting at line 23 should be surrounded by blank lines to ensure proper formatting and readability in markdown.
Apply this diff to add blank lines around the list:
+ - Views count + Subscriber count + The latest uploaded video +Committable suggestion was skipped due to low confidence.
Tools
Markdownlint
23-23: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
source/_integrations/econet.markdown (1)
51-53: Approved: Addition of 'Switch' section with a minor grammatical correction.
The new section effectively describes the functionality of the "Switch" platform. However, there's a minor grammatical error:
- "let's" should be "lets" as it is not a contraction but a verb.
Consider this correction:
- The EcoNet Switch platform let's you control the EcoNet thermostat emergency heat. + The EcoNet Switch platform lets you control the EcoNet thermostat emergency heat.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.### Switch The EcoNet Switch platform lets you control the EcoNet thermostat emergency heat.source/_integrations/bsblan.markdown (2)
25-25: Suggested grammatical and typographical corrections.
Several minor issues need correction to enhance the clarity and professionalism of the documentation:
- Line 25: Add a comma after "Also".
- Line 29: Replace "have a look" with "take a look" to align with American English.
- Line 38: Add a comma after "please".
Consider these corrections:
- Also available is a ESP32 version of the board. + Also, available is a ESP32 version of the board. - For more information of which system it supports, have a look at their [documentation](https://docs.bsb-lan.de). + For more information of which system it supports, take a look at their [documentation](https://docs.bsb-lan.de). - To see a more detailed listing of the reported systems which are successfully used with BSB-LAN please follow the corresponding link: + To see a more detailed listing of the reported systems which are successfully used with BSB-LAN, please follow the corresponding link:Also applies to: 29-29, 38-38
Tools
LanguageTool
[uncategorized] ~25-~25: A comma may be missing after the conjunctive/linking adverb ‘Also’.
Context: ...Thision,Brötje` and similar systems. Also available is a ESP32 version of the boa...(SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
42-42: Approved: Update to
ha_releasewith a minor formatting correction.The update to the firmware version ensures users are aware of the specific version tested with the integration. However, there's a minor formatting issue:
- The comma before "because" is unnecessary as the clause is essential to the meaning.
Consider this correction:
- A newer firmware versions may not work, because the api could have changed. + A newer firmware versions may not work because the api could have changed.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.The integration is tested with the stable firmware version `3.1.6-20230327101530`. A newer firmware versions may not work because the api could have changed.Tools
LanguageTool
[formatting] ~42-~42: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: .... A newer firmware versions may not work, because the api could have changed. Please use ...(COMMA_BEFORE_BECAUSE)
source/_integrations/smlight.markdown (1)
64-64: Suggest grammatical correction.
Consider adding a comma before "and" to improve readability:
- **Auto Zigbee update** - This allows the core firmware on SLZB-06x to manage Zigbee firmware updates and it will automatically install updates when they are released. + **Auto Zigbee update** - This allows the core firmware on SLZB-06x to manage Zigbee firmware updates, and it will automatically install updates when they are released.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.- **Auto Zigbee update** - This allows the core firmware on SLZB-06x to manage Zigbee firmware updates, and it will automatically install updates when they are released.Tools
LanguageTool
[uncategorized] ~64-~64: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ZB-06x to manage Zigbee firmware updates and it will automatically install updates w...(COMMA_COMPOUND_SENTENCE)
source/_integrations/iskra.markdown (1)
39-56: Formatting issue: Lists should be surrounded by blank lines.
The configuration options are well-explained, but the Markdown formatting needs a minor adjustment to improve readability and adhere to standards.
Please add blank lines around the lists to resolve the issue flagged by the static analysis tool.
Tools
Markdownlint
40-40: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
source/_integrations/ring.markdown (1)
139-141: New "Event" entity needs more detailed documentation.
The introduction of the "Event" entity is a significant change. While the description is clear, it would be beneficial for users to have more detailed examples of how to use this new entity in automations, especially considering it is replacing the binary sensor.
Consider adding examples or linking to more comprehensive guides on migrating from binary sensors to event entities.
source/_integrations/lg_thinq.markdown (1)
1-139: Approved: Comprehensive documentation for LG ThinQ integration with a minor correction needed.
The documentation for the LG ThinQ integration is thorough and well-organized, covering all aspects from setup to troubleshooting.
However, there is a minor typographical issue:
- The word "represented" is misspelled as "represensted" in the description of the switch platform.
Please correct the spelling to "represented" to maintain professionalism in the documentation.
Tools
LanguageTool
[duplication] ~63-~63: Possible typo: you repeated a word
Context: ...file/kimchi-refrigerator/) - Microwave Oven - [Oven](https://thinq.developer.lge.com/en/clo...(ENGLISH_WORD_REPEAT_RULE)
source/_integrations/habitica.markdown (1)
25-31: Approved: Addition of prerequisites section with minor corrections needed.
The new "Prerequisites for Habitica integration" section is a valuable addition, providing clear guidance on the setup requirements.
However, there are minor formatting issues:
- Trailing spaces are present on lines 27, 28, and 30, which should be removed to adhere to Markdown best practices.
Please remove the trailing spaces to improve the Markdown file's formatting.
Tools
Markdownlint
27-27: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
28-28: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
30-30: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
add comma Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
home-assistant
bot
removed
in-progress
Proposed change
Added support for platform sensor.
#125474
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
Bug Fixes
Documentation
Chores