Matter Switch move button and switch initialization to doConfigure by nickolas-deboom · Pull Request #2041 · SmartThingsCommunity/SmartThingsEdgeDrivers

nickolas-deboom · 2025-04-01T18:04:15Z

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 change moves the initialization logic for buttons and switches to do_configure. This consolidates all of the profile selection logic to be within doConfigure and allows the removal of logic gates from device_init that were there to ensure init code only ran one time.

Also added is a new function that runs at init that can rename or delete persisted fields on the device. The original __component_to_endpoint_map field can now be utilized by buttons and other devices because initialize_buttons_and_switches is ensured to only run one time, meaning that old MCD switch devices will not be affected. Also, the __switch_intialized field can now be deleted from devices.

Summary of Completed Tests

Tested with various matter buttons and lights to ensure no change in behavior.

github-actions · 2025-04-01T18:05:37Z

Channel deleted.

github-actions · 2025-04-01T18:06:27Z

Test Results

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

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

♻️ This comment has been updated with latest results.

github-actions · 2025-04-01T18:06:29Z

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

Minimum allowed coverage is 90%

Generated by 🐒 cobertura-action against ea1236c

hcarter-775 · 2025-04-02T17:51:04Z

I found this line: -- The resulting endpoint to component map is saved in the COMPONENT_TO_ENDPOINT_MAP_BUTTON field
Can you update it to the correct field name?

nickolas-deboom · 2025-04-03T20:08:05Z

I found this line: -- The resulting endpoint to component map is saved in the COMPONENT_TO_ENDPOINT_MAP_BUTTON field Can you update it to the correct field name?

Good catch! Fixed in latest commit

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.

This change moves the initialization logic for buttons and switches to doConfigure. This keeps all of the profile selection logic all within doConfigure and allows the removal of logic gates from device_init that were there to ensure init code only ran one time. Also added is a new function that runs at init that can rename or delete persisted fields on the device.

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.

nickolas-deboom requested review from ctowns, hcarter-775 and z-michel April 1, 2025 18:04

nickolas-deboom force-pushed the matter-switch-update-field-names branch from 951333e to d2843e6 Compare April 1, 2025 19:51

hcarter-775 reviewed Apr 2, 2025

View reviewed changes

Comment thread drivers/SmartThings/matter-switch/src/init.lua

hcarter-775 reviewed Apr 2, 2025

View reviewed changes