Skip to content

Document generic_thermostat enhancements for PR #136298. #37546

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: next
Choose a base branch
from
Open

Document generic_thermostat enhancements for PR #136298. #37546

wants to merge 1 commit into from

Conversation

esand
Copy link
Contributor

@esand esand commented Feb 19, 2025 •
edited by coderabbitai bot
Loading

Documentation changes for min_cycle_duration, max_cycle_duration, and cycle_cooldown. Also adjustments regarding min_cycle_duration and keep_alive (they can now co-exist).

Proposed change

These changes document the changes proposed in home-assistant/core#136298.

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

  • Documentation
    • Enhanced thermostat configuration documentation with clearer descriptions of timing settings.
    • Introduced two new options: maximum cycle duration and cycle cooldown.
    • Updated existing parameters for minimum cycle duration and keep-alive to reflect improved type flexibility and value constraints.

@esand
Document generic_thermostat enhancements for PR #136298.
10dcfd8 
Documentation changes for `min_cycle_duration`, `max_cycle_duration`, and `cycle_cooldown`. Also adjustments regarding `min_cycle_duration` and `keep_alive` (they can now co-exist).
@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 Feb 19, 2025
@netlify Netlify
Copy link

netlify bot commented Feb 19, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 10dcfd8
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67b5425ce21126000884603f
😎 Deploy Preview https://deploy-preview-37546--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.

@esand esand mentioned this pull request Feb 19, 2025
Draft
19 tasks
@esand esand marked this pull request as ready for review February 19, 2025 02:34
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 19, 2025

📝 Walkthrough

Walkthrough

The changes update the documentation for the generic thermostat integration. New configuration options, max_cycle_duration and cycle_cooldown, have been added. The descriptions for min_cycle_duration and keep_alive were revised, and their types (along with the new options) were modified to support both time and integer formats. The YAML example was updated to reflect these changes, including a new constraint that, when both min_cycle_duration and max_cycle_duration are set, the latter must be greater than the former.

Changes

File(s) Change Summary
source/_integrations/generic_thermostat.markdown - New Options: Added max_cycle_duration and cycle_cooldown.
- Updated Descriptions: Revised description for min_cycle_duration (clarifying minimum off time) and modified keep_alive (removed outdated note).
- Type Changes: Adjusted types for all duration options to accept both time and integer.
- YAML Example: Updated min_cycle_duration from 5 seconds to 1 minute, and added max_cycle_duration (10 minutes) and cycle_cooldown (30 seconds) with an added constraint on duration values.

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.

coderabbitai[bot]
coderabbitai bot reviewed Feb 19, 2025
View reviewed changes
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 (1)
source/_integrations/generic_thermostat.markdown (1)

147-147: Detail Time Format Constraints and Parameter Relationships

The newly added note succinctly specifies acceptable time formats (either "hh:mm:ss", dictionary forms, or integers representing seconds) and reiterates that if both min_cycle_duration and max_cycle_duration are provided, the maximum must be greater than the minimum. Given the PR objective clarifies that min_cycle_duration and keep_alive can now coexist, consider explicitly mentioning this coexistence if it’s a common point of confusion for users.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8f65293 and 10dcfd8.

📒 Files selected for processing (1)
  • source/_integrations/generic_thermostat.markdown (4 hunks)
🔇 Additional comments (4)
source/_integrations/generic_thermostat.markdown (4)

82-84: Clarify min_cycle_duration Documentation

The updated description now clearly states that this parameter specifies the minimum time that must elapse before the heater switch can be turned off, and the type now accepts both time and integer formats. Ensure that any examples (such as in the YAML configuration below) reflect this dual-format capability accurately.

85-88: Add max_cycle_duration Option

The new max_cycle_duration parameter is well documented. The description specifies that it marks the maximum allowable cycle duration and the type supports both time and integer values. It would be beneficial to remind users (or cross-reference in the clarification note) that if both min_cycle_duration and max_cycle_duration are set, the latter must be greater than the former.

89-90: Introduce cycle_cooldown Parameter

The description for cycle_cooldown clearly states that it defines the minimum wait time before the heater switch can be switched back on after being turned off. The type change to [time, integer] is consistent with the other cycle duration parameters.

168-172: Update YAML Configuration Example for Cycle Durations

The example now demonstrates using different time formats:

  • min_cycle_duration is set using a minute-based dictionary (minutes: 1),
  • max_cycle_duration with (minutes: 10), and
  • cycle_cooldown with (seconds: 30).

This clearly illustrates the expected YAML formatting for durations. It may help to include a brief inline comment or note that these values must satisfy the condition where max_cycle_duration is greater than min_cycle_duration for clarity.

c0ffeeca7
c0ffeeca7 approved these changes Feb 24, 2025
View reviewed changes
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, @esand 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label Feb 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@c0ffeeca7 c0ffeeca7 c0ffeeca7 approved these changes

Assignees
No one assigned
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
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@esand @c0ffeeca7