Add modern configuration for template light and switch #38332

Petro31 · 2025-04-02T16:31:23Z

Proposed change

Update documents to reflect changes in home-assistant/core#140326 and home-assistant/core#140324

Because this is late for beta, Frenck requested this PR to be merged against current not next.

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:
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

New Features
- Introduced enhanced configuration options for light and switch entities, allowing for broader control and customization.
Documentation
- Updated references and entity listings to include legacy types and a more comprehensive categorization of lights and switches.

home-assistant · 2025-04-02T16:31:28Z

It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the next branch. Please change the target branch of this PR to next and rebase if needed.

netlify · 2025-04-02T16:31:41Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`8cb1ca1`
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/67ed665e2b50560008694330
😎 Deploy Preview	https://deploy-preview-38332--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 · 2025-04-02T16:35:28Z

📝 Walkthrough

Walkthrough

The pull request updates the documentation in source/_integrations/template.markdown. It adds a new code owner, @Petro31, to the code owners section and enhances the documentation by including legacy references for ‘Light’ and ‘Switch’. Detailed configuration options for both light and switch entities have been introduced, complete with comprehensive keys, descriptions, types, requirements, and default values. Additionally, the combined entity types description has been updated to include these entities.

Changes

File	Change Summary
source/_integrations/template.markdown	- Added new code owner (`@Petro31`) to the code owners section. - Updated documentation to include legacy references for 'Light' and 'Switch'. - Introduced detailed configuration options for light (e.g., state, level, temperature, etc.) and switch (state, turn_on, turn_off) entities. - Revised combined entity types description to list light and switch.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@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 (2)

source/_integrations/template.markdown (2)
57-60: Legacy Types Section Update & Markdown Spacing.
The addition of legacy references for Light and Switch is a helpful inclusion for users familiar with older configurations. To adhere to markdownlint guidelines (MD032), please ensure that the list items are surrounded by blank lines for improved readability.

🧰 Tools

🪛 markdownlint-cli2 (0.17.2)

58-58: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)

312-412: Review of Light Entity Configuration Documentation.
This section provides a comprehensive schema for defining light entities with various attributes (state, brightness, color temperature, color configurations, etc.) and actions. A few points for consideration:

Typo Correction: In the description for set_level (line 386), the phrase “only ha brightness” appears to be a typo. It should read “only has brightness.”

Default Value Consistency: The default value "optimistic" is used repeatedly. Please verify that this aligns well with the integration’s behavior and is documented consistently across the platform.

Schema Validation: The use of required: inclusive for keys such as effect_list and effect should be double-checked to confirm that it is the intended marker for conditional requirement (if that’s the case as per schema definitions).

Proposed diff for the typo correction:
-      description: Defines an action to run when the light is given a brightness command. The script will only be called if the `turn_on` call only ha brightness, and optionally transition. Receives variables `brightness` and, optionally, `transition`.
+      description: Defines an action to run when the light is given a brightness command. The script will only be called if the `turn_on` call only has brightness, and optionally transition. Receives variables `brightness` and, optionally, `transition`.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ed59bff and 8cb1ca1.

📒 Files selected for processing (1)

source/_integrations/template.markdown (5 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.17.2)

source/_integrations/template.markdown

58-58: Lists should be surrounded by blank lines
null

(MD032, blanks-around-lists)

🔇 Additional comments (2)

source/_integrations/template.markdown (2)

16-18: Add New Code Owner Entry.
The code owner @Petro31 has been correctly added to the ha_codeowners section to ensure that documentation changes are properly reviewed and maintained.

413-430: Review of Switch Entity Configuration Documentation.
The configuration for switch entities mirrors other similar sections and is clearly defined. Ensure that the default value "optimistic" specified for the state field is valid and consistent with how the switch integration interprets this value.

frenck

Thanks, @Petro31 👍

../Frenck

Add modern configuration for template light and switch

8cb1ca1

Petro31 requested a review from a team as a code owner April 2, 2025 16:31

github-project-automation bot added this to Documentation PRs Apr 2, 2025

home-assistant bot assigned Petro31 Apr 2, 2025

home-assistant bot added current This PR goes into the current branch has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 2, 2025

github-project-automation bot moved this to Todo in Documentation PRs Apr 2, 2025

coderabbitai bot reviewed Apr 2, 2025

View reviewed changes

frenck approved these changes Apr 2, 2025

View reviewed changes

github-project-automation bot moved this from Todo to Approved in Documentation PRs Apr 2, 2025

frenck merged commit 1bb66e9 into home-assistant:current Apr 2, 2025
7 checks passed

home-assistant bot removed in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 2, 2025

github-project-automation bot moved this from Approved to Done in Documentation PRs Apr 2, 2025

github-actions bot locked and limited conversation to collaborators Apr 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add modern configuration for template light and switch #38332

Add modern configuration for template light and switch #38332

Uh oh!

Petro31 commented Apr 2, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

home-assistant bot commented Apr 2, 2025

Uh oh!

netlify bot commented Apr 2, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Apr 2, 2025

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

frenck left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Add modern configuration for template light and switch #38332

Add modern configuration for template light and switch #38332

Uh oh!

Conversation

Petro31 commented Apr 2, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

Uh oh!

home-assistant bot commented Apr 2, 2025

Uh oh!

netlify bot commented Apr 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for home-assistant-docs ready!

Uh oh!

coderabbitai bot commented Apr 2, 2025

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

frenck left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Petro31 commented Apr 2, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Apr 2, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)