Refactoring driver and support for PIR Motion Sensor #2093

pInksenberg · 2025-04-23T08:24:30Z

Check all that apply

Type of Change

WWST Certification Request
- If this is your first time contributing code:
  - I have reviewed the README.md file
  - I have reviewed the CODE_OF_CONDUCT.md file
  - I have signed the CLA
- I plan on entering a WWST Certification Request or have entered a request through the WWST Certification console at developer.smartthings.com
Bug fix
New feature
Refactor

Checklist

I have performed a self-review of my code
I have commented my code in hard-to-understand areas
I have verified my changes by testing with a device or have communicated a plan for testing
I am adding new behavior, such as adding a sub-driver, and have added and run new unit tests to cover the new behavior

Description of Change

Refactoring zigbee-sensor driver.

Summary of Completed Tests

github-actions · 2025-04-23T08:25:09Z

Duplicate profile check: Passed - no duplicate profiles detected.

github-actions · 2025-04-23T08:26:13Z

Test Results

66 files + 66 426 suites +426 0s ⏱️ ±0s
2 193 tests +2 193 2 193 ✅ +2 193 0 💤 ±0 0 ❌ ±0
3 742 runs +3 742 3 742 ✅ +3 742 0 💤 ±0 0 ❌ ±0

Results for commit a59d461. ± Comparison against base commit 40b6262.

♻️ This comment has been updated with latest results.

github-actions · 2025-04-23T08:26:15Z

File	Coverage
All files	`100%`	✅

Minimum allowed coverage is 90%

Generated by 🐒 cobertura-action against a59d461

greens · 2025-04-24T18:13:33Z

drivers/SmartThings/zigbee-sensor/fingerprints.yml

+        - 0xfe00 # EZVIZ private cluster
+        - 0xfe05 # EZVIZ private cluster


we usually capitalize the letters in our hex

greens · 2025-04-24T18:17:18Z

drivers/SmartThings/zigbee-sensor/src/meian/init.lua

+local generate_event_from_emergency = function(driver, device)
+  device:emit_event(capabilities.button.button.pushed({ state_change = true }))
+end
+
+local ias_ace_emergency_handler = function(driver, device)
+  generate_event_from_emergency(driver, device)
+end


these functions can be consolidated

greens · 2025-04-24T18:18:29Z

drivers/SmartThings/zigbee-sensor/src/contact/init.lua

+local generate_event_from_zone_status = function(driver, device, zone_status, zb_rx)
+  local event
+  if zone_status:is_alarm1_set() or zone_status:is_alarm2_set() then
+    event = capabilities.contactSensor.contact.open()
+  else
+    event = capabilities.contactSensor.contact.closed()
+  end
+  if event ~= nil then
+    device:emit_event_for_endpoint(
+      zb_rx.address_header.src_endpoint.value,
+      event)
+  end
+end
+
+
+local ias_zone_status_attr_handler = function(driver, device, zone_status, zb_rx)
+  generate_event_from_zone_status(driver, device, zone_status, zb_rx)
+end
+
+local ias_zone_status_change_handler = function(driver, device, zb_rx)
+  generate_event_from_zone_status(driver, device, zb_rx.body.zcl_body.zone_status, zb_rx)
+end


are we overwriting the defaults somewhere that makes it necessary to redefine them here?

you are right, we double check, and the redefine handler is not necessary and will be removed.

greens

I'd appreciate if we could separate the zigbee generic sensor driver from the Tuya drivers.

pInksenberg · 2025-04-25T09:43:23Z

I'd appreciate if we could separate the zigbee generic sensor driver from the Tuya drivers.

Currently we have divided tuya and zigbee_generic_sensor into different directories, specifically located within "/drivers/generic_zigbee_sensor" and "/Unofficial/tuya" floder. Are you suggesting that we should further separate the Tuya-powered manufacturers, such as Eviz and Meian, into the "/Unofficial/tuya" folder?

greens · 2025-04-28T22:36:00Z

@pInksenberg I meant have them as two separate pull requests

github-actions · 2025-04-29T01:51:16Z

Invitation URL:
https://bestow-regional.api.smartthings.com/invite/VbMbBXKAd3MB

pInksenberg · 2025-04-29T02:03:33Z

@pInksenberg I meant have them as two separate pull requests

@greens , sure, I separated tuya devices support into another PR, please kindly check~
https://github.com/SmartThingsCommunity/SmartThingsEdgeDrivers/pull/2102/files

greens · 2025-04-29T20:26:40Z

drivers/SmartThings/zigbee-sensor/fingerprints.yml

+  - id: "generic-button-sensor"
+    deviceLabel: "Zigbee Generic Button"
+    clusters:
+      server:
+        - 0x0500
+        - 0xFE00 # EZVIZ private cluster
+        - 0xFE05 # EZVIZ private cluster
+    deviceProfileName: generic-remote-control


if this device is a button it should be in the zigbee button driver

As far as I can tell it doesn't do any sensing, so it doesn't make much sense to put it here

After our team discussions, we have no better solution for this yet. Could you please share your suggestions? How about just put it to Unofficial/ezviz directory?

You could do that or you could put this exact same fingerprint in the zigbee-button driver.

@greens
Actually, this device is non-WWST device, so we can't put exact fingerprint in zigbee-button driver for this device.
As you know, zigbee-sensor have only generic fingerprint for generic purpose and scalability. I think by adding like this, we can support more ezviz button if they use same private cluster in the future(or now) for their new button devices. and If we need to support more other different types of ezviz devices in the future, then let's move this device into Unofficial/ezviz. but now, Let's just keep this device into zigbee-sensor for a while. What do you think?

id: "generic-button-sensor"
deviceLabel: "Zigbee Generic Button"
clusters:
server:
- 0x0500
- 0xFE00 # EZVIZ private cluster
- 0xFE05 # EZVIZ private cluster
deviceProfileName: generic-remote-control

CC: @kdbang @varzac

put this fingerprint:

- id: "generic-button-sensor" deviceLabel: "Zigbee Generic Button" clusters: server: - 0x0500 - 0xFE00 # EZVIZ private cluster - 0xFE05 # EZVIZ private cluster deviceProfileName: generic-remote-control

under a new zigbeeGeneric: section here: https://github.com/SmartThingsCommunity/SmartThingsEdgeDrivers/blob/main/drivers/SmartThings/zigbee-button/fingerprints.yml

@greens Then, do you agree to add the generic fingerprint only for 'EZVIZ button(non-WWST)' into zigbee-button(public driver)?
I think 'Meian button' can be moved into 'Unofficial/Tuya' driver with exact fingerprint.
Actually, when we made this driver(zigbee-sensor), I misunderstood the meaning of 'sensor' as just 'iot device',
So I thought it would be okay to add the button devices into this driver(zigbee-sensor) under generic fingerprint.

zigbee-sensor is also a public driver. If you're adding a "generic" fingerprint for a device, that fingerprint should go in the driver that most closely matches the type of device it is. In this case it's a button.

@greens
Then, we will proceed as I mentioned, assuming you agree.
Meian button -> move to 'Unofficial/Tuya' with manufacturer specific fingerprint
EZVIZ button -> move to 'zigbee-button' with generic fingerprint
CC: @pInksenberg

what fingerprint were you expecting the Meian button to match with on this PR as-is?

Meian button have these clusters.
In-cluster: 0x000, 0x0001, 0x0003, 0x0500
out-cluster: 0x0501, 0x0019, 0x000A

I heard this device is matched with fingerprint below.

id: "generic-sensor"
deviceLabel: "Zigbee Generic Sensor"
clusters:
server:
- 0x0500
deviceProfileName: generic-sensor

greens · 2025-04-30T18:44:15Z

drivers/SmartThings/zigbee-sensor/src/waterleak/init.lua

+  },
+  can_handle = is_water_sensor
+}
+defaults.register_for_default_handlers(generic_water_sensor, generic_water_sensor.supported_capabilities)


@varzac Does only registering for defaults in a specific sub-driver work like this?

So I think this will correctly add the zigbee and capability command handlers as it is just adding them on the "driver" table passed in and the subdrivers use the same expected structure as the base driver. However, there will be some unnecessary stuff added like cluster configurations, which I don't think are handled for subdrivers (https://github.ecodesamsung.com/iot-hub/scripting-engine/blob/main/lua_libs/st/zigbee/defaults/init.lua#L135)

Are you suggesting that using "register_for_default_handlers" in a sub-driver might cause unnecessary cluster configurations, and therefore we should implement water capability by adding specific command handlers instead of using the default approach? Could you please explain on this with more details?

inasail · 2025-05-02T07:00:26Z

drivers/SmartThings/zigbee-sensor/src/init.lua

+    require("meian"),
+    require("ezviz")


How about changing to 'meian-button' / 'ezviz-button' for the clarity? (including the folder name of each sub drivers)

pInksenberg · 2025-05-13T12:24:31Z

@inasail revise finished

pInksenberg force-pushed the generic_zigbee_sensor_improvement branch from 0f03911 to 21f22c9 Compare April 23, 2025 08:36

lelandblue requested review from greens, mtilchen, varzac and wkhenon April 23, 2025 13:31

pInksenberg force-pushed the generic_zigbee_sensor_improvement branch 5 times, most recently from 9267b81 to b81729b Compare April 24, 2025 09:44

greens reviewed Apr 24, 2025

View reviewed changes

pInksenberg closed this Apr 25, 2025

pInksenberg reopened this Apr 25, 2025

pInksenberg force-pushed the generic_zigbee_sensor_improvement branch 5 times, most recently from 6a5a0dd to 29fae3a Compare April 27, 2025 09:05

pInksenberg force-pushed the generic_zigbee_sensor_improvement branch from 29fae3a to 9946a16 Compare April 29, 2025 01:50

varzac approved these changes Apr 29, 2025

View reviewed changes

greens reviewed Apr 29, 2025

View reviewed changes

greens reviewed Apr 30, 2025

View reviewed changes

inasail reviewed May 2, 2025

View reviewed changes

generic_zigbee_sensor_improvement

a59d461

pInksenberg force-pushed the generic_zigbee_sensor_improvement branch from 9946a16 to a59d461 Compare May 13, 2025 12:03

pInksenberg changed the title ~~generic_zigbee_sensor_improvement~~ Refactoring driver and support for PIR Motion Sensor May 14, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactoring driver and support for PIR Motion Sensor #2093

Refactoring driver and support for PIR Motion Sensor #2093

pInksenberg commented Apr 23, 2025 •

edited

Loading

github-actions bot commented Apr 23, 2025

github-actions bot commented Apr 23, 2025 •

edited

Loading

github-actions bot commented Apr 23, 2025 •

edited

Loading

greens Apr 24, 2025

greens Apr 24, 2025

greens Apr 24, 2025

pInksenberg Apr 27, 2025

greens left a comment

pInksenberg commented Apr 25, 2025 •

edited

Loading

greens commented Apr 28, 2025

github-actions bot commented Apr 29, 2025

pInksenberg commented Apr 29, 2025

greens Apr 29, 2025 •

edited

Loading

pInksenberg Apr 30, 2025

greens Apr 30, 2025

inasail May 2, 2025 •

edited

Loading

greens May 2, 2025

inasail May 7, 2025

greens May 7, 2025

inasail May 7, 2025

greens May 8, 2025

inasail May 8, 2025

greens Apr 30, 2025

varzac May 8, 2025

pInksenberg May 8, 2025

inasail May 2, 2025

pInksenberg commented May 13, 2025

		- 0xfe00 # EZVIZ private cluster
		- 0xfe05 # EZVIZ private cluster

Refactoring driver and support for PIR Motion Sensor #2093

Are you sure you want to change the base?

Refactoring driver and support for PIR Motion Sensor #2093

Conversation

pInksenberg commented Apr 23, 2025 • edited Loading

Type of Change

Checklist

Description of Change

Summary of Completed Tests

github-actions bot commented Apr 23, 2025

github-actions bot commented Apr 23, 2025 • edited Loading

Test Results

github-actions bot commented Apr 23, 2025 • 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

greens left a comment

Choose a reason for hiding this comment

pInksenberg commented Apr 25, 2025 • edited Loading

greens commented Apr 28, 2025

github-actions bot commented Apr 29, 2025

pInksenberg commented Apr 29, 2025

greens Apr 29, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

inasail May 2, 2025 • 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

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

pInksenberg commented May 13, 2025

pInksenberg commented Apr 23, 2025 •

edited

Loading

github-actions bot commented Apr 23, 2025 •

edited

Loading

github-actions bot commented Apr 23, 2025 •

edited

Loading

pInksenberg commented Apr 25, 2025 •

edited

Loading

greens Apr 29, 2025 •

edited

Loading

inasail May 2, 2025 •

edited

Loading