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

[homematicip_cloud] Add set_home_cooling_mode service #33753

Merged
merged 7 commits into from
Aug 12, 2024

Conversation

barryvdh
Copy link
Contributor

@barryvdh barryvdh commented Jul 14, 2024

Add set_home_cooling_mode service, ref: home-assistant/core#121943

Proposed change

Document the new set_home_cooling_mode method for home-assistant/core#121943

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
    • Added the ability to enable or disable the home cooling mode in the homematicip_cloud integration.
    • Introduced a new service to control cooling, with an option to revert to heating mode.
    • Updated documentation with a description and example configuration for the new cooling service.

@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 Jul 14, 2024
Copy link
Contributor

coderabbitai bot commented Jul 14, 2024

Walkthrough

Walkthrough

The homematicip_cloud integration has been enhanced with a new feature that allows users to enable or disable the cooling mode in their home automation system. This update introduces the set_home_cooling_mode service, which provides greater control over climate settings, facilitating a seamless transition between cooling and heating modes. Documentation has been updated to include detailed usage instructions and examples.

Changes

File Summary
source/_integrations/homematicip_cloud.markdown Added the new set_home_cooling_mode service to documentation, detailing its functionality and configuration examples.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomematicIPCloud as HomematicIP Cloud
    User->>HomematicIPCloud: set_home_cooling_mode(enable)
    HomematicIPCloud-->>User: Cooling enabled confirmation

    User->>HomematicIPCloud: set_home_cooling_mode(disable)
    HomematicIPCloud-->>User: Heating mode activated confirmation
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>.
    • 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.

Copy link

netlify bot commented Jul 14, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 2ceca54
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/66b9c35c54649800086f4ff9
😎 Deploy Preview https://deploy-preview-33753--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 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

source/_integrations/homematicip_cloud.markdown Outdated Show resolved Hide resolved
barryvdh and others added 2 commits July 14, 2024 20:01
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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

Outside diff range, codebase verification and nitpick comments (1)
source/_integrations/homematicip_cloud.markdown (1)

222-223: Fix loose punctuation and add a blank line before the list.

There is a loose punctuation mark and a missing blank line before the list.

- 
- `homematicip_cloud.set_cooling`: Enable or disable cooling for the home.
+ 
+ - `homematicip_cloud.set_cooling`: Enable or disable cooling for the home.
Tools
LanguageTool

[uncategorized] ~223-~223: Loose punctuation mark.
Context: ...ex. - - homematicip_cloud.set_cooling: Enable or disable cooling for the home....

(UNLIKELY_OPENING_PUNCTUATION)

Markdownlint

222-222: Expected: 0 or 2; Actual: 1
Trailing spaces

(MD009, no-trailing-spaces)

c0ffeeca7
c0ffeeca7 previously approved these changes Jul 19, 2024
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, @barryvdh 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label Jul 19, 2024
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

Outside diff range, codebase verification and nitpick comments (1)
source/_integrations/homematicip_cloud.markdown (1)

222-222: Fix loose punctuation and add a blank line before the list.

There is a loose punctuation mark and a missing blank line before the list.

- - `homematicip_cloud.set_home_cooling_mode`: Enable or disable cooling for the home.
+ 
+ - `homematicip_cloud.set_home_cooling_mode`: Enable or disable cooling for the home.
Tools
LanguageTool

[uncategorized] ~222-~222: Loose punctuation mark.
Context: ...homematicip_cloud.set_home_cooling_mode`: Enable or disable cooling for the home....

(UNLIKELY_OPENING_PUNCTUATION)

@barryvdh barryvdh changed the title [homematicip_cloud] Add set_cooling service [homematicip_cloud] Add set_home_cooling_mode service Aug 12, 2024
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

Outside diff range, codebase verification and nitpick comments (2)
source/_integrations/homematicip_cloud.markdown (2)

222-222: Fix loose punctuation and add a blank line before the list.

There is a loose punctuation mark and a missing blank line before the list.

- - `homematicip_cloud.set_home_cooling_mode`: Enable or disable cooling for the home.
+ 
+ - `homematicip_cloud.set_home_cooling_mode`: Enable or disable cooling for the home.
Tools
LanguageTool

[uncategorized] ~222-~222: Loose punctuation mark.
Context: ...homematicip_cloud.set_home_cooling_mode`: Enable or disable cooling for the home....

(UNLIKELY_OPENING_PUNCTUATION)


322-331: Use consistent action naming in YAML example.

Ensure the action name in the YAML example is consistent with the service name.

-  action: homematicip_cloud.set_home_cooling_mode
+  action: homematicip_cloud.set_home_cooling_mode

@gjohansson-ST gjohansson-ST added parent-merged The parent PR has been merged already and removed awaits-parent Awaits the merge of an parent PR labels Aug 12, 2024
@gjohansson-ST gjohansson-ST merged commit 393108b into home-assistant:next Aug 12, 2024
6 checks passed
@home-assistant home-assistant bot removed the parent-merged The parent PR has been merged already label Aug 12, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Aug 13, 2024
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