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 tplink cameras to the docs #36016

Merged
merged 7 commits into from
Dec 22, 2024
Merged

Conversation

sdb9696
Copy link
Contributor

@sdb9696 sdb9696 commented Nov 27, 2024

Proposed change

Update tplink docs to include section about new support for tapo cameras

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

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
    • Expanded support for Tapo devices, now including additional camera models and updated power strip model.
    • Introduced a new category for cameras in the integration documentation.
  • Documentation
    • Enhanced clarity regarding Tapo camera authentication requirements and live view functionality.
    • Updated note format for better visibility and comprehension.
    • Clarified information on unavailable entities and stability issues.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Nov 27, 2024
Copy link

netlify bot commented Nov 27, 2024

Deploy Preview for home-assistant-docs ready!

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

source/_integrations/tplink.markdown Outdated Show resolved Hide resolved
source/_integrations/tplink.markdown Outdated Show resolved Hide resolved
@sdb9696 sdb9696 marked this pull request as ready for review December 22, 2024 13:55
@sdb9696 sdb9696 requested a review from bdraco as a code owner December 22, 2024 13:55
Copy link
Contributor

coderabbitai bot commented Dec 22, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The 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

File Change Summary
source/_integrations/tplink.markdown - Added Camera to ha_category and ha_platforms
- Updated supported Tapo camera models: added C100, C225, C325WB, C520WS
- Updated power strip model from P100 to P210M
- Added authentication notes for Tapo cameras
- Clarified camera live view requirements
- Updated footnotes and update section

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.

rytilahti
rytilahti previously approved these changes Dec 22, 2024
Copy link
Member

@rytilahti rytilahti left a 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 👍

source/_integrations/tplink.markdown Outdated Show resolved Hide resolved
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 (3)
source/_integrations/tplink.markdown (3)

57-59: Fix markdown formatting

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

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

The 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

📥 Commits

Reviewing files that changed from the base of the PR and between 2422aa8 and bbddac8.

📒 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

rytilahti
rytilahti previously approved these changes Dec 22, 2024
Copy link
Member

@rytilahti rytilahti left a 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.

@home-assistant home-assistant bot added the parent-merged The parent PR has been merged already label Dec 22, 2024
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 (2)
source/_integrations/tplink.markdown (2)

57-62: Fix markdown formatting

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

While the instructions are clear, it would be helpful to explain:

  1. What features the "Camera Account" enables
  2. Any security implications of enabling/disabling it
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between bbddac8 and 584ff7c.

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

source/_integrations/tplink.markdown Outdated Show resolved Hide resolved
source/_integrations/tplink.markdown Outdated Show resolved Hide resolved
source/_integrations/tplink.markdown Outdated Show resolved Hide resolved
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 (2)
source/_integrations/tplink.markdown (2)

58-63: LGTM: Warning notes are clear and properly formatted

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

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

  1. Move the camera section up, right after the authentication warning note
  2. Add a cross-reference between the two sections
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 584ff7c and d982a5c.

📒 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

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

../Frenck

@frenck frenck merged commit d662cd6 into home-assistant:next Dec 22, 2024
7 checks passed
@home-assistant home-assistant bot removed the parent-merged The parent PR has been merged already label Dec 22, 2024
@sdb9696 sdb9696 deleted the tplink_camera branch December 22, 2024 20:32
@sdb9696
Copy link
Contributor Author

sdb9696 commented Dec 22, 2024

Many thanks for the commits @frenck!

@frenck
Copy link
Member

frenck commented Dec 22, 2024

No problem! ❤️

Happy Holidays 🎄

../Frenck

@github-actions github-actions bot locked and limited conversation to collaborators Dec 23, 2024
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants