Allegion Developer Portal

Auto_Unlock_Records

Auto Unlock Records

Auto unlock records are device specific events that describe when the device should be put into secure or passage mode based upon a specific day of the week and time. An auto-unlock record only describes when the device should change its current state. In order to put the device back to its original state, an additional auto unlock record is required. For many doors, a good “rule of thumb” is to have an auto-lock schedule, scheduled for midnight. This way if someone toggles a device unlocked during the day, the door will relock itself at midnight.

In the event that the existing auto unlock record needs to be deleted from the device, and not replaced with a new set of auto unlockevents, then an ID empty tag of “[ ]” is sent from the host. Auto unlock must be explicitly defined for every database structure provided to the device, even if previously defined. The table below describes each of the fields associated with an auto unlock record.

 

Auto Unlock Record Fields

Tag

JSON Short Tag

Type/Length (ASCII bytes)

Value

Device Exclusions

Database Block

db

String/2

N/A

SC, MTB, MTKB

Auto Unlock Block

autoUnlock

String/10

N/A

SC, MTB, MTKB

Action

action

String/4

“pass” “sec”

SC, MTB, MTKB

Start Hour

strtHr

Unsigned Int/2

Hr, where HR can be 0 - 23

SC, MTB, MTKB

Start Min

strtMn

Unsigned Int/2

Min, where Min can be 0 - 59

SC, MTB, MTKB

Day

days

Array of String/2s

[ “Su”, “Mo”, “Tu”, “We”, “Th”, “Fr”, “Sa” ]      

SC, MTB, MTKB

 

Example of Auto Unlock Records (JSON)

The following JSON data structure represents how the data structure might look if the auto event records were being sent to the device.

{
  “db”: {
    "autoUnlock": [
      {
        "action": "pass",
        "strtHr": 8,
        "strtMn": 0,
        "days": ["Mo","Tu","We","Th","Fr" ]
      },
      {
        "action": "sec",
        "strtHr": 17,
        "strtMn": 0,
        "days": ["Mo","Tu","We","Th","Fr" ]
      }
    ]
  }
}

Delete Auto Unlock Event Records

There may be instances when auto unlock records need to be deleted from the device. The host must be able to provide a JSON data structure that permits this operation.

The following JSON structure represents how auto unlock records would be erased from the device during a database update.

{
 “db”:{
  "autoUnlock": []
 }
}

Last Modified: October 24, 2019