-
Notifications
You must be signed in to change notification settings - Fork 533
WWSTCERT-11482 & WWSTCERT-11485: Add support to frient keypad #2927
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
marcintyminski
wants to merge
24
commits into
SmartThingsCommunity:main
Choose a base branch
from
marcintyminski:add-support-to-frient-keypad
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
e08e51d
keypad initial commit
marcintyminski 6cb682a
Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…
marcintyminski 432f4b2
Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…
marcintyminski a6b309a
add exitDelay
marcintyminski 2631b82
Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…
marcintyminski c131e65
Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…
marcintyminski d68ab14
Almost finished, no tests
marcintyminski 0fa9c13
split codes snapshot into chunks if length exceeds 255
marcintyminski 7799081
Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…
marcintyminski a9cccce
make rfid unaffected by pin length limitation
marcintyminski b0788f2
Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…
marcintyminski 715d6c3
two profiles
marcintyminski 61241a2
Merge branch 'add-support-to-frient-keypad' of https://github.com/mar…
marcintyminski 8cd56c0
WIP
marcintyminski 667d81f
securitySystem tests
marcintyminski f83970a
Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…
marcintyminski 3d7e120
Merge branch 'add-support-to-frient-keypad' of https://github.com/mar…
marcintyminski 5ca57a5
WIP
marcintyminski 36e496c
accomodate in one profile
marcintyminski 6bf438c
Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…
marcintyminski 66391ec
finished driver with tests
marcintyminski 59eb342
remove unnecessary value assignment
marcintyminski dd1175e
Merge branch 'SmartThingsCommunity:main' into add-support-to-frient-k…
marcintyminski 7074611
Add preference to enable/disable triggering panicAlarm with SOS button
marcintyminski File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| name: 'Zigbee Keypad' | ||
| packageKey: 'zigbee-keypad' | ||
| permissions: | ||
| zigbee: {} | ||
| description: "SmartThings driver for Zigbee keypad devices" | ||
| vendorSupportInformation: "https://support.smartthings.com" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| zigbeeManufacturer: | ||
| - id: "frient A/S/KEPZB-110" | ||
| deviceLabel: "frient Intelligent Keypad" | ||
| manufacturer: "frient A/S" | ||
| model: KEPZB-110 | ||
| deviceProfileName: frient-keypad-security-system | ||
| - id: "frient A/S/KEPZB-112" | ||
| deviceLabel: "frient Alarm Keypad" | ||
| manufacturer: "frient A/S" | ||
| model: KEPZB-112 | ||
| deviceProfileName: frient-keypad-security-system | ||
| - id: "frient A/S/KEPZB-120" | ||
| deviceLabel: "frient Intelligent Keypad" | ||
| manufacturer: "frient A/S" | ||
| model: KEPZB-120 | ||
| deviceProfileName: frient-keypad-security-system | ||
| - id: "frient A/S/KEPZB-122" | ||
| deviceLabel: "frient Alarm Keypad" | ||
| manufacturer: "frient A/S" | ||
| model: KEPZB-122 | ||
| deviceProfileName: frient-keypad-security-system |
136 changes: 136 additions & 0 deletions
136
drivers/SmartThings/zigbee-keypad/profiles/frient-keypad-security-system.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| name: frient-keypad-security-system | ||
| components: | ||
| - id: main | ||
| capabilities: | ||
| - id: securitySystem | ||
| version: 1 | ||
| - id: lockCodes | ||
| version: 1 | ||
| - id: battery | ||
| version: 1 | ||
| - id: tamperAlert | ||
| version: 1 | ||
| - id: refresh | ||
| version: 1 | ||
| - id: mode | ||
| version: 1 | ||
| - id: panicAlarm | ||
| version: 1 | ||
| categories: | ||
| - name: SecurityPanel | ||
| preferences: | ||
| - name: mode | ||
| title: Control Security System or Mode | ||
| description: "Choose whether to use the keypad to control Security System Status (Arm/Disarm) or Mode Status (Lock/Unlock)." | ||
| required: false | ||
| preferenceType: enumeration | ||
| definition: | ||
| options: | ||
| 0: "Security System Status" | ||
| 1: "Mode Status" | ||
| default: 0 | ||
| - name: pinMap | ||
| title: Add PIN code(s) | ||
| description: "Format: 1234:Alice,4321:Bob (other format will not be accepted). Only PIN(s) present in this setting are recognized." | ||
| required: false | ||
| preferenceType: string | ||
| definition: | ||
| stringType: text | ||
| default: "" | ||
| - name: rfidMap | ||
| title: Add RFID(s) | ||
| description: "Format: +ABCD1234:Alice,+EFGH5678:Bob (other format will not be accepted, the + prefix is required). Only RFID(s) present in this setting are recognized." | ||
| required: false | ||
| preferenceType: string | ||
| definition: | ||
| stringType: text | ||
| default: "" | ||
| - name: panicAlarmActive | ||
| title: Panic Alarm Active | ||
| description: "When enabled, the SOS button will trigger the alarm. When disabled, the SOS button will be ignored." | ||
| required: false | ||
| preferenceType: boolean | ||
| definition: | ||
| default: true | ||
| - name: showPinSnapshot | ||
| title: Show PIN Snapshot | ||
| description: "Display the current PIN/RFID list in the device history after adding them (sensitive)." | ||
| required: false | ||
| preferenceType: boolean | ||
| definition: | ||
| default: false | ||
| - name: minCodeLength | ||
| title: Minimal PIN Length | ||
| description: "Minimal allowed PIN length." | ||
| required: false | ||
| preferenceType: integer | ||
| definition: | ||
| minimum: 1 | ||
| maximum: 32 | ||
| default: 4 | ||
| - name: maxCodeLength | ||
| title: Maximal PIN Length | ||
| description: "Maximal allowed PIN length." | ||
| required: false | ||
| preferenceType: integer | ||
| definition: | ||
| minimum: 1 | ||
| maximum: 32 | ||
| default: 15 | ||
| - name: exitDelay | ||
| title: Exit Delay | ||
| description: "Turn on exit delay when arming away. Duration in seconds can be set in the 'Exit Delay Duration' setting." | ||
| required: false | ||
| preferenceType: boolean | ||
| definition: | ||
| default: false | ||
| - name: duration | ||
| title: Exit Delay Duration | ||
| description: "Exit delay duration in seconds." | ||
| required: false | ||
| preferenceType: integer | ||
| definition: | ||
| minimum: 0 | ||
| maximum: 30 | ||
| default: 5 | ||
| - name: autoArmDisarmMode | ||
| title: Auto Arm/Disarm Mode | ||
| description: "Automatically arm/disarm (lock/unlock) without pressing a function button on a keypad. Options: 'Disabled', 'RFID', 'PIN'." | ||
| required: false | ||
| preferenceType: enumeration | ||
| definition: | ||
| options: | ||
| 0: "Disabled" | ||
| 1: "RFID" | ||
| 2: "PIN" | ||
| default: 0 | ||
| - name: autoDisarmModeSetting | ||
| title: Auto Disarm/Unlock Mode Setting | ||
| description: "When Auto Arm/Disarm Mode is set to 'PIN' or 'RFID', automatically disarm when a valid PIN/RFID is used." | ||
| required: false | ||
| preferenceType: boolean | ||
| definition: | ||
| default: false | ||
| - name: autoArmModeSetting | ||
| title: Auto Arm/Lock Mode Setting | ||
| description: "When Auto Arm/Disarm Mode is set to 'PIN' or 'RFID', automatically arm in one of the following modes: 'Disabled', 'Arm Stay', 'Arm Away'. Any option other than 'Disabled' allows to lock while controlling Mode Status. " | ||
| required: false | ||
| preferenceType: enumeration | ||
| definition: | ||
| options: | ||
| 0: "Disabled" | ||
| 1: "Arm Away" | ||
| 3: "Arm Stay" | ||
| default: 0 | ||
| - name: pinLengthSetting | ||
| title: PIN length to auto arm/disarm | ||
| description: "When Auto Arm/Disarm Mode is set to 'PIN', the length of PINs that will trigger auto arm/disarm (lock/unlock)." | ||
| required: false | ||
| preferenceType: integer | ||
| definition: | ||
| minimum: 1 | ||
| maximum: 32 | ||
| default: 4 | ||
| metadata: | ||
| mnmn: SmartThings | ||
| vid: SmartThings-smartthings-frient_Keypad | ||
14 changes: 14 additions & 0 deletions
14
drivers/SmartThings/zigbee-keypad/src/frient-keypad/can_handle.lua
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| -- Copyright 2026 SmartThings, Inc. | ||
| -- Licensed under the Apache License, Version 2.0 | ||
|
|
||
| local function frient_keypad_can_handle(opts, driver, device, ...) | ||
| local FINGERPRINTS = require("frient-keypad.fingerprints") | ||
| for _, fingerprint in ipairs(FINGERPRINTS) do | ||
| if device:get_manufacturer() == fingerprint.mfr and device:get_model() == fingerprint.model then | ||
| return true, require("frient-keypad") | ||
| end | ||
| end | ||
| return false | ||
| end | ||
|
|
||
| return frient_keypad_can_handle |
11 changes: 11 additions & 0 deletions
11
drivers/SmartThings/zigbee-keypad/src/frient-keypad/fingerprints.lua
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| -- Copyright 2026 SmartThings, Inc. | ||
| -- Licensed under the Apache License, Version 2.0 | ||
|
|
||
| local FRIENT_DEVICE_FINGERPRINTS = { | ||
| { mfr = "frient A/S", model = "KEPZB-110"}, | ||
| { mfr = "frient A/S", model = "KEPZB-112"}, | ||
| { mfr = "frient A/S", model = "KEPZB-120"}, | ||
| { mfr = "frient A/S", model = "KEPZB-122"}, | ||
| } | ||
|
|
||
| return FRIENT_DEVICE_FINGERPRINTS |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@marcintyminski Have you considered adding a preference to enable and disable panicAlarm events? (scenario when the keypad is outside)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is added now