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

Update govee-light-local docs #37112

Merged
merged 2 commits into from
Feb 5, 2025

Conversation

Galorhallen
Copy link
Contributor

@Galorhallen Galorhallen commented Jan 25, 2025

Proposed change

Update to the supported device list

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: Govee local api 200 core#136530
  • 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
    • Added support for numerous new Govee light device models
  • Documentation
    • Added note about potential scene compatibility limitations across different device models

@home-assistant home-assistant bot added 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 next This PR goes into the next branch labels Jan 25, 2025
@home-assistant
Copy link

It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the current branch. Please change the target branch of this PR to current and rebase if needed. If this is documentation for a new feature, please add a link to that PR in your description.

Copy link

netlify bot commented Jan 25, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 2917bb5
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6798a0d8bc69bc0008a138f5
😎 Deploy Preview https://deploy-preview-37112--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.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo and removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Jan 25, 2025
@Galorhallen Galorhallen marked this pull request as ready for review January 25, 2025 17:16
Copy link
Contributor

coderabbitai bot commented Jan 25, 2025

📝 Walkthrough

Walkthrough

The pull request updates the Govee Light Local integration documentation by expanding the list of supported device models. The changes include adding numerous Govee light model identifiers, ranging from H6069 to H805C. A new note has been included to advise users about potential scene compatibility limitations across different device models, recommending reporting of any model-specific issues to the library's issue tracker.

Changes

File Change Summary
source/_integrations/govee_light_local.markdown Added 40+ new Govee light device model identifiers (H6069, H606A, H6079, ..., H805C) and included a user advisory note about scene support

This update appears to be a straightforward documentation enhancement to improve device compatibility information for the Govee Light Local integration.


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.

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 (1)
source/_integrations/govee_light_local.markdown (1)

146-148: Fix typo in the note section.

There's a typo in the word "underling" (should be "underlying").

-Some scenes may not be supported from all devices. If you find a scene that's not working with a specific model, please open an issue at the [underling library](https://github.com/Galorhallen/govee-local-api/issues)
+Some scenes may not be supported from all devices. If you find a scene that's not working with a specific model, please open an issue at the [underlying library](https://github.com/Galorhallen/govee-local-api/issues)
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 91b79b6 and 7d59823.

📒 Files selected for processing (1)
  • source/_integrations/govee_light_local.markdown (3 hunks)
🔇 Additional comments (2)
source/_integrations/govee_light_local.markdown (2)

Line range hint 1-148: Documentation structure looks good!

The documentation follows Home Assistant's standards and provides clear information about the integration, including:

  • Proper frontmatter
  • Clear setup instructions
  • External resource links
  • Comprehensive device support list
  • Important notes about compatibility

37-38: Verify device models against the core PR.

The device models have been added in alphanumeric order. Let's verify that these models match the supported devices in the parent PR.

Also applies to: 43-44, 49-50, 53-53, 55-57, 59-62, 68-69, 88-89, 92-92, 94-95, 97-101, 107-110, 115-115, 119-122, 126-126, 128-128, 130-144

✅ Verification successful

Models are correctly formatted and ordered

The device models H6069 and H606A are properly placed in alphanumeric order within the comprehensive list of supported models in the documentation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Fetch and compare device models from the parent PR

# Fetch the parent PR's changed files
curl -s https://api.github.com/repos/home-assistant/core/pulls/136530/files | \
  jq -r '.[].raw_url' | \
  grep -i "govee" | \
  xargs curl -s | \
  grep -o 'H[0-9A-Z]\{4\}' | \
  sort | \
  uniq

Length of output: 172


Script:

#!/bin/bash
# Get all device models from the documentation
echo "=== Models in documentation ==="
cat source/_integrations/govee_light_local.markdown | grep -o 'H[0-9A-Z]\{4\}' | sort | uniq

# Search for Govee-related files in the repository
echo -e "\n=== Govee implementation files ==="
fd -t f -e py govee

# Try to find model definitions in Python files
echo -e "\n=== Model definitions in code ==="
rg -A 5 -B 5 "MODEL_" $(fd -t f -e py govee)

Length of output: 1122

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, @Galorhallen 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label Jan 28, 2025
@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Feb 5, 2025
@silamon silamon merged commit 27b0e79 into home-assistant:next Feb 5, 2025
7 checks passed
@home-assistant home-assistant bot removed parent-merged The parent PR has been merged already in-progress This PR/Issue is currently being worked on awaits-parent Awaits the merge of an parent PR labels Feb 5, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Feb 6, 2025
@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Feb 25, 2025
@Galorhallen Galorhallen deleted the govee-local-update branch March 9, 2025 12:20
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
has-parent This PR has a parent PR in a other repo next This PR goes into the next branch parent-merged The parent PR has been merged already
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants