Programming the Allegion Integration
As well as normal door and door type programming, the Allegion integration requires additional programming in the controller's onboard reader expander, smart readers and trouble inputs.
The integration must be programmed separately for each controller with Allegion locks connected.
Programming Doors and Door Types
Doors and door types are programmed in the same way as normal doors. You will need to program:
-
One door per Allegion lock that will be used in this integration.
-
Enough door types to cover all of the required modes of operation. This integration supports:
-
Card only
-
PIN only
-
Card and PIN
-
Card or PIN
-
Custom Wiegand credential types (see Credential Types)
For more information about programming and using Wiegand credential types, see Application Note 276: Configuring Credential Types in Protege GX. Specific documentation for Protege X is coming soon.
-
Custom formats (see Controllers)
-
After programming the doors, you can assign them to door groups and access levels to give access to users.
Programming PIM Records
Each Allegion wired lock and hub is represented by a PIM programmed on the controller's onboard reader expander.
-
Navigate to Controller Records | Reader Expanders.
-
Select the location and controller that you are programming.
-
Select the controller's onboard reader expander (i.e. the reader expander with a Physical Address of 1).
-
Click Edit.
-
Scroll down to General | Configuration.
-
If locks / wireless hubs are wired to reader port 1, set the Port 1 Network Type to Allegion.
-
If locks / wireless hubs are wired to reader port 2, set the Port 2 Network Type to Allegion.
-
-
Scroll to the Reader 1/2 PIM Config sections at the bottom of the page. Click Add to add PIM records representing each wired lock or hub connected to the controller.
-
Set the PIM Address to the address of the lock, PIM or GWE.
-
Set the APM address range for each PIM:
-
For individual wired locks, set the APM Start Address and Number of APMs to 1.
-
For PIMs and GWEs, the APM Start Address is the same as the Low APM Range configured for that hub. This determines the address for the first wireless lock assigned to that device. The minimum address is 1.
-
The Number of APMs sets the number of locks that will be connected to each hub. It is recommended that you reserve the maximum number of APMs available (16 for PIMs, 10 for GWEs) so that you can add more locks later without reprogramming the system.
-
Ensure that there are no duplicate APM addresses on one reader port, even across multiple PIMs/GWEs. For example, if there are two PIMs connected with 16 locks each, PIM 1 should have an APM Start Address of 1 and PIM 2 should have an APM Start Address of 17. This ensures there will be no duplication of APM addresses.
-
-
Click Save.
Adding Smart Readers
Each wired and wireless lock is represented by a smart reader in Protege X.
-
Navigate to Controller Records | Smart Readers.
-
Select the location and controller that you are programming.
-
Click Add.
-
Give the smart reader a descriptive name that identifies which lock it represents.
-
Set the Expander Address to 1.
-
Set the Expander Port to 1 or 2, depending on the port the lock or hub is connected to.
-
Set the Configured Address to the address of the lock as configured in Allegion.
-
Set the Linked RSD Address:
-
For wired locks, this should be NotSet.
-
For wireless locks, this should be the PIM Address of the hub that the lock is connected to.
-
-
In the Reader tab, set the Reader 1 Format to the format that this lock will read.
-
If you are using a credential type, select Custom Credential.
-
If you are using a custom reader format (programmed in the controller record), select Custom Format.
-
-
Set the Reader 1 Location to Entry or Exit.
-
Select the Reader 1 Door from the doors that you programmed above.
-
Click Create.
-
Repeat to create all of the required locks.
Adding Trouble Inputs
A number of trouble inputs are available for reporting troubles in locks and hubs. Note that some trouble conditions are grouped so that one trouble input reports on multiple conditions.
Trouble Input Name |
Module Input Number |
Type |
Lock Condition |
---|---|---|---|
Door Forced Open |
1 |
Door |
Lock has been forced open |
Door Left Open |
2 |
Door |
Lock has been left open |
Reader Tamper* |
3 |
Door |
Lock tamper PIM tamper GWE BLE tamper |
Battery Low |
4 |
Door |
Lock has low battery |
RF Loss |
5 |
Door |
Lock has RF loss |
Battery Critical |
9 |
Door |
Lock has critical battery |
Reader 1 Tamper / Missing** |
12 |
Reader Expander |
PIM/GWE/AD300 lock offline on reader port 1 |
Reader 2 Tamper / Missing** |
13 |
Reader Expander |
PIM/GWE/AD300 lock offline on reader port 2 |
*When a PIM or GWE tamper is triggered, the Reader Tamper trouble input of the first door associated with that hub will open. This is the door corresponding to the lock with the lowest Configured Address.
**If any wired lock or hub goes offline, the Reader 1/2 Tamper / Missing trouble input will open.
Programming Trouble Inputs
There is no need to program the reader expander trouble inputs, as these are created automatically with the onboard reader expander. However, you will need to manually program the trouble inputs for each door.
-
Navigate to Controller Records | Trouble Inputs.
-
Select the location and controller that you are programming.
-
Click Add to program six new trouble inputs for each Allegion door. These should have the following settings:
Name
Module Type
Door Module Address
Module Input
Trouble Group
Trouble Group Options
[Door Name] Forced Open
Door
Relevant Allegion Door
1
Access
AC Failure / Module Tamper / Door Forced
[Door Name] Left Open
Door
Relevant Allegion Door
2
Access
Battery / Module Offline / Door Left Open
[Door Name] Reader Tamper
Door
Relevant Allegion Door
3
System
AC Failure / Module Tamper / Door Forced
[Door Name] Battery Low
Door
Relevant Allegion Door
4
General
Battery / Module Offline / Door Left Open
[Door Name] RF Loss
Door
Relevant Allegion Door
5
System
Battery / Module Offline / Door Left Open
[Door Name] Battery Critical
Door
Relevant Allegion Door
9
System
Battery / Module Offline / Door Left Open
-
Set the Areas and Input Types for each trouble input appropriately. Most commonly these would use the controller's system area and the Trouble Silent input type.
-
Click Create.
Optional Allegion Features
These additional features can be enabled in the Allegion lock during commissioning (see Allegion Configuration).