Update lifecycle handling for Eve Energy and Aqara subdrivers #2116

nickolas-deboom · 2025-05-09T15:43:40Z

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

With the changes from
#2041, the matter switch subdrivers for Eve and Aqara should be updated to maintain consistency. This involves:

Moving the initialization code from device_init into do_configure
Implement the driverSwitched lifecycle event
Additionally, the TEST_CONFIGURE field can be removed from the Aqara subdriver, leveraging a technique used in other test files to set device.profile.id for a mock device.
A few other minor changes to increase consistency between subdrivers

Lastly, while testing the Aqara Cube T1 Pro, it was found that the LongPress event was being emitted in place of InitialPress. This PR add support for handling LongPress, in case different versions of the device emit different event types.

Note that some of the changes are purely cosmetic meant to increase consistency across the subdrivers and main driver.

Summary of Completed Tests

Tested with Eve Energy and Aqara Cube.

github-actions · 2025-05-09T15:44:52Z

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

github-actions · 2025-05-09T15:45:53Z

Test Results

66 files 426 suites 0s ⏱️
2 185 tests 2 185 ✅ 0 💤 0 ❌
3 735 runs 3 735 ✅ 0 💤 0 ❌

Results for commit 57452e8.

♻️ This comment has been updated with latest results.

github-actions · 2025-05-09T15:45:55Z

File	Coverage
All files	`91%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/matter-switch/src/embedded-cluster-utils.lua	`38%`	❌
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/matter-switch/src/init.lua	`92%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/matter-switch/src/aqara-cube/init.lua	`92%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/matter-switch/src/eve-energy/init.lua	`90%`	✅

Minimum allowed coverage is 90%

Generated by 🐒 cobertura-action against 57452e8

nickolas-deboom · 2025-05-09T16:06:45Z

drivers/SmartThings/matter-switch/src/aqara-cube/init.lua

 -- after 3 seconds of cubeAction, to automatically change the action status of Plugin UI or Device Card to noAction
 local CUBEACTION_TIMER = "__cubeAction_timer"
 local CUBEACTION_TIME = 3

 local function is_aqara_cube(opts, driver, device)
-  local name = string.format("%s", device.manufacturer_info.product_name)


device.manufacturer_info does not exist for child devices. Moving this statement inside the if statement prevents an error from occurring here.

With the changes from #2041, the matter-switch subdrivers should be updated to maintain consistency. This involves: * Moving the initialization code from device_init into do_configure * Implement the driverSwitched lifecycle event * Additionally, improve the lifecycle event testing for the Aqara subdriver, removing the `TEST_CONFIGURE` field and instead leveraging a technique used in other test files to set `device.profile.id` for a mock device.

The device can also emit LongPress events, and the subdriver needs to be updated to account for this.

nickolas-deboom · 2025-05-13T17:59:07Z

Hi @DongHoon-Ryu , I made a few changes to the Aqara subdriver in this PR, to be more consistent with the changes from #2041 and a few minor changes to increase consistency with other subdrivers. Could you please review when you have a chance? One thing I noticed during testing is that the cube was sending the LongPress event rather than InitialPress. Have you seen this before? I wonder if this behavior is firmware-dependent. I added a handler for the LongPress event similar to the InitialPress handler to account for this.

hcarter-775 · 2025-05-21T18:05:17Z

drivers/SmartThings/matter-switch/src/test/test_aqara_cube.lua

    function()
-      test.socket.device_lifecycle:__queue_receive({ mock_device.id, "added" })


should we be removing this part of the test?

The profile update occurs in doConfigure now which is handled in the test init function to be more consistent with other test files

hcarter-775 · 2025-05-21T18:05:38Z

drivers/SmartThings/matter-switch/src/test/test_aqara_cube.lua

@@ -236,20 +251,11 @@ test.register_coroutine_test(
 test.register_coroutine_test(
  "Handle single press sequence in case of exhausted endpoint",
    function()
-      test.socket.device_lifecycle:__queue_receive({ mock_device_exhausted.id, "added" })


should we be removing this part of the test?

Similar to above this was moved to the init function

hcarter-775 · 2025-05-21T18:06:56Z

drivers/SmartThings/matter-switch/src/test/test_aqara_cube.lua

  local subscribe_request = CLUSTER_SUBSCRIBE_LIST[1]:subscribe(mock_device)
  for i, clus in ipairs(CLUSTER_SUBSCRIBE_LIST) do
    if i > 1 then
      subscribe_request:merge(clus:subscribe(mock_device))
    end
  end
  test.socket.matter:__expect_send({mock_device.id, subscribe_request})
+  test.socket.device_lifecycle:__queue_receive({ mock_device.id, "added" })


why is this logic being added to the init test? Shouldn't these be implemented as separate tests if required?

This way each test case will run after already having gone through added, doConfigure, and infoChanged, it's done this way in other test files as well, although not all of them include every lifecycle event.

drivers/SmartThings/matter-switch/src/aqara-cube/init.lua

nickolas-deboom requested review from ctowns and hcarter-775 May 9, 2025 15:43

nickolas-deboom added the do not merge label May 9, 2025

nickolas-deboom mentioned this pull request May 9, 2025

Matter Switch move button and switch initialization to doConfigure #2041

Merged

12 tasks

nickolas-deboom force-pushed the update-lifecycle-events-for-eve-and-aqara-subdrivers branch from 16cc922 to cb70ab8 Compare May 9, 2025 15:50

nickolas-deboom commented May 9, 2025

View reviewed changes

nickolas-deboom force-pushed the matter-switch-update-field-names branch 3 times, most recently from ea07e1b to 653030b Compare May 9, 2025 18:47

nickolas-deboom changed the base branch from matter-switch-update-field-names to main May 12, 2025 20:00

nickolas-deboom changed the base branch from main to matter-switch-update-field-names May 12, 2025 20:00

nickolas-deboom force-pushed the matter-switch-update-field-names branch from 653030b to ea1236c Compare May 13, 2025 15:40

Base automatically changed from matter-switch-update-field-names to main May 13, 2025 15:48

nickolas-deboom force-pushed the update-lifecycle-events-for-eve-and-aqara-subdrivers branch from cb70ab8 to 43e5825 Compare May 13, 2025 16:41

Fixing Aqara subdriver issues found from testing

2d52642

The device can also emit LongPress events, and the subdriver needs to be updated to account for this.

nickolas-deboom removed the do not merge label May 13, 2025

nickolas-deboom requested a review from DongHoon-Ryu May 13, 2025 17:52

Update Eve test file

57452e8

nickolas-deboom force-pushed the update-lifecycle-events-for-eve-and-aqara-subdrivers branch from 9771c42 to 57452e8 Compare May 13, 2025 18:01

hcarter-775 reviewed May 21, 2025

View reviewed changes

hcarter-775 reviewed May 28, 2025

View reviewed changes

drivers/SmartThings/matter-switch/src/aqara-cube/init.lua Show resolved Hide resolved

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update lifecycle handling for Eve Energy and Aqara subdrivers #2116

Update lifecycle handling for Eve Energy and Aqara subdrivers #2116

Uh oh!

nickolas-deboom commented May 9, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 9, 2025

Uh oh!

github-actions bot commented May 9, 2025 •

edited

Loading

Uh oh!

github-actions bot commented May 9, 2025 •

edited

Loading

Uh oh!

nickolas-deboom May 9, 2025

Uh oh!

nickolas-deboom commented May 13, 2025 •

edited

Loading

Uh oh!

hcarter-775 May 21, 2025

Uh oh!

nickolas-deboom May 22, 2025

Uh oh!

hcarter-775 May 21, 2025

Uh oh!

nickolas-deboom May 29, 2025

Uh oh!

hcarter-775 May 21, 2025

Uh oh!

nickolas-deboom May 29, 2025

Uh oh!

Uh oh!

Uh oh!

		function()
		test.socket.device_lifecycle:__queue_receive({ mock_device.id, "added" })

Update lifecycle handling for Eve Energy and Aqara subdrivers #2116

Are you sure you want to change the base?

Update lifecycle handling for Eve Energy and Aqara subdrivers #2116

Uh oh!

Conversation

nickolas-deboom commented May 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Checklist

Description of Change

Summary of Completed Tests

Uh oh!

github-actions bot commented May 9, 2025

Uh oh!

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

Uh oh!

Uh oh!

nickolas-deboom May 9, 2025

Choose a reason for hiding this comment

Uh oh!

nickolas-deboom commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hcarter-775 May 21, 2025

Choose a reason for hiding this comment

Uh oh!

nickolas-deboom May 22, 2025

Choose a reason for hiding this comment

Uh oh!

hcarter-775 May 21, 2025

Choose a reason for hiding this comment

Uh oh!

nickolas-deboom May 29, 2025

Choose a reason for hiding this comment

Uh oh!

hcarter-775 May 21, 2025

Choose a reason for hiding this comment

Uh oh!

nickolas-deboom May 29, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nickolas-deboom commented May 9, 2025 •

edited

Loading

github-actions bot commented May 9, 2025 •

edited

Loading

github-actions bot commented May 9, 2025 •

edited

Loading

nickolas-deboom commented May 13, 2025 •

edited

Loading