Skip to content

Update documentation device connections troubleshooting - TSS onboarding breaks local TP-Link (Tapo) KLAP authentication on latest firmware #37729

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

Merged
merged 3 commits into from
Feb 28, 2025

Conversation

Thireus
Copy link
Contributor

@Thireus Thireus commented Feb 26, 2025

TSS breaks local authentication for new firmware - See python-kasa/python-kasa#1353 (comment)

Proposed change

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
    • Enhanced the TP-Link integration guide with new troubleshooting steps.
    • Instructs users to disconnect existing TP-Link/Tapo devices before onboarding a new device.
    • Advises performing a factory reset on the new device if issues persist.

TSS breaks local authentication for new firmware - See python-kasa/python-kasa#1353 (comment)
@home-assistant home-assistant bot added the current This PR goes into the current branch label Feb 26, 2025
Copy link

netlify bot commented Feb 26, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 5b17a6f
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67c0eb4b2ff60f0008b4532c
😎 Deploy Preview https://deploy-preview-37729--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 Feb 26, 2025

📝 Walkthrough

Walkthrough

This change updates the TP-Link integration documentation by adding a new troubleshooting step. The update advises users to unplug any existing TP-Link/Tapo devices from their network before attempting to onboard a new device. It also recommends that if issues persist after this step, users should perform a factory reset of the new device and try adding it again without any other TP-Link devices active. There are no modifications to exported or public entities.

Changes

File(s) Change Summary
source/_integrations/tplink.markdown Updated documentation to include a troubleshooting step advising users to unplug existing TP-Link/Tapo devices before onboarding a new device. If issues persist, the documentation now instructs a factory reset and re-addition of the new device.

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.
  • @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

🧹 Nitpick comments (1)
source/_integrations/tplink.markdown (1)

207-207: Documentation Update: Added Unplugging Step for TSS Troubleshooting

The new troubleshooting step advises users to unplug existing TP-Link/Tapo devices before onboarding a new device. This clearly addresses the TSS protocol issue—where shared credentials might break authentication—and aligns well with the PR objectives. Consider adding a brief explanatory note or a reference (e.g., to this GitHub issue) for users who desire additional context.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e88ab4b and bf41c44.

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

@Thireus Thireus changed the title Update documentation device connections troubleshooting - TSS onboarding breaks local KLAP authentication on latest firmware Update documentation device connections troubleshooting - TSS onboarding breaks local TP-Link (Tapo) KLAP authentication on latest firmware Feb 27, 2025
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, @Thireus 👍

../Frenck

@frenck frenck merged commit 6c30bd8 into home-assistant:current Feb 28, 2025
7 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Mar 1, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants