Skip to content
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.

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

flux: document how the "mired" mode actually sets kelvin #36808

Open
wants to merge 1 commit into
base: current
Choose a base branch
from

Conversation

bors-ltd
Copy link

@bors-ltd bors-ltd commented Jan 8, 2025

Since home-assistant/core#132839 the Flux integration is using the value in kelvin to set the light temperature.

Let's reflect this in the documentation while preserving existing installations.

Proposed change

As Home Assistant is switching to kelvin over mired, some components still refer to mired. I know Flux is not the most popular integration, but as someone who is starting to equip with smart lights, automatic colour temperature and brightness (aka circadian lighting) was one of my main motivations.

I started with modifying the Flux integration itself, but then found the change was trivial and kind of useless, as the code works the same, whether the mode is "mired", "kelvin", or even "foobar" if that value was allowed.

So I thought it's more a matter of adjusting the documentation than bothering the core repository with yet another PR to review.

I can still push my PR to core if you want to go the long way and actually add "kelvin" as a possible configuration value. Or do it yourself, which will probably be faster than reviewing me doing so.

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

  • 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

  • Documentation
    • Updated documentation for the flux integration to clarify that mired is an alias for kelvin in the mode configuration option.

@home-assistant 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 Jan 8, 2025
@home-assistant
Copy link

home-assistant bot commented Jan 8, 2025

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.

Copy link

netlify bot commented Jan 8, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 504a390
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/677ea29496ae660008e16d04
😎 Deploy Preview https://deploy-preview-36808--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.

Since home-assistant/core#132839 the Flux
integration is using the value in kelvin to set the light temperature.

Let's reflect this in the documentation while preserving existing
installations.
Copy link
Contributor

coderabbitai bot commented Jan 8, 2025

📝 Walkthrough

Walkthrough

The pull request involves a minor documentation update for the Flux integration in Home Assistant. The change clarifies the description of the mode configuration option, specifically noting that mired is an alias for kelvin, which provides additional context for users configuring the integration.

Changes

File Change Summary
source/_integrations/flux.markdown Updated description of mode configuration option to clarify that mired is an alias for kelvin

No sequence diagram is necessary for this documentation update, as it does not introduce any new functionality or change in system behavior.


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3d00e98 and 504a390.

📒 Files selected for processing (1)
  • source/_integrations/flux.markdown (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • source/_integrations/flux.markdown
⏰ 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

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

@bors-ltd bors-ltd removed their assignment Jan 8, 2025
@bors-ltd bors-ltd marked this pull request as draft January 8, 2025 16:50
@bors-ltd bors-ltd marked this pull request as ready for review January 8, 2025 16:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant