Skip to content
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 new integration Homee #36526

Merged
merged 14 commits into from
Jan 27, 2025
Merged

Add new integration Homee #36526

merged 14 commits into from
Jan 27, 2025

Conversation

Taraman17
Copy link
Contributor

@Taraman17 Taraman17 commented Dec 23, 2024

Proposed change

Add integration page for upcoming new Homee 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).
  • 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 integration for Homee in Home Assistant, allowing users to set up and manage Homee devices.
    • Provided detailed documentation for integration setup, including prerequisites and configuration steps.
    • Included information on device recognition and limitations regarding real-time updates.
  • Documentation

    • Added comprehensive metadata and instructions for the Homee integration, including title, description, and configuration details.
    • Specified integration metadata such as release version, IoT class, and code owners.

@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 Dec 23, 2024
Copy link

netlify bot commented Dec 23, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 8f679aa
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6797401a6e896f000815aa09
😎 Deploy Preview https://deploy-preview-36526--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 Dec 23, 2024

Warning

Rate limit exceeded

@c0ffeeca7 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 19 minutes and 11 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between ef9a01b and 8f679aa.

📒 Files selected for processing (1)
  • source/_integrations/homee.markdown (1 hunks)
📝 Walkthrough

Walkthrough

This pull request introduces a new markdown file for the Homee integration in Home Assistant. The documentation includes essential metadata and provides detailed instructions for setting up Homee devices within Home Assistant. It covers prerequisites, configuration details, and limitations of the integration, which supports various protocols such as Z-Wave, Zigbee, and EnOcean. The documentation also explains the process for creating a dedicated user in Homee and how to manage device recognition and integration removal.

Changes

File Change Summary
source/_integrations/homee.markdown New integration documentation file added with metadata, setup instructions, configuration details, and usage guidelines for Homee integration

Sequence Diagram

sequenceDiagram
    participant User
    participant Homee App
    participant Home Assistant
    User->>Homee App: Create dedicated user
    User->>Home Assistant: Configure Homee integration
    Home Assistant->>Homee App: Authenticate with credentials
    Homee App-->>Home Assistant: Provide device access
    Home Assistant->>User: Display available devices
Loading

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?

❤️ 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. (Beta)
  • @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: 1

🧹 Nitpick comments (5)
source/_integrations/homee.markdown (5)

27-30: Minor grammatical improvements needed

Consider these grammatical improvements:

-1. In your Homee app tap the menu button in the top left corner.
+1. In your Homee app, tap the menu button in the top-left corner.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~27-~27: Possible missing comma found.
Context: ...ed by Home Assistant. 1. In your Homee app tap the menu button in the top left cor...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~27-~27: Consider adding a hyphen.
Context: ...ur Homee app tap the menu button in the top left corner. 2. Tap the gear wheel icon on t...

(TOP_LEFT_CORNER)


35-40: Add validation patterns and examples

Consider adding:

  • IP address format example
  • Password requirements (if any)
  • Note about whether localhost/127.0.0.1 is supported

43-44: Emphasize restart requirement

Consider adding a note block to emphasize the restart requirement:

Available devices will automatically show up in your Home Assistant installation.
-New devices in Homee will be added after a restart of Home Assistant.
+{% note %}
+New devices in Homee will be added after a restart of Home Assistant.
+{% endnote %}

48-48: Add specific timing details

Consider specifying:

  • Actual polling interval (e.g., "every 5 seconds")
  • Whether the interval is configurable
  • Impact on different device types
🧰 Tools
🪛 LanguageTool

[uncategorized] ~48-~48: Possible missing article found.
Context: ...nd intermediate states may be missed by Home Assistant. ## Removing the integration...

(AI_HYDRA_LEO_MISSING_THE)


52-52: Fix grammar in removal instructions

-This integration follows standard integration removal, once the integration is removed you can also remove the dedicated user from your Homee.
+This integration follows standard integration removal. Once the integration is removed, you can also remove the dedicated user from your Homee.
🧰 Tools
🪛 LanguageTool

[typographical] ~52-~52: It seems that a comma is missing.
Context: ...ration removal, once the integration is removed you can also remove the dedicated user ...

(IF_COMMA)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between dc032aa and d8ba898.

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

[uncategorized] ~27-~27: Possible missing comma found.
Context: ...ed by Home Assistant. 1. In your Homee app tap the menu button in the top left cor...

(AI_HYDRA_LEO_MISSING_COMMA)


[uncategorized] ~27-~27: Consider adding a hyphen.
Context: ...ur Homee app tap the menu button in the top left corner. 2. Tap the gear wheel icon on t...

(TOP_LEFT_CORNER)


[uncategorized] ~48-~48: Possible missing article found.
Context: ...nd intermediate states may be missed by Home Assistant. ## Removing the integration...

(AI_HYDRA_LEO_MISSING_THE)


[typographical] ~52-~52: It seems that a comma is missing.
Context: ...ration removal, once the integration is removed you can also remove the dedicated user ...

(IF_COMMA)

🔇 Additional comments (1)
source/_integrations/homee.markdown (1)

7-7: Verify integration release version and supported platforms

The release version is set to 2025.2, which seems unusually far in the future. Additionally, only the 'cover' platform is listed despite Homee supporting multiple device types (Z-Wave, Zigbee, EnOcean).

Also applies to: 12-13

✅ Verification successful

Release version 2025.2 is correct, but platform support needs review

Based on the PR information, this integration is indeed targeted for HA 2025.02 release as stated in the PR description. However, while currently only the cover platform is implemented (as evidenced by the PR files showing only cover.py), the integration connects to Homee which is a hub supporting multiple device types. The documentation should mention this is the initial release with only cover support, with potential for more platforms in future updates.

  • Consider adding a note in the documentation about current platform limitations
  • Consider mentioning that more device types may be supported in future releases
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check the core PR for supported platforms and version
gh api repos/home-assistant/core/pulls/133738 | jq -r '.body' | grep -i "platform\|version"

# Check for platform-related files in the core PR
gh api repos/home-assistant/core/pulls/133738/files | jq -r '.[].filename' | grep -i "homee.*platform"

Length of output: 337


Script:

#!/bin/bash
# Let's check the actual PR files to understand the implementation
gh api repos/home-assistant/core/pulls/133738/files | jq -r '.[].filename'

# Also check the PR title and body for more context
gh api repos/home-assistant/core/pulls/133738 | jq -r '[.title, .body] | join("\n\n")'

Length of output: 5892


Script:

#!/bin/bash
# Let's check the manifest.json for supported platforms and version info
cat homeassistant/components/homee/manifest.json

# Also check if there are other platform files that might be in development
fd -e py -p ".*platform.*" homeassistant/components/homee/

Length of output: 307

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 (4)
source/_integrations/homee.markdown (4)

29-29: Consider adding a hyphen in "top-left"

For consistency with technical writing standards, consider hyphenating the compound modifier.

-In your Homee app tap the menu button in the top left corner.
+In your Homee app tap the menu button in the top-left corner.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~29-~29: Consider adding a hyphen.
Context: ...ur Homee app tap the menu button in the top left corner. 2. Tap the gear wheel icon on t...

(TOP_LEFT_CORNER)


45-46: Consider clarifying the restart requirement

The restart requirement for new devices could benefit from additional context.

-New devices in Homee will be added after a restart of Home Assistant.
+New devices added to Homee will be automatically discovered after a restart of Home Assistant. This restart is only required when adding new devices, not for state updates of existing devices.

54-54: Add comma for better readability

Add a comma to separate the dependent clauses.

-This integration follows standard integration removal, once the integration is removed you can also remove the dedicated user from your Homee.
+This integration follows standard integration removal, and once the integration is removed, you can also remove the dedicated user from your Homee.
🧰 Tools
🪛 LanguageTool

[typographical] ~54-~54: It seems that a comma is missing.
Context: ...ration removal, once the integration is removed you can also remove the dedicated user ...

(IF_COMMA)


27-28: Consider adding security recommendations

It would be helpful to include security best practices for the dedicated user account.

-You need to create a new user in your Homee, that is only used by Home Assistant.
+You need to create a new user in your Homee that is only used by Home Assistant. For security reasons, it's recommended to:
+- Use a strong, unique password
+- Limit the user's permissions to only what's necessary for Home Assistant
+- Do not use this account for any other purpose
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between d8ba898 and 4388661.

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

[uncategorized] ~29-~29: Consider adding a hyphen.
Context: ...ur Homee app tap the menu button in the top left corner. 2. Tap the gear wheel icon on t...

(TOP_LEFT_CORNER)


[uncategorized] ~50-~50: Possible missing article found.
Context: ...nd intermediate states may be missed by Home Assistant. ## Removing the integration...

(AI_HYDRA_LEO_MISSING_THE)


[typographical] ~54-~54: It seems that a comma is missing.
Context: ...ration removal, once the integration is removed you can also remove the dedicated user ...

(IF_COMMA)

🔇 Additional comments (2)
source/_integrations/homee.markdown (2)

1-15: LGTM! Metadata follows Home Assistant standards

The metadata is well-structured and includes all required fields for a new integration.


17-23: LGTM! Clear introduction with appropriate platform support disclaimer

The introduction effectively describes Homee's capabilities, and line 23 appropriately addresses the future platform additions.

@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Jan 3, 2025
@home-assistant
Copy link

home-assistant bot commented Jan 3, 2025

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft January 3, 2025 12:46
@Taraman17 Taraman17 mentioned this pull request Jan 12, 2025
19 tasks
@Taraman17 Taraman17 marked this pull request as ready for review January 18, 2025 15:39
@home-assistant home-assistant bot requested a review from joostlek January 18, 2025 15:40
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: 1

🧹 Nitpick comments (1)
source/_integrations/homee.markdown (1)

28-28: Improve readability with better pronoun usage.

Consider revising the sentence to use "who" instead of "that" when referring to a person:

-Create a user that is only used by Home Assistant.
+Create a user who is only used by Home Assistant.
🧰 Tools
🪛 LanguageTool

[style] ~28-~28: Consider using “who” when you are referring to a person instead of an object.
Context: ...w user in your Homee app. Create a user that is only used by Home Assistant. For sec...

(THAT_WHO)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0b1e6d6 and ef9a01b.

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

[style] ~28-~28: Consider using “who” when you are referring to a person instead of an object.
Context: ...w user in your Homee app. Create a user that is only used by Home Assistant. For sec...

(THAT_WHO)

🔇 Additional comments (2)
source/_integrations/homee.markdown (2)

24-24: Consider removing implementation detail.

As discussed in previous reviews, it might be better to remove the line about future platforms to maintain focus on current functionality.


1-61: Verify documentation alignment with implementation.

Please ensure that this documentation aligns with the implementation in the parent PR (home-assistant/core#133738), particularly regarding:

  • Supported platforms (cover, sensor)
  • Configuration options
  • Update intervals mentioned in limitations
🧰 Tools
🪛 LanguageTool

[style] ~28-~28: Consider using “who” when you are referring to a person instead of an object.
Context: ...w user in your Homee app. Create a user that is only used by Home Assistant. For sec...

(THAT_WHO)

c0ffeeca7 and others added 2 commits January 27, 2025 09:13
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, @Taraman17 👍

@c0ffeeca7 c0ffeeca7 dismissed joostlek’s stale review January 27, 2025 08:15

requested changes have been implemented

@c0ffeeca7 c0ffeeca7 merged commit 38a30c9 into home-assistant:next Jan 27, 2025
2 checks passed
@home-assistant home-assistant bot removed the parent-merged The parent PR has been merged already label Jan 27, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Jan 28, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants