WWSTCERT-11482 & WWSTCERT-11485: Add support to frient keypad by marcintyminski · Pull Request #2927 · SmartThingsCommunity/SmartThingsEdgeDrivers

marcintyminski · 2026-04-27T12:43:50Z

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

…eypad

…cintyminski/SmartThingsEdgeDrivers into add-support-to-frient-keypad

…eypad

…cintyminski/SmartThingsEdgeDrivers into add-support-to-frient-keypad

…eypad

Co-authored-by: Copilot <copilot@github.com>

github-actions · 2026-04-27T12:44:21Z

Duplicate profile check: Passed - no duplicate profiles detected.

github-actions · 2026-04-27T12:45:02Z

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

github-actions · 2026-04-27T12:45:54Z

Test Results

73 files 507 suites 0s ⏱️
2 805 tests 2 805 ✅ 0 💤 0 ❌
4 693 runs 4 693 ✅ 0 💤 0 ❌

Results for commit 7074611.

♻️ This comment has been updated with latest results.

github-actions · 2026-04-27T12:45:56Z

File	Coverage
All files	`76%`	❌
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-keypad/src/frient-keypad/init.lua	`75%`	❌
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-keypad/src/frient-keypad/can_handle.lua	`83%`	❌
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-keypad/src/init.lua	`94%`	✅
/home/runner/work/SmartThingsEdgeDrivers/SmartThingsEdgeDrivers/drivers/SmartThings/zigbee-keypad/src/lazy_load_subdriver.lua	`57%`	❌

Minimum allowed coverage is 90%

Generated by 🐒 cobertura-action against 7074611

KKlimczukS · 2026-05-05T12:17:12Z

+    version: 1
+  categories:
+  - name: SecurityPanel
+preferences:


@marcintyminski Have you considered adding a preference to enable and disable panicAlarm events? (scenario when the keypad is outside)

It is added now

…eypad

Co-authored-by: Copilot <copilot@github.com>

cjswedes

Even though this isnt explicitly a door lock, it belongs in the zigbee-lock driver. We do not want to create a new driver that will only handle a small number of devices, because it negatively impacts hub memory more than adding devices to an existing driver. Please make this a subdriver of the zigbee-lock driver.

cjswedes · 2026-05-07T20:12:33Z

+end
+
+local function handle_arm_command(driver, device, zb_rx)
+  armCommandFromKeypad = true


Using a module level variable to track device state breaks down if there are more than 1 device using the driver. This should probably be a transient (persisted = false) on the device object.

There are also several early returns, where the value would not be unset, leaving the state tracking inconsistent for the device. This can result in commands being blocked indefinitely after one fails.

cjswedes · 2026-05-07T20:22:23Z

+
+local function send_panel_status(device, status)
+  local duration = get_exit_delay_duration(device)
+  local panel_status = STATUS_TO_PANEL[status] or PanelStatus.PANEL_DISARMED_READY_TO_ARM


This is a little confusing. STATUS_TO_PANEL is defined as

local STATUS_TO_PANEL = { armedAway = PanelStatus.ARMED_AWAY, armedStay = PanelStatus.ARMED_STAY, disarmed = PanelStatus.PANEL_DISARMED_READY_TO_ARM, exitDelay = PanelStatus.EXIT_DELAY, }

But you call send_panel_status with both Unlocked as the status, which default to PANEL_DISARMED_READY_TO_ARM; is that intentional? There are several other possible values that could be fed into send_panel_status that do not have mappings in that constant.

cjswedes · 2026-05-07T20:24:37Z

+local SECURITY_STATUS_EVENTS = {
+  armedAway = SecuritySystem.securitySystemStatus.armedAway,
+  armedStay = SecuritySystem.securitySystemStatus.armedStay,
+  disarmed = SecuritySystem.securitySystemStatus.disarmed,
+}
+
+local MODE_STATUS_VALUES = {
+  Locked = "Locked",
+  Unlocked = "Unlocked",
+}
+
+local ARM_MODE_TO_STATUS = {
+  [ArmMode.DISARM] = "disarmed",
+  [ArmMode.ARM_DAY_HOME_ZONES_ONLY] = "armedStay",
+  [ArmMode.ARM_NIGHT_SLEEP_ZONES_ONLY] = "armedStay",
+  [ArmMode.ARM_ALL_ZONES] = "armedAway",
+}
+
+local ARM_MODE_TO_NOTIFICATION = {
+  [ArmMode.DISARM] = ArmNotification.ALL_ZONES_DISARMED,
+  [ArmMode.ARM_DAY_HOME_ZONES_ONLY] = ArmNotification.ONLY_DAY_HOME_ZONES_ARMED,
+  [ArmMode.ARM_NIGHT_SLEEP_ZONES_ONLY] = ArmNotification.ONLY_NIGHT_SLEEP_ZONES_ARMED,
+  [ArmMode.ARM_ALL_ZONES] = ArmNotification.ALL_ZONES_ARMED,
+}
+
+local STATUS_TO_PANEL = {
+  armedAway = PanelStatus.ARMED_AWAY,
+  armedStay = PanelStatus.ARMED_STAY,
+  disarmed = PanelStatus.PANEL_DISARMED_READY_TO_ARM,
+  exitDelay = PanelStatus.EXIT_DELAY,
+}
+
+local STATUS_TO_ACTIVITY = {
+  armedAway = "armed away",
+  armedStay = "armed stay",
+  disarmed = "disarmed",
+  exitDelay = "exit delay",
+}
+
+local LOCK_STATUS_TO_ACTIVITY = {
+  Locked = "Locked",
+  Unlocked = "Unlocked",
+}


These constants need some explanation and if possible, we should combine them. At the very least, please add a comment explaining what the mappings are used for to help anyone trying to understand all the different status, modes, activities, and notifications and what they mean for the user.

cjswedes · 2026-05-07T20:30:29Z

+  device:send(device_management.build_bind_request(device, PowerConfiguration.ID, self.environment_info.hub_zigbee_eui))
+  device:send(PowerConfiguration.attributes.BatteryVoltage:configure_reporting(device, 30, 21600, 1))


Suggested change

device:send(device_management.build_bind_request(device, PowerConfiguration.ID, self.environment_info.hub_zigbee_eui))

device:send(PowerConfiguration.attributes.BatteryVoltage:configure_reporting(device, 30, 21600, 1))

device:configure()

Use the default configuration path to ensure that the default attributes are configured properly and that IASZone is setup properly for this device. I do not see anything in here that will setup the IASZone status attribute reporting or the zone status notifications.

cjswedes · 2026-05-07T20:31:31Z

Please clean up commented code in the tests.

cjswedes · 2026-05-07T20:34:57Z

+end
+
+local function refresh(driver, device)
+  device:send(PowerConfiguration.attributes.BatteryVoltage:read(device))


Suggested change

device:send(PowerConfiguration.attributes.BatteryVoltage:read(device))

device:refresh()

Use default refresh behavior for the default attributes, and then do extra panel specific stuff.

marcintyminski and others added 21 commits February 17, 2026 14:58

keypad initial commit

e08e51d

Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…

6cb682a

…eypad

Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…

432f4b2

…eypad

add exitDelay

a6b309a

Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…

2631b82

…eypad

Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…

c131e65

…eypad

Almost finished, no tests

d68ab14

split codes snapshot into chunks if length exceeds 255

0fa9c13

Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…

7799081

…eypad

make rfid unaffected by pin length limitation

a9cccce

Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…

b0788f2

…eypad

two profiles

715d6c3

Merge branch 'add-support-to-frient-keypad' of https://github.com/mar…

61241a2

…cintyminski/SmartThingsEdgeDrivers into add-support-to-frient-keypad

WIP

8cd56c0

securitySystem tests

667d81f

Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…

f83970a

…eypad

Merge branch 'add-support-to-frient-keypad' of https://github.com/mar…

3d7e120

…cintyminski/SmartThingsEdgeDrivers into add-support-to-frient-keypad

WIP

5ca57a5

accomodate in one profile

36e496c

Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…

6bf438c

…eypad

finished driver with tests

66391ec

Co-authored-by: Copilot <copilot@github.com>

remove unnecessary value assignment

59eb342

KKlimczukS changed the title ~~Add support to frient keypad~~ WWSTCERT-11482 & WWSTCERT-11485: Add support to frient keypad May 5, 2026

KKlimczukS reviewed May 5, 2026

View reviewed changes

marcintyminski and others added 2 commits May 6, 2026 09:54

Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…

dd1175e

…eypad

Add preference to enable/disable triggering panicAlarm with SOS button

7074611

Co-authored-by: Copilot <copilot@github.com>

cbaumler requested review from aleclorimer, cjswedes and nand-nor May 6, 2026 20:59

cjswedes requested changes May 7, 2026

View reviewed changes

		device:send(device_management.build_bind_request(device, PowerConfiguration.ID, self.environment_info.hub_zigbee_eui))
		device:send(PowerConfiguration.attributes.BatteryVoltage:configure_reporting(device, 30, 21600, 1))

	device:send(device_management.build_bind_request(device, PowerConfiguration.ID, self.environment_info.hub_zigbee_eui))
	device:send(PowerConfiguration.attributes.BatteryVoltage:configure_reporting(device, 30, 21600, 1))
	device:configure()

	device:send(PowerConfiguration.attributes.BatteryVoltage:read(device))
	device:refresh()

Conversation

marcintyminski commented Apr 27, 2026

Type of Change

Checklist

Description of Change

Summary of Completed Tests

Uh oh!

github-actions Bot commented Apr 27, 2026

Uh oh!

github-actions Bot commented Apr 27, 2026

Uh oh!

github-actions Bot commented Apr 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

github-actions Bot commented Apr 27, 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!

Choose a reason for hiding this comment

Uh oh!

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

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Apr 27, 2026 •

edited

Loading

github-actions Bot commented Apr 27, 2026 •

edited

Loading