Add Tuya vibration door sensor `_TZE200_kzm5w4iz` #3246

adam-zlatniczki · 2024-07-08T21:04:03Z

Proposed change

Added quirk for the Tuya Vibration Door Sensor, which didn't have any matching quirks before.

Additional information

--

Checklist

The changes are tested and work correctly
pre-commit checks pass / the code has been formatted using Black
Tests have been added to verify that the new code works

codecov · 2024-07-08T21:09:35Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.33%. Comparing base (156aaa6) to head (9148010).
Report is 6 commits behind head on dev.

Additional details and impacted files

@@            Coverage Diff             @@
##              dev    #3246      +/-   ##
==========================================
+ Coverage   88.25%   88.33%   +0.07%     
==========================================
  Files         302      304       +2     
  Lines        9434     9497      +63     
==========================================
+ Hits         8326     8389      +63     
  Misses       1108     1108

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

zhaquirks/tuya/ts601_door.py

TheJulianJES · 2024-08-03T23:26:44Z

Thanks for adding tests btw!

adam-zlatniczki · 2024-08-05T20:16:21Z

_CONSTANT_ATTRIBUTES is a good proposal, I've moved the constant attributes.

TheJulianJES

I think the quirk looks really good. Added a few small comments.

TheJulianJES · 2024-08-26T19:29:43Z

zhaquirks/tuya/ts601_door.py

+        # Initialize remaining battery to 100% until a proper measurement arrives.
+        # Device measures battery in 1% steps, while the ZCL specifies it in 0.5% steps.
+        self.update_attribute(
+            attr_name=PowerConfiguration.AttributeDefs.battery_percentage_remaining.name,
+            value=100 * 2,
+        )


Since this is done in __init__, this will update the attribute to 100% if HA is restarted.
Something like if attr_id not in self._attr_cache could be added before, but I think I'd just remove this for now.
HA should still initialize the sensor. It should just show something like "unknown". How long does it take for the device to report a value?

Removed for now.

As far as I've noticed, the device reports battery state when there's a change in percentage. This doesn't happen too often: either when there's some variability in the measured voltage (e.g. moves from 80% to 81% then back to 80%), or when there's an actual drop. Since this is a door sensor and is supposed to be used frequently, the value will probably get initialized fairly soon, so I'm fine with this decision.

TheJulianJES · 2024-08-26T19:30:34Z

zhaquirks/tuya/ts601_door.py

+    def __init__(self, endpoint: Endpoint, is_server: bool = True):
+        """Init constructor that initializes the major IasZone attributes."""
+        super().__init__(endpoint=endpoint, is_server=is_server)
+
+        # Initialize zone status until a proper update comes.
+        self.update_attribute(
+            attr_name=IasZone.AttributeDefs.zone_status.name,
+            value=0x0000,
+        )


Same thing here. This will update, as soon as the sensor is opened/closed once, right?
Do we really need to put "fake" initial data here?

Removed for now.

Same reasoning applies: the opening sensor will probably get used fairly soon, it doesn't matter much if it doesn't get initialized.

TheJulianJES · 2024-08-26T19:30:48Z

zhaquirks/tuya/ts601_door.py

+    def __init__(self, endpoint: Endpoint, is_server: bool = True):
+        """Init constructor that initializes the major IasZone attributes."""
+        super().__init__(endpoint=endpoint, is_server=is_server)
+
+        # Initialize zone status until a proper update comes.
+        self.update_attribute(
+            attr_name=IasZone.AttributeDefs.zone_status.name,
+            value=0x0000,
+        )


Same thing here.

Removed for now.

This is where I disagree. Significant force is very rarely applied to most doors (in fact, my sensor only detected such change when I was manually testing the quirk, but never since then). This leads to an unitialized entity for quite a long time, which I personally don't really like to see on a UI. Initializing the vibration state to "no vibration" seems to me the lesser evil :)

zhaquirks/tuya/ts601_door.py

for more information, see https://pre-commit.ci

TheJulianJES

Thanks!

I've removed initializing the attributes for now, as they'd always initialize to the defaults specified when rebooting HA.
If the defaults are really needed, they can be re-added with adjustments I mentioned here. For now, the entities should stay unknown until the first update report.

TheJulianJES · 2024-08-27T18:06:14Z

zhaquirks/tuya/ts601_door.py

+class CustomBasicCluster(CustomCluster, Basic):
+    """Custom Basic cluster to report power source."""
+
+    _CONSTANT_ATTRIBUTES = {
+        Basic.AttributeDefs.power_source.id: Basic.PowerSource.Battery
+    }


Not sure we need this, not an issue for now though. Was it shown wrong on the HA device page?
That data comes from the node descriptor though.

ZHA displayed the power source as "battery or unknown", which was bothering me a little, and in hopes of fixing that I tried setting it this way. However, it didn't really help, so I guess that is solely based on the device signature.

Jimfizz · 2024-09-20T10:18:39Z

Hello, I have the same Tuya vibration sensor (TS0601) but the manufacturer is _TZE200_iba1ckek.
Are you able to deal different sensors (of the same type) in the same quirk or should I create a new topic ?
I use it to detect the sound of a doorbell and I would like to manage the sensitivity of the sensor.

EDIT : ooop, it's not strictly the same sensor, mine is only a vibration one. I will create a new entry.

adam-zlatniczki · 2024-09-20T10:26:23Z

Hi, it really depends on whether the Tuya DataPoints that it reports are the same or not. Can you do a quick analysis on that?

…

On Fri, 20 Sept 2024, 12:19 Jimfizz, ***@***.***> wrote: Hello, I have the same Tuya vibration sensor (TS0601) but the manufacturer is _TZE200_iba1ckek. Are you able to deal different sensors (of the same type) in the same quirk or should I create a new topic ? I use it to detect the sound of a doorbell and I would like to manage the sensitivity of the sensor. — Reply to this email directly, view it on GitHub <#3246 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AITBLK2QKGKKFBNWUITMG2LZXPZBJAVCNFSM6AAAAABKRSL57SVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGNRTGM3TMNBVHE> . You are receiving this because you authored the thread.Message ID: ***@***.***>

Jimfizz · 2024-09-20T10:38:52Z

Thank you @adam-zlatniczki : in ZHA the sensor does not report any door state (open/closed), only vibration detection (with reset), battery level (CR2450) & identifier

Added quirk for Tuya Vibration Door Sensor.

74cdc21

Merge branch 'dev' into dev

5b44d58

TheJulianJES changed the title ~~Added quirk for Tuya Vibration Door Sensor.~~ Add Tuya vibration door sensor Aug 3, 2024

TheJulianJES added the Tuya Request/PR regarding a Tuya device label Aug 3, 2024

TheJulianJES reviewed Aug 3, 2024

View reviewed changes

zhaquirks/tuya/ts601_door.py Outdated Show resolved Hide resolved

TheJulianJES reviewed Aug 3, 2024

View reviewed changes

zhaquirks/tuya/ts601_door.py Outdated Show resolved Hide resolved

TheJulianJES reviewed Aug 3, 2024

View reviewed changes

zhaquirks/tuya/ts601_door.py Outdated Show resolved Hide resolved

TheJulianJES reviewed Aug 3, 2024

View reviewed changes

zhaquirks/tuya/ts601_door.py Outdated Show resolved Hide resolved

adam-zlatniczki and others added 2 commits August 5, 2024 21:38

Merge branch 'zigpy:dev' into dev

c4a9c74

Code style improvement for tuya vibration sensor

6e02fdd

Merge branch 'zigpy:dev' into dev

469c668

TheJulianJES reviewed Aug 26, 2024

View reviewed changes

TheJulianJES added the smash This PR is close to be merged soon label Aug 26, 2024

TheJulianJES changed the title ~~Add Tuya vibration door sensor~~ Add Tuya vibration door sensor _TZE200_kzm5w4iz Aug 26, 2024

TheJulianJES reviewed Aug 27, 2024

View reviewed changes

zhaquirks/tuya/ts601_door.py Outdated Show resolved Hide resolved

zhaquirks/tuya/ts601_door.py Outdated Show resolved Hide resolved

zhaquirks/tuya/ts601_door.py Outdated Show resolved Hide resolved

TheJulianJES and others added 2 commits August 27, 2024 20:01

Remove always initializing fake attributes

b4dd9fe

[pre-commit.ci] auto fixes from pre-commit.com hooks

9148010

for more information, see https://pre-commit.ci

TheJulianJES approved these changes Aug 27, 2024

View reviewed changes

TheJulianJES reviewed Aug 27, 2024

View reviewed changes

TheJulianJES merged commit a257c6c into zigpy:dev Aug 27, 2024
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Tuya vibration door sensor `_TZE200_kzm5w4iz` #3246

Add Tuya vibration door sensor `_TZE200_kzm5w4iz` #3246

adam-zlatniczki commented Jul 8, 2024

codecov bot commented Jul 8, 2024 •

edited

Loading

TheJulianJES commented Aug 3, 2024

adam-zlatniczki commented Aug 5, 2024

TheJulianJES left a comment

TheJulianJES Aug 26, 2024

TheJulianJES Aug 27, 2024

adam-zlatniczki Aug 28, 2024 •

edited

Loading

TheJulianJES Aug 26, 2024

TheJulianJES Aug 27, 2024

adam-zlatniczki Aug 28, 2024

TheJulianJES Aug 26, 2024

TheJulianJES Aug 27, 2024

adam-zlatniczki Aug 28, 2024

TheJulianJES left a comment

TheJulianJES Aug 27, 2024

adam-zlatniczki Aug 28, 2024

Jimfizz commented Sep 20, 2024 •

edited

Loading

adam-zlatniczki commented Sep 20, 2024 via email

Jimfizz commented Sep 20, 2024

Add Tuya vibration door sensor _TZE200_kzm5w4iz #3246

Add Tuya vibration door sensor _TZE200_kzm5w4iz #3246

Conversation

adam-zlatniczki commented Jul 8, 2024

Proposed change

Additional information

Checklist

codecov bot commented Jul 8, 2024 • edited Loading

Codecov Report

TheJulianJES commented Aug 3, 2024

adam-zlatniczki commented Aug 5, 2024

TheJulianJES left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

adam-zlatniczki Aug 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TheJulianJES left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Jimfizz commented Sep 20, 2024 • edited Loading

adam-zlatniczki commented Sep 20, 2024 via email

Jimfizz commented Sep 20, 2024

Add Tuya vibration door sensor `_TZE200_kzm5w4iz` #3246

Add Tuya vibration door sensor `_TZE200_kzm5w4iz` #3246

codecov bot commented Jul 8, 2024 •

edited

Loading

adam-zlatniczki Aug 28, 2024 •

edited

Loading

Jimfizz commented Sep 20, 2024 •

edited

Loading