Allegion NDE and LE Lock Integration - Quick Start Guide

Allegion NDE and LE Lock Integration - Quick Start Guide

1.0 Introduction

This quick start guide walks you through the process of setting up the Doors.NET integration between the Allegion Gateway and the Allegion NDE and LE locks.

 

It assumes you have an existing Allegion ENGAGE 'Third-Party' account type and you have already added the Allegion Gateway (and any locks) to the Allegion ENGAGE app.

Notes:

  • Doors.NET v5.2.0 includes NDE and LE wireless support with Mercury EP and LP series controllers. The Allegion wireless lock devices will be displayed when the TB2 or TB3 port has been configured for Schlage RSI protocol.
  • Doors.NET V5.2.0 allows you to have Allegion Gateways, PIM400 or AD300 locks connected to the same bus - communicating simultaneously (up to a maximum of 8 devices per bus).
  • Effective from Doors.NET v5.2.0, when using NXT-MSC controllers you will need to delete the Keri NXT reader which is added to the bus by default and then configure the protocol to support the Schlage RSI protocol before adding the gateway node (this is covered in more detail in section 7.0).
  • The Allegion Control locks are NOT supported with the Doors.NET integration and neither is the MT-20W USB enrollment reader.

 

The integration offers you advanced door control. You can lock or unlock the doors from the software and you can change the door operating modes (see section 11). You can use the Doors.NET software to immediately change cardholder access rights and view the real-time door open status and doors can be programmed to automatically lock and unlock during the day.

 

The integration can also be combined with Doors.NET system alerts, system and auditing reports, event-driven video recording capability and advanced facility monitoring using the Telepathy map client.

 

2.0 System Capacities

  • The maximum number of locks per gateway is 10.
  • The maximum number of gateways per controller is 8.
  • Maximum of 64 locks/readers per controller.

3.0 Before you Begin

This document assumes that you have an existing Allegion ENGAGE system already setup with the ENGAGE app. It also makes the following assumptions:

  1. You have registered a 'Third-Party' Allegion ENGAGE account.
  2. You have added the Allegion Gateway to your account.
  3. You have added your NDE/LE locks to your Allegion ENGAGE account.

    Note: The locks can be added to the ENGAGE account in any order as they will be paired to the gateway from within Doors.NET.

  4. The Allegion Gateway needs to be added to your ENGAGE app and configured for RSI Mode (RS-485 communication). The RS-485 address number also needs to be set (in accordance to which NXT-MSC bus the gateway is connected to). Or if there are multiple gateways on the same bus. If there is just one gateway connected to the controller then use address 1.
  5. You have an existing Doors.NET system installed and ready to use, with an NXT-MSC or Mercury EP or LP controller setup and online.
  6. The NDE and LE locks should NOT be configured for Wi-Fi.

 

Note: For further details about using the Allegion ENGAGE app, use the following link:

us.allegion.com/en/home/products/categories/.../ENGAGE-web-mobile-apps.html

 

4.0 Check your Doors.NET License

The Allegion Lock Integration is a licensed feature, so it must be enabled on your Doors.NET license.

The following steps explain how to check your license is configured correctly.

  1. From the Windows Start menu: Go to Doors.NET >> License Manager.

    DoorsNET License Manager

  2. When the License Manager is open, click on the License tab located on the right side of the window.

    License Tab

  3. Scroll through the list of supported capacities and locate the Readers - Allegion option.
  4. Ensure both 'Allegion' AND 'Allegion per Controller' are both set to a value greater than zero.
  5. Close down License Manager if your license is correct.

 

5.0 Wire the ENGAGE Gateway to the Controller

5.1 Allegion Gateway to NXT-MSC Controller Wiring

 

The ENGAGE gateway connects to the NXT-MSC controller via RS-485 to one of the controllers buses. For example; bus 1.

Allegion GWE Wiring

 

You should not connect the power (to NXT-MSC controller pin 1) because the gateway has its own separate power supply.

 

5.2 Allegion Gateway to LP-4502 Controller Wiring

The Allegion Gateway is shown as connected to TB2 of the LP-4502. TB3 can also be used.

LP-4502 Wiring


6.0 Add the ENGAGE Gateway to Doors.NET

6.1 Add the ENGAGE Gateway to an NXT-MSC Controller

Next is to add the gateway to Doors.NET. It assumes that Doors.NET has been successfully installed, licensed and the MSC gateway is added and online.

 

Note: When using NXT-MSC controllers, to add the Allegion Gateway you must first delete the default (NXT) reader from the bus and then configure the bus for the correct protocol.

  1. Log into Doors.NET (default user name and password are both admin).
  2. Go to Setup >> Hardware Setup >> All.

    Hardware Setup - All

  3. You will see the MSC gateway listed at the top of the hardware tree and NXT-MSC controllers will be listed beneath it.
  4. Double-click the controller, then locate the bus which the gateway is wired into (for example, bus 1).
  5. Select the default reader that is displayed for bus 1.
  6. Click the Hardware Browser tab near the top of the screen.
  7. Click the REMOVE button.

    Hardware Browser Button

  8. The reader on that bus will be removed from the hardware tree.
  9. Select the bus again.
  10. You will see the bus properties located on the right.
  11. Locate the Protocol (Serial) setting and set it to Schlage RSI.
  12. Save the bus settings.

    Set Schlage RSI

  13. With the bus still selected, click the Add ENGAGE Gateway icon.

    Add ENGAGE Gateway Icon

  14. Click ACCEPT on the dialog box that appears.
  15. The ENGAGE Gateway will be added to the bus on the hardware tree.
  16. Select the ENGAGE Gateway on the hardware tree and the gateway properties will be on the right.
  17. Enable Advanced View for the gateway properties.

    Advanced View Enabled

  18. Set the comm address to match the address that was configure on the Gateway using the ENGAGE app.

    Set Comm Address

  19. Save the Gateway settings and a few seconds later the gateway should come online.

    Engage GW Online

  20. Now that the gateway is added and online you are ready to add the locks to
    Doors.NET.

 

6.1 Add the ENGAGE Gateway to a Mercury LP-4502 Controller

The following steps explain how to add a gateway that has been connected to the TB2 port of the controller. It assumes you already have an LP-4502 controller added and online in Doors.NET.

 

Note: Allegion integration is supported with the Mercury EP and LP controller types.

  1. From Doors.NET, go to Setup >> Hardware Setup >> All.
  2. The hardware tree will display.
  3. Select the LP4502 controller and the properties will be on the right.
  4. Ensure the controller is online.

    LP controller online

  5. Double-click to expand the controller in the hardware tree.
  6. Select the TB2 node and the TB2 properties will be on the right.
  7. Change the Protocol (Serial) value from Mercury Security to Schlage RSI protocol.
  8. Then save the TB2 settings.

    TB2 - RSI

  9. You will be prompted to reset the controller so click YES to go ahead with this.
  10. After approximately 30 seconds the controller will come back online.
  11. With the TB2 node still highlighted in the hardware tree, click on the ADD ENGAGE GATEWAY icon on the ribbon bar.

    ADD Engage GW

  12. Click ACCEPT on the dialog box that appears.
  13. The ENGAGE Gateway will be added to the TB2 node on the hardware tree.
  14. Expand the TB2 node to view and select the gateway node.

    Gateway Node

  15. The gateway properties will be on the right.
  16. Ensure Advanced View is enabled for the gateway properties.
  17. Set the comm address to match the address that was configure on the Gateway using the ENGAGE app.
  18. Save the gateway settings and a few seconds later the gateway should be online.

    Save GW Settings

  19. A few seconds later the gateway should be online.

    ENGAGE GW Online

 

7.0 Add the Allegion Wireless Locks to Doors.NET

  1. Select the ENGAGE gateway on the hardware tree.
  2. Click on the lock type you wish to add from the hardware selection ribbon bar.

    Allegion Lock Icons

  3. Click the tree-expander icon to the left of the gateway , then expand the Readers - you will see the new lock listed beneath the gateway.

    New Lock Added

  4. Repeat steps 1 to 3 for all additional locks you need to add.

    Additional Locks Added

  5. You should now rename the locks (based on their location) so that the system can be easily administered in the future.

 

8.0 Linking the NDE and LE Locks to the Gateway

The final step in Doors.NET is to link the locks to the ENGAGE gateway. The gateway will then be permanently connected to the lock(s) via Bluetooth.

  1. Right-click the first Allegion lock, select Mode >> Link.
  2. The LED on the gateway will now be alternating between blue and red.
  3. Hold down the interior lever of the lock then present and hold a credential to the reader.
  4. Hold the credential at the reader for approx. 10 seconds.
  5. The reader LED will then alternate between red and green and will then continually flash green.
  6. Wait until you hear 4 beeps from the reader.
  7. You can now release the interior lever and take the card away from the reader.
  8. The lock will now be linked to the gateway.
  9. If you present an inactive card to the lock you should now be seeing an event in the live events grid.

    Live Events Message

  10. The lock is now ready for use.

 

9.0 Enrolling Cards into Doors.NET

The quickest and easiest method for adding cards is to use the presentation enrollment method. The presentation enrollment method is also required if you are not enrolling standard 26-bit Wiegand credentials - (only 26-bit Wiegand credentials can be manually enrolled). Press the F1 key while on the cardholders screen of Doors.NET and this will take you to the Cardholders section of Doors.NET where all enrollment methods are fully documented.

 

Presentation Enrollment

 

You will also be able to find information about adding and selecting custom formats in Doors.NET (such as Mifare (32-bit CSN).

 

10.0 Supported Credential Types

The Allegion NDE and LE-Series locks support the following credential formats

 

125KHz Credential Compatibility

  • Schlage
  • XceedID
  • HID
  • GE/CASI ProxLite

 

13.56 Smart Credential Compatibility

(Secure Sector Reading) - Schlage MIFARE®, aptiQ® MIFARE Classic, XceedID, aptiQ MIFARE DESFire™ EV1 with PACSA,

aptiQmobile™

 

CSN only compatibility: DESFire, HID iClass®, Inside Contactless Pico Tag®, MIFARE, MIFARE DESFire EV1, ST Microelectronics®, Texas Instruments Tag-It®, Phillips I-Code®

 

aptiQ credential style formats: Clamshell, ISO card, ISO card with magnetic stripe, keyfob, mobile, PVC disk (8000 Series) and PVC patch (9000 Series)

 

 

11.0 Operate the Hardware

11.1 Unlock and Lock the Door

You can immediately unlock, lock or temporarily unlock any of the doors either via a right-click on the hardware tree:

 

Right Click Unlock

 

Or you can select the reader on the hardware tree or from the door status grid and use one of the lock/unlock icons located on the ribbon bar.

 

ENGAGE Temp Unlock

 

11.2 Set the Required Operating Mode

The Allegion LE/NDE Series of locks support several different operating modes that can be accessed via a right-click on the reader: Select Mode >> Extended and you will see a list of options.

NOTE: Not all operating modes are supported on every lock type:

 

Lock TypeSupported Operating Modes
LE DeadboltClassroom, Privacy and Apartment
LE IPBClassroom, Privacy, Office and Apartment
LE LEDClassroom
NDE SeriesClassroom

 

Classroom Mode

In Classroom mode: The outside lever is locked and unlocked by key. The inside lever is always unlocked for immediate egress.

Privacy Mode

In Privacy Mode, the lock is secured as part of the Privacy Mode process. When Privacy Mode is disabled, if the lock is still within an auto-unlock period, the lock will unlock (unsecured). If the lock is NOT within an auto-unlock period when Privacy Mode is disabled, then the lock will stay secured.

 

NOTE: A door position sensor (DPS) Must be installed for Privacy Mode to operate. The door must be in a closed state to enter Privacy Mode.

Apartment Mode

When the lock is set to Apartment Mode the door automatically unlocks when opened and does not re-lock. A valid credential must be presented to the exterior reader or an interior button must be pressed to re-lock the door.

Storeroom Mode

In storeroom mode the outside lever is fixed. Entrance is by key only. Inside lever is always unlocked for immediate egress.

 

12.0 Factory Reset Procedures

A Factory Default Reset (FDR) will return the gateway or the locks to their original settings as shipped from the factory. An FDR will NOT remove the device from your ENGAGE account. Refer to the Allegion supporting documentation for the exact factory reset procedure.

 


13.0 Allegion NDE IPB Support on MSC LP Hardware

The NDEb lock has a Interior Push Button (IPB) that can be configured to perform additional functions when the ENGAGE gateway is communicating with any LP controller. These additional functions are not available for EP and NXT-MSC hardware.

 

The additional functions are as follows:

 

● Office - Lockset is normally secure. Interior push button on inside housing may be used to select a passage or secured status. Valid toggle credentials on the exterior may also be used to change status. Meets the need for a lockdown function for safety and

security. A mechanical key will retract the latch. Inside lever always allows free egress.

 

● Privacy - Lockset is normally secure. Interior push button on inside housing may be used to select a privacy status. The interior push button will disable normal electronic access from the exterior. Opening the door or pressing the interior push button a second time on the inside housing deactivates the privacy status. A mechanical key will always retract the latch. Inside lever always allows free egress. Door position sensor required for function.

 

● Apartment - Lockset is normally secure. Interior push button on inside housing may be used to select a passage or secured status. Opening the door or pressing the interior push button causes the lockset to toggle unsecured. While toggled unsecured, the

lockset can only be secured while the door is closed by pressing the interior pushbutton or using a normal credential on the exterior. Normal electronic access from the exterior is always allowed. A mechanical key will retract the latch. Inside lever always allows free egress.

 

The additional function can be configured by the Extended Feature property:

 

ndeb_extended

 

Attempting to set this feature on MSC EP or NXT-MSC hardware will display the following message:

 

MESSAGE

 

The NDEb can still be used with EP and NXT-MSC hardware and will function normally but the additional Extended Feature modes are not supported.

 

 

14.0 Troubleshooting

  • You will not be able to add hardware that has already been added to another ENGAGE account.
  • You will not be able to add a new lock until it has been factory reset
  • You will not be able to add the Allegion Gateway unless you have registered as a 'Third-Party' account.

    • Related Articles

    • Allegion NDE and LE Lock Integration - Full Reference Guide

      IMPORTANT NOTE: "Before beginning hardware installation and setup, please read this document completely as there may be information related to your specific application that appears in different sections." 1.0 Introduction Keri can integrate with the ...
    • Doors.NET and Allegion Lock Integration Overview

      Doors.NET and Allegion Lock Integration Allegion AD, NDE and LE Series locks seamlessly integrate with Keri Doors.Net to provide a cost effective and scalable access control solution to meet your security needs. The integration allows real-time ...
    • Allegion and Keri Integration Data Sheet

      Allegion and Keri Integration Data Sheet (attached).
    • Allegion Lock Operating Modes

      Doors.NET software integrates seamlessly with the Allegion AD-series, NDE and LE series of wireless locks. The Allegion LE/NDE Series of locks support several different operating modes that can be accessed via a right-click on the reader: Select Mode ...
    • AD-300 Lock Setup Guide

      IMPORTANT NOTE: "Before beginning hardware installation and setup, please read this document completely as there may be information related to your specific application that appears in different sections." 1.0 Introduction Allegion Schlage AD-300 ...