Added switch documentation for the blue current integration #39404

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.

Sign up for GitHub

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

Jump to bottom

Merged

joostlek merged 4 commits into home-assistant:next from bluecurrent:blue-current-switch-documentation

Jul 23, 2025

Contributor

NickKoepr commented Jun 5, 2025 •

edited by coderabbitai bot

Loading

Proposed change

Added documentation for the switch functionality in the blue current integration.

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: Add switches for blue current integration. core#146210
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 Blue Current integration documentation to include support for switches.
- Added "Switch" category and platform details.
- Introduced a new section describing available switches: "Toggle Plug & Charge," "Toggle linked charging cards only," and "Toggle charge point block."


          Added switch documentation for the blue current integration

bb45bea

home-assistant bot added has-parent next labels

netlify bot commented Jun 5, 2025 •

edited

Loading

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`526d384`
🔍 Latest deploy log	https://app.netlify.com/projects/home-assistant-docs/deploys/68497204e199d80008f944aa
😎 Deploy Preview	https://deploy-preview-39404--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.

NickKoepr mentioned this pull request

Add switches for blue current integration. home-assistant/core#146210

Merged

19 tasks

Contributor

coderabbitai bot commented Jun 5, 2025 •

edited

Loading

📝 Walkthrough

"""

Walkthrough

The Blue Current integration documentation was updated to reflect new support for switches. The changes include adding "Switch" to relevant categories and platform lists, as well as introducing a new section that describes the available switches provided by the integration.

Changes

File	Change Summary
source/_integrations/blue_current.markdown	Updated documentation to add "Switch" support, revised categories/platforms, added switch info.

Sequence Diagram(s)

No sequence diagram generated since the changes are documentation-only and do not affect control flow or features.
"""

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 bot reviewed

View reviewed changes

Contributor

coderabbitai bot left a comment

Actionable comments posted: 0

🧹 Nitpick comments (2)

source/_integrations/blue_current.markdown (2)
82-83: Remove extra blank line
MarkdownLint flags multiple consecutive blank lines between the Button and Switch sections. Please reduce to a single blank line to adhere to style guidelines.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

82-82: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

83-90: Add “Charge point switches” subheading for consistency
Other sections use a ### Charge point … subheading (e.g., sensors, buttons). Insert:
 ## Switch

+### Charge point switches

 The Blue Current integration provides the following switches:
to maintain structural consistency.

📜 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 d950dd2 and bb45bea.

📒 Files selected for processing (1)

source/_integrations/blue_current.markdown (3 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

source/_integrations/blue_current.markdown

82-82: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

⏰ Context from checks skipped due to timeout of 90000ms (4)

GitHub Check: Lint Markdown
GitHub Check: Redirect rules - home-assistant-docs
GitHub Check: Header rules - home-assistant-docs
GitHub Check: Pages changed - home-assistant-docs

🔇 Additional comments (2)

source/_integrations/blue_current.markdown (2)

7-7: Category updated with Switch
Adding Switch to the ha_category list properly exposes this new feature in the integration metadata.

18-18: Platform list updated with switch
Including switch in ha_platforms correctly registers the new switch platform for the integration.


          Added an extra description for the Toggle linked charge cards only

0fba073

switch.
Also changed the name of Plug & Charge to match the received feedback in
linked PR.

coderabbitai bot reviewed

View reviewed changes

Contributor

coderabbitai bot left a comment

Actionable comments posted: 0

🧹 Nitpick comments (2)

source/_integrations/blue_current.markdown (2)

81-82: Remove extra blank line

Markdown lint flags multiple consecutive blank lines before the new section. Please reduce to a single blank line for compliance with MD012.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

82-82: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

90-90: Clarify "Toggle charge point block" behavior

Consider adding a brief description for the "Toggle charge point block" switch (similar to the note under linked charge cards) to improve user understanding.

📜 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 bb45bea and 0fba073.

📒 Files selected for processing (1)

source/_integrations/blue_current.markdown (3 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

source/_integrations/blue_current.markdown

82-82: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

⏰ 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

🔇 Additional comments (3)

source/_integrations/blue_current.markdown (3)

7-7: Add Switch to ha_category

Including "Switch" in the ha_category frontmatter correctly classifies this integration under the Switch domain.

18-18: Add switch to ha_platforms

The ha_platforms entry now includes switch, ensuring that the Switch platform is recognized and documented.

83-90: Document Switch section

The new "## Switch" section clearly outlines all available switch entities provided by this integration.

NickKoepr marked this pull request as draft

June 6, 2025 11:09


          Changed charge to charging.

46d1f98

NickKoepr marked this pull request as ready for review

June 6, 2025 11:28


          Added extra documentation to two switches for blue current.

526d384

coderabbitai bot reviewed

View reviewed changes

Contributor

coderabbitai bot left a comment

Actionable comments posted: 0

🧹 Nitpick comments (1)

source/_integrations/blue_current.markdown (1)

91-91: Ensure a single trailing newline.
Add exactly one newline at end of file to satisfy MD047 (single-trailing-newline).

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

91-91: Files should end with a single newline character
null

(MD047, single-trailing-newline)

📜 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 46d1f98 and 526d384.

📒 Files selected for processing (1)

source/_integrations/blue_current.markdown (3 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

source/_integrations/blue_current.markdown

91-91: Files should end with a single newline character
null

(MD047, single-trailing-newline)

⏰ 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

🔇 Additional comments (3)

source/_integrations/blue_current.markdown (3)

7-7: Add "Switch" to integration categories.
The new Switch category correctly reflects support for switch entities in the Blue Current integration.

18-18: Include switch in supported platforms.
Adding switch under ha_platforms aligns the front matter with the documented switch entities.

82-91: Document switch entities under a new "Switch" section.
The new "Switch" section clearly enumerates the available switch controls and their effects.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

91-91: Files should end with a single newline character
null

(MD047, single-trailing-newline)

home-assistant bot added the parent-merged label

joostlek approved these changes

View reviewed changes

joostlek merged commit faec851 into home-assistant:next

7 checks passed

home-assistant bot removed the parent-merged label

github-actions bot locked and limited conversation to collaborators

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

has-parent next