Add Linxura Smart Controller Zigbee mode integrate with SmartThings hub #1829

simon3panda · 2024-12-17T06:54:18Z

Linxura Zigbee mode include 4 buttons, each button support press, double press, held.

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

New sub-driver for zigbee button, which support four buttons, each support press, double press, held.

Summary of Completed Tests

Linxura Zigbee mode include 4 buttons, each button support press, double press, held.

CLAassistant · 2024-12-17T06:54:47Z

All committers have signed the CLA.

add configuration part for Linxura smart controller driver

simon3panda · 2025-01-15T02:26:16Z

Does anything I need to do, before anyone can review this request?

Remove main button info in device panel. So user could only see four buttons information.

Remove firmwareUpdate on profile.

Add Aura smart button device.

greens · 2025-03-19T22:58:39Z

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

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


date should be 2024, I think?

greens · 2025-03-19T23:11:21Z

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

We use 2-space tabs in our drivers. You've got a mix here of 2- and 4-spaces.

greens · 2025-03-19T23:12:23Z

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

+local IASZone = (require "st.zigbee.zcl.clusters").IASZone
+local constants = require "st.zigbee.constants"
+local clusters = require "st.zigbee.zcl.clusters"
+local Groups = clusters.Groups


local capabilities = require "st.capabilities"
local IASZone = (require "st.zigbee.zcl.clusters").IASZone
local log = require "log"
Remain these three lines.

greens · 2025-03-19T23:12:31Z

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

+
+local capabilities = require "st.capabilities"
+local IASZone = (require "st.zigbee.zcl.clusters").IASZone
+local constants = require "st.zigbee.constants"


local capabilities = require "st.capabilities"
local IASZone = (require "st.zigbee.zcl.clusters").IASZone
local log = require "log"
Remain these three lines.

greens · 2025-03-19T23:12:53Z

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

+local device_management = require "st.zigbee.device_management"
+local zcl_commands = require "st.zigbee.zcl.global_commands"
+local zcl_clusters = require "st.zigbee.zcl.clusters"


The same as comment above.

greens · 2025-03-19T23:15:38Z

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

+
+    if status.value == BUTTON1_HELD or status.value == BUTTON1_PUSHED or status.value == BUTTON1_DOUBLE then
+        device:emit_component_event(device.profile.components[BUTTON1], event)
+        device:emit_event(event)


this will log an error every time since main has no button capability

Removed.
device:emit_event(event)

greens · 2025-03-19T23:26:25Z

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

+        return false
+    end
+
+    if status.value == BUTTON1_HELD or status.value == BUTTON1_PUSHED or status.value == BUTTON1_DOUBLE then


I'd just use the // (integer division) operator to determine the button, e.g.:

if (event) then button = string.format("button%d", status.value // 6 + 1) device:emit_component_event(device.profile.components[button], event) end

Thank you, modified.

greens · 2025-03-19T23:26:56Z

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

+    elseif mod == 5 then
+        event = capabilities.button.button.held(additional_fields)
+    else
+        return false


I think you just want a void return here. Not sure how the runner would interpret a false value being returned.

Modified.
local mod = status.value % 6
if mod == 1 then
event = capabilities.button.button.pushed(additional_fields)
elseif mod == 3 then
event = capabilities.button.button.double(additional_fields)
elseif mod == 5 then
event = capabilities.button.button.held(additional_fields)
end

xiaodah123 · 2025-03-20T09:32:13Z

Thank you for your suggestion, all modification has been uploaded.

greens · 2025-03-20T19:07:08Z

@xiaodah123 @simon3panda perhaps you forgot to push to your branch? You will also need to re-base your branch to resolve the conflicts.

simon3panda · 2025-03-21T01:34:20Z

@xiaodah123 @simon3panda perhaps you forgot to push to your branch? You will also need to re-base your branch to resolve the conflicts.

Thank you!
We are new on this.
We‘ve re-base to Linxura_test and publish the branch.

What else we need to do?

simon3panda · 2025-03-21T01:56:29Z

Do I need to click 'Force push' to Current branch?

simon3panda · 2025-03-21T01:59:46Z

I Clicked 'Resolve conflict' button and modified file, can I click the 'Commit Merge' button?

github-actions · 2025-03-25T18:17:30Z

Duplicate profile check: Passed - no duplicate profiles detected.

github-actions · 2025-03-25T18:18:13Z

Channel deleted.

greens · 2025-03-25T18:18:27Z

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

+local BUTTON1_HELD = 0x0001
+local BUTTON1_PUSHED = 0x0003
+local BUTTON1_DOUBLE = 0x0005
+local BUTTON2_HELD = 0x0007
+local BUTTON2_PUSHED = 0x0009
+local BUTTON2_DOUBLE = 0x000B
+local BUTTON3_HELD = 0x000D
+local BUTTON3_PUSHED = 0x000F
+local BUTTON3_DOUBLE = 0x0011
+local BUTTON4_HELD = 0x00013
+local BUTTON4_PUSHED = 0x00015
+local BUTTON4_DOUBLE = 0x0017
+
+local BUTTON1 = "button1"
+local BUTTON2 = "button2"
+local BUTTON3 = "button3"
+local BUTTON4 = "button4"


these can all be removed now I think

Thanks, removed.

github-actions · 2025-03-25T18:20:18Z

Test Results

65 files 421 suites 0s ⏱️
2 141 tests 2 141 ✅ 0 💤 0 ❌
3 668 runs 3 668 ✅ 0 💤 0 ❌

Results for commit e5ba868.

♻️ This comment has been updated with latest results.

github-actions · 2025-03-25T18:20:19Z

File	Coverage
All files	`97%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/adurosmart/init.lua	`98%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/somfy/somfy_situo_4.lua	`98%`	✅
/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/ecosmart/init.lua	`98%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/ikea/TRADFRI_remote_control.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/zigbee-multi-button/supported_values.lua	`99%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/init.lua	`94%`	✅
/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/button_utils.lua	`92%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/init.lua	`97%`	✅
/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/iris/init.lua	`90%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/frient/init.lua	`93%`	✅
/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/wallhero/init.lua	`88%`	❌
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-button/src/zigbee-multi-button/heiman/init.lua	`98%`	✅

Minimum allowed coverage is 90%

Generated by 🐒 cobertura-action against e5ba868

greens · 2025-03-25T18:22:47Z

It would be good if you added some tests of your device's specific behavior. A good template would be this test file, which also bases its behavior off the value of the IAS Zone attribute: https://github.com/SmartThingsCommunity/SmartThingsEdgeDrivers/blob/main/drivers/SmartThings/zigbee-motion-sensor/src/test/test_gator_motion.lua

remove unused definition

simon3panda · 2025-03-26T03:12:37Z

It would be good if you added some tests of your device's specific behavior. A good template would be this test file, which also bases its behavior off the value of the IAS Zone attribute: https://github.com/SmartThingsCommunity/SmartThingsEdgeDrivers/blob/main/drivers/SmartThings/zigbee-motion-sensor/src/test/test_gator_motion.lua

Tests added and uploaded. By the way is there any way for me to run the tests?

greens · 2025-03-26T21:09:57Z

@simon3panda Yep. Assuming you've set up you dev environment following the instructions here: https://developer.smartthings.com/docs/devices/hub-connected/set-up-dev-env

Once you've done that, you can navigate in your terminal to the src directory of the specific driver and then just run lua test/[test_file_name].lua to run the tests locally.

greens · 2025-03-26T21:12:01Z

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

+              ZoneStatusAttribute:build_test_attr_report(mock_device, 3 + var * 6)
+          })
+          test.socket.capability:__expect_send(
+              mock_device:generate_test_message(string.format("button%d", var + 1), button_attr.double({ state_change = true }))


button_attr is undefined in the test file

button_attr is undefined in the test file

Ok, add definition.

simon3panda · 2025-03-27T05:13:37Z

@simon3panda Yep. Assuming you've set up you dev environment following the instructions here: https://developer.smartthings.com/docs/devices/hub-connected/set-up-dev-env

Once you've done that, you can navigate in your terminal to the src directory of the specific driver and then just run lua test/[test_file_name].lua to run the tests locally.

Thank you. Tests ran. Tests result are in the attaches.
aura_result.txt
linxura_result.txt

Add Linxura Smart Controller Zigbee mode integrate with SmartThings hub

fa1731d

Linxura Zigbee mode include 4 buttons, each button support press, double press, held.

Update init.lua

2c3b445

add configuration part for Linxura smart controller driver

simon3panda added 6 commits February 19, 2025 15:47

Modify fingerprint.

83164e1

Remove main button info in device panel. So user could only see four buttons information.

Update fingerprints.yml

855522f

Update four-buttons-without-main-button.yml

5a22b33

Remove firmwareUpdate on profile.

Add Aura smart button device.

94b8851

Add Aura smart button device.

Modify Linxura Aura Smart Button configuration

8afe8bb

Update fingerprints.yml

e668683

lelandblue requested review from greens, wkhenon and cbaumler March 19, 2025 15:09

lelandblue added WWST do not merge labels Mar 19, 2025

greens reviewed Mar 19, 2025

View reviewed changes

Update init.lua

2a9c076

Merge branch 'main' into Linxura_test

f420544

greens reviewed Mar 25, 2025

View reviewed changes

simon3panda added 3 commits March 26, 2025 09:10

Merge branch 'SmartThingsCommunity:main' into Linxura_test

2aafa60

Update init.lua

545e9b3

remove unused definition

add test files for Linxura Smart Controller and Aura Smart Button

aedae38

greens reviewed Mar 26, 2025

View reviewed changes

add button_attr

e5ba868

greens approved these changes Mar 27, 2025

View reviewed changes

wkhenon approved these changes Mar 28, 2025

View reviewed changes

greens merged commit aea67b3 into SmartThingsCommunity:main Apr 24, 2025
12 checks passed

Add Linxura Smart Controller Zigbee mode integrate with SmartThings hub #1829

Add Linxura Smart Controller Zigbee mode integrate with SmartThings hub #1829

Uh oh!

Conversation

simon3panda commented Dec 17, 2024

Type of Change

Checklist

Description of Change

Summary of Completed Tests

Uh oh!

CLAassistant commented Dec 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

simon3panda commented Jan 15, 2025

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!

greens Mar 19, 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!

xiaodah123 commented Mar 20, 2025

Uh oh!

greens commented Mar 20, 2025

Uh oh!

simon3panda commented Mar 21, 2025

Uh oh!

simon3panda commented Mar 21, 2025

Uh oh!

simon3panda commented Mar 21, 2025

Uh oh!

github-actions bot commented Mar 25, 2025

Uh oh!

github-actions bot commented Mar 25, 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!

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

Uh oh!

Uh oh!

greens commented Mar 25, 2025

Uh oh!

simon3panda commented Mar 26, 2025

Uh oh!

greens commented Mar 26, 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!

CLAassistant commented Dec 17, 2024 •

edited

Loading

greens Mar 19, 2025 •

edited

Loading

github-actions bot commented Mar 25, 2025 •

edited

Loading

github-actions bot commented Mar 25, 2025 •

edited

Loading

github-actions bot commented Mar 25, 2025 •

edited

Loading

greens commented Mar 26, 2025 •

edited

Loading