Template fan new syntax

[tetele]

Proposed change

Template fans now support the new template entity syntax (which is also the default)

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.
• [x] 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: https://github.com/home-assistant/core/pull/128405
• Link to parent pull request in the Brands repository:
• This PR fixes or closes issue: fixes #

Checklist

• [x] 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.
• [x] The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

• New Features

  • Introduced a simplified YAML configuration structure for template fans, enhancing clarity and usability.
  • Added support for fan entities, including attributes like state, percentage, preset mode, oscillating, and direction.

• Documentation

  • Updated documentation to reflect the new fan entity configuration, including examples and descriptions for new attributes and actions.
  • Added a note indicating that UI configuration is not available for template fans.

[netlify[bot]]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	c7d939fcf7bc1664454d8c5b97e9f25fbbf7a852
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/674da6c84008e90008f5b18f
😎 Deploy Preview	https://deploy-preview-35240--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[bot]]

📝 Walkthrough

Walkthrough

The changes in this pull request involve a significant restructuring of the YAML configuration format for template fans in Home Assistant. The configuration now utilizes a template key containing fan entries, replacing the previous nested structure. Key attributes have been renamed for clarity, and the overall schema has been simplified. Additionally, the documentation for the template integration has been updated to include detailed information about the new fan entity type and its attributes, enhancing the integration's capabilities.

Changes

File	Change Summary
source/_integrations/fan.template.markdown	Restructured YAML configuration format for template fans, renaming keys and simplifying templates. Removed fans key and updated examples to reflect new syntax.
source/_integrations/template.markdown	Updated documentation to include new fan entity type with attributes like state, percentage, and actions for controlling fans. Enhanced clarity and consistency.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant TemplateFan

    User->>HomeAssistant: Configure fan
    HomeAssistant->>TemplateFan: Apply new configuration
    TemplateFan-->>HomeAssistant: Acknowledge configuration
    User->>HomeAssistant: Control fan (turn_on, set_percentage, etc.)
    HomeAssistant->>TemplateFan: Execute fan action
    TemplateFan-->>HomeAssistant: Confirm action
    HomeAssistant-->>User: Update on fan status

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 704d05a2fda34c0e4e66f63470af81071fa793bb and c7d939fcf7bc1664454d8c5b97e9f25fbbf7a852.

📒 Files selected for processing (2)

• source/_integrations/fan.template.markdown (8 hunks)
• source/_integrations/template.markdown (3 hunks)

🔇 Additional comments (5)

source/_integrations/fan.template.markdown (3)

40-47: Configuration example looks good!

The new configuration structure is clearer and more consistent with other template entities. The renamed attributes (state, percentage, preset_mode, etc.) are more intuitive than the previous *_template naming convention.

---

29-31: Clear user guidance provided

The note about UI configuration unavailability is well-placed and properly formatted.

---

19-20: Good cross-referencing

The added link to template entities documentation provides valuable context for users.

source/_integrations/template.markdown (2)

291-349: Fan configuration documentation is comprehensive

The documentation for fan configuration is thorough and well-structured, covering all necessary attributes and actions. The descriptions are clear and include validation rules where applicable.

---

449-449: Common configuration options properly updated

The inclusion of fans in the common configuration section ensures consistency across all template 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

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