1.0 Introduction

The Allegion IP Gateway allows you to send immediate updates to your locks following any database change. This eliminates the need to physically go to the locks to update them with new cardholder information. As well as immediate system updating, you can also use the device to immediately unlock any door from any PC that is connected to the internet and to retrieve audit information from the locks.

Note: The Allegion Gateway and all Allegion devices should be connected to a 2.4GHZ Wi-Fi network. They are not compatible with a 5GHz network.

2.0 System Capacities

• Maximum Number of Locks per Gateway = 10
• Maximum Number of Events held in Memory = 1,000 for Control BE467 and FE410 locks and 2,000 for NDE and LE locks.
• Maximum Number of Users = 500 for Control locks and 5,000 for NDE and LE locks.

3.0 Factory Default Reset (FDR) the Allegion Gateway

To clear any possible configuration that may be programmed into the Gateway, you should first perform a factory reset. A Factory Default Reset (FDR) will return the ALLEGION Gateway settings to the original settings as shipped from the factory. If you have been using the Gateway on a different site you will also need to log in to that site and delete it - so it can then be recommissioned to a new site:

1. Press and hold down (for approximately 10 seconds) the reset button until the Gateway status LED flashes twice and remains solid.
   
   
   
   
2. Release the button when the LED has flashed twice.
3. Wait for the Gateway to complete the factory default reset. Initially, the status LED will be solid green for a moment - the device will then reboot. The reboot process can take a few minutes. During the reboot process, the status LED will be solid amber. Once the device is reset the status LED will be solid red.

4.0 LED Indicator Guide

5.0 Capture the Allegion Gateway

IMPORTANT: These steps must be followed exactly. If the device is not setup correctly you will need to delete it, factory reset it and begin the setup process again from the start.

The first step when setting up the Gateway is to capture it to your site using the ALLEGION ENGAGE app.

1. Log into the ENGAGE app on your Android or iOS device.
2. Tap your existing site name >> then Select. At this point, you may be prompted to activate Bluetooth on your smart device (if it is not currently enabled).
   
3. The device screen will appear and will display all existing devices.
4. Tap the Add (+) icon.
5. From the device list, select the GATEWAY (GWE).
   
   
   
   
6. Select the ENGAGE Gateway that appears.
   
   
   
   
7. The app will connect to the device.
8. Tap YES to confirm that the Gateway LED is blinking blue.
9. Please wait...
10. Enter a name for the Gateway device. Click NEXT.
11. Select IP as the communication mode.
12. Select to enable IP Behind Firewall.
13. Set IP Settings to DHCP. Click NEXT.
    
    
    
    
14. Enter the following URLs:
    
    - Server URL should be https://allegion.aetheros.net/engage/wss
    - CA Server URL : http://allegion.aetheros.net/swordfish/lock/certificates/current
    
    
    
15. The Keep Alive (in seconds) value should be left at the default of 300. Click NEXT.
16. Wait a few seconds while the device configures.
17. Click the green FINISH button.
18. The app will return to the device screen and the Allegion Gateway will be displayed.

6.0 Sync Gateway Device in the Web Portal

Now that the device has been added to your ENGAGE account you can now add it to your registered site in the Web Portal:

Note: For detailed instructions about setting up a new site and registering it to the web portal, refer to the Allegion No Tour - Full Reference Guide (P/N: 02321-001)
or you can view the knowledge base article here: Allegion - No Tour Full Reference

Paste the following URL into your browser: (http://www.keri-kb.com/#Allegion_NO_TOUR/Allegion_No_Tour.htm)

1. Open a web browser and navigate to the following URL:
   
   https://allegion.aetheros.net
   
   
2. Login with your Allegion ENGAGE username and password.
3. Once logged in, go to Devices >> Devices.
4. Click the SYNC DEVICES button.
5. The Allegion Gateway will then appear in the device list.

7.0 Check the Gateway is Online

To check the gateway is online, click the device name and the device status screen will appear. The status should be showing as 'Online'. You will also see firmware details and the time of the last connection.

8.0 Pair the Locks with the Gateway

The following steps explain how to pair your locks with the gateway. Once locks have been paired to the Gateway you will be able to update the locks via the Web Portal. Locks can be paired to the gateway using the Allegion ENGAGE app or from the Keri Web Portal. The following steps explain how to pair the locks using the web portal.

Notes:

• A maximum of 10 locks can be paired with the Allegion Gateway.
• The locks must already be added to the same site that the gateway is added to.
• If locks are paired using the ENGAGE app you should then click the refresh icon while on the gateway screen (this will refresh the list of paired/connected locks).

• If no locks are linked, you can click the + icon, and the gateway will scan for locks that are in range and not already linked.  Select the lock(s) you want to link from there.

1. From the Gateway device status screen, click the Add (+) icon.
2. Select the lock that you wish to pair, then click SUBMIT.
   
   
   
   
3. The lock's reader will beep 4 times and the lock will then be displayed in the Linked Devices list. A pending update indicator will most likely be displayed next to the lock.
   
   
   
   
4. If you have a gray coloured icon displayed to the right of the model name this indicates that the lock firmware needs to be updated.

9.0 Updating the Locks

Certain database changes will require a 'door file update', for example, changes to access rights or removing access rights from a cardholder. The following steps explain how to update the locks via the Gateway:

1. From the device list in the web portal, click on the Gateway entry.
2. Click on the Allegion Gateway.
3. The device screen will appear and the linked devices will be listed.
4. Use the drop-down list for a lock that requires an update.
   
   
   
   
5. Select Sync Database from the list. Status indicators will inform you of when the update has completed.
6. Once update is complete the pending update indicator will disappear.

10.0 Synchronizing the Time

Part of the initial setup is to synchronize the clock on the locks (this is a separate action to updating the locks:

1. Open the list of locks that are connect to the IP Gateway.
2. From the action type drop-down list, select Sync Real Time Clock.
3. Create an event at the lock and then view the lock audit data... (see next section).
4. Check that the new event time and date stamp is correct.

11.0 Retrieving and Viewing Audit Data

The audit data are the events that are generated by the locks; access granted, access denied, door opened, door closed, etc and these are stored in the locks memory until they are retrieving using the Mobile app or the Web Portal (using the IP Gateway) or the NDE and LE can be configured to send their event information automatically. In order to provide privacy there is the option (per gateway), to select whether or not to automatically upload audits or not (the Edge devices selection). So if the building owner was concerned about privacy issues, they could put all the Control locks on gateways that have the selection to manual and the NDE/LE on gateways that are uploading in real-time.

The daily event collection option is a balance between the two...So the building owner is not seeing events inreal time but does not have to manually get audits.

11.1 Manually Collecting Events

When set to manual, all the event download options are off. The following steps explains how to manually retrieve all the events from a lock:

Notes:

- Control BE467 and FE410 locks will hold 1,000 events in memory.

- NDE and LE locks will hold 2,000 events in memory

1. Open the list of locks that are connected to the IP Gateway.
2. From the action type drop-down list, select Download Audits.
3. All events will be downloaded to the Cloud.
4. Next, from the drop-down list, select View Audits.
5. You will now be able to view all the most recent event information for the lock.

11.2 Download Audits Daily

You can configure the system to download all the lock event information once a day from each of the locks..

1. Go to the Gateway settings screen.
2. Locate the Manage drop-down list and select Edit.
3. On the Gateway edit screen enable Download audits daily.
   
   
   
   
4. Click SUBMIT to save the settings.

11.3 Download Events Automatically

You can subscribe to events and this will automatically download all events as they happen (in real time). This settings is enabled on the gateway settings screen via the Manage drop-down list >> Edit >> Download Audits Daily).

1. Go to the Gateway settings screen.
2. Locate the Manage drop-down list and select Edit.
3. On the Gateway edit screen enable Edge Devices.
   
   
   

12.0 View Lock Status Information

When a lock is paired with an IP Gateway it is very easy to do a status check on the lock. The status check will allow you to retrieve information such as: whether the lock is locked or unlocked, the battery status, door position, deadbolt position, if the tamper lid is open or if the real-time clock is incorrect:

1. Open the list of devices that are linked to the IP Gateway.
2. From the Action drop-down menu, select Lock Status.
3. A window will appear displaying all the available information about the lock.

13.0 Remove a Lock

Note: If a lock is paired with an IP Gateway you MUST ensure the IP Gateway is online when the lock is deleted. Failing to do so will mean the lock will not be correctly deleted from the Allegion database and the lock will still be listed in the ENGAGE app as a linked device. The lock will also be listed in the firmware details page. If a lock is accidentally deleted while the gateway is offline you will need to connect to the gateway with the ENGAGE app, select Linked Devices, select the lock and remove it from linked list (swipe left in iOS).

To remove a lock:

1. Open the list of locks that are connected to the IP Gateway.
2. From the action type drop-down list, select Remove.
3. The lock will be removed from the linked devices list.
4. This will not, however, remove the lock from your site... it will just no longer be communicating with the Gateway and cardholders will continue to be able to gain access at the lock.
5. You will also be able to add the lock again by clicking the plus (+) icon.
6. To delete the lock from the system completely you should delete it from the device list.

14.0 Temp Unlock Doors

When using the Allegion Gateway in IP mode you can perform a temp unlock on doors via the web portal.

1. From the device list in the web portal, click on the Gateway entry.
2. Click on the Allegion Gateway.
3. The device screen will appear and the linked devices will be listed.
4. Use the drop-down list for a lock that you wish to unlock and select Unlock.
   
   
   
   
5. The door will temporarily unlock.
   

15.0 Lockdown All Doors

There is a Lockdown devices broadcast message that can be sent to all NDE and LE locks on the system (when you are using the Allegion Gateway). When actioned, this will immediately lockdown all locks that support this feature - all locks will be put into 'frozen secure' mode and will only allow access for credentials of 'passage type'. Any doors which are unlocked or auto-unlocked will be immediately locked.

15.1 Set Individual Locks to Lockdown

1. From the Gateway settings screen, locate the Manage drop-down list.
2. Select Lockdown devices from the list.
3. All NDE and LE locks will be put into 'frozen secure' mode.
4. Next to the locks will be a small black padlock icon - to indicate that the lock is in lockdown mode.
   
   
   

15.2 Set an Individual Lock into Lockdown

1. Open the list of devices that are paired with the IP Gateway.
2. Use the lock's Manage drop down list to select Commands >> Lockdown.
3. That particular lock will go into lockdown state.
4. A small black padlock will appear next to the lock.

15.3 Take Locks Out of Lockdown State

To take the locks out of 'Lockdown' mode you can either present a Freeze credential or you can use the Manage drop-down list again and select  Commands >> Clear Lockdown - when a Freeze credential is presented the reader LED will alternatively blink red/green/red/green for a few seconds. A few seconds later the padlock will then not be displayed next to the lock.

16.0 Updating the IP Gateway Firmware

You can update the IP Gateway firmware by doing the following:

1. From the Devices list, click on the IP Gateway.
2. When the IP Gateway screen appears, locate the Manage drop-down list.
3. From the Manage drop-down list, select Firmware Updates.
4. Click YES to update the firmware on the Gateway and also on all the connected devices.
5. While the device firmware is being updated the device LEDs will alternate between green, red and amber, wait for the LED to return to blue and to remain on blue for a few minutes.

Note: This will take a few minutes to update the Gateway and also allow 10-15 minutes to update the firmware on each connected lock.

17.0 Updating the Lock Firmware

You can upgrade firmware from the ENGAGE app or from the web portal. If the lock requires a new firmware version you will see an icon next to the lock, as highlighted:

The following steps explain how to upgrade the firmware on the locks. The firmware file is sent via the gateway over Bluetooth - but in the ENGAGE app you can configure the lock to communicate over Wi-Fi and then the update will be much quicker.

1. From the Gateway screen, locate the Manage drop-down list on the left.
2. From the list, select Firmware Updates.
   
   
   
   
   
3. You will see a message prompting to confirm that you wish to update the firmware on the gateway and on all connected devices that require an update. Click YES to this.
4. Once the firmware update has completed the firmware update required icons will disappear.