Allegion Developer Portal
Allegion Developer Portal
Some device parameters can be changed by a host device. When modifying (configuring) parameters, a host sends a JSON data structure to the device that contains a set of configuration parameters. The Table below shows a complete list of the JSON data tags and tag values that can be modified by a host. Some of the parameters are device specific and may not apply to all devices. Modifiable (configurable) parameters vary by each device’s capability or the specific configuration of the device.
To support a standard of JSON configurations moving into the future, the standard has been established to use “T” / “F” for configuration tags/items (to enable or disable a feature). However, because some of the currently established tags do not use this standard, the previously implemented tag types maintain their current implementation and the standard will be established for new tags implemented in the future.
See the Example of Configuration Records (JSON) section below for an example of this data structure.
The table below shows a listing of Modifiable (Configurable) Parameters.
Table: Modifiable (Configurable) Parameters
| Tag | Short Tag | Type/Length (ASCII bytes) | Value | Device Exclusions |
|---|---|---|---|---|
| Configuration Block | config | String/6 | N/A | <R1: no blanks in tables, use N/A or None. |
| Type | type | String/6 | “strm” “clsrm” “office” “dorm” “apt” “prvcy” | SC, RMRU, MTB, MTKB |
| Relock | relock | Unsigned Int/3 | Delay time in seconds (1-60s for SC, 1-30 for all other supported products) | RMRU, MTB, MTKB |
| Central Decision Mode Timeout | cntrlDecTimeout | Unsigned Int/4 | Delay time in deciseconds (0-6540) NOTE: 0=central decision mode disabled (local decision mode enabled) | NDE, LE, RMRU, CTE, MTB, MTKB, NDEB, LEB, RC |
| Credential Sector Number | credSectNum | Unsigned Int/2 | Credential Sector Number (1-15) | NDE, LE, SC, CTE, RMRU, NDEB, LEB, MTB, MTKB, RC |
| Jaguar Sectors | jagSectors | Unsigned Int/5 | Jaguar Sector Bitmask (0-65535) | RMRU, MTB, MTKB, RC |
| Lock ID | lockId | Unsigned Int/5 | Door ID (0-65534) 65535 disables no tour on LE locks | RMRU, MTB, MTKB, RC |
| Group IDs | groupIds | UnsignedInt/5 | Group ID (0-65535) array with up to 16 elements | RMRU, MTB, MTKB, RC |
| Door Prop Delay | doorProp | Unsigned Int/3 | Delay time in seconds (1-255) | SC, MTB, MTKB |
| Propped Door Delay Enable | doorPropEn | String/1 | “T”,“F” | NDE, SC, LE, RMRU, MTB, MTKB, NDEB, LEB |
| ADA Delay | ada | Unsigned Int/3 | Delay time in seconds (1-255) | SC, RMRU, MTB, MTKB |
| First Man In | firstManIn | Int/1 | 0=No First Man In 1= First Man In | SC, RMRU, MTB, MTKB |
| Dog On Next Exit | dneEn | Int/1 | 0=Do not use Dog on Next Exit 1=Schedules Dog on Next Exit | NDE, SC, LE, CTE, MTB, MTKB, NDEB, LEB, RC |
| Battery Fail State | battFail | String/4 | “asIs”, “safe, “sec” | SC, RMRU can only operate as sec, CTE, MTB, MTKB, RC |
| Blink Interior LED when locked | blinkIntLed | String/1 | “T” = enabled , “F” = disabled (default) | NDE, SC, CTE, MTB, MTKB, RC |
| Privacy Rapid blink | rapidBlink | String/1 | “T” = enabled , “F” = disabled (default) | NDE, SC, RMRU, CTE, MTB, MTKB, RC |
| IPB Audit Enable / Disable | ipbAuditEnable | String/1 | “T” = enabled , “F” = disabled (default) | NDE, SC, LE, RMRU, CTE, MTB, MTKB, RC, NDEB, LEB |
| Daylight Savings Time | dstEnable | Int/1 | 0=DST not observed 1=DST observed | MTB, MTKB |
| DST Start | dstStart | String/4 | Hour that clocks are moved ahead by 1 hr. 3=standard month start (1=Jan,…) 0=standard day of week start, 0 = Sun…. 2=standard week # start (1=1st,..5=last) 2=standard hour start US default is 3022 | MTB, MTKB |
| DST End | dstEnd | String /4 | Hour that clocks are moved behind by 1 hour. B=daylight month start 0=daylight day of week start 1=daylight week # start 2=daylight hour start US default is B012 | MTB, MTKB |
| Clock Time | rtcTime | String /14 | “YYYYMMDDHHMMSS” YYYY = Year MM = Month ( 01 – 12 ) DD = Day ( 01 – 31 ) HH = Hour ( 00 – 23 ) MM = Minutes ( 00 – 59 ) SS = Seconds ( 00 – 59 ) Example: “20140710145030” = July 10, 2014, 2:50:30 pm. NOTE 1: this message affects any date/time event (including FW upgrade) so it needs to precede the fwDownldTm and fwImplTm tags. NOTE 2: in order to limit flash write operations, the current rctTime of a device will not be changed if it is already within +/- 5mins of the specified time. For ENGAGE 6.0 Firmware and later this value has been changed to 1 minute for all ENGAGE products. | MTB, MTKB |
| Immediate WiFi Alert Enable | wifiAlertEn | String/1 | “T” = enabled (default), “F” = disabled, “S” = limit immediate alert reporting to the selection made in wifiAlertSel. NOTE: Conflicting settings between this tag and wifiAlertSel (e.g. a list of alerts specified in wifiAlertSel but wifiAlertEn is “F”) will result in the last tag processed being used. | SC, MTB, MTKB, RC |
| Individual WiFi Immediate Alert Selection | wifiAlertSel | Array of String/6s | See separate document for Audit & Alert Definitions (Alert Type Only) | SC, MTB, MTKB, RC |
| Firmware Address | fwurl | String/64 | Max 64 characters NOTE 1: The config PUT from the lock presents a different tag “fwUrl” than what it consumes “fwurl”. NOTE 2: NDE Firmware revisions < 02.06.12 only support a fixed url endpoint: http://<host>/api/firmware/latest It is suggested that a symbolic link or copy of the latest NDE binary firmware be placed at this endpoint if supporting older NDE firmware versions <02.06.12. When using an ENGAGE mobile application to connect to an NDE lock running these older firmware versions, the ‘Update Firmware’ option will be visible and will command these locks to the fixed endpoint for ease of upgrade and to allow updating of a lock to a firmware revision that supports root certificate change. | SC, MTB, MTKB |
| Firmware download Time | fwDwnldTm | String /14 | YYYYMMDDHHMMSS – “20140527040000” May 27, 2014, 4:00:00 am Value of “0” will result in immediate download. NOTE: All revisions of NDE, LE, and SC only support a value of “0” (immediate download) currently. | MTB, MTKB |
| Firmware Implement/Update Time | fwImplTm | String /14 | YYYYMMDDHHMMSS – “20140603030000” June 3, 2014, 3:00:00 am Value of “0” will result in immediate update/implement. NOTE: Prior to ENGAGE 6.0 revisions of NDE, LE, and SC only support a value of “0” (implement immediately) currently. ENGAGE 6.0 and later process this tag as expected. | MTB, MTKB |
| DPS Audits Enable | dpsEn | String/1 | “T”,“F” | SC, MTB, MTKB |
| Beeper En | bprEn | String/1 | “T”,“F” | <R1: no blanks in tables, use N/A or None. |
| Reader Sensitivity | rdrSense | String/4 | "norm", "high", "max" | SC, RMRU, CTE, MTB, MTKB, RC |
| Prox Config HID | proxConfHID | String/1 | “T”,“F” | SC, SCB, RMRU |
| Prox Config GECASI | proxConfGECASI | String/1 | “T”,“F” | SC, SCB, RMRU |
| Prox Config GE4001 | proxConfGE4001 | String/1 | “T” = 4001, “F” = 4002 | SC, SCB, RMRU |
| Prox Config GE4002 | proxConfGE4002 | String/1 | “T” = 4002,“F” = 4001 | SC, SCB, RMRU |
| Prox Config AWID | proxConfAWID | String/1 | “T”,“F” | SC, SCB, RMRU |
| Smart Card 14443 UID | uid14443 | String/1 | “T”,“F” | SC, SCB, RMRU |
| Smart Card 14443 MiFare | mi14443 | String/1 | “T”,“F” | SC, SCB, RMRU |
| Smart Card 14443 MiFare Plus | mip14443 | String/1 | “T”,“F” | RMRU |
| Smart Card 14443 NOC | noc14443 | String/1 | “T”,“F” | RMRU |
| Smart Card 15693 iClass SE | iCls15693 | String/1 | “T”,“F” | NDE, SC, LE, RMRU, CTE, NDEB, LEB, MTB, MTKB, RC |
| Smart Card 15693 UID | uid15693 | String/1 | “T”,“F” | SC, SCB, RMRU |
| Smart Card iClass UID 40 bit CSN | iClsUID40b | String/1 | “T”,“F” | SC, SCB, RMRU |
| PIV Configuration | pivCnfg | String/11 | "disbld","75bPIV", "58bTWIC_CAC", ”14443PIV200b”,"64bBCD_TWIC","83bTWIC_CAC", "66bTWIC_CAC", "64bTWIC", "91bTWIC_CAC", "40bBCD", "40bRevBCD", "64bBCD", "64bRevBCD", "128bBCD", "128bRevBCD", "58bAMAG" | NDE, SC, LE, RMRU, CTE, NDEB, LEB, MTB, MTKB, RC |
| iClass Format | iClsFrmt | String/11 | “disbld”, “64bCSN” | RMRU |
| BLE Credential Enable | bleCredEn | String/1 | “T”, “F” | RMRU, NDE, LE, SC |
| BLE Credential Range | bleCredRng | String/5 | “short”, “long” | RMRU, NDE, LE, SC |
| BLE Performance | blePerf | String/4 | “norm”, “max” | RMRU, NDE, LE, SC, MTB, MTKB, CTE, RC |
| Mag Card Reader Track 1 Enable | magtrk1 | String/1 | “T”,“F” | NDE, SC, LE, RMRU, CTE, MTB, MTKB, NDEB, LEB, SCB, RC |
| Mag Card Reader Track 2 Enable | magtrk2 | String/1 | “T”,“F” | NDE, SC, LE, RMRU, CTE, MTB, MTKB, NDEB, LEB, SCB, RC |
| Mag Card Reader Track 3 Enable | magtrk3 | String/1 | “T”,“F” | NDE, SC, LE, RMRU, CTE, MTB, MTKB, NDEB, LEB, SCB, RC |
| Mag Card Reader Low Power Enable | magLwPwrEn | String/1 | “T”,“F” | NDE, SC, LE, RMRU, CTE, MTB, MTKB, NDEB, LEB, SCB, RC |
| Standby LED Color | ledStbyColor | String/5 | "off", "red", "green", "amber" | NDE, NDEB, LE, LEB, RMRU, SC, SCB |
| Standby LED State | ledStbyState | String/5 | "solid", "flash" | NDE, NDEB, LE, LEB, RMRU, SC, SCB |
| Credential Read LED | ledCredRd | String/5 | "none", "green" | NDE, NDEB, LE, LEB, RMRU, SC, SCB, CTE |
| Backlight Timeout | bckLghtTmOut | Unsigned Int/2 | 0-15, 0 = disabled | NDE, NDEB, SC, SCB, LE, LEB, RMRU, MTB, CTE, MTB, MTKB |
| Keypad Output Format | keypadOutput | String/13 | "4BitNP", "8BitNP", "Galaxy26A", "PCSC4", "PCSC5" | NDE, NDEB, SC, SCB, LE, LEB, RMRU, MTB, CTE |
| Keypad facility code | kpFclCode | Unsigned Int/3 | 0-255 | NDE, NDEB, SC, SCB, LE, LEB, RMRU, MTB, CTE |
| Number of key presses to buffer/cache | kpBuffCache | Unsigned Int/2 | 0-15 | NDE, SC, LE, RMRU, CTE, MTB, MTKB, NDEB, LEB, RC |
| Keystroke Timeout | keystrokeTO | Unsigned Int/2 | 0-15, 0 = disabled | NDE, SC, LE, RMRU, CTE, MTB, MTKB, NDEB, LEB |
| PIN Length | pinLength | Unsigned Int/2 | 3-16, default 6; RC: 0-9, 0 is variable PIN length (user must enter start (*) and stop (#)), acceptable PIN lengths are 1-9 | NDE, SC, LE, RMRU, MTB, MTKB, NDEB, LEB |
| PIN enable (ignore keypad) | pinEn | String/1 | “T”,“F” | NDE, SC, LE, RMRU, MTB, MTKB, NDEB, LEB |
| Clock and Data Format | rdrOutFmt | String/8 | “dsbld”, "format1", "format2", "format3", "format4", "format5", "format6", "format7", "format8", "format9", "format10", "format11", "format12" | NDE, NDEB, SC, SCB, LE, LEB, RMRU, MTB, MTKB, CTE, RC |
| Reader output Format | rdrOutput | String/8 | “wiegand", "clkndata” | NDE, NDEB, SC, SCB, LE, LEB, RMRU, CTE, RC |
| Anti-Tailgate (immediate relock on door close) | immRelockEn | String/1 | “T”,“F” | NDE, SC, LE, RMRU, NDEB, LEB, MTB, MTKB |
| 410-IP Communication Failsafe Mode | gatewayCommFail | String/4 | “asIs”, “sec”, “safe” | NDE, SC, LE, CTE, RMRU does not support “safe”, MTB, MTKB, NDEB, LEB, RC |
| Tamper Cover Removal Failsafe Mode | tamperFail | String/4 | “asIs”, “sec”, “safe” | NDE, SC, LE, CTE, RMRU does not support “safe”, MTB, MTKB, NDEB, LEB, RC does not support "safe" |
| Invalid Card Presented Audit | invCrdAudEn | String/1 | “F”=Do not create an audit for invalid card presentations (Default). “T”= Create an audit for invalid card presentations. NOTE 1: if this configuration is enabled the edge device audits should be checked regularly to ensure that the edge device audit buffer is not inadvertently filled with invalid card presentation audits. NOTE 2: The default for RC-05 is “T”. Since the device reports audits in real time it is not necessary to check the device audits regularly. | RMRU, MTB, MTKB |
| WiFi Download Retry Time Interval | wifiDwnldRtyTmIntv | Unsigned Int/4 | 5-1440 Default Value Setting is 1440 If WiFi event fails, this setting is the number of minutes after the failure that the device should re-try the WiFi event. The retry will continue wifiDwnldRtyCnt times every wifiDwnldRtyTmIntv minutes. | SC, MTB, MTKB, RC |
| WiFi Download Retry Counter | wifiDwnldRtyCnt | Unsigned Int/3 | 1-250 Default Value Setting is 1 If WiFi event fails, this setting is the number of times after the failure that the device should re-try the WiFi event. The retry will continue wifiDwnldRtyCnt times every wifiDwnldRtyTmIntv minutes. | SC, MTB, MTKB, RC |
| Audit ID Enable | auditIDEn | String/1 | “F”= The lock will not send the new unique audit identifier with the audit json (default). “T”= The lock will send the new unique audit identifier with the audit JSON | MTB, MTKB |
| Prevent Construction Mode | blkCnstr | String/1 | “T” = enables prevent construction mode. “F” = disables prevent construction mode (default option). | RMRU, SC, SCB, MTB, MTKB, RC |
| Advanced Security Module (ASM) Enable | asmEn | String/1 | "T", "F" | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| ASM Key | asmKey | String/8 | 4 byte key | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Beep on Tamper | tmprBp | String/1 | "T", "F" | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Tamper Sensitivity | tmprSens | String/4 | "low", "med", "high" | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Network Timeout | ntwkTO | UnsignedInt/3 | Time in seconds (0-30), 0 (default) = decision at door (DaD); NOTE: A non-zero value prescribes Decision at Host (DaH) and the value specifies the amount of time since the last successful communication with the host before the device transitions to DaD. | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Two-Factor Timeout | twoFctrTO | UnsignedInt/3 | Time in seconds (0-30), 10s (default) | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| General Purpose Inputs | gpi | Array | N/A | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Input Type | iType | String/5 | "rex", "auxIn", "dps" | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Input Enable | iEn | String/1 | "T", "F" | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Signal Polarity | pol | String/4 | "high", "low" | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| General Purpose Outputs | gpo | Array | N/A | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Output Type | oType | String/7 | “mainRly”, “ttl1”, “ttl2”; NOTE: The main relay is included here to specify whether the main relay will be activated on a REX or Aux Input. | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Output Enable | oEn | String/1 | "T", "F" | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Signal Polarity | pol | String/4 | "high", "low" | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Mode | mode | String/4 | "puls" (default), "hold" | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Source | src | Array of Strings/9 | ["mirrorRly", "rex", "auxIn", "auxCred", "tamper", "frcdDoor", "prppdDoor"] | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| New Access Point Config | apCfgNew | String/6 | N/A | SC, MTB, MTKB |
| New AP Config Enable | apCfgNewEn | String/1 | “T” = enables new Access Point Config. “F” = disables new Access Point Config (default option). | SC, MTB, MTKB |
| New SSID | ssidNew | String/32 | Max 32 characters | SC, MTB, MTKB |
| New AP Password | psswdNew | String/64 | Max 63 characters | SC, MTB, MTKB |
| New User Name | usrNmNew | String/16 | Max 16 characters | SC, MTB, MTKB |
| New WiFi Security | wifiSecNew | String/7 | “prsnl”, “entrprs”, “open”, ”wep” | SC, MTB, MTKB |
| Config Start Time | apCfgNewStrtTm | String /14 | “YYYYMMDDHHMMSS” | SC, MTB, MTKB |
| Ethernet Configuration | ethConfig | String/9 | N/A | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Host Connection Type | hostProtocol | String/9 | “rs485Rsi”, “ipEngage”, “ipClient”; NOTE: RC only supports ipClient | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Interface ID | interfaceId | String/4 | "eth0", "wlan0"; NOTE: RC only supports eth0 | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Interface Enable | interfaceEnable | String/1 | "T" = enables interface operation, "F" = disables interface operation | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Discovery Method | discoveryMethod | String/6 | "dhcp", "staticIP", "zeroConf"; NOTE: RC supports dhcp and staticIP | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Fixed IP Address, (only applies if discovery method is set to staticIP) | fixedIpAddr | String/15 | "xxx.xxx.xxx.xxx" | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Default Gateway IP Address (only applies if discovery method is set to staticIP) | defGatewayAddr | String/15 | "xxx.xxx.xxx.xxx" | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Netmask (only applies if discovery method is set to staticIP) | netmask | String/15 | "xxx.xxx.xxx.xxx" | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| IP DNS Service | ipDnsAddr | String/15 | "xxx.xxx.xxx.xxx" | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Alternate IP DNS Service | altDnsAddr | String/15 | "xxx.xxx.xxx.xxx" | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| IP Server URL (only applies if hostProtocol is ipClient) | ipServerURL | String/64 | Max 64 characters | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| CA Server URL (only applies if hostProtocol is ipClient) | caServerURL | String/64 | Max 64 characters | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
| Keep Alive Time (only applies if hostProtocol is ipClient) | wsKeepAlive | String/4 | "1" to "3600" seconds | CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB |
The following JSON data structure represents how the data structure might look if the configuration records were being sent to the device.
{
"config":{
"battFail":"sec",
"proxConfGE4001":"T",
"rtcTime":"20140424152753",
"iClsUID40b":"T",
"bprEn":"T",
"proxConfHID":"T",
"uid15693":"T",
"mi14443":"T",
"uid14443":"F",
"proxConfGECASI":"T",
"dstStart":"12b0",
"ada":"30",
"proxConfAWID":"T",
"proxConfGE4002":"F",
"doorProp":20,
"relock":3,
"noc14443":"T",
"dstEnd":"2230",
"firstManIn":0,
"dstEnable":0,
"fwUrl":""
},
"apCfgNew":
{
"apCfgNewEn":"T",
"ssidNew":"02.04.12",
"psswdNew":" G10N\@113",
"usrNmNew":"Cr649",
"wifiSecNew":"entrprs",
"apCfgNewStrtTm":"20140527141029"
}
}
Last Modified: October 24, 2019