Skip to content

updated keba implementation for new config option and new switch #38494

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

Open
wants to merge 3 commits into
base: next
Choose a base branch
from

Conversation

tzahari
Copy link

@tzahari tzahari commented Apr 11, 2025

Proposed change

Added new config option to remove the lock from Home Assistant and for the new switch

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).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

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

  • New Features

    • Introduced a new switch platform to control charging authorization and status.
    • Added an option to disable the lock feature when the charging station lacks RFID support.
  • Documentation

    • Updated integration documentation to explain the new switch platform and lock configuration option.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Apr 11, 2025
Copy link

netlify bot commented Apr 11, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit d7148a6
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6807834e6916d400081080cb
😎 Deploy Preview https://deploy-preview-38494--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Contributor

coderabbitai bot commented Apr 11, 2025

📝 Walkthrough

Walkthrough

The PR updates the Keba integration documentation by adding support for a new "Switch" platform in the ha_category and ha_platforms lists. This platform enables charging authorization and status display without an RFID reader. A new boolean configuration option, add_lock_to_homeassistant (default true), is introduced to allow users to remove the lock entity from Home Assistant when the Wallbox lacks an RFID reader, as the lock functionality is otherwise ineffective.

Changes

File(s) Change Summary
source/_integrations/keba.markdown Added "Switch" platform to ha_category and ha_platforms; introduced add_lock_to_homeassistant boolean configuration option (default true) with documentation explaining its use when no RFID reader is available.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant KebaIntegration

    User->>HomeAssistant: Configure Keba Integration (set add_lock_to_homeassistant)
    HomeAssistant->>KebaIntegration: Initialize integration
    KebaIntegration->>KebaIntegration: Check for RFID reader in Wallbox
    alt RFID reader available
        KebaIntegration->>HomeAssistant: Enable full lock functionality
    else RFID reader missing
        KebaIntegration->>HomeAssistant: Disable lock and expose Switch for charging authorization
    end
Loading

📜 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 abe762d and d7148a6.

📒 Files selected for processing (1)
  • source/_integrations/keba.markdown (4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/keba.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.
    • 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 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

🧹 Nitpick comments (2)
source/_integrations/keba.markdown (2)

30-30: Ensure Consistent Terminology for Authorization

The text on this line uses “authorise / deauthorise” while elsewhere (e.g., in the switch platform description) the American English variant “authorize / deauthorize” is used. To maintain consistency across the documentation, consider updating this text to use the same variant as the rest of the integration docs.

-If your Wallbox does not include an RFID reader, the lock is useless. You can only use authorise / deauthorise with the switch implementation. Without an RFID reader, you can remove the lock from Home Assistant using the `add_lock_to_homeassistant` configuration option.
+If your Wallbox does not include an RFID reader, the lock is useless. You can only use authorize / deauthorize with the switch implementation. Without an RFID reader, you can remove the lock from Home Assistant using the `add_lock_to_homeassistant` configuration option.

39-39: Refine the Switch Description for Clarity

The description for the Switch platform currently reads:
"Switch: Authorize, deauthorize charging and shows also the status of the Wallbox"

For better readability and consistency, consider a minor wording change:

-Switch: Authorize, deauthorize charging and shows also the status of the Wallbox
+Switch: Authorize, deauthorize charging and displays the status of the Wallbox

This ensures the language is smooth and consistent with the rest of the documentation.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~39-~39: Do not mix variants of the same word (‘authorize’ and ‘authorise’) within a single text.
Context: ... with a built-in LED display. - Switch: Authorize, deauthorize charging and shows also th...

(EN_WORD_COHERENCY)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f6426cd and 78657cc.

📒 Files selected for processing (1)
  • source/_integrations/keba.markdown (4 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/keba.markdown

[uncategorized] ~37-~37: Do not mix variants of the same word (‘authorize’ and ‘authorise’) within a single text.
Context: ...on and total energy charged. - Actions: authorize, deauthorize, set energy target, set th...

(EN_WORD_COHERENCY)


[uncategorized] ~39-~39: Do not mix variants of the same word (‘authorize’ and ‘authorise’) within a single text.
Context: ... with a built-in LED display. - Switch: Authorize, deauthorize charging and shows also th...

(EN_WORD_COHERENCY)

🔇 Additional comments (3)
source/_integrations/keba.markdown (3)

9-9: Add "Switch" to Home Assistant Categories

The addition of - Switch to the ha_category list clearly exposes the new switch functionality. This helps users quickly understand all the available features provided by the Keba integration.


20-20: Include "switch" in the Platforms List

Adding - switch to the ha_platforms section is consistent with the new functionality. This change ensures that the switch platform is formally supported and discoverable.


92-96: Document the New Configuration Option

The new add_lock_to_homeassistant configuration option is clearly defined. Its description indicates that it removes the lock from Home Assistant—which is useful when the Wallbox lacks an RFID reader. This addition is well integrated with the explanatory text above.

c0ffeeca7
c0ffeeca7 previously approved these changes Apr 22, 2025
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @tzahari 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label Apr 22, 2025
@tzahari tzahari requested a review from c0ffeeca7 April 22, 2025 09:40
@tzahari
Copy link
Author

tzahari commented Apr 22, 2025

Thank you, @tzahari 👍

Thanks for reviewing @c0ffeeca7.
I detected now, that the CodeRabbit suggested to small changes wich I updated now.
Could you please review again?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaits-parent Awaits the merge of an parent PR has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
No open projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

2 participants