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

Discover new device at runtime in Plugwise #117688

Merged
merged 4 commits into from
May 29, 2024

Conversation

bouwew
Copy link
Contributor

@bouwew bouwew commented May 18, 2024

Proposed change

Implement automatic updating during runtime for Plugwise: when adding a new device to for instance an Adam, the device will automatically be added to the integration in HA Core.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @CoMPaTech, @frenck, mind taking a look at this pull request as it has been labeled with an integration (plugwise) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of plugwise can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign plugwise Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@bouwew bouwew changed the title Automatic updating of devices in Plugwise Discover new added device at runtime inPlugwise May 18, 2024
@bouwew bouwew marked this pull request as ready for review May 18, 2024 12:21
@bouwew bouwew requested a review from frenck as a code owner May 18, 2024 12:21
@bouwew bouwew changed the title Discover new added device at runtime inPlugwise Discover new device at runtime in Plugwise May 18, 2024
@bouwew
Copy link
Contributor Author

bouwew commented May 18, 2024

@mib1185 thanks for pointing out the Fritz-update on which this update is based on!

@mib1185
Copy link
Contributor

mib1185 commented May 27, 2024

@coderabbitai review

Copy link

coderabbitai bot commented May 27, 2024

Walkthrough

The changes enhance the Plugwise integration in Home Assistant by introducing a callback mechanism to handle the addition of entities asynchronously. This involves adding a new _add_entities function across various components such as binary sensor, climate, number, select, sensor, and switch. Additionally, the coordinator component is updated to manage new devices more effectively, and corresponding tests are improved to validate these updates.

Changes

File Path Change Summary
homeassistant/components/plugwise/binary_sensor.py Added _add_entities callback function for asynchronous entity addition. Updated async_setup_entry to use this callback.
homeassistant/components/plugwise/climate.py Introduced _add_entities callback function for adding entities. Updated async_setup_entry to use this callback.
homeassistant/components/plugwise/number.py Added _add_entities callback function for entity setup. Updated async_setup_entry to use this callback.
homeassistant/components/plugwise/select.py Added _add_entities callback function for entity setup. Updated async_setup_entry to use this callback.
homeassistant/components/plugwise/sensor.py Added _add_entities callback function for entity setup. Updated async_setup_entry to use this callback.
homeassistant/components/plugwise/switch.py Added _add_entities callback function for entity setup. Updated async_setup_entry to use this callback.
homeassistant/components/plugwise/coordinator.py Enhanced device management by adding attributes for device_list, hass, and new_devices. Updated _async_update_data method.
tests/components/plugwise/test_init.py Updated imports and added test_update_device function to validate device and entity registry updates.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant HomeAssistant
    participant PlugwiseIntegration
    participant Coordinator
    participant DeviceRegistry

    HomeAssistant->>PlugwiseIntegration: async_setup_entry()
    PlugwiseIntegration->>Coordinator: Add listener for new devices
    Coordinator->>DeviceRegistry: Fetch device data
    DeviceRegistry-->>Coordinator: Return device data
    Coordinator->>PlugwiseIntegration: Notify new devices
    PlugwiseIntegration->>PlugwiseIntegration: _add_entities()
    PlugwiseIntegration->>HomeAssistant: Add entities

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

@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

Outside diff range and nitpick comments (1)
homeassistant/components/plugwise/coordinator.py (1)

21-21: Ensure consistent import grouping.

Consider grouping all device_registry related imports together for better readability.

@bouwew bouwew force-pushed the pw-runtime-update branch 2 times, most recently from ea25431 to 4a73619 Compare May 28, 2024 06:20
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

One very small comment, otherwise looks good 👍

../Frenck

homeassistant/components/plugwise/coordinator.py Outdated Show resolved Hide resolved
@home-assistant home-assistant bot marked this pull request as draft May 29, 2024 06:55
@home-assistant
Copy link

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.

@bouwew bouwew marked this pull request as ready for review May 29, 2024 08:54
@home-assistant home-assistant bot requested a review from frenck May 29, 2024 08:54
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @bouwew 👍

../Frenck

@frenck frenck merged commit 83e62c5 into home-assistant:dev May 29, 2024
24 checks passed
@bouwew bouwew deleted the pw-runtime-update branch May 29, 2024 09:00
@github-actions github-actions bot locked and limited conversation to collaborators May 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants