Skip to content

Add flash and transition feature flags for MQTT json light #38478

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
Merged
merged 1 commit into from
Apr 13, 2025
Merged

Add flash and transition feature flags for MQTT json light #38478

merged 1 commit into from
Apr 13, 2025

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Apr 10, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Add flash and transition feature flags for MQTT json light

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

  • New Features

    • Introduced new configurable options for MQTT lights, enabling enhanced control over flash and transition effects.

  • Documentation

    • Updated configuration documentation with concise abbreviations for flash and transition settings, simplifying setup and usage.

@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 Apr 10, 2025
@netlify Netlify
Copy link

netlify bot commented Apr 10, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

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

@jbouwh jbouwh mentioned this pull request Apr 10, 2025
Merged
19 tasks
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 10, 2025

📝 Walkthrough

Walkthrough

This pull request extends MQTT light configuration documentation by adding two new optional boolean properties, flash and transition, both defaulting to true. In parallel, corresponding abbreviations have been introduced—flsh for flash and trns for transition—to support more concise configuration messages.

Changes

File(s) Change Summary
source/_integrations/light.mqtt.markdown Added optional boolean properties flash and transition (defaulting to true) to the MQTT light configuration.
source/_integrations/mqtt.markdown Added new abbreviations: 'flsh' maps to flash and 'trns' maps to transition in the MQTT documentation.

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[bot]
coderabbitai bot reviewed Apr 10, 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 (2)
source/_integrations/mqtt.markdown (2)

740-745: New Abbreviation for Flash Feature Added
The addition of the 'flsh': 'flash' entry is consistent with the existing abbreviation pattern. The abbreviation “flsh” succinctly represents “flash” and fits well with the style used in this list.

935-940: New Abbreviation for Transition Feature Added
The inclusion of the 'trns': 'transition' entry follows the same abbreviation style as the rest of the table. Make sure that the shortened form “trns” is referenced appropriately in other documentation so users can reliably use it when configuring MQTT messages.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1ae6407 and d4631d0.

📒 Files selected for processing (2)
  • source/_integrations/light.mqtt.markdown (2 hunks)
  • source/_integrations/mqtt.markdown (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (2)
source/_integrations/light.mqtt.markdown (2)

667-674: Addition of Flash Property to MQTT Light Schema
The new flash property is defined clearly with an appropriate description, a default of true, and marked as not required. This change meets the PR objectives and aligns correctly with the new abbreviation in the MQTT documentation.

763-770: Addition of Transition Property to MQTT Light Schema
The newly added transition property is well specified with a boolean type, a default value of true, and a clear description. This update correctly enables transition effects for MQTT lights and is consistent with the overall schema design.

@home-assistant
Copy link

Hey there @emontnemery, @bdraco, mind taking a look at this feedback as it has been labeled with an integration (mqtt) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of mqtt can trigger bot actions by commenting:

  • @home-assistant close Closes the feedback.
  • @home-assistant rename Awesome new title Renames the feedback.
  • @home-assistant reopen Reopen the feedback.
  • @home-assistant unassign mqtt Removes the current integration label and assignees on the feedback, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information) to the feedback.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information) on the feedback.

c0ffeeca7
c0ffeeca7 approved these changes Apr 11, 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, @jbouwh 👍

@github-project-automation github-project-automation bot moved this from Todo to Approved in Documentation PRs Apr 11, 2025
@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label Apr 11, 2025
@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Apr 13, 2025
@jbouwh jbouwh merged commit ae6a082 into next Apr 13, 2025
9 checks passed
@jbouwh jbouwh deleted the mqtt-json-light-feature-flags branch April 13, 2025 19:41
@home-assistant home-assistant bot removed awaits-parent Awaits the merge of an parent PR parent-merged The parent PR has been merged already labels Apr 13, 2025
@github-project-automation github-project-automation bot moved this from Approved to Done in Documentation PRs Apr 13, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Apr 14, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

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

@c0ffeeca7 c0ffeeca7 c0ffeeca7 approved these changes

@emontnemery emontnemery Awaiting requested review from emontnemery emontnemery is a code owner

@bdraco bdraco Awaiting requested review from bdraco bdraco is a code owner

Assignees

@bdraco bdraco

@emontnemery emontnemery

Labels
by-code-owner has-parent This PR has a parent PR in a other repo integration: mqtt next This PR goes into the next branch
Projects
No open projects
Documentation PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jbouwh @c0ffeeca7 @bdraco @emontnemery