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

Add Reolink automation ideas #35941

Open
wants to merge 5 commits into
base: current
Choose a base branch
from
Open

Conversation

starkillerOG
Copy link
Contributor

@starkillerOG starkillerOG commented Nov 23, 2024

Proposed change

Add Reolink automation ideas.

I will work out the "Sending rich notifications" part further in a seperate PR.

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
    • Added a new "Examples" section for the Reolink integration, providing practical use cases such as displaying the camera on the dashboard and automation ideas.
    • Reformatted and integrated the previous "Showing the camera in the dashboard" content into the new section for enhanced context.
    • Expanded troubleshooting section with detailed guidance on setup, emphasizing firmware updates and various connection methods including app, web browser, and QR code.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Nov 23, 2024
Copy link

netlify bot commented Nov 23, 2024

Deploy Preview for home-assistant-docs ready!

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

Copy link
Contributor

coderabbitai bot commented Nov 23, 2024

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the documentation for the Reolink integration in Home Assistant. A new "Examples" section has been added, detailing various use cases such as displaying the camera on the dashboard, sending rich notifications, and automation ideas. The existing content on displaying the camera has been reformatted and incorporated into this section. Additionally, the troubleshooting section has been updated with more detailed setup instructions, emphasizing camera firmware updates and connection methods.

Changes

File Change Summary
source/_integrations/reolink.markdown Added a new "Examples" section with use cases; reformatted and integrated previous content on showing the camera; updated troubleshooting instructions for setup and connection methods.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant ReolinkCamera

    User->>HomeAssistant: Access Reolink integration
    HomeAssistant->>ReolinkCamera: Connect to camera
    ReolinkCamera-->>HomeAssistant: Confirm connection
    HomeAssistant->>User: Display camera on dashboard
    User->>HomeAssistant: Request rich notifications
    HomeAssistant->>ReolinkCamera: Send notification
    ReolinkCamera-->>User: Deliver notification
Loading

Warning

Rate limit exceeded

@starkillerOG has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 2 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between b6fa50a and c278bc4.


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

🧹 Outside diff range and nitpick comments (2)
source/_integrations/reolink.markdown (2)

465-468: Fix grammar and consider adding placeholder for future content.

  1. Fix grammar: "a event" should be "an event"
  2. Since this section will be expanded in a future PR, consider adding a note like "More details coming soon" to set proper expectations.
-You can receive rich notifications on your phone when someone rings a Reolink doorbell or a Reolink camera detects a event like motion or a person.
+You can receive rich notifications on your phone when someone rings a Reolink doorbell or a Reolink camera detects an event like motion or a person.
🧰 Tools
🪛 LanguageTool

[misspelling] ~467-~467: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...nk doorbell or a Reolink camera detects a event like motion or a person. ### Aut...

(EN_A_VS_AN)


469-485: Fix grammar issues and enhance technical clarity.

Grammar fixes needed:

  1. Line 476: "detects a event" should be "detects an event"
  2. Line 478: Add comma after conditional: "if a camera detects a person/vehicle/animal, then point"
  3. Line 485: "Make a input" should be "Make an input"

Consider enhancing these examples with more technical details:

  1. Line 481: Specify typical framerate/bitrate values for clarity
  2. Line 482: Consider mentioning the use of delay or for in automations
  3. Line 485: Add a note about using timer.cancel or similar to handle the automatic re-enable
-wake up and start recording on other battery cameras nearby if one camera/motion sensor detects a event.
+wake up and start recording on other battery cameras nearby if one camera/motion sensor detects an event.

-If a camera detects a person/vehicle/animal then point other PTZ camaras in that direction
+If a camera detects a person/vehicle/animal, then point other PTZ cameras in that direction

-Make a input boolean helper to easily disable notifications
+Make an input boolean helper to easily disable notifications
🧰 Tools
🪛 LanguageTool

[misspelling] ~476-~476: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...rby if one camera/motion sensor detects a event. - Turn on spotlights/sirens of o...

(EN_A_VS_AN)


[typographical] ~478-~478: Consider adding a comma.
Context: ...a camera detects a person/vehicle/animal then point other PTZ camaras in that directi...

(IF_THEN_COMMA)


[misspelling] ~485-~485: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...e camera based on sunset/sunrise - Make a input boolean helper to easily disable ...

(EN_A_VS_AN)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between eb722e8 and 5406bae.

📒 Files selected for processing (1)
  • source/_integrations/reolink.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/reolink.markdown

[misspelling] ~467-~467: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...nk doorbell or a Reolink camera detects a event like motion or a person. ### Aut...

(EN_A_VS_AN)


[misspelling] ~476-~476: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...rby if one camera/motion sensor detects a event. - Turn on spotlights/sirens of o...

(EN_A_VS_AN)


[typographical] ~478-~478: Consider adding a comma.
Context: ...a camera detects a person/vehicle/animal then point other PTZ camaras in that directi...

(IF_THEN_COMMA)


[misspelling] ~485-~485: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...e camera based on sunset/sunrise - Make a input boolean helper to easily disable ...

(EN_A_VS_AN)

🔇 Additional comments (1)
source/_integrations/reolink.markdown (1)

458-464: LGTM!

The section header and camera dashboard example are well-structured and provide clear references to existing documentation.

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

🧹 Outside diff range and nitpick comments (5)
source/_integrations/reolink.markdown (5)

467-468: Fix grammar: Use "an" instead of "a" before "event"

The sentence contains a grammar error.

-You can receive rich notifications on your phone when someone rings a Reolink doorbell or a Reolink camera detects a event like motion or a person.
+You can receive rich notifications on your phone when someone rings a Reolink doorbell or a Reolink camera detects an event like motion or a person.
🧰 Tools
🪛 LanguageTool

[misspelling] ~467-~467: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...nk doorbell or a Reolink camera detects a event like motion or a person. ### Aut...

(EN_A_VS_AN)


476-476: Fix grammar: Use "an" instead of "a" before "event"

The sentence contains a grammar error.

-Wake up and start recording on other battery cameras nearby if one camera/motion sensor detects a event.
+Wake up and start recording on other battery cameras nearby if one camera/motion sensor detects an event.
🧰 Tools
🪛 LanguageTool

[misspelling] ~476-~476: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...rby if one camera/motion sensor detects a event. - Turn on spotlights/sirens of o...

(EN_A_VS_AN)


478-478: Add missing comma in conditional statement

Add a comma before "then" in the if-then statement for better readability.

-If a camera detects a person/vehicle/animal then point other PTZ camaras in that direction using PTZ presets
+If a camera detects a person/vehicle/animal, then point other PTZ camaras in that direction using PTZ presets
🧰 Tools
🪛 LanguageTool

[typographical] ~478-~478: Consider adding a comma.
Context: ...a camera detects a person/vehicle/animal then point other PTZ camaras in that directi...

(IF_THEN_COMMA)


485-485: Fix grammar: Use "an" instead of "a" before "input"

The sentence contains a grammar error.

-Make a input boolean helper to easily disable notifications on all cameras and automatically enable notifications again after 1 hour.
+Make an input boolean helper to easily disable notifications on all cameras and automatically enable notifications again after 1 hour.
🧰 Tools
🪛 LanguageTool

[misspelling] ~485-~485: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...e camera based on sunset/sunrise - Make a input boolean helper to easily disable ...

(EN_A_VS_AN)


471-484: Improve formatting of automation ideas

The automation ideas section provides valuable examples but could benefit from better organization. Consider:

  1. Grouping similar automations together (e.g., security-related, convenience-related)
  2. Adding brief explanations or links to relevant integrations for complex automations
  3. Using consistent punctuation at the end of each item
🧰 Tools
🪛 LanguageTool

[misspelling] ~476-~476: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...rby if one camera/motion sensor detects a event. - Turn on spotlights/sirens of o...

(EN_A_VS_AN)


[typographical] ~478-~478: Consider adding a comma.
Context: ...a camera detects a person/vehicle/animal then point other PTZ camaras in that directi...

(IF_THEN_COMMA)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 5406bae and e8100a3.

📒 Files selected for processing (1)
  • source/_integrations/reolink.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/reolink.markdown

[misspelling] ~467-~467: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...nk doorbell or a Reolink camera detects a event like motion or a person. ### Aut...

(EN_A_VS_AN)


[misspelling] ~476-~476: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...rby if one camera/motion sensor detects a event. - Turn on spotlights/sirens of o...

(EN_A_VS_AN)


[typographical] ~478-~478: Consider adding a comma.
Context: ...a camera detects a person/vehicle/animal then point other PTZ camaras in that directi...

(IF_THEN_COMMA)


[misspelling] ~485-~485: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...e camera based on sunset/sunrise - Make a input boolean helper to easily disable ...

(EN_A_VS_AN)

🔇 Additional comments (1)
source/_integrations/reolink.markdown (1)

465-468: Consider expanding the rich notifications section

The "Sending rich notifications" section is quite brief and could benefit from more details or examples, especially since it's mentioned in the PR objectives that this section will be expanded in a separate PR.

Consider adding a placeholder note indicating that more detailed information about rich notifications will be provided in a future update.

🧰 Tools
🪛 LanguageTool

[misspelling] ~467-~467: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...nk doorbell or a Reolink camera detects a event like motion or a person. ### Aut...

(EN_A_VS_AN)

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between e8100a3 and b6fa50a.

📒 Files selected for processing (1)
  • source/_integrations/reolink.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/reolink.markdown

[misspelling] ~467-~467: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...nk doorbell or a Reolink camera detects a event like motion or a person. ### Aut...

(EN_A_VS_AN)


[misspelling] ~476-~476: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...rby if one camera/motion sensor detects a event. - Turn on spotlights/sirens of o...

(EN_A_VS_AN)


[typographical] ~478-~478: Consider adding a comma.
Context: ...a camera detects a person/vehicle/animal then point other PTZ camaras in that directi...

(IF_THEN_COMMA)


[misspelling] ~485-~485: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...e camera based on sunset/sunrise - Make a input boolean helper to easily disable ...

(EN_A_VS_AN)

🔇 Additional comments (1)
source/_integrations/reolink.markdown (1)

458-464: LGTM! Well-structured examples section.

The new section provides clear instructions for showing cameras in the dashboard with appropriate cross-references to existing documentation.

source/_integrations/reolink.markdown Outdated Show resolved Hide resolved
source/_integrations/reolink.markdown Outdated Show resolved Hide resolved
starkillerOG and others added 2 commits November 23, 2024 18:28
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
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

🧹 Outside diff range and nitpick comments (3)
source/_integrations/reolink.markdown (3)

465-468: Fix grammar in notification description.

The sentence needs a minor grammatical correction.

-You can receive rich notifications on your phone when someone rings a Reolink doorbell or a Reolink camera detects a event like motion or a person.
+You can receive rich notifications on your phone when someone rings a Reolink doorbell or a Reolink camera detects an event like motion or a person.

471-485: Improve clarity and organization of automation ideas.

The automation ideas provide valuable examples but could benefit from better organization and some grammatical improvements.

Consider these improvements:

  1. Group related automations together under categories:

    • Security (motion detection, person detection)
    • Doorbell-specific
    • Camera settings optimization
    • Home automation integration
  2. Fix grammar and formatting:

-If a camera detects a person/vehicle/animal then point other PTZ cameras in that direction using PTZ presets.
+If a camera detects a person/vehicle/animal, then point other PTZ cameras in that direction using PTZ presets.

-Wake up and start recording on other battery cameras nearby if one camera/motion sensor detects a event.
+Wake up and start recording on other battery cameras nearby if one camera/motion sensor detects an event.

-Make a input boolean helper to easily disable notifications on all cameras and automatically enable notifications again after 1 hour.
+Make an input boolean helper to easily disable notifications on all cameras and automatically enable notifications again after 1 hour.
  1. Add periods at the end of each bullet point for consistency.

481-481: Fix typo in automation idea description.

There's a typo in the word "saves".

-Increase framerate and maximum bitrate of a camera when a person/vehicle/animal is detected and lower it again after 1 minute of no detection. This safes storage space so you can record longer when recording 24/7 without compromising image clarity during events.
+Increase framerate and maximum bitrate of a camera when a person/vehicle/animal is detected and lower it again after 1 minute of no detection. This saves storage space so you can record longer when recording 24/7 without compromising image clarity during events.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b6fa50a and c278bc4.

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

460-464: LGTM! Clear and helpful dashboard example.

The example provides a good reference to the picture glance card documentation and explains a practical use case.

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant