home-assistant.io icon indicating copy to clipboard operation
home-assistant.io copied to clipboard

Template fan config flow

Open tetele opened this issue 1 year ago • 2 comments

Proposed change

This is a follow up of #35240. Add config flow for template fans

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).
  • [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/128408
  • 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 streamlined configuration format for template fans, enhancing usability.
    • Added new configuration keys for fan attributes, improving clarity in setup.
    • Updated YAML examples to demonstrate the new syntax for fan actions.
  • Documentation

    • Included a note on the necessity of default_config: in configuration.yaml for user interface accessibility.

tetele avatar Oct 15 '24 07:10 tetele

Deploy Preview for home-assistant-docs failed.

Name Link
Latest commit 99040d3b632a7d0beb31b4d7ff9ac1b5bd5c17ac
Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/670e1e0f6506ba000891c41b

netlify[bot] avatar Oct 15 '24 07:10 netlify[bot]

📝 Walkthrough

Walkthrough

The changes introduce a new configuration structure for template fans in Home Assistant, transitioning from a nested format under the fan platform to a simplified format under a template key. Several configuration keys have been renamed to align with a consistent naming convention. Additionally, YAML examples have been updated to demonstrate the new syntax for defining fan actions. A note has been added to the documentation emphasizing the need for default_config: in the configuration.yaml file for user interface accessibility.

Changes

File Change Summary
source/_integrations/fan.template.markdown - Updated configuration keys: friendly_name to name, value_template to state, percentage_template to percentage, preset_mode_template to preset_mode, oscillating_template to oscillating, direction_template to direction, availability_template to availability.
- Added new entity type fan with configuration variables for state, percentage, preset_mode, oscillating, direction, and various actions.
- Updated YAML examples to reflect new syntax and structure.
- Added note about default_config: requirement in configuration.yaml.

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 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] avatar Oct 15 '24 07:10 coderabbitai[bot]