[OBSOLETE] SHM Delay Version 2.0

Table of Contents

New Install? Use the Classic app and Modes, then consider moving to the New App
1. Purpose
2. Support This Project - Donate
3. Features
4. Quick Setup Guide
5. Installing the Smartapp
6. Create Simulated Sensor
7. Settings: SHM Classic and STHM New App
8. Settings: SmartThings Home Monitor-STHM New App or SHM without Routines
9. Global Definitions
10. Delay Profile Setup
11. User/Pin Profile Setup
12. Modefix Setup and Usage, Fix keypad out of sync with SHM Arming State
13. How to Use Keypads
14. Supported Keypads, hardware setup and troubleshooting
15. Initial Testing
16. Fix Motion Sensor Intrusion During Entry Delay
17. Fix Motion Sensor Intrusion During Exit Delay
18. Using Sounds and Text to Speach
19. Fix Siren Alarm During Entry delay
20. Using True Entry Delay
21. TrueNight Option, Keypads, and Exit / Entry Delays
22. Way Beyond the Basics, User Created SHM Modes
23. Using Simulated Keypad
24. Known Issues
25. Update History
26. Background
27. Source Code
28. Switching between “beta” and “Version2”
29. Help and Support
30. Addon Module - SHM Delay TrueExit
31. Addon Module - SHM Delay BuzzerSwitch
32. Converting from Version 1

1. Purpose

This smartapp provides the Entry and Exit Delay options currently missing in Smart Home Monitor (SHM), allowing for some time on entry to disarm the system, and time to exit the facility without triggering an alarm.

Entry and Exit delays operate on contact sensors selected in Delay Profiles. SHM is generally fully armed during entry delay, and may or may not be armed during exit delay. Tripping a ‘non-delayed sensor’ immediately triggers a SHM intrusion alert. This means a motion sensor that ‘sees’ a door with a delayed sensor, or ‘sees’ a arming/disarming device such as a keypad, may trigger an intrusion alert while you are arming/disarming the system. Motion sensor issues may be mitigated by specifying the motion sensors in the Delay Profile.

Contact and motion sensors defined in Delay Profiles must be removed from SHM Security monitoring. A single Simulated Contact Sensor device must be added to the SmartThings IDE, then monitored by SHM Security.

This smartapp functions with or without real or simulated keypads.

Should there be issues causing unexpected intrusion alerts, there is an add-on smartapp for exit issues, and a global option for complex entry delay issues. Both options are defined later in the documentation.
:arrow_up_small: Back to top

2. Support this project - Donate

This app is free. Donations are appreciated.

:arrow_up_small: Back to top

3. Features

  • Built in optional Keypad monitoring and control, allowing for multiple User Pin Profiles that may have a schedule. To activate: set global option “A real or simulated Keypad
” to on/true. Specialized User Profiles (pins) may be defined that only execute a SHM Routine or WebCore Piston.

  • Supports Iris keypad’s Panic Key, or a Panic Pin on all supported keypads. Creates an intrusion alert when panic key is pressed and held, or panic pin is entered.

  • Supports Iris keypad’s “Instant On” Alarm hardware feature. Arms system by tapping Partial or On key with no pin.

  • Support for a Simulated Keypad. Creates an Iris or Xfinity/Centralite image in a browser, including smartphones, that functions as a keypad with Smarthings using the SHM Delay smartapp, or install the Android app.

  • Door “Chime” option. When real contact sensor opens and the Alarm State is off, beep tones are issued to user selected devices.

  • Supports multiple real contact sensor delay profiles, that may include one or more ‘followed’ motion sensors. Profiles allow for sounding exit and entry delay tones on Keypads, and Beep tones on Sirens

  • For monitored contact sensors: Replaces SHM’s messaging when the system is armed with an open contact. These messages may be: logged, sent by notification, sent by SMS to one or more phones. The app also supports the hidden "SmartThings Contact List" feature when it is activated. Note: Contact Book deprecated by ST on July 30, 2018

  • Optionally issue intrusion messages with the name of the real device causing the intrusion. This message may optionally include a 3 digit emergency number and one or more emergency phone numbers.

  • Optional spoken messages during Exit and Entry Delay.

  • True Night Mode - Choose if Stay / Night mode has an entry delay or immediate alarm (Optional)

  • Mode Fix - Fix Mode when setting alarm state from the SmartThings Dashboard Home Solutions, and fix Alarm State when mode is set. Syncronize keypad status lights with non-keypad initiated ST/SHM alarm and mode changes (Optional, but strongly suggested when using a keypad)

  • Way Beyond the Basics - full use of the Xfinity and Centralite keypad’s three Modes: Stay, Away and Night (Optional)

Entry Delay example:
The system is armed, a monitored sensor opens, let’s call it "The Front Door’, the app waits for the specified number of seconds while optional sirens and keypads sound tones or beeps. When the system remains armed, the paired simulated sensor is opened, triggering an intrusion alarm.

Exit Delay example:
You arm the system. You may then open and close the monitored sensor as many as necessary during the Exit Delay time period.

Arming with an Open Sensor Monitor example:
You arm the system but the sensor on the monitored Back Door is open. An immediate warning notification is issued. Additional warnings can be issued based upon the Delay Profile settings. No warnings issued during a keypad created Exit Delay.
:arrow_up_small: Back to top

4. Quick Setup Guide

  1. In the IDE Devices create one simulated contact sensor device. Later this device is added to SHM Security “contact sensors to use”
  2. When using a Keypad read and review section “Xfinity/Iris/Centralite Keypad Installation and TroubleShooting”. Install the suggested Keypad Device Handler (DTH) then properly install the keypad into SmartThings. Take your time, it is a multistep procedure. Note: The RBoy Apps DTH is also supported.
  3. Install this smartApp into the IDE: follow directions in “Installation”
  4. In SmartThings phone app, tap “Automations” (bottom)–> tap Smartapps (top)–> scroll down then tap “+ Add a SmartApp”–> scroll down then tap “+ My Apps”–> scroll down then tap “SHM_Delay”
  5. In this app, SHM_Delay, view the “Global Application Settings”. Suggest keeping all the defaults, but define your 3 digit emergency and local police department telephone numbers. When using a keypad set “A real or simulated Keypad” is used to on/true, then click “Done”. The app is now installed, but does nothing until a Delay Profile and User Profile (keypads only) are created.
  6. Create one or more Delay Profiles
  7. When using a keypad, create one or more User profiles
  8. Adjust SHM Security monitored sensors, exclude SHM Delay monitored contacts and motion sensors used in step 6 above, and include the simulated sensor(s) defined in step 1.
  9. Test your system in Away, and Stay/Night modes for correct operation.
    Stop here! When ready, add one or more of the following features documented below.
  10. In Global Settings Implement “True Night Mode” (all users)
  11. in Global Settings set “Mode Fix” on then edit and save the Modefix profile. Alarm Status and Mode changes stay syncronized. (all users) This is important for Keypad users who want non keypad SHM Alert Status and Mode changes to reflect on the keypad’s status keys or icons.
  12. Way Beyond the Basics (Xfinity and Centralite keypad users only. Not for Iris users) Utilize all available armed keypad modes: Stay, Away, and Night
  13. When Keypads are not installed and you want a True Exit Delay, meaning the system is not armed during the exit delay, smartapp SHM Delay TrueExit is suggested.

:arrow_up_small: Back to top

5. Smartapp Installation

There are six modules and a Device Handler (DTH) associated with the Version2 SHM Delay app:

  1. SHM Delay. Module should be Saved, Published, then Installed with the Smarthings app (must be done first)
  2. SHM Delay Child. Should be Saved, do not publish or Install. (Required. Creates and processes Delay Profiles)
  3. SHM Delay ModeFix Should be Saved, do not publish or install. When SHM status changes, changes SHM Mode to follow; when SHM Mode changes, changes SHM Status to follow. Makes SHM status and mode changes reflect on Keypads. Required when using a keypad or you directly set the SHM Status or Mode.
  4. SHM Delay Users Should be Saved, do not publish or install (Required when using real or simulated keypads)
  5. SHM Delay Talker Child Should be Saved, do not publish or install, (Optional, creates spoken messages during exit and entry delays)
  6. SHM Delay Simkypd Child Should be Saved, do not publish or install, oauth required (Simulated Keypad)
  7. DTH Internet Keypad (Required when using Simulated Keypad, otherwise optional)

Let’s Begin using the Smartthings Classic app, not ST Samsung Connect, with install via repository, or manually from code below:

  1. Login to the IDE at https://account.smartthings.com
  2. click “My Smartapps”
  3. click settings, scroll down, click add new repository
  4. add repository: arnbme SHMDelay Version2 (Note: all data fields are case dependent!)
    Owner: arnbme (in upper case that is ARNBME, but use lower case)
    Name: SHMDelay
    Branch: Version2
  5. Click ‘Save’, then in ‘My Smart Apps’ click 'Update from repo",
  6. Select the SHMDelay repository and install and publish SHM_Delay (must be first)
  7. Install, but do not publish: SHM_Delay Child, SHM_Delay ModeFix, SHM_Delay_Users (Optional, required if using keypad), SHM Delay Talker Child (Optional, required for spoken delay messages-beta), and optionally SHM_Delay_Simkypd_Child
  8. When you plan to use the Simulated Keypad see Section 23 for additional information about Oauth, and installing the Internet Keypad DTH
  9. In the SmartThings phone app, tap “Automations” (bottom)–> tap Smartapps (top)–> scroll down then tap “+ Add a SmartApp”–> scroll down then tap “+ My Apps”–> scroll down then tap “SHM_Delay”

When using an Iris V2, Centralite V2 (Xfinity), or Centalite V3 keypad use the DTH in Centralite Keypad DTH in github arnbme/SHMDelay/Version2, or you may get it at this link: https://raw.githubusercontent.com/arnbme/SHMDelay/Version2/devicetypes/arnbme/centralite-keypad.src/centralite-keypad.groovy
Other DTHs may function, but may not produce entry or exit tones.

:arrow_up_small: Back to top

6. Creating a Simulated Contact Sensor

Each contact sensor defined in a Delay Profile must be paired with a “simulated contact sensor” device. A single simulated sensor is preferred and may used in multiple Delay Profiles, or if you insist it may be unique. The simulated sensor must be monitored by SHM.

  1. Login to the IDE at https://account.smartthings.com/
  2. Click “My Devices”
  3. Click the “New Device” Button
  4. Enter a “Name” for the device, this can be whatever you want.
  5. Enter a “Label” for the device, this is optional and can be whatever you want.
  6. Enter a “Device Network Id” This can be anything you want, but it cannot duplicate other device ID’s. Example: SIMSEN01
  7. “Zigbee” Id should be left blank
  8. Select a “Type” from the dropdown, this must be “Simulated Contact Sensor”
  9. “Version” should be published
  10. “Location” should be your hub location, probably “Home”
  11. “Hub” should be your hub name.
  12. “Group” you won’t be able to select when creating, but these are Groups you’ve created in the Things page in the SmartThings app.
  13. Click Create

Directions updated from, and originally posted in this thread
:arrow_up_small: Back to top

7. Settings: SHM Classic and STHM New App

In Both: Sensors When home is unoccupied, and When home is occupied

  • Use every open/close sensor: off/false
  • Open/Closed Sensors: exclude Real Sensors monitored by this app, include Simulated contact sensor used by this app; include other real contact sensors not monitored by this app, and be sure to exclude all keypads that show up as a sensors
  • Motion sensors unoccupied mode (Away): When an optional motion sensor is defined in a Delay Profile remove it from SHM Security monitoring
  • Motion sensors for occupied mode (Stay/Night) Exclude motions sensors where you would normally move around at during the night or while you are at home. If you don’t know, set no motion sensors in this mode.

:arrow_up_small: Back to top

8. Settings: SmartThings Home Monitor-STHM New App are at this link

Please post all installation and usage results along with any questions, issues, or comments on this thread. Thank You
:arrow_up_small: Back to top

9. Global Preferences

Controls the operation of this SmartApp

  1. Start by tapping “Global Settings”
  2. Disable All Functions. Default: False/Off When on allows this smartapp to remain installed, however it does nothing.
  3. Activate “A real or simulated Keypad is used”. Default: False/Off Set On/True implements full operation of 3400 series Iris, Xfinity and Centralite Keypads including User Pin control.
  4. Issue intrusion message with name of sensor. Default: True/On Smart Home Monitor intrusion messages will have the name of the simulated sensor used in a delay profile for all SHM Delay issued intrusions. Stongly suggest this be set to True.
  5. (Optional) Add 3 digit emergency number on SHM Ddelay intrusion message.
  6. (Optional) Include additional telephone numbers separated with a semicolon on intrusion message.
  7. Multiple motions sensors in a Delay Profile. Default Off/False
  8. Mode Fix Default: Off/False suggested On/True when using keypads
    • Requires Modefix Profile be set and saved
    • When alarm state changes, sets mode to follow alarm state
    • When mode changes, sets alarm state to follow mode
    • Sets any keypad status lights to follow the SHM alarm state and mode
  9. True Night Flag When arming in Stay mode from a non-keypad device, or Partial from an Iris Keypad, and a SHM Delay monitored sensor triggers:
    • On - Creates an instant intrusion alert
    • Off - Creates an Entry Delay
  10. (Keypad Control: True) One or more 3400 series Keypads used to arm and disarm Smart Home Monitor
  11. (Keypad Control: True) True Exit Delay in seconds when arming in Away mode from any keypad. Range 0
90 Default: 30
    • This is a true exit delay. During this delay all keypads sound exit delay tones, then system arms in Away mode
  12. (Keypad Control: True) Required Routines that execute when valid User pin is entered. Routines must set both Alarm State and Mode. Defaults follow
    • Off - I’m Back!
    • Stay/Partial - Good Night!
    • Night - Good Night!
    • Away/On - Goodbye
  13. (Keypad Control: True) Panic Key/Pin is Monitored Default: On/True When Panic key is held or Panic pin is entered Issue instant intrusion alarm.
  14. (Keypad Control: True) Log valid pin entries Default: On/True
    • additional settings show for routine pin messages to phoneapp notification log, Contactss, push and SMS
  15. (Keypad Control: True) Log invalid pin entries Default: On/True
    • additional settings show for routine pin messages to phoneapp notification log, Contactss, push and SMS
  16. Simulated sensors must be unique. Default: Off/False Normally one simulated sensor is needed with this SmartApp. If for some realon you want to use multiple simulated sensors, set this slider to On/True.
  17. True Entry Delay. Default Off/False This is a last resort when adding multiple sensors to a delay profile does not correct a false intrusion alert during Entry Delay. It manipulates the SmartThings Alarm State so the Dashboard or ActionTiles may not reflect the actual status.
  18. Tap Save/Done to save these settings

:arrow_up_small: Back to top

10. Delay Profiles

Define a Delay Profile for each real contact sensor where an entry or exit delay is desired. Generally this is a door that is actively used for access or egress. One or more delay profiles are required.

  1. Start by tapping “Create A New Delay Profile” or tapping on an exisiting Delay Profile name
  2. Select the real contact sensor associated with the door to be delayed
  3. Select the simulated contact device that was initially defined. This device may be used in multiple delay profiles.
  4. (Optional) When a motion sensor triggers an intrusion during an entry or exit delay: select a motion sensor device
    When multiple motion sensors must be defined: set global Allow Multiple Motion Sensors to On/True
    Defined motion sensors are monitored during Alarm Status: Away
  5. (Optional) When the Real Contact sensor is rejected as “Simulated” enter 4 to 8 alphanumeric characters from the IDE Device Type to force accept the device
  6. Profile name is internally set to “Profile Delay: (real contact sensor name)” It may be modified, but must be unique.
  7. Tap ‘Next’ on top of page
  8. The ‘Entry and Exit Data’ page displays
  9. Set the entry delay time in seconds from 0 to 90. Default:30
  10. When arming from a non-keypad device set the exit delay time in seconds from 0 to 90. Default:30
    Keypad exit delay time is defined in Global Settings.
  11. (Optional) When armed in Away mode some motion sensors may react to a door movement before the contact sensor registers as open. Enter time in seconds to ignore the motion sensors defined in step 4 above before the contact sensor must register as open. Leave at 0 unless you encounter a problem.
  12. (Optional shows only when global “A real or simulated Keypad
” is Off) set keypads where to sound the Entry Delay tones
  13. (Optional) Beep these devices during entry delay. Note Keypads defined in global settins generate Entry Delay Tones
  14. (Optional) “Chime” or beep these devices when the contact sensor defined in step 1 above opens and Alarm State is Off
  15. Tap ‘Next’ on top of page
  16. The ‘Open Door Monitor and Notifications’ page displays
  17. Set the maximum number of open door warning messages. Default: 2, Minimum: 1
  18. Set the number of minutes between open door messages from 1 to 15. Default: 1
  19. Notifcation Settings for SHm Delay Open Door and SHM Delay Intrusion Alert messages
    • Log to phone app notifications log. Default: true (set to off when duplicated messages are issued)
    • Notify Contacts? (Shows when hidden ST Contact Book is enabled)
    • Should the message be issued as an application push notification.
    • Should the message be sent by text (SMS) message. Default: false
      When set to true: Enter telephone number. Separate multiple numbers with a semicolon ;
  20. Tap ‘Done/Save’ on top of page
  21. Adjust Smart Home Monitor
  22. In phone app tap Dashboard–>Tap Smart Home Monitor–>tap Gear on top right–>tap Security
  23. On sensors to monitor when home is unoccupied
    • In Open Closed Sensors: Remove sensor defined in paragraph 2 above
    • In Open Closed Sensors: If not already showing, add sensor defined in paragraph 3 above
    • In Motion Sensors: Remove motion sensors defined in paragraph 4 above
  24. Tap “Next”, sensors to be monitored when home is occupied displays
    • In Open Closed Sensors: Remove sensor defined in paragraph 2 above
    • In Open Closed Sensors: If not already showing, add sensor defined in paragraph 3 above
  25. Tap “Next”–>Tap “Save”

:arrow_up_small: Back to top

11. User Profiles

When global “A real or simulated Keypad” is used is true, define one of more User Pin Profiles.

  1. Start by tapping “Create A New User Profile” or tapping on an existing User Profile name
  2. When pin has date, day or time restrictions: set Scheduled slider to On/True.
  3. When pin has mode or device restrictions: set Restriction slider to On/True.
  4. Override Global Valid Pin message routing: Default Off/False
    • When on additional settings show for routing pin messages to phoneapp notification log, Contacts, push and SMS.
  5. Enter a unique 4 digit pin number.
    • _Support for quick arming on Iris keypad without entering a pin using pin 0000.
      Iris harware sends a 0000 pin code when single or double tapping the On or Partail key without entering a pin. The device firmware determines if it is single of double tapped.
      To implement: add User or UserRoutinePiston pin type with pin 0000. The Iris does not send the 0000 when the Off key is pressed. For security reasons, suggest setting the User Profile flag to ignore a real 0000 pin entry with the Off button.
  6. Enter the user name or unique identifier associated with this pin. This will show in phone app Notifications log.
  7. Set Pin usage
    • User - this is a person, pin arms or disarms SmartThings
    • UserRoutinePiston - this is a person, pin arms or disarms SmartThings. then executes optional Routines, then executes optional Pistons
    • Ignore - pin is treated as undefined
    • Disabled - pin is accepted but does nothing
    • Routine - pin is accepted and executes a Routine. Executes a unique Routine for Off, Stay(Partial) or Away(On) mode
    • Piston - pin is accepted and executes a WebCore Piston. Executes a unique Piston for Off, Stay(Partial) or Away(On) mode
      requires the full WebCore Piston’s external URL
    • Panic - pin is accepted and creates a SmartThings intrusion when global Panic is set to true
      Iris keypads and some Centralite keypads have a Panic key or setting
  8. Maximum Times a pin may be used before it is rejected. Set to 0 (zero) for infinite.
  9. When Maximum Times is greater then 0, set the reset slider to true to reenable the pin/user. Use count is displayed
  10. Profile name is internally set to “Profile User: (data entered in paragraph 4 above)” It may be modified, but must be unique.
  11. Tap ‘Next’ on top of page
  12. When Schedule slider is true: Scheduling Rules page appears. All fields optional
    • Set weekdays pin may be used
    • Set start and stop time the pin may be used
    • Set initial date pin may be used. Format MMM dd, yyyy where MMM is Jan thru Dec
    • Set last date pin may be used.
    • Click ‘Next’ on top of page
  13. When Restriction slider is true: Restriction Rules page appears. All fields optional
    • Set Mode(s) when pin is allowed. Null = all modes
    • Select Real Devices where pin may be used
    • Select Simulated Devices where pin may be used
    • Click ‘Next’ on top of page
  14. A User profile summary appears. Verify, then click ‘Save’

:arrow_up_small: Back to top

12. ModeFix, optional (Default: False/Off), but recommended when:

  • You want to syncronize the SHM Alarm State and SHM Mode settings

  • There are user created Modes

  • Keypads are in use and system is armed with something other than a Keypad

How this functions
Syncronizes the SHM Alarm State, SHM Mode, and any defined Keypad Light modes when changes are made to the SHM Alarm State, or SHM Mode.

  • When SHM Alarm State is changed, for example from the Dashbboard, sets the SHM Mode to follow when the current mode does not match a user defined mode for the Alarm State

  • When SHM Mode is changed, for example from WebCore or ActionTiles, set the SHM Alarm State to follow when the mode is defined in Modefix, and the defined Alarm state does not match the current Alarm State.

  • When using a keypad, the keypad’s arm state lights follow changes to the SHM alarm state and mode.

Activation requires two steps:

  1. In Global Application Settings set the Fix Mode option on/true
  2. Create then save A ModeFix Profile (default profile initially shows in the child app)

Have you ever wondered why Mode restricted Routines, SmartApps, and Pistons sometimes fail to execute, or execute when they should not? I gave up trying to use mode for Core Pistons, now I know why it did not work.

Perhaps like me you conflated AlarmState and Mode, however they are separate and independent SmartThings settings. When Alarm State is directly changed using the SmartThings Dashboard Home Solutions, a Smartapp, or a Webcore Piston—surprise, Mode does not change!

SHM routines generally, but not always, have a defined SystemAlarm and Mode setting. Experienced SmartThings users seem to favor changing the AlarmState using SHM routines, avoiding use of the Dashboard’s Home Solutions.

If like me, you can’t keep track of all this, or use the Dashboard for changing the AlarmState, or Action Tiles for changing the mode, the Mode Fix option may be helpful. For each AlarmState, set the Valid Mode states, and a Default Mode. Mode Fix attempts to correctly set the Mode by monitoring AlarmState and Mode for changes.
:arrow_up_small: Back to top

13. How use Keypads with this app.

  1. In Global Settings set the slider for “A real or simulated Keypad
” to on/true. Set global keypad settings then Save.

  2. Create a Delay Profile for each door you want delayed

  3. Create one or more User Profiles (pin numbers)

  4. Test your system

Keypads (Installed indoors) Verify the keypad is operating normally before using it with the SHM Delay app!

  • Global Settings → Keypad Routines suggested: Away: Goodbye, Disarm: I’m Back, Stay and Night: Good Night
    Selected routines must have a "Set Smart Home Monitor to “alarm state”, and a "Change the mode to “valid mode” -or the SHm Delay keypad control will malfunction.
    Exit Delay: seconds 15 to 90. This is the Exit Delay and sounds exit tones when arming from the keypad. While this delay is active SHM is not armed
  • On each User: Set 4 digit pin code;

SHM Delay Sensor Profile settings:

  • Entry Delay: something greater than zero.
  • Exit Delay: zero (0)
  • Set keypads to sound entry delay tones

Smart Door Locks and outdoor Keypads
When unlocking with smart door lock or entering a pin on an outdoor keypad with a contact sensor on the door, and the contact sensor reports an intrusion before the system sets the Alarm Status to off:

  • set exit delay to 0
  • set entry delay to > 0

:arrow_up_small: Back to top

14. Supported Keypads, Installation and TroubleShooting

Before proceeding please insure your keypad is supported by the suggested Device Handler noted below, and is properly installed on Smarthings:

Link to Rboy’s article about zigbee keypads

This app was developed and tested with the DTH at arnbme/SHMDelay/Version2, or you may get it at this link: https://raw.githubusercontent.com/arnbme/SHMDelay/Version2/devicetypes/mitchpond/centralite-keypad.src/centralite-keypad.groovy This DTH supports Centalite/Xfinity, Iris V2 & V3, and UEI keypads.

The RBoy Apps Keypad DTH $$ is also supported. Use version 01.08 or higher. In global settings set “I am using RBoy Apps DTH” flag to on/true.

he DTH should look something like the following image:
image

  • No entry or exit tones sounding:

Press and hold the 8 button until you get a confirmation beep to toggle the chime on or off.

On the keypad press and hold the 2 key to raise the volume until you hear a tone, press 5 to lower the volume.
Then in the ST phone app go to My Home, select the keypad, then tap on settings. Set length of beep to 10, save it, then press the ‘Sound’ icon. You should hear tones.
If you hear tones continue on

  • Still no entry tone when door is opened. Make sure you are beyond the exit delay time, the keypad is selected in the real sensor’s Delay profile, and entry delay is greater than 0.
  • Still no exit tone: Make sure the global “true exit delay” time is greater than 0
    More information Note: Some information is specific to using an Xfinity keypad on an Xfinity system.
    :arrow_up_small: Back to top

Documentation Continued at this link

24 Likes

Thanks for all the great work to make ST work well with keypads, Arn. This is a huge hole in their device support and your smartapps have done a great job of filling it.

3 Likes

SHM Delay Version 2.0, How to convert from prior version

Enhancements and Changes

  • Smartapp includes full support for all Iris, Xfinity and Centralite keypads, User pin profiles, and SmartThings interactions. Lock Manager is no longer needed by SHM Delay when using a Keypad device.

  • Previous Smartapp settings and delay profiles are used by updated SmartApp, along with new global keypad settings and user profile information. This allows for an easy transition, and quick recovery in the unlikely event that a fallback is required.

  • SHM Delay now includes a keypad centric facility to maintain user pins that may include an optional schedule with easy date entry. User profile data is verified for errors, then displayed for verification prior to being saved.

  • Optimized, self contained code provides smoothe, reliable keypad operations with an easier learning curve.

  • Pin can execute a SHM Routine or Webcore Piston aka pin type.

  • Issues Notification log message when SHM Delay Modefix changes the SHM mode

  • Issues Notification log message when accepted pin was entered, with pin type and user name

  • Issues Keypad tones as follows:
    Short beep - pin accepted (may issue a medium beep)
    Medium beep - pin accepted but was not a user pin, or bad pin and bad pin count > 1
    Long beep - pin rejected and bad pin count reached (always works)

How to Install
There are four (4) modules associated with the app:

  1. SHM Delay. Module should be Saved, Published, then Installed with the Smarthings app (must be done first)
  2. SHM Delay Child. Should be Saved, do not publish or Install.
  3. SHM Delay ModeFix Should be Saved, do not publish or install

    SHM Delay Version 2.0, How to convert from Version 1

Enhancements and Changes

  • Smartapp includes full support for all Iris, Xfinity and Centralite keypads, User pin profiles, and SmartThings interactions. Lock Manager is no longer needed by SHM Delay when using a Keypad device.

  • Previous Smartapp settings and delay profiles are used by updated SmartApp, along with new global keypad settings and user profile information. This allows for an easy transition, and quick recovery in the unlikely event that a fallback is required.

  • SHM Delay now includes a keypad centric facility to maintain user pins that may include an optional schedule with easy date entry. User profile data is verified for errors, then displayed for verification prior to being saved.

  • Optimized, self contained code provides smoothe, reliable keypad operations with an easier learning curve.

  • Pin can execute a SHM Routine or Webcore Piston aka pin type.

  • Issues Notification log message when SHM Delay Modefix changes the SHM mode

  • Issues Notification log message when accepted pin was entered, with pin type and user name

  • Issues Keypad tones as follows:
    Short beep - pin accepted (may issue a medium beep)
    Medium beep - pin accepted but was not a user pin, or bad pin and bad pin count > 1
    Long beep - pin rejected and bad pin count reached (always works)

How to Install
There are four (4) modules associated with the app:

  1. SHM Delay. Module should be Saved, Published, then Installed with the Smarthings app (must be done first)

  2. SHM Delay Child. Should be Saved, do not publish or Install.

  3. SHM Delay ModeFix Should be Saved, do not publish or install

  4. SHM Delay User Should be Saved, do not publish or install. (New module added with Version 2) version

    1. SHM Delay User Should be Saved, do not publish or install. (New module added with Version 2) version

There are two ways to Install:

  • Install via the repository (preferred), add the following to the IDE Settings.
    Owner: arnbme (in upper case that is ARNBME)
    Name: SHMDelay
    Branch: Version2
    1 Click ‘Save’
    2 When prior version of SHM Delay already installed via github : change the IDE source for SHM Delay, SHM Delay Child, and SHM modefix from Master to Version2 branch
    3 In ‘My Smart Apps’ click 'Update from repo",
    4 select the SHMDelay Version2 repository, then install and publish SHM_Delay (must be first)
    5 install do not publish SHM_Delay Child, SHM_Delay ModeFix, SHM Delay User
    6 (If not previously done) In the ST Phone APP install the SHM_Delay app

  • Manually install by going to https://github.com/arnbme/SHMDelay/tree/Version2/smartapps/arnbme then copy the modules and install 'from code"

Prepare smartapp for use

  • When using SHM Delay to control all Keypads
  1. Important In Ethayer’s Lock Manager app: Remove ALL keypad profiles.
  2. important In Lock Manager go to Automation->SmartApps->Lock Manager, Remove all Keypad Routines
  3. in SHM Delay edit Global Settings (scroll if it does not show)
  4. Set slider on to activate Total Keypad Control, then review all existing global settings and add Keypad information. Then Save
  5. Review existing Delay Profiles, then Save
  6. Create one or more User Pin Profiles
  7. Test your system.
  8. Lock Manager is no longer needed by SHM Delay for keypad control
  • When not using SHM Delay to control any Keypads
  1. Review all preferrences and profiles.
  2. Test your system

Known issues

  • Occasional strange system operation when creating a user profile. Ignores all input data or forces reentry of a field.

:arrow_up_small: SHM Delay Release Thread There are two ways to Install:

  • Install via the repository (preferred), add the following to the IDE Settings.
    Owner: arnbme (in upper case that is ARNBME)
    Name: SHMDelay
    Branch: Version2
    1 Click ‘Save’
    2 When prior version of SHM Delay already installed via github : change the IDE source for SHM Delay, SHM Delay Child, and SHM modefix from Master to Version2 branch
    3 In ‘My Smart Apps’ click 'Update from repo",
    4 select the SHMDelay Version2 repository, then install and publish SHM_Delay (must be first)
    5 install do not publish SHM_Delay Child, SHM_Delay ModeFix, SHM Delay User
    6 (If not previously done) In the ST Phone APP install the SHM_Delay app

  • Manually install by going to https://github.com/arnbme/SHMDelay/tree/Version2/smartapps/arnbme then copy the modules and install 'from code"

Prepare smartapp for use

  • When using SHM Delay to control all Keypads
  1. Important In Ethayer’s Lock Manager app: Remove ALL keypad profiles.
  2. important In Lock Manager go to Automation->SmartApps->Lock Manager, Remove all Keypad Routines
  3. in SHM Delay edit Global Settings (scroll if it does not show)
  4. Set slider on to activate Total Keypad Control, then review all existing global settings and add Keypad information. Then Save
  5. Review existing Delay Profiles, then Save
  6. Create one or more User Pin Profiles
  7. Test your system.
  8. Lock Manager is no longer needed by SHM Delay for keypad control
  • When not using SHM Delay to control any Keypads
  1. Review all preferrences and profiles.
  2. Test your system

Known issues

  • Occasional strange system operation when creating a user profile. Ignores all input data or forces reentry of a field.

:arrow_up_small: SHM Delay Release Thread

4 Likes

Installed the beta all is working except panel is not updating when the mode is changed anywhere but the panel. When I arm SHM in the app it is not reflected on the panel. I have tried Mode Fix on and off with no difference.

1 Like

I gather you’re having a problem but I don’t understand what you mean by panel.
In mode fix be sure after turning on the global modefix flag to tap on the mode fix profile, set the options then save it. You may have to scroll down to see the modefix options
Are you using a keypad?

1 Like

I meant keypad not panel, sorry. I will try that again. It is when I change the mode on the dashboard of the app. If I change SHM to disarm or anything the keypad doesn’t change. If I run the routine it does.

1 Like

When setting SmartThings from the keypad it executes a routine specified in the globals. The routine must set both the smart home mode and the SmartThings alarm state
Which keypad are you using Iris, or Xfinity / Centralite

Sorry I edited my previous post.

1 Like

I have the IRIS

1 Like

Yes im also editing my posts.
When you change only the mode and it creates unexpected system States such as alarm state home mode away. Try setting the system by changing the alarm state not mode

1 Like

Ok I will give that a try tomorrow and report back.

1 Like

Okay also please let me know on the IRIS if the proper kepad lights come on when setting partial and on

1 Like

I checked the source code: when using a keypad and Mode changed from a source other than the keypad it should set the keypad light to match, however it doesn’t currently set the alarm state.

It appears there’s sufficient information in the mode fix data to set the alarm state from a mode change I’ll take a look at this

1 Like

When using ActionTiles to change only the Mode, my Xfinity keypad icon immediatly reflects the change. However, the ST Alarm State remains unchanged. Changing the alarm state on mode only changes was never a supported option with Version 1 of this app, nor the Lock Manager’s Keypad module.

Did this work for you prior to switching to Version 2 Beta?

1 Like

Yes it worked before using ethayers lock manager also the partial lights did not light up it just shows off. I going to do some more testing with ethayers beta.

1 Like

It works correctly when using the master branch of SHM and the beta of ethayers LM.

1 Like

Ok thanks for all the testing.

Are you saying when the mode only is changed the ST alarm state changes to follow? If yes I’ll add that logic into Verrsion 2. Just wondering what is being used to change the mode?

Also when using the beta shm delay and setting the Iris keypad with Partial or On, do the properr keypad lights come on?

Edit
Just wondering has globalTotalKeypadControl been set on in the Version 2 testing?

1 Like

I am using routines to change the mode. No the partial did not light up, the keypad would display the alarm Off.

it would be so much easier if ST allowed me to see your logs with your permission.

Some debugging statements were added to the keypadModeHandler and keypadLightHandler routines in module SHM Delay. If it’s not too much trouble please retry version 2 with the updated module while using live logging, then send me the filtered results for modeule SHM Delay.

I also went into Automation on my phone app, tapped the Goodbye, I’m Back, Good Morning, Goodnight routines: ST and the keypad responsed as expected. Which routines are being used on your system and do they also set both the ST Alarm State and SHM Mode?

1 Like

I now have it fully functional. The solution was to rename my location modes. ie: My “Night” mode was “Sleeping” and even though I had selected that under “Update Active Mode Fix Settings” The keypad was not being updated to the current mode. Once I went to IDE and renamed the location mode from “Sleeping” to “Night” I went back into the app and “Update Active Mode Fix Settings” and selected “Night” it all works. I have renamed my location modes to “Home - Away - Night” and it all works correctly.

1 Like