8000 Replace still image example in generic camera by davet2001 · Pull Request #37339 · home-assistant/home-assistant.io · GitHub
[go: up one dir, main page]
Skip to content
8000

Replace still image example in generic camera #37339

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
Feb 7, 2025
Merged

Replace still image example in generic camera #37339

merged 1 commit into from
Feb 7, 2025

Conversation

davet2001
Copy link
Contributor
@davet2001 davet2001 commented Feb 6, 2025 •
edited by coderabbitai bot
Loading

Proposed change

As per #35819, one of the still image examples for the generic camera integration does not work. This PR swaps to another example weather map which does ok.

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

The reason for the previous yr.no svg file not working is because of a slightly abnormal svg format which fails the image verification.

Since IP cameras are not expected to be displaying svg files, it was decided not to add that capability.

If users want to display svg files, they should use a picture entity card, rather than setting up a generic camera.

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 the example for the generic camera integration, modifying the header to highlight the USA National Weather Service.
    • Replaced the previous static weather image example with a new animated GIF display.
    • Removed outdated instructions related to the earlier weather service setup.

@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 Feb 6, 2025
@home-assistant
Copy link
home-assistant bot commented Feb 6, 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.

@netlify Netlify
Copy link
netlify bot commented Feb 6, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

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

@coderabbitai coderabbitai
Copy link
Contributor
coderabbitai bot commented Feb 6, 2025
📝 Walkthrough

Walkthrough

The documentation for the Generic Camera integration has been updated. The example header now reads "Weather graph from USA National Weather Service" instead of "Weather graph from yr.no," and the example image URL has been changed from an SVG to a GIF from the USA National Weather Service. Additionally, the instructions for locating the outdated yr.no SVG have been removed. No modifications were made to public or exported entities.

Changes

File Change Summary
source/_integrations/generic.markdown Updated example header text, replaced the yr.no SVG URL with a USA National Weather Service GIF URL, and removed obsolete instructions

Assessment against linked issues

Objective Addressed Explanation
Replace the unsupported yr.no SVG example with a working image example (#35819) ✅

Tip

🌐 Web search-backed reviews and chat
  • We have enabled web search-based reviews and chat for all users. This feature allows CodeRabbit to access the latest documentation and information on the web.
  • You can disable this feature by setting web_search: false in the knowledge_base settings.
  • Please share any feedback in the Discord discussion.
📜 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 bb9b92d and e5e3927.

📒 Files selected for processing (1)
  • source/_integrations/generic.markdown (1 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 (3)
source/_integrations/generic.markdown (3)

62-62: Header Update Reflects Correct Source

The header now reads "Weather graph from USA National Weather Service," which clearly communicates the change from the non-standard SVG example. This update aligns with the PR objectives by clarifying the example source.

64-64: Clear Description Update

The description now indicates that a GIF from the web is used as a still image. This provides clear guidance on the expected image format and supports the updated example.

66-66: Updated Still Image URL Verification

The Still Image URL has been updated to use a GIF from the USA National Weather Service (https://radar.weather.gov/ridge/standard/CONUS_0.gif), replacing the old SVG. Please verify that this URL is accessible and renders correctly across different environments.

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.

frenck
frenck approved these changes Feb 7, 2025
View reviewed changes
Copy link
Member
@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @davet2001 👍

../Frenck

@frenck frenck merged commit d4a85fe into current Feb 7, 2025
9 checks passed
@home-assistant 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 Feb 7, 2025
@frenck frenck deleted the davet2001-patch-2 branch February 7, 2025 10:34
@github-actions github-actions bot locked and limited conversation to collaborators Feb 8, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@frenck frenck frenck approved these changes

Assignees

@davet2001 davet2001

Labels
current This PR goes into the current branch has-parent This PR has a parent PR in a other repo
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Generic Camera does not accept yr.no svg files, while its clearly stated as an example in the Generic Camera Wiki.
2 participants
@davet2001 @frenck
0