Document generic_thermostat enhancements for PR #136298.

[esand]

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).
  • I've opened up a PR to add logos and icons in Brands repository.
• Added documentation for a new feature I'm adding to Home Assistant (next branch).
• Removed stale or deprecated documentation.

Additional information

• Link to parent pull request in the codebase: Enhance generic_thermostat with min/max run time and cooldown time core#136298
• Link to parent pull request in the Brands repository:
• This PR fixes or closes issue: fixes #

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.

[netlify]

✅ 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... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[coderabbitai]

📝 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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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]

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]

Thank you, @esand 👍

[netlify]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	048e4da
🔍 Latest deploy log	https://app.netlify.com/projects/home-assistant-docs/deploys/69594c33acbb0d0008a06a8e
😎 Deploy Preview	https://deploy-preview-37546--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.

[netlify]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	2347259
🔍 Latest deploy log	https://app.netlify.com/projects/home-assistant-docs/deploys/69594e5c4a4f0d000811152a
😎 Deploy Preview	https://deploy-preview-37546--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify project configuration.