-
-
Notifications
You must be signed in to change notification settings - Fork 7.3k
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
base: current
Are you sure you want to change the base?
Add Reolink automation ideas #35941
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe 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
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
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 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. 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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.
- Fix grammar: "a event" should be "an event"
- 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:
- Line 476: "detects a event" should be "detects an event"
- Line 478: Add comma after conditional: "if a camera detects a person/vehicle/animal, then point"
- Line 485: "Make a input" should be "Make an input"
Consider enhancing these examples with more technical details:
- Line 481: Specify typical framerate/bitrate values for clarity
- Line 482: Consider mentioning the use of
delay
orfor
in automations- 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
📒 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.
There was a problem hiding this 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 statementAdd 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 ideasThe automation ideas section provides valuable examples but could benefit from better organization. Consider:
- Grouping similar automations together (e.g., security-related, convenience-related)
- Adding brief explanations or links to relevant integrations for complex automations
- 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
📒 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)
There was a problem hiding this 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
📒 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.
There was a problem hiding this 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:
Group related automations together under categories:
- Security (motion detection, person detection)
- Doorbell-specific
- Camera settings optimization
- Home automation integration
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.
- 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
📒 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.
Proposed change
Add Reolink automation ideas.
I will work out the "Sending rich notifications" part further in a seperate PR.
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit