WWSTCERT-8745 Add support to frient vibration sensor wiszb 137 by marcintyminski · Pull Request #2454 · SmartThingsCommunity/SmartThingsEdgeDrivers

marcintyminski · 2025-10-07T12:59:19Z

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

Summary of Completed Tests

…ibration-sensor-WISZB-137

…tps://github.com/marcintyminski/SmartThingsEdgeDrivers into Add-support-to-frient-vibration-sensor-WISZB-137

github-actions · 2025-10-07T12:59:48Z

Duplicate profile check: Passed - no duplicate profiles detected.

github-actions · 2025-10-07T13:00:31Z

Channel deleted.

github-actions · 2025-10-07T13:02:07Z

Test Results

71 files 485 suites 0s ⏱️
2 518 tests 2 518 ✅ 0 💤 0 ❌
4 332 runs 4 332 ✅ 0 💤 0 ❌

Results for commit 9ff61c4.

♻️ This comment has been updated with latest results.

github-actions · 2025-10-07T13:02:09Z

File	Coverage
All files	`97%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-contact/src/init.lua	`98%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-contact/src/multi-sensor/init.lua	`97%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-contact/src/frient/init.lua	`98%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-contact/src/smartsense-multi/init.lua	`95%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-contact/src/frient/frient-vibration/init.lua	`88%`	❌

Minimum allowed coverage is 90%

Generated by 🐒 cobertura-action against 9ff61c4

…ibration-sensor-WISZB-137

…-137

wkhenon

LGTM

greens · 2025-11-11T02:01:55Z

drivers/SmartThings/zigbee-contact/src/frient/frient-vibration/init.lua

+    if attribute_id == 0x0000 then
+      measured_x = axis_value
+      device:set_field("measured_x", measured_x)
+      log.trace("Updated X value: " .. axis_value)


if you're satisfied with the behavior, please remove the logging

greens · 2025-11-11T02:06:24Z

drivers/SmartThings/zigbee-contact/src/frient/frient-vibration/init.lua

+  ID = 0xFC04,
+  ManufacturerSpecificCode = 0x1015,
+  attributes = {
+    MeasuredValueX = { ID = 0x0000, data_type = data_types.name_to_id_map["Int16"] },


you can just use data_types.Int16

greens · 2025-11-11T02:08:00Z

drivers/SmartThings/zigbee-contact/src/frient/frient-vibration/init.lua

+    log.trace "Initializing sensor"
+    battery_defaults.build_linear_voltage_init(2.3, 3.0)(driver, device)
+    --Add the manufacturer-specific attributes to generate their configure reporting and bind requests
+    for _, config in pairs(get_cluster_configurations()) do
+        device:add_configured_attribute(config)
+    end


nit: we use 2 spaces

…ibration-sensor-WISZB-137

greens · 2025-11-18T19:37:17Z

drivers/SmartThings/zigbee-contact/src/frient/frient-vibration/init.lua

+  if device.preferences.garageSensor == "Yes" then
+    if device.preferences.contactSensorAxis == "X" then
+      local initial_position = device.preferences.sensorInitialPosition or 0
+      if math.abs(initial_position - measured_x) >= device.preferences.contactSensorValue - device.preferences.contactSensorValue * (device.preferences.tolerance / 100) then
+        device:emit_event(capabilities.contactSensor.contact.open())
+      else
+        device:emit_event(capabilities.contactSensor.contact.closed())
+      end
+    elseif device.preferences.contactSensorAxis == "Y" then
+      local initial_position = device.preferences.sensorInitialPosition or 0
+      if math.abs(initial_position - measured_y) >= device.preferences.contactSensorValue - device.preferences.contactSensorValue * (device.preferences.tolerance / 100) then
+        device:emit_event(capabilities.contactSensor.contact.open())
+      else
+        device:emit_event(capabilities.contactSensor.contact.closed())
+      end
+    elseif device.preferences.contactSensorAxis == "Z" then
+      local initial_position = device.preferences.sensorInitialPosition or 0
+      if math.abs(initial_position - measured_z) >= device.preferences.contactSensorValue - device.preferences.contactSensorValue * (device.preferences.tolerance / 100) then
+        device:emit_event(capabilities.contactSensor.contact.open())
+      else
+        device:emit_event(capabilities.contactSensor.contact.closed())
+      end
+    end
+  end


Suggested change

if device.preferences.garageSensor == "Yes" then

if device.preferences.contactSensorAxis == "X" then

local initial_position = device.preferences.sensorInitialPosition or 0

if math.abs(initial_position - measured_x) >= device.preferences.contactSensorValue - device.preferences.contactSensorValue * (device.preferences.tolerance / 100) then

device:emit_event(capabilities.contactSensor.contact.open())

else

device:emit_event(capabilities.contactSensor.contact.closed())

end

elseif device.preferences.contactSensorAxis == "Y" then

local initial_position = device.preferences.sensorInitialPosition or 0

if math.abs(initial_position - measured_y) >= device.preferences.contactSensorValue - device.preferences.contactSensorValue * (device.preferences.tolerance / 100) then

device:emit_event(capabilities.contactSensor.contact.open())

else

device:emit_event(capabilities.contactSensor.contact.closed())

end

elseif device.preferences.contactSensorAxis == "Z" then

local initial_position = device.preferences.sensorInitialPosition or 0

if math.abs(initial_position - measured_z) >= device.preferences.contactSensorValue - device.preferences.contactSensorValue * (device.preferences.tolerance / 100) then

device:emit_event(capabilities.contactSensor.contact.open())

else

device:emit_event(capabilities.contactSensor.contact.closed())

end

end

end

if device.preferences.garageSensor == "Yes" then

local garageAxis = measured_x

if device.preferences.contactSensorAxis == "Y" then

garageAxis = measured_y

elseif device.preferences.contactSensorAxis == "Z" then

garageAxis = measured_z

end

local initial_position = device.preferences.sensorInitialPosition or 0

if math.abs(initial_position - garageAxis) >= device.preferences.contactSensorValue - device.preferences.contactSensorValue * (device.preferences.tolerance / 100) then

device:emit_event(capabilities.contactSensor.contact.open())

else

device:emit_event(capabilities.contactSensor.contact.closed())

end

end

I have made a change and pushed the change to pr

…ibration-sensor-WISZB-137

greens · 2025-11-25T22:14:39Z

drivers/SmartThings/zigbee-contact/src/frient/frient-vibration/init.lua

+
+  -- Ensure all values are non-nil before emitting
+  if measured_x and measured_y and measured_z then
+    device:emit_event(threeAxis.threeAxis({measured_x, measured_y, measured_z}))


Don't the measured_{} fields need to be reset after an event is sent so that a new event is only sent when you get three new measurements?

would be good to have a test case of this.

@greens Each value shall update whenever any of them changes; therefore, not only when 3 of them change.

Just to clarify on it, the body will always contains of three values, as these values are never nill or empty. Also, each of values shall update whenever there is a change on them.

would be good to have a test case of this.

I can see that we have some test cases for X, Y, Z axes cases - can you clarify on which additional test cases you're thinking about? Thanks!

The device would send bundled report with the changed value, and last cached values for remaining axes.

Right, so your driver would send three events. 2 of those are likely to get bounced for being duplicates, but it's not an ideal situation to have to rely on that.

Since you can always rely on the device sending all 3 attributes every time, it should be easy to update the driver to only send one event after it's received a report for all three attributes.

I think you can now omit the usage of device:set_field and get_field.

…ibration-sensor-WISZB-137

greens · 2026-02-04T19:44:30Z

drivers/SmartThings/zigbee-contact/src/frient/frient-vibration/init.lua

+  if measured_x and measured_y and measured_z then
+    device:emit_event(threeAxis.threeAxis({measured_x, measured_y, measured_z}))
+
+    if device.preferences.garageSensor == "Yes" then


a better check is probably to see if the device supports the contactSensor capability.

greens · 2026-02-04T19:58:40Z

drivers/SmartThings/zigbee-contact/profiles/acceleration-motion-temperature-battery.yml

+  - id: refresh
+    version: 1
+  categories:
+  - name: VibrationsSensor


I am not certain this category is defined.

You're right. Changed it to ContactSensor

…ibration-sensor-WISZB-137

marcintyminski and others added 7 commits October 6, 2025 08:29

Add support to frient vibration sensor

ec16d4e

garageDoor functionality added

fb7628b

add profile with contact sensor capability

3fc7be6

Merge branch 'SmartThingsCommunity:main' into Add-support-to-frient-v…

edbae37

…ibration-sensor-WISZB-137

Merge branch 'Add-support-to-frient-vibration-sensor-WISZB-137' of ht…

99bedd2

…tps://github.com/marcintyminski/SmartThingsEdgeDrivers into Add-support-to-frient-vibration-sensor-WISZB-137

changes to test file

30e6c96

tests and profile fixed

c033982

marcintyminski and others added 5 commits October 14, 2025 11:38

Merge branch 'SmartThingsCommunity:main' into Add-support-to-frient-v…

295fc64

…ibration-sensor-WISZB-137

Add tolerance to measurement

230a497

fix failing tests

34c2d92

change preference name

54b578c

Merge branch 'main' into Add-support-to-frient-vibration-sensor-WISZB…

ac43af1

…-137

greens changed the title ~~Add support to frient vibration sensor wiszb 137~~ WWSTCERT-8745 Add support to frient vibration sensor wiszb 137 Nov 4, 2025

greens requested review from greens, pegor-karoglanian and wkhenon November 4, 2025 21:01

wkhenon approved these changes Nov 6, 2025

View reviewed changes

greens reviewed Nov 11, 2025

View reviewed changes

marcintyminski and others added 2 commits November 17, 2025 08:21

Merge branch 'SmartThingsCommunity:main' into Add-support-to-frient-v…

662dd9f

…ibration-sensor-WISZB-137

removed logging, changed data_type and fixed indentation

9841cf2

KKlimczukS requested a review from greens November 17, 2025 09:06

greens reviewed Nov 18, 2025

View reviewed changes

marcintyminski and others added 2 commits November 24, 2025 07:20

Merge branch 'SmartThingsCommunity:main' into Add-support-to-frient-v…

22b7891

…ibration-sensor-WISZB-137

suggested refactoring

1609b3e

greens reviewed Nov 25, 2025

View reviewed changes

KKlimczukS requested a review from greens January 16, 2026 10:49

marcintyminski and others added 2 commits February 2, 2026 12:42

Merge branch 'SmartThingsCommunity:main' into Add-support-to-frient-v…

cd84020

…ibration-sensor-WISZB-137

update driver so it sends only one threeAxis event

ca4ce27

greens reviewed Feb 4, 2026

View reviewed changes

marcintyminski and others added 3 commits February 5, 2026 09:17

Merge branch 'SmartThingsCommunity:main' into Add-support-to-frient-v…

ac858cd

…ibration-sensor-WISZB-137

Changes according to pr comments

784851f

removed unused variable

9ff61c4

greens approved these changes Feb 5, 2026

View reviewed changes

greens merged commit 6f4e5d2 into SmartThingsCommunity:main Feb 5, 2026
12 checks passed

Conversation

marcintyminski commented Oct 7, 2025

Type of Change

Checklist

Description of Change

Summary of Completed Tests

Uh oh!

github-actions bot commented Oct 7, 2025

Uh oh!

github-actions bot commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

github-actions bot commented Oct 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wkhenon 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!

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!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

github-actions bot commented Oct 7, 2025 •

edited

Loading

github-actions bot commented Oct 7, 2025 •

edited

Loading

github-actions bot commented Oct 7, 2025 •

edited

Loading