Allegion Developer Portal

Retrievable_Parameters

Retrievable Parameters

When a host makes a request to the device for information that resides in the device, it receives all of the retrievable parameters for that device at that time.

Device Profile

Later firmware versions of ENGAGE devices include a section that defines the type and any special type variances (called extensions) supported by the device as part of a dvcProfile block contained at the beginning of the config block.

To support a standard of JSON configs moving into the future, the standard is for all device profiles to be implemented as integers. 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.

 

Currently Established Non-Integer Tags

Tag

Short Tag

Type/Length (ASCII bytes)

Value

Device Profile

dvcProfile

Section Heading

N/A

Base Type

baseType

String/8

“rmru”, “nde”, “le”, “mt20w”, “cte”, “be467”, “gwe”, "ndeb", "leb", "be467b", "mtb", "mtkb15", "rc05"  <Q1:should these be CAP?>

Extensions

ext

Array

Array of structures of following types: <Q2:missing info?>

Extension’s name

key

String/15

See Extensions & Supported Custom Arguments table for extension key, custom argument (value) combinations

Extension custom argument

value

String/15

<R1: no blanks in tables, use N/A or None>

 

Extensions & Supported Custom Arguments

Extension key

Extension value

Device Associated <Q3:should these be CAP?>

undog

empty

rmru

WiFiTest

0 = unsupported; 1 = Full Update Server; 2 = Fast Connection Attempt

nde, le, rmru, mt20w, cte, ndeb, leb

jsonHmac

0 = unsupported; 1 = HMAC Rev 0 Supported

nde, le, sc, rmru, cte, ndeb, leb, scb, rc

dupAuditDet

0 = unsupported; 1 = Duplicate Audit Detection supported (auditId provided with audit JSON)

nde, le, sc, rmru, cte, ndeb, leb, scb, rc

fwUrlMethod

0 = unsupported; 1 = Full URL Sent (Pre-ENGAGE 6.2 firmware will continue support of "URL Path only"); 2 = URL Path only (Server name or address removed)

mt20w

getAuditNoErase

0 = unsupported; 1 = Retrieve Audits without Erase supported

nde, le, sc, rmru, cte, ndeb, leb, scb, rc

gweSiteSurvey

0 = unsupported; 1 = Site Survey JSON Definition Version 1

gwe

newAPCfg

0 = unsupported; 1 = New Access Point Configuration Supported

nde, le, rmru, cte, ndeb, leb

usbMode

0 = unsupported; 1 = supports USB communication mode

mt20w

crdRdr

0 = unsupported; 1 = supports Card Reader configs

cte, rc

bleRdrCfg

0 = unsupported; 1 = supports BLE Credential reader configs

cte, rc

bleCred

0 = unsupported; 1 = supports BLE Credential Configuration

ndeb, leb, mtb, mtkb15, scb, rc

ipbEnabled

0 = unsupported; 1 = supports IPB Configuration Supported

ndeb

keyPad

0 = unsupported; 1 = supports Keypad configuration

mtkb, rc

cnstrBlock

0 = unsupported; 1 = supports prevent construction mode

nde, le, cte, ndeb, leb

 

External Device Parameters

The table below shows a complete list of all the JSON data tags and values that can be read by an external device. Some of the retrievable parameters are device specific and may not apply to all devices.

ENGAGE devices report all retrievable parameters in one large block, and include some parameters that may not directly apply to the device or its mode of operation. For example; RSI protocol capable devices might report RSI parameters when the device is not configured for RSI protocol operation.

See the Device Settings section, below this table, for an example of this data structure.

 

Retrievable Parameters

Tag

Short Tag

Type/Length (ASCII bytes)

Value

Device Exclusions

Battery Voltages

battV

String/5

N/A

MTB, MTKB, RC

Main

main

String/5

“x.x” to “xx.xx”

CTE, MTB, MTKB, RC

Lithium

li

String/5

“x.x” to “xx.xx” (This is always reported as a value of 0 for NDE, LE, and RMRU) when reported from the GWE.

CTE, SC, MTB, MTKB, RC

Line Voltages

lineV

String/5

N/A

<R1: N/A or None>

Main

main

String/5

“x.x” to “xx.xx”

NDE, LE, SC, RMRU, NDEB, LEB

Power input

power

String/4

“poe”, “poe+”, “line”

NDE, LE, SC, RMRU, NDEB, LEB, MTB, MTKB, RC does not support "poe+"

Firmware Versions

fwVer

String/5

N/A

<R1: N/A or None>

Lock

lock

String/8

“xx.xx.xx”

<R1: N/A or None>

Main

main

String/8

“xx.xx.xx”

<R1: N/A or None>

Credential Reader

credRdr

String/8

“xx.xx.xx”

SC, RMRU

Bluetooth Module

ble

String/8

“xx.xx.xx”

<R1: N/A or None>

WiFi Module

wifi

String/8

“xx.xx.xx”

SC, MTB, MTKB, RC

Main Bootloader

mainBl

String/8

“xx.xx.xx”

<R1: N/A or None>

Credential Reader Bootloader

credRdrBl

String/8

“xx.xx.xx”

SC, RMRU, CTE

WiFi MAC Address

macAdr

String/17

“xx.xx.xx.xx.xx.xx”

SC, MTB, MTKB, RC

Safe Mode Recovery FW version

recoveryFwVer

String/8

“xx.xx.xx”

SC, MTB, MTKB, RC

Ethernet module

ethernet

String/8

“xx.xx.xx”

SC, RMRU, LE, NDE, NDEB, LEB, MTB, MTKB, RC

Ethernet module bootloader

ethernetBl

String/8

“xx.xx.xx”

NDE, SC, RMRU, LE, NDEB, LEB, MTB, MTKB, RC

Ethernet MAC Address

ethernetMacAdr

String/17

“xx.xx.xx.xx.xx.xx”

NDE, SC, RMRU, LE, NDEB, LEB, MTB, MTKB

Reader Main

rdrMain

String/8

“xx.xx.xx”

CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB

Reader Main Bootloader

rdrMainBl

String/8

“xx.xx.xx”

CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB

WiFi Settings

wifiStngs

String/8

N/A

SC, MTB, MTKB, RC

SSID

ssid

String/32

Max 32 characters

SC, MTB, MTKB, RC

AP Password / Security Key

psswd

String/64

Max 63 characters

SC, MTB, MTKB, RC

User Name

usrNm

String/16

Max 16 characters

SC, MTB, MTKB, RC

WiFi Security

wifiSec

String/7

“prsnl”, “entrprs”, “open”, “wep”

SC, MTB, MTKB, RC

Key Index

kyIndx

Unsigned Int/1

1,2,3,4

SC, MTB, MTKB, RC

Discovery Type

dscvryTyp

String/6

“ipAddr”, “dmnNm”, “srvcNm”

SC, MTB, MTKB, RC

Secure Connection

scrCnn

String/5

“http”, “https”

SC, MTB, MTKB, RC

IP

Ip

String/15

“xxx.xxx.xxx.xxx”

SC, MTB, MTKB, RC

IP DNS Service

ipDNS

String/64

Max 64 characters

SC, MTB, MTKB, RC

Alternate IP DNS Service

altDNS

String/64

Max 64 characters

SC, NDE, LE, RMRU, CTE, NDEB, LEB, MTB, MTKB, RC

New Access Point Config

apCfgNew

String/6

N/A

SC, MTB, MTKB, RC

New AP Config Enable

apCfgNewEn

String/1

“T” = enables new Access Point Config. “F” = disables new Access Point Config (default option).

SC, MTB, MTKB, RC

New SSID

ssidNew

String/32

Max 32 characters

SC, MTB, MTKB, RC

New AP Password

psswdNew

String/64

Max 63 characters

SC, MTB, MTKB, RC

New User Name

usrNmNew

String/16

Max 16 characters

SC, MTB, MTKB, RC

New WiFi Security

wifiSecNew

String/7

“prsnl”, “entrprs”, “open”, ”wep”

SC, MTB, MTKB, RC

Config Start Time

apCfgNewStrtTm

String /14

“YYYYMMDDHHMMSS”

SC, MTB, MTKB, RC

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

Lock Parameters

lockPrmtrs

String/8

N/A

<R1: N/A or None>

Name

name

String/32

“xxxx….….xxxx”

<R1: N/A or None>

Model

mdl

String/6

“nde”, “be467”, “fe410”, “lems”, “lemb”, “lemd”, “rm”, “ru”, “cte”, "ndeb", "lebms", "lebmb", "lebmd", "be467b", "fe410b", "mtb11", "mtb15", "mtkb15", "rc05m", "rc05w", "rc05wk", "rc11", "rc15", "rck15"

<R1: N/A or None>

Lock Operation Mode

lckMode

String/8

“null”, “200”, “210”, “310”, “410rsi”, “410ip”

MTB, MTKB, 200 mode not supported on RMRU

Lock Serial Number

lckSn

String/16

“xxxx….….xxxx”

<R1: N/A or None>

Main Serial Number

mainSn

String/16

“xxxx….….xxxx”

<R1: N/A or None>

Mfg Date

mfgDt

String/8

“YYYYMMDD” YYYY = Year MM = Month (01 – 12) DD = Day (01 – 31) Example: “20140527” means May 27, 2014

<R1: N/A or None>

Days In Use

daysInUse

Unsigned Int/5

0 – 65536

SC

Warranty Activation date

wtyAct

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” means July 10, 2014, 2:50:30 pm

NDE, LE, RMRU, CTE, NDEB, LEB, MTB, MTKB, RC

Hardware Version

hwVer

String/6

“xxxxxx”

<R1: N/A or None>

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” means July 10, 2014, 2:50:30 pm

MTB, MTKB

Type

type

String/6

“strm” “clsrm” “office” “dorm” “apt” “prvcy”

SC, RMRU, MTB, MTKB

Relock

relock

Unsigned Int/3

Delay time in seconds (0-254)

RMRU, MTB, MTKB

Door Prop Delay

doorProp

Unsigned Int/3

Delay time in seconds (0-254)

SC, MTB, MTKB

Door Prop Delay Enable

doorPropEn

String/1

“T” = enabled, “F” = disabled

NDE, LE, SC, RMRU, NDEB, LEB, MTB, MTKB

ADA Delay

ada

Unsigned Int/3

Delay time in seconds (0-254)

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, NDEB, LEB, MTB, MTKB, RC

Battery Fail State

battFail

String/4

“asIs”, “safe, “sec”

SC, RMRU can only operate as sec, CTE, MTB, MTKB, RC

Daylight Saving 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

Next Database Download Time

dbDwnldTm

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: “20140527154102” means May 27, 2014, 3:41:02 pm

SC, MTB, MTKB

Firmware Address

fwUrl

String/64

Max 64 characters NOTE: this is fwUrl though it conveys the same information as fwurl.

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.

SC, MTB, MTKB

Firmware Implement/Update Time

fwImpTm

String /14

YYYYMMDDHHMMSS – “20140603030000” June 3, 2014, 3:00:00 am. Value of “0” will result in immediate update/implement.

SC, MTB, MTKB

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

Next Database Version Time Stamp

nxtDbVerTS

String/18

Hexadecimal value, that starts with 0x, followed by 16 hex digits. (i.e. “0x08d16357eef73a69”)

MTB, MTKB

Immediate WiFi Alert Enable

wifiAlertEn

String/1

“T” = enabled (default), “F” = disabled

SC, MTB, MTKB, RC

Individual WiFi Immediate Alert Selection

wifiAlertSel

Array of Strings/6

See separate document for Audit & Alert Definitions (Alert Type Only)

SC, MTB, MTKB, RC

Blink Interior LED when locked

blinkIntLed

String/1

“T” = enabled, “F” = disabled

NDE, SC, CTE, MTB, MTKB, RC

Privacy Rapid blink

rapidBlink

String/1

“T” = enabled, “F” = disabled

NDE, SC, RMRU, CTE, MTB, MTKB, RC

IPB Audit Enable / Disable

ipbAuditEnable

String/1

“T” = enabled, “F” = disabled

NDE, SC, LE, RMRU, CTE, MTB, MTKB, RC, NDEB, LEB

Hardware Configuration

hwCfg

String/6

"ipb", "dbolt", "strm"

NDE, SC, RMRU, NDEB, MTB, MTKB, RC

Lock ID

lockId

Unsigned Int/5

Door ID (0-65534) 65535 no tour disabled on LE locks

NDE, RMRU, MTB, MTKB, RC

Number of motor cycle counts

numCycles

Usigned Int/32

0 - 4294967295

NDE, LE, RMRU, NDEB, LEB, MTB, MTKB, RC

DPS Audit Enable

dpsEn

String/1

“T” or “F”

SC, MTB, MTKB

Database Update Status

dbUpdateStatus

Unsigned Int/3

0=Reset/download not started. 1=JSON data Download completed. 2=DB Update Completed.

SC, RMRU, MTB, MTKB

PIN Length

pinLength

Unsigned Int/2

3-16, RC: 0-9, 0 is variable PIN length (user must enter start (*) and stop(#)), acceptable PIN lengths are 1-9

NDE, SC, LE, RMRU, NDEB, LEB, MTB, MTKB

PIN Enable

pinEn

String/1

“T” or “F”

NDE, SC, LE, RMRU, NDEB, LEB, MTB, MTKB

Anti-Tailgate (Immediate relock on door close)

immRelockEn

String/1

“T” or “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”, NDEB, LEB, MTB, MTKB

Tamper Cover Removal Failsafe Mode

tamperFail

String/4

“asIs”, “sec”, “safe”

NDE, SC, LE, CTE, RMRU does not support “safe”, NDEB, LEB, MTB, MTKB, 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

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

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

Communication Mode

commMode

String/4

“usb” or “wifi”

NDE, LE, SC, RMRU, CTE, NDEB, LEB, MTB, MTKB, RC

Initial TimeStamp

initTS

String/14

“YYYYMMDDHHMMSS”– “20140704030000” means July 4, 2014, 3:00:00 am

NDE, LE, SC, RMRU, CTE, NDEB, LEB, MTB, MTKB, RC

Prevent Construction Mode

blkCnstr

String/1

“T” or “F”

RMRU, SC, SCB, MTB, MTKB

Advanced Security Module (ASM) Enable

asmEn

String/1

"T", "F"

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

PACS

pacs

String/7

"ISONAS", "Schlage"

CTE, LE, LEB, MTB, MTKB, NDE, NDEB, RMRU, SC, SCB

Reader Parameters

rdrPrmtrs

String/7

N/A

RMRU

BLE Reader Name

bleRdrName

String/25

“xxxx......xxxx”

NDE, NDEB, LE, LEB, RMRU, SC, SCB, MTB, MTKB, RC

Beeper Enable

bprEn

String/1

“T” or “F”

<R1: N/A or None>

Reader Sensitivity

rdrSense

String/4

"norm", "high", "max"

SC, RMRU, CTE, MTB, MTKB, RC

Days In Use

daysInUse

Unsigned Int/5

0 - 65536

SC, SCB, RMRU

Serial Number

sn

String 10

“xxxxxxxxxx”

SC, SCB, RMRU

Hardware Version

hwVer

String/6

“xxxxxx”

SC, SCB, RMRU

Manufacture Date

mfgDt

String/8

“YYYYMMDD” YYYY = Year MM = Month (01 – 12) DD = Day (01 – 31) Example: “20140527” means May 27, 2014

SC, SCB, RMRU

Config Card Presented Status (Read Only)

configCrdPrsntd

String/1

“T”,“F”

RMRU, SCB, SC, CTE

Prox Config HID

proxConfHID

String/1

“T”,“F”

SC, RMRU, SCB

Prox Config GECASI

proxConfGECASI

String/1

“T”,“F”

SC, RMRU, SCB

Prox Config GE4001

proxConfGE4001

String/1

“T” = 4001, “F” = 4002

SC, RMRU, SCB

Prox Config GE4002

proxConfGE4002

String/1

“T” = 4002, ”F” = 4001

SC, RMRU, SCB

Prox Config AWID

proxConfAWID

String/1

“T”,“F”

SC, RMRU, SCB

Smart Card 14443 UID

uid14443

String/1

“T”,“F”

RMRU, SCB, SC

Smart Card 14443 MiFare

mi14443

String/1

“T”,“F”

RMRU, SCB, SC

Smart Card 14443 MiFare Plus

mip14443

String/1

“T”,“F”

SC, RMRU, SCB

Smart Card 14443 NOC

noc14443

String/1

“T”,“F”

SC, RMRU

Smart Card 15693 iClass SE

iCls15693

String/1

“T”,“F”

NDE, SC, RMRU, CTE, LE, NDEB, LEB, MTB, MTKB, RC

Smart Card 15693 UID

uid15693

String/1

“T”,“F”

RMRU, SCB, SC

Smart Card iClass UID 40 bit CSN

iClsUID40b

String/1

“T”,“F”

RMRU, SCB, SC

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”

SC, RMRU, SCB

Mag Card Reader Track 1 Enable

magtrk1

String/1

“T”,“F”

NDE, SC, LE, RMRU, CTE, NDEB, LEB, MTB, MTKB, RC

Mag Card Reader Track 2 Enable

magtrk2

String/1

“T”,“F”

NDE, SC, LE, RMRU, CTE, NDEB, LEB, MTB, MTKB, RC

Mag Card Reader Track 3 Enable

magtrk3

String/1

“T”,“F”

NDE, SC, LE, RMRU, CTE, NDEB, LEB, MTB, MTKB, RC

Mag Card Reader Low Power Enable

magLwPwrEn

String/1

“T”,“F”

NDE, SC, LE, RMRU, CTE, NDEB, LEB, MTB, MTKB, 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, MTKB, CTE

Keypad Output Format

keypadOutput

String/10

"4BitNP", "8BitNP", "Galaxy26A", "PCSC4", "PCSC5"

NDE, SC, LE, RMRU, LEB, NDEB, SCB, MTB, CTE, RC

Keypad facility code

kpFclCode

Unsigned Int/3

0-255

NDE, NDEB, SC, SCB, LE, LEB, RMRU, MTB, RC

Number of key presses to buffer/cache

kpBuffCache

Unsigned Int/2

0-15

NDE, SC, LE, RMRU, CTE, NDEB, LEB, MTB, MTKB, RC

Keystroke Timeout

keystrokeTO

Unsigned Int/2

0-15, 0 = disabled

NDE, SC, LE, RMRU, CTE, NDEB, LEB, MTB, MTKB

Custom Key Installation Status

customKeyPrsntd

String/1

“T”,“F”

RMRU, SC, CTE

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, RC

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

Device Parameters

rsiPrmtrs

String/8

N/A

<R1: N/A or None>

Deny Access

dnyAccs

String/1

“T”,“F”

RMRU, CTE, MTB, MTKB

Relock Method

relockMethod

String/9

“tmr”, “drOpn”, “drCls”

SC, RMRU, CTE, MTB, MTKB

Heartbeat Time

rsiHrtbtTm

Unsigned Int/5

0 – 65535

CTE, MTB, MTKB

Retry times

rsiRtryTm

Unsigned Int/2

1-15

CTE, MTB, MTKB

Subsequent Delay

rsiSubqtDly

Unsigned Int/2

1-15

CTE, MTB, MTKB

First Delay

rsiFrstDly

Unsigned Int/2

1-15

CTE, MTB, MTKB

Cache memory bits per card

cacheMemBts

Unsigned Int/3

0-255

RMRU, CTE, MTB, MTKB

Clear cache entries

clrCache

String/1

“T”,“F”

RMRU, CTE, MTB, MTKB

Auto purge

autoPrg

String/1

“T”,“F”

RMRU, CTE, MTB, MTKB

Communication Failsafe mode

rsiCommFailSfMd

String/6

“disbld”,“sec”,”safe”

CTE, MTB, MTKB

Cache memory mode

cacheMemMd

String/7

“full”,“fcltyCd”

RMRU, CTE, MTB, MTKB

Maximum number of cache entries

maxCacheEntries

Unsigned Int/3

0-255

RMRU, CTE, MTB, MTKB

PIN-Required Mode

pinReqMode

String/12

“disbld”, “GrnRedNoBeep”, “GrnRedBeep2”

RMRU, CTE, MTB, MTKB

Request to Enter Inquiry Enable

renInquiry

String/1

“T”,“F”

RMRU, CTE, MTB, MTKB

IPB LED Blink Enable

ipbLedBlink

String/1

“T”,“F”

NDE, SC, CTE, MTB, MTKB

IPB Online Configuration Enable Lock/Unlock

ipbOnlineCfg

String/8

“disbld”,“lckUnlk”

NDE, SC, RMRU, CTE, MTB, MTKB

IPB Offline Configuration

ipbOfflineCfg

String/8

“disbld”,“lckUnlk”,“dsbRdr”

NDE, SC, RMRU, CTE, MTB, MTKB

IPB Long Press

ipbLongPress

Unsigned Int/2

0-15

NDE, SC, RMRU, CTE, MTB, MTKB

RSI APM Type

rsiApmType

Unsigned Int/2

00 to 13 reserved (see RSI doc); 14 = NDE; 15 = ADE; 16 = BE467/FE410/BE467B; 17 = LE/LEB; 18 = RMRU; 19 = NDEB

CTE, MTB, MTKB

RSI Reader Type

rsiRdrType

Unsigned Int/3

00 to 66 reserved (see RSI doc); 67 = NDE_MT2_NO_KPD; 68 = CONTROL_SM2_NO_KPD; 69 = LE_MT2_NO_KPD; 255 = No Model Information

RMRU, CTE, MTB, MTKB

 

NOTE: For ENGAGE 6.1 and later devices, devices configured for IP or stand-alone communication may not transmit their RSI parameters (rsiPrmtrs) or any children tags under the RSI parameters as they are not relevant to IP or stand-alone operation. The device accepts any changes to the RSI parameters if they are provided to the device, however the device does not provide the updated information back to the host.

 

Device Settings

This section gives an example of how the data is structured by the device when a request is made for the device parameters. These parameters are broken down into 5 different components so that redundant tags can be used.

Example Data Structure

When a mobile device connects to a device, the device reports a set of parameters to the mobile device. This is an example of the data structure that would be returned by the device.

{
   "dvcProfile":
   {
           "baseType":"nde",
           "key":"NewAPCfg",
           "value":"1"
   },
   "battV":
   {
           "main":"5.87",
           "li":"2.99"
   },
   "fwVer":
   {
           "main":"01.03.11",
           "credRdr":"01.02.10",
           "ble":"01.02.10",
           "wifi":"01.05.10",
           "mainBl":"00.01.03",
           "credRdrBl":"00.01.01"
   },
   "wifiStngs":
   {
           "ssid":"01.03.11",
           "psswd":"\@113G10N",
           "usrNm":"Br549",
           "wifiSec":"entrprs",
           "encrypt":"wep",
           "kyIndx":4,
           "dscvryTyp":"ipAddr",
           "scrCnn": "http",
           "ip":"196.23.43.113",
           "dns":"firstChoice",
           "altDNS":"secondChoice"
   },
   "apCfgNew":
   {
           "apCfgNewEn":"T",
           "ssidNew":"02.04.12",
           "psswdNew":" G10N\@113",
           "usrNmNew":"Cr649",
           "wifiSecNew":"entrprs",
           "apCfgNewStrtTm":"20140527160629"
   },
   "lckPrmtrs":
   {
           "nm":"corner office",
           "mdl": "nde",
           "lckSn":"1122334455",
           "mnSn":"2233445566",
           "mfgDt":"20140607",
           "daysInUse":145,
           "hwVer":"c1",
           "type":"strm",
           "relock":1,
           "doorProp":20,
           "ada":30,
           "firstManIn":0,
           "dstEnable":0,
           "dstStart": "3022",
           "dstEnd": "B012",
           "battFail": "sec",
           "rtcTime": "20140527140629",
           "dbDwnldTm":"20140528020000"
   },
   "rdrPrmtrs":
   {
           "bprEn": "T",
           "sn":"4455667788",
           "mfgDt":"20140607",
           "daysInUse":145,
           "hwVer":"c1"
   }
}

Last Modified: October 25, 2019