plugwise-beta Intermediate Core downstream / prepare tagging upstream

Points to notice:

[ ] We must check and thoroughly test the zeroconf change in manifest (not sure if this works in custom_components)
[ ] Mostly mentions of consts, but we might want to validate before upstreaming
[ ] Downstream most of the add_entities constructors
[ ] Language still to compare
[ ] Tests still to compare
[ ] climate.py has issues when rewriting as separate pw-beta and core functionality (rough progress in gist; https://gist.github.com/CoMPaTech/664d3d15a4572be5769fb510df154f2b)
[ ] We need to check alignment on the Set up [Plugwise/Smile] ... descriptors :)
[ ] Added parallels on all platforms (as induced from https://developers.home-assistant.io/docs/integration_fetching_data?_highlight=paral#request-parallelism)

Summary by CodeRabbit

New Features
- Improved error handling with the addition of a validation error for climate tests.
Improvements
- Streamlined setup and notification processes for Plugwise components.
- Enhanced maintainability and clarity through refactored entity addition logic across several components.
- Updated documentation and comments to enhance clarity throughout the codebase.
Bug Fixes
- Resolved climate-test errors related to service validation.
Documentation
- Updated the CHANGELOG to reflect recent changes and improvements.

Aug 10 '24 19:08 CoMPaTech

Walkthrough

The recent updates to the Plugwise integration encompass enhancements to the CHANGELOG, manifest, HACS configuration, and project settings. The CHANGELOG now includes an entry for version v0.52.1, detailing code improvements and documentation updates. The manifest and HACS files reflect a simplified name and the addition of automatic device discovery. Additionally, the project configuration description has been refined, indicating a potential rebranding.

Changes

Files	Change Summary
`CHANGELOG.md`	Added entry for version v0.52.1, documenting code improvements and notes on documentation updates regarding upstreaming and downstreaming.
`custom_components/plugwise/manifest.json`, `hacs.json`	Simplified integration name from "Plugwise Smile/Stretch Beta" to "Plugwise Beta," removed `after_dependencies`, added `zeroconf` for automatic device discovery, and updated Home Assistant version from "2024.2.0" to "2024.8.0."
`pyproject.toml`	Updated description from "Plugwise Smile/Stretch custom_component (BETA)" to "Plugwise beta custom-component."
`custom_components/plugwise/climate.py`	Introduced a new constant `PARALLEL_UPDATES = 0` and adjusted the order of attributes `_homekit_mode` and `_previous_mode`.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Plugwise
    participant HomeAssistant

    User->>HomeAssistant: Configure Plugwise
    HomeAssistant->>Plugwise: Initiate async_setup_entry
    Plugwise->>Plugwise: Setup entities
    Plugwise->>HomeAssistant: Register services
    HomeAssistant->>User: Confirm setup

🐰 In the garden where I play,
New changes bloom and sway,
Streams of code, all bright and neat,
Hop along, a joyful feat!
With every tweak, our hearts align,
Plugwise shines, oh how divine!
🌼✨

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 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.

Aug 10 '24 19:08 coderabbitai[bot]

Please remove the async_setup_entry()-changes, I kept the code like it was because I wanted to keep in the debug-logging for troubleshooting.

Reverted but dropped ATTR_NAME just for clarity, tried wrapping/overloading the Core functionality but that would take considerable more mypy time. If it is better for diagnostics we might challenge this to core as well by adding debug check to that helpers class? (Outside of scope for this PR though)

Aug 11 '24 10:08 CoMPaTech

In 'our' HA core there is a pwsmall branch fwiw (not yet fully up to par)

Aug 12 '24 18:08 CoMPaTech

I added the zeroconf-line in my system, all looks normal after a HA restart.