-
-
Notifications
You must be signed in to change notification settings - Fork 7.4k
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 tplink cameras to the docs #36016
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request updates the TP-Link integration documentation in Home Assistant, focusing on expanding device support and clarifying technical details. The changes primarily involve adding new Tapo camera models (C100, C225, C325WB, C520WS), updating power strip models, and providing more detailed authentication and compatibility information. The documentation now includes specific guidance on camera integration, authentication requirements, and handling of unavailable entities. Changes
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.
A minor nitpick, LGTM otherwise 👍
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
🧹 Nitpick comments (3)
source/_integrations/tplink.markdown (3)
57-59
: Fix markdown formattingRemove the blank line inside the blockquote to comply with markdown standards.
> [!NOTE] > The hub attached Tapo buttons S200B and S200D do not currently support alerting when the button is pressed. -
🧰 Tools
🪛 Markdownlint (0.37.0)
59-59: null
Blank line inside blockquote(MD028, no-blanks-blockquote)
60-62
: LGTM: Clear authentication instructionsThe note about Tapo camera authentication requirements is well-placed and provides crucial setup information. Consider adding the minimum firmware version where this is required, if known.
93-98
: Improve grammar in camera setup instructionsThe new camera section provides valuable setup information. Consider these minor grammar improvements:
## Cameras Only Tapo cameras are currently supported. -In order for live view to work you will need to enable your camera account in the Tapo App > "Advanced Settings" > "Camera Account". +In order for live view to work, you will need to enable your camera account in the Tapo App > "Advanced Settings" > "Camera Account". If you do not want to do this keep "Live view" unchecked when adding the device.🧰 Tools
🪛 LanguageTool
[uncategorized] ~96-~96: Possible missing comma found.
Context: ...ly supported. In order for live view to work you will need to enable your camera acc...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/tplink.markdown
(4 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
source/_integrations/tplink.markdown
59-59: null
Blank line inside blockquote
(MD028, no-blanks-blockquote)
🪛 LanguageTool
source/_integrations/tplink.markdown
[uncategorized] ~96-~96: Possible missing comma found.
Context: ...ly supported. In order for live view to work you will need to enable your camera acc...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (2)
source/_integrations/tplink.markdown (2)
7-7
: LGTM: Front matter updates for camera support
The additions of "Camera" category and "camera" platform are correctly placed and formatted, aligning with the integration's expanded support for cameras.
Also applies to: 28-28
68-68
: LGTM: Device list updates are accurate and well-formatted
The device list updates maintain consistent formatting and properly document the supported models, including the new Tapo cameras. The footnotes clearly indicate authentication requirements.
Also applies to: 77-77, 81-81, 85-87
Co-authored-by: Teemu R. <[email protected]>
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.
LGTM & can be merged when the parent gets merged.
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
🧹 Nitpick comments (2)
source/_integrations/tplink.markdown (2)
57-62
: Fix markdown formattingRemove the blank line between the blockquotes to comply with markdown standards.
> [!NOTE] > The hub attached Tapo buttons S200B and S200D do not currently support alerting when the button is pressed. - > [!NOTE] > Some firmware versions of Tapo Cameras will not authenticate unless you enable "Tapo Lab" > "Third-Party Compatibility" in the native Tapo app. > Alternatively, you can factory reset and then prevent the device from accessing the internet.🧰 Tools
🪛 Markdownlint (0.37.0)
59-59: null
Blank line inside blockquote(MD028, no-blanks-blockquote)
93-97
: Consider adding more context about Camera AccountWhile the instructions are clear, it would be helpful to explain:
- What features the "Camera Account" enables
- Any security implications of enabling/disabling it
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/tplink.markdown
(4 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
source/_integrations/tplink.markdown
59-59: null
Blank line inside blockquote
(MD028, no-blanks-blockquote)
🔇 Additional comments (3)
source/_integrations/tplink.markdown (3)
7-7
: LGTM: Camera support properly configured
The addition of camera category and platform is correctly placed and aligns with the documentation standards.
Also applies to: 28-28
68-68
: LGTM: Device lists properly updated
The device lists are correctly updated with new models while maintaining consistent formatting and organization.
Also applies to: 77-77, 81-81
85-87
: LGTM: Footnotes clearly updated
The footnote updates improve clarity while maintaining accuracy.
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
🧹 Nitpick comments (2)
source/_integrations/tplink.markdown (2)
58-63
: LGTM: Warning notes are clear and properly formattedThe notes effectively communicate important limitations and requirements. Consider adding a brief explanation of why enabling "Third-Party Compatibility" is necessary for better user understanding.
Some firmware versions of Tapo Cameras will not authenticate unless you enable **Tapo Lab** > **Third-Party Compatibility** in the native Tapo app. +This setting allows local access to the camera required by Home Assistant. Alternatively, you can factory reset and then prevent the device from accessing the internet.
95-99
: LGTM: Camera section provides clear setup instructionsThe camera section effectively communicates setup requirements. Consider moving this section closer to the authentication warning note for better flow, as they are related topics.
Consider reorganizing the document to group related information:
- Move the camera section up, right after the authentication warning note
- Add a cross-reference between the two sections
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/tplink.markdown
(4 hunks)
🔇 Additional comments (3)
source/_integrations/tplink.markdown (3)
7-7
: LGTM: Camera category and platform additions are properly placed
The additions follow the correct alphabetical order and maintain consistent formatting.
Also applies to: 28-28
87-88
: LGTM: Footnote changes improve clarity
The updated footnote text better communicates the authentication requirements.
70-70
: LGTM: Device lists are properly updated
The device list updates maintain consistent formatting and proper footnote references.
Let's verify the model numbers against the official documentation:
Also applies to: 79-79, 83-83
✅ Verification successful
Device model numbers verified against python-kasa documentation
All the camera models (C100, C225, C325WB, C520WS) are officially listed in the python-kasa's supported devices documentation, confirming the accuracy of the device list updates.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify camera model numbers against the python-kasa documentation
# Expected: Find references to the new camera models in the python-kasa docs
# Check python-kasa docs for camera model references
curl -s https://raw.githubusercontent.com/python-kasa/python-kasa/master/SUPPORTED.md | grep -E "C100|C225|C325WB|C520WS"
Length of output: 171
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.
Thanks, @sdb9696 👍
../Frenck
Many thanks for the commits @frenck! |
No problem! ❤️ Happy Holidays 🎄 ../Frenck |
Proposed change
Update tplink docs to include section about new support for tapo cameras
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit