WWSTCERT-9467 Add Sonoff SNZB-01M Smart Scene Button into zigbee-button. by Oniums · Pull Request #2510 · SmartThingsCommunity/SmartThingsEdgeDrivers

Oniums · 2025-10-30T01:59:15Z

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

This PR adds support for the Sonoff SNZB-01M Smart Scene Button to the existing zigbee-button driver.

Changes made:

Added device fingerprint in fingerprints.yml to recognize the SONOFF SNZB-01M device
Created device profile sonoff-buttons-battery.yml with 4 button components and battery capability
Implemented custom handler in src/zigbee-multi-button/sonoff/init.lua to handle SONOFF-specific Zigbee communication
Added device support to the multi-button matching matrix with support for 4 button actions: pushed, double, held, pushed_3x
Created test file test_sonoff_button.lua for verification purposes

Summary of Completed Tests

Device Testing:

✅ Device pairing: Successfully paired SONOFF SNZB-01M with SmartThings Hub
✅ Button actions: Verified all 4 button types work correctly:
- Single press (pushed)
- Double press (double)
- Long press (held)
- Triple press (pushed_3x)
✅ Battery reporting: Confirmed battery percentage is correctly displayed in SmartThings app
✅ Endpoint mapping: Verified button events are properly mapped to correct button components (button1-button4)

Code Testing:

✅ Fingerprint recognition: Device correctly identified during pairing process
✅ Profile loading: Device profile loaded successfully with all 4 button components
✅ Event handling: Custom SONOFF handler processes Zigbee messages correctly
✅ Integration: No conflicts with existing button drivers

Compatibility:

✅ SmartThings Hub compatibility: Tested on SmartThings Hub v3
✅ Driver integration: Successfully integrates with existing zigbee-button driver framework
✅ No regression: Existing button devices continue to function normally

pegor-karoglanian · 2025-12-12T22:43:42Z

drivers/SmartThings/zigbee-button/src/zigbee-multi-button/sonoff/init.lua

@@ -0,0 +1,87 @@
+-- Copyright 2024 SmartThings


Update date

pegor-karoglanian · 2025-12-12T22:46:03Z

drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua

@@ -0,0 +1,26 @@
+-- Test file for SONOFF SNZB-01M integration


Please add copyright info.

pegor-karoglanian · 2025-12-12T22:50:31Z

drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua

+  end
+end
+
+return test


Please add some proper unit tests utiliizing expect_send and expect_receive. More details can be found here

github-actions · 2025-12-13T20:11:32Z

Duplicate profile check: Passed - no duplicate profiles detected.

github-actions · 2025-12-13T20:12:21Z

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

github-actions · 2025-12-13T20:13:56Z

Test Results

72 files 493 suites 0s ⏱️
2 695 tests 2 690 ✅ 0 💤 0 ❌ 5 🔥
4 557 runs 4 552 ✅ 0 💤 0 ❌ 5 🔥

For more details on these errors, see this check.

Results for commit 61d1077.

♻️ This comment has been updated with latest results.

github-actions · 2025-12-13T20:13:58Z

File	Coverage
All files	`97%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/heiman/init.lua	`98%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/zunzunbee/init.lua	`95%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/ecosmart/init.lua	`98%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/ikea/init.lua	`98%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/iris/init.lua	`89%`	❌
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/vimar/init.lua	`96%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/robb/init.lua	`99%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/shinasystems/init.lua	`97%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/sonoff/init.lua	`70%`	❌
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/frient/init.lua	`98%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/adurosmart/init.lua	`97%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/aqara/init.lua	`94%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/pushButton/init.lua	`76%`	❌
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/init.lua	`83%`	❌
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/supported_values.lua	`99%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/SLED/init.lua	`95%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/wallhero/init.lua	`87%`	❌
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/button_utils.lua	`92%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/init.lua	`96%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/lazy_load_subdriver.lua	`57%`	❌
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/ikea/TRADFRI_remote_control/init.lua	`98%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/somfy/somfy_situo_4/init.lua	`98%`	✅

Minimum allowed coverage is 90%

Generated by 🐒 cobertura-action against 61d1077

greens · 2026-02-04T22:02:17Z

drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua

@@ -0,0 +1,261 @@
+-- Copyright 2022 SmartThings


wkhenon · 2026-02-05T15:08:55Z

drivers/SmartThings/zigbee-button/src/zigbee-multi-button/sonoff/init.lua

+local function battery_attr_handler(driver, device, value, zb_rx)
+  local percent = math.floor((value.value or 0) / 2)
+  device:emit_event(capabilities.battery.battery(percent))
+  log.info(string.format("Battery percentage remaining: %d%%", percent))


remove this log line

wkhenon · 2026-02-05T15:09:05Z

drivers/SmartThings/zigbee-button/src/zigbee-multi-button/sonoff/init.lua

+  local endpoint = zb_rx.address_header.src_endpoint.value
+  local button_name = "button" .. tostring(endpoint)
+  local event_func = EVENT_MAP[attr_val]
+  log.info(string.format("SONOFF attr: endpoint=%s, value=%s, button=%s", endpoint, attr_val, button_name))


remove this log line

greens · 2026-02-05T18:23:55Z

Checking drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua 8 warnings

    drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua:67:1: (W611) line contains only whitespace
    drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua:143:122: (W612) line contains trailing whitespace
    drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua:145:1: (W611) line contains only whitespace
    drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua:161:1: (W611) line contains only whitespace
    drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua:180:1: (W611) line contains only whitespace
    drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua:199:1: (W611) line contains only whitespace
    drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua:218:1: (W611) line contains only whitespace
    drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua:253:1: (W611) line contains only whitespace

greens · 2026-02-10T23:40:56Z

drivers/SmartThings/zigbee-button/profiles/sonoff-buttons-battery.yml

to avoid duplication here, I'd recommend you use the existing profile four-buttons-without-main-button

greens · 2026-02-10T23:48:04Z

drivers/SmartThings/zigbee-button/src/zigbee-multi-button/sonoff/init.lua

+local function battery_attr_handler(driver, device, value, zb_rx)
+  local percent = math.floor((value.value or 0) / 2)
+  device:emit_event(capabilities.battery.battery(percent))
+end


this should be handled by the defaults

greens · 2026-02-10T23:50:06Z

drivers/SmartThings/zigbee-button/src/zigbee-multi-button/supported_values.lua

+  },
+  SONOFF_BUTTON_4 = {
+    MATCHING_MATRIX = {
+      { mfr = "SONOFF", model = "SNZB-01M" }
+    },
+    SUPPORTED_BUTTON_VALUES = { "pushed", "double", "held", "pushed_3x" },
+    NUMBER_OF_BUTTONS = 4


Since you overwrote added in your handler (because you did not include the button capability on your main component, this info is never used.

Thanks for the suggestion. I checked the existing profiles: four-buttons-without-main-button has no battery capability, while four-buttons-battery includes button on main, which doesn’t match the SNZB-01M capability layout. Would you prefer that I: use four-buttons-without-main-button and accept no battery on main, or use the profile I added earlier.

I understand why you've added the new profile, but I'll advise you on why our multi-button profiles include the button capability on the main component: without it (and duplicating any other buttons' events to main, the remote on the device list will not change to indicate button presses. You'll only see them within the device details page.

I didn't notice four-buttons-without-main-button didn't have battery. I definitely think you should maintain that.

So you can go with your new profile if you like, but this comment was merely pointing out that, because these values are only used in the zigbee-multi-button added handler, your additions to this file are not used.

greens · 2026-02-10T23:50:49Z

Checking drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua 1 warning

    drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua:143:122: (W612) line contains trailing whitespace

CLAassistant · 2026-02-25T10:32:10Z

All committers have signed the CLA.

greens · 2026-02-27T21:28:34Z

drivers/SmartThings/zigbee-button/src/zigbee-multi-button/sonoff/init.lua

+      log.warn("Unknown button component: " .. button_name)
+    end
+  else
+    log.warn("Unknown event value: " .. tostring(attr_val))


remove these log statements

greens · 2026-02-27T21:29:12Z

driver needs to be rebased

Oniums · 2026-03-06T03:39:38Z

Is the rebase based on this PR? If I submit a new PR, will it cause any issues if it doesn’t match the PR used for the Samsung certification application?

greens · 2026-03-09T19:46:33Z

@Oniums you should be able to set your fork's upstream to our main repo, update the main branch there, then rebase your changes on your local branch onto main:

In your fork's directory:

git remote add upstream git@github.com:SmartThingsCommunity/SmartThingsEdgeDrivers.git
git checkout upstream/main
git pull
git checkout main
git rebase upstream/main

Then you should be able to resolve the conflicts and git push --force up your changes.

… lines Update copyright year from 2022 to 2026,remove remove whitespace-only lines

remove log.info

- Remove custom battery attribute handler and added lifecycle in Sonoff subdriver - Align Sonoff tests with default added behavior and keep battery report coverage

greens · 2026-03-10T20:20:53Z

drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua

+  end
+)
+
+return test


Your tests are not being run.

Your test should end with test.run_registered_tests().

If you had run your tests, you would see that they fail, because you have not actually added your sub-driver to the base driver. You need to use this file: https://github.com/SmartThingsCommunity/SmartThingsEdgeDrivers/blob/main/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/sub_drivers.lua a and also change how your can_handle function is written and broken out. Here's an example: https://github.com/SmartThingsCommunity/SmartThingsEdgeDrivers/blob/main/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/ecosmart/can_handle.lua

Your directory structure should look like all the other sub-drivers'

greens requested review from greens, pegor-karoglanian and wkhenon December 12, 2025 22:17

pegor-karoglanian reviewed Dec 12, 2025

View reviewed changes

greens reviewed Feb 4, 2026

View reviewed changes

drivers/SmartThings/zigbee-button/src/test/test_sonoff_button.lua Outdated

@@ -0,0 +1,261 @@

-- Copyright 2022 SmartThings

Copy link

Contributor

greens Feb 4, 2026

Choose a reason for hiding this comment

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

date

wkhenon reviewed Feb 5, 2026

View reviewed changes

KKlimczukS requested review from greens, pegor-karoglanian and wkhenon February 9, 2026 21:01

greens reviewed Feb 10, 2026

View reviewed changes

Oniums force-pushed the main branch from bbf4e10 to 1831070 Compare February 25, 2026 10:38

KKlimczukS requested a review from greens February 27, 2026 14:07

greens reviewed Feb 27, 2026

View reviewed changes

Oniums and others added 5 commits March 10, 2026 09:12

Add Sonoff SNZB-01M Smart Scene Button into zigbee-button.

1329c3f

modify Copyright Date

f1e199d

modify test_sonoff.py fix PR error

c0ae8b7

Update copyright year from 2022 to 2026,remove remove whitespace-only…

df3c547

… lines Update copyright year from 2022 to 2026,remove remove whitespace-only lines

remove log.info

bce843b

remove log.info

Oniums added 2 commits March 10, 2026 09:12

Use defaults for Sonoff battery and added lifecycle

e929ca4

- Remove custom battery attribute handler and added lifecycle in Sonoff subdriver - Align Sonoff tests with default added behavior and keep battery report coverage

remove log

9aeec23

Oniums force-pushed the main branch from 0c66315 to 9aeec23 Compare March 10, 2026 01:13

greens reviewed Mar 10, 2026

View reviewed changes

greens changed the title ~~Add Sonoff SNZB-01M Smart Scene Button into zigbee-button.~~ WWSTCERT-9467 Add Sonoff SNZB-01M Smart Scene Button into zigbee-button. Mar 10, 2026

Fix Sonoff multi-button sub-driver registration and test execution

61d1077

		@@ -0,0 +1,26 @@
		-- Test file for SONOFF SNZB-01M integration

Conversation

Oniums commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Checklist

Description of Change

Changes made:

Summary of Completed Tests

Device Testing:

Code Testing:

Compatibility:

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!

github-actions bot commented Dec 13, 2025

Uh oh!

github-actions bot commented Dec 13, 2025

Uh oh!

github-actions bot commented Dec 13, 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 Dec 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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!

greens commented Feb 5, 2026

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!

greens Feb 25, 2026 • 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!

greens commented Feb 10, 2026

Uh oh!

CLAassistant commented Feb 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

greens commented Feb 27, 2026

Uh oh!

Oniums commented Mar 6, 2026

Uh oh!

greens commented Mar 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Oniums commented Oct 30, 2025 •

edited

Loading

github-actions bot commented Dec 13, 2025 •

edited

Loading

github-actions bot commented Dec 13, 2025 •

edited

Loading

greens Feb 25, 2026 •

edited

Loading

CLAassistant commented Feb 25, 2026 •

edited

Loading

greens commented Mar 9, 2026 •

edited

Loading