Extend smartcam detection support #1552

gpongelli · 2025-06-17T07:31:30Z

New detection added with tests:

bark detection
glass detection
line crossing detection
meow detection
vehicle detection

those module should be ready for home assistant, a change is needed into core repo adding more entity like this one .

closes #1551

Those file have linecrossingDetection in app_component_list; this fix tests

codecov · 2025-06-17T08:08:23Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.74%. Comparing base (e21ab90) to head (b695653).

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1552      +/-   ##
==========================================
+ Coverage   92.66%   92.74%   +0.08%     
==========================================
  Files         150      155       +5     
  Lines        9538     9648     +110     
  Branches      974      974              
==========================================
+ Hits         8838     8948     +110     
  Misses        499      499              
  Partials      201      201

☔ View full report in Codecov by Sentry.
📢 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.

This avoid typos when defining entity keys in Home Assistant that must be same as Feature ID.

rytilahti

First of all, thanks for the PR and looking into this, I'm sure many will find this useful in the future! Just a quick initial review, with a couple of points:

I think we should generalize the togglables/enablables under a "TogglableFeature" or something similar to avoid copy&pasting boilerplate for both the implementation and the tests. We could also leverage this for other features in the future.
This PR should be kept as small as possible, so please avoid adding the feature identifier class as a part of this. We can discuss having such later, but it's better to keep PRs contained and clean for the future maintainers' sake.

rytilahti · 2025-06-17T18:32:02Z

kasa/feature.py

@@ -81,6 +81,44 @@
 _LOGGER = logging.getLogger(__name__)


+class FeatureIdentifier(StrEnum):


Let's not add this, at least not yet, to keep the PR as small as possible.

ok, I've added it after looking at home assistant code, where I've found that feature's id must be the same as the home assistant entity's key, and this can be easily mistyped.

I could revert those changes and create a different PR after this will be merged.

rytilahti · 2025-06-17T18:36:12Z

kasa/smartcam/modules/barkdetection.py

+_LOGGER = logging.getLogger(__name__)
+
+
+class BarkDetection(SmartCamModule):


Considering all detection modules follow the same format, only with a different section and method names, I'm wondering if we could generalize this to avoid boilerplate? Maybe the generic detection module could read the available components and create the entities, having an enum defining the available detection types that could also be passed to a generic "set_enabled".

This will allow keeping the codebase easier to maintain, and also the tests much simpler.

I'll work on this

refactored with a common class for all the detections

rytilahti · 2025-06-17T18:38:53Z

tests/fixtures/smartcam/C325WB(EU)_1.0_1.1.17.json

@@ -506,6 +506,22 @@
            }
        }
    },
+    "getLinecrossingDetectionConfig": {


Do you have all these devices that have new fixtures including this information? If yes, I would suggest only including one fixture update alongside the dump_devinfo updates in this initial PR, and creating a new PR to update the rest.

no I haven't, I've put those blocks to have test passed.

code looks at this dict when fixture has

{ "name": "linecrossingDetection", "version": 2 },

let me know if you prefer having failure tests or not.

as example of why I did this change, with commit add LineCrossingDetectionRegion on dump_devinfo I've added a new section about linedetection region and then dumped the C220 webcam I have: the tests now fail for other webcams that have declared the linecrossingDetection feature but they have no "region_info" block.

To fix this, there are two ways:

remove the change on devtools/helpers/smartcamrequests.py

add missing block on all the fixture files

let me know which is the way to do, thanks.

There is a dictionary in one of the fake protocol implementation files containing dummy payloads where none is available, that's the place to add one so that the fixtures remain intact. I'll try to review other changes now on the train or latest later this weekend :)

edit: https://github.com/python-kasa/python-kasa/blob/master/tests%2Ffakeprotocol_smart.py#L91

There is a dictionary in one of the fake protocol implementation files containing dummy payloads where none is available, that's the place to add one so that the fixtures remain intact. I'll try to review other changes now on the train or latest later this weekend :)

edit: https://github.com/python-kasa/python-kasa/blob/master/tests%2Ffakeprotocol_smart.py#L91

tryied to use that file, and also fakeprotocol_smartcam, but none working as you can see by all the failing pipeline.

This reverts commit 2ab846c.

QUERY_SECTION_NAMES can be list, so mypy returns error.

rytilahti · 2025-06-20T15:00:06Z

tests/smartcam/modules/test_barkdetection.py

@@ -0,0 +1,45 @@
+"""Tests for smartcam bark detection module."""


Maybe we should also parameterize the tests to avoid code duplication for these similar modules? Just an idea 🤔

reverted to multiple SmartCamModule with repeated code, it's the only version that passes tests.

I've tried parametrize_combine but I cannot get it to work; same end also using @pytest.mark.parametrize .

Sorry for the late response, but let's rather fix the tests to avoid code duplication to keep it more maintainable.
If you want to bring your generalized revision back to this PR, I will try to find some time soon to look into fixing the tests.

hi @rytilahti , sorry for this late response, I've pushed the branch with detectionmodule common class, all the detections inherits from it.

I've tried some test changes but I've no idea actually on how to fix it, thanks.

This reverts commit 1d042f8.

This reverts commit 06499cc

gpongelli added 6 commits June 16, 2025 23:59

feat: linecrossing_detection dict and dump from C220

b83fa79

feat: add linecrossingdetection feature and test

b58002b

test: add config block on fixture files

1d042f8

Those file have linecrossingDetection in app_component_list; this fix tests

feat: new detections bark, glass, meow and vehicle

24a2bad

ruff checks

5e0afd1

fix: ruff format

0ab1546

feat: FeatureIdentifier string enum

2ab846c

This avoid typos when defining entity keys in Home Assistant that must be same as Feature ID.

gpongelli marked this pull request as draft June 17, 2025 11:43

gpongelli marked this pull request as ready for review June 17, 2025 11:55

rytilahti requested changes Jun 17, 2025

View reviewed changes

gpongelli added 5 commits June 18, 2025 12:03

Revert "feat: FeatureIdentifier string enum"

e288cc1

This reverts commit 2ab846c.

feat: added DetectionModule to reduce boilerplate code

479990b

add LineCrossingDetectionRegion on dump_devinfo

06499cc

fix: new set section name.

bc87f1d

QUERY_SECTION_NAMES can be list, so mypy returns error.

fix file length

c8e0f74

gpongelli requested a review from rytilahti June 20, 2025 14:46

rytilahti reviewed Jun 20, 2025

View reviewed changes

gpongelli added 9 commits June 22, 2025 19:48

test: add getLinecrossingDetectionConfig into FIXTURE_MISSING_MAP

23013c3

Revert "test: add config block on fixture files"

8a4b16f

This reverts commit 1d042f8.

Revert "add LineCrossingDetectionRegion on dump_devinfo"

b9b08c2

This reverts commit 06499cc

chore: style format

0a1dbcb

test: fake method on smartcam module

da3f022

test: fake method as tuple

67f6a57

ruff format

32370b0

move on smartcam fakeprotocol

9e80a46

test: remove fakeprotocol, filter by model

745342a

gpongelli requested a review from rytilahti June 23, 2025 08:29

rytilahti changed the title ~~Add more detections~~ Extend smartcam detection support Jul 3, 2025

rytilahti added the enhancement New feature or request label Jul 3, 2025

gpongelli force-pushed the linecrossing_detection branch from b695653 to 745342a Compare July 14, 2025 07:14

		@@ -81,6 +81,44 @@
		_LOGGER = logging.getLogger(__name__)


		class FeatureIdentifier(StrEnum):

		_LOGGER = logging.getLogger(__name__)


		class BarkDetection(SmartCamModule):

		@@ -0,0 +1,45 @@
		"""Tests for smartcam bark detection module."""

Uh oh!

Extend smartcam detection support #1552

Are you sure you want to change the base?

Extend smartcam detection support #1552

Uh oh!

Conversation

gpongelli commented Jun 17, 2025

Uh oh!

codecov bot commented Jun 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

rytilahti left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rytilahti Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov bot commented Jun 17, 2025 •

edited

Loading

rytilahti Jun 20, 2025 •

edited

Loading