Skip to content

Fix IOT KLAPv2 transport selection and class detection#1692

Open
thatdaveguy1 wants to merge 1 commit into
python-kasa:masterfrom
thatdaveguy1:fix/iot-klap-lv2-transport-and-class
Open

Fix IOT KLAPv2 transport selection and class detection#1692
thatdaveguy1 wants to merge 1 commit into
python-kasa:masterfrom
thatdaveguy1:fix/iot-klap-lv2-transport-and-class

Conversation

@thatdaveguy1

Copy link
Copy Markdown

Summary

This PR fixes two related regressions for IOT KLAP devices on newer firmware:

  1. Transport selection: Use KlapTransportV2 for IOT KLAP devices when login_version >= 2.
  2. Device class detection: For IOT plug/switch and bulb families, derive class from system.get_sysinfo during connect() (not family-only mapping), so strips are correctly instantiated as IotStrip instead of IotPlug.

Why

Tests

  • Added iot-klap-lv2 coverage in test_get_protocol to assert KlapTransportV2 for login v2.
  • Added test_connect_iot_klap_uses_sysinfo_for_device_class to ensure KLAP strips are identified from sysinfo and not misclassified as plugs.

Use KlapTransportV2 for IOT KLAP devices with login_version >= 2 and derive IOT plug/switch+b ulb classes from get_sysinfo so strips are not misclassified as plugs.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@codecov

codecov Bot commented Apr 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.22%. Comparing base (76d9f68) to head (8b1f6b8).
⚠️ Report is 14 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1692   +/-   ##
=======================================
  Coverage   93.22%   93.22%           
=======================================
  Files         157      157           
  Lines        9815     9817    +2     
  Branches     1003     1004    +1     
=======================================
+ Hits         9150     9152    +2     
  Misses        472      472           
  Partials      193      193           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes regressions affecting IOT devices using KLAP on newer firmware by selecting the correct KLAP transport for login v2 and ensuring correct device-class instantiation (e.g., strips vs plugs) based on system.get_sysinfo during connect().

Changes:

  • Select KlapTransportV2 for IOT KLAP devices when login_version >= 2.
  • Use system.get_sysinfo-based device class detection during connect() for IOT plug/switch and bulb families (not just XOR).
  • Add unit tests covering both transport selection and KLAP device-class detection.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
kasa/device_factory.py Adjusts IOT connect path to derive class from sysinfo for plugs/bulbs and selects KlapTransportV2 for IOT KLAP login v2.
tests/test_device_factory.py Adds tests asserting IOT KLAP login v2 uses KlapTransportV2 and that KLAP strips are instantiated via sysinfo detection.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@bradcarnage

Copy link
Copy Markdown

Independently confirmed this fix works on real hardware.

I hit this exact bug on an HS103 (US) HW 5.0, FW 1.1.3 Build 250908 running on Home Assistant 2026.5.4 (python-kasa 0.10.2). Device reports with in discovery, but mapped it to (v1, MD5) — causing .

I independently arrived at the same fix (upgrading to when ) before finding this PR. Validated by:

  1. Raw KLAP handshake1+2 with SHA-based (v2) hashes → ✅ success
  2. Raw KLAP handshake1 with MD5-based (v1) hashes → ❌ mismatch
  3. Patching identically to this PR → device fully controllable via python-kasa and HA

This is blocking real HA users — anyone with HS103/HS200/HS300/KP303 on newer firmware (HW 5.0+) can't add these devices. The fix is minimal, correct, and well-tested. Would love to see this merged. 🚀

@carterbs

Copy link
Copy Markdown

Hey Brad! Another Brad here confirming this against real hardware.

I hit the same failure path in Home Assistant with a TP-Link HS103:

  • Home Assistant Core: 2026.1.3
  • python-kasa: 0.10.2
  • Device: HS103(US), HW 5.0
  • Discovery metadata:
    • device_type: IOT.SMARTPLUGSWITCH
    • mgt_encrypt_schm.encrypt_type: KLAP
    • mgt_encrypt_schm.http_port: 80
    • mgt_encrypt_schm.lv: 2
    • mgt_encrypt_schm.new_klap: 1

Before applying this patch, Home Assistant/python-kasa selected the normal KlapTransport path for IOT.KLAP and failed during handshake1:

Finding protocol for 192.168.5.241
Finding transport for IOT.KLAP
Created KLAP transport for 192.168.5.241
Handshake1 success ... Response status is 200
Device response did not match our challenge on ip 192.168.5.241

I applied the same selection logic from this PR inside the HA container and restarted HA. A direct transport-selection probe then showed:

login_version None -> KlapTransport
login_version 1    -> KlapTransport
login_version 2    -> KlapTransportV2

After that, the HS103 began authenticating/querying successfully from Home Assistant:

Device 192.168.5.241 query posted ... Response status is 200
Device 192.168.5.241 query response received
Finished fetching 192.168.5.241 data ... success: True

So this is another confirmation that IOT KLAP devices advertising lv: 2 / new_klap: 1 need KlapTransportV2; otherwise valid TP-Link credentials fail with the challenge mismatch. This PR is the minimal fix for the behavior I observed.

@benbenmoss benbenmoss left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed and tested.

  • Code change is minimal and well-scoped: correctly selects KlapTransportV2 for IOT KLAP devices with login_version >= 2, and fixes device-class detection (sysinfo-based) for IOT plug/bulb families so strips aren't misclassified as plugs (#1691).
  • tests/test_device_factory.py passes (1287 passed) with the new iot-klap-lv2 and sysinfo-class-detection cases.
  • Ran the full test suite on this branch vs master: the 182 test_discover_raw failures are pre-existing on master too -- unrelated to this change.
  • Live-tested against my own SMART.TAPOHUB (H110, KLAP login_version 2) on this branch -- connects and updates correctly, confirming no regression to the existing SMART KLAP path.
  • Combined with the real-hardware confirmations from @bradcarnage (HS103) and @carterbs (HS103) above, this fixes #1648 and #1691 for IOT KLAP v2 devices (HS103/HS200/HS300/KP303 on newer firmware).

LGTM -- recommend merging.

@bradcarnage

Copy link
Copy Markdown

paging @rytilahti to review this PR

@michaelpetrov

Copy link
Copy Markdown

I independently validated this failure and the two-part fix against a real HS300 power strip through Home Assistant.

Environment and device:

  • Home Assistant Core: 2026.6.4
  • python-kasa: 0.10.2
  • Device: HS300(US)
  • Discovery/device data:
    • device_type: IOT.SMARTPLUGSWITCH
    • mgt_encrypt_schm.encrypt_type: KLAP
    • mgt_encrypt_schm.http_port: 80
    • mgt_encrypt_schm.lv: 2
    • mgt_encrypt_schm.new_klap: 1
    • port 80 open, port 9999 closed

Stock HA / python-kasa 0.10.2 failed immediately during reauth with valid TP-Link credentials:

Device response did not match our challenge

A direct KLAP v2 handshake succeeded with the same credentials, and IotProtocol + KlapTransportV2 was able to query the device successfully. I then patched HA's vendored integration locally with the same two behavioral changes as this PR:

  1. select KlapTransportV2 for IOT.KLAP when login_version >= 2
  2. use system.get_sysinfo during connect to pick the concrete IOT device class

After restarting HA, the reconfigure flow completed successfully and the config entry stored the credential hash. The sysinfo/class-detection part was also required: without that path, this HS300 gets treated as a generic IotPlug, losing the strip children. With both parts of the fix in place, HA created the strip plus all child outlets and energy/voltage sensors as available.

So this PR matches the fix required for HS300 as well as the HS103 confirmations above: the transport change fixes auth, and the sysinfo class detection fixes child outlet/entity creation for strips.

@benbenmoss benbenmoss left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGMT

@ZeliardM

ZeliardM commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

There is already an existing, extensively tested PR that handles all of the CLI and API changes, #1580, we are working to get this implemented and a new version released soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants