Cluster Commands: Door Lock#

Locks the door

• PIN - CHAR_STRING

Unlocks the door

• PIN - CHAR_STRING

Toggles the door lock from its current state to the opposite state locked or unlocked.

• pin - CHAR_STRING

Unlock the door with a timeout. When the timeout expires, the door will automatically re-lock.

• timeoutInSeconds - INT16U

• pin - CHAR_STRING

Retrieve a log record at a specified index.

• logIndex - INT16U

Set the PIN for a specified user id.

• userId - INT16U

• userStatus - DoorLockUserStatus [ENUM8]

• userType - DoorLockUserType [ENUM8]

• pin - CHAR_STRING See Also

  • EmberAfDoorLockUserStatusEmberAfDoorLockUserType

Retrieve PIN information for a user with a specific user ID.

• userId - INT16U

Clear the PIN for a user with a specific user ID

• userId - INT16U

Clear all PIN codes on the lock for all users.

Set the status value for a specified user ID.

• userId - INT16U

• userStatus - INT8U

Retrieve the status byte for a specific user.

• userId - INT16U

Set the schedule of days during the week that the associated user based on the user ID will have access to the lock and will be able to operate it.

• scheduleId - INT8U

• userId - INT16U

• daysMask - DoorLockDayOfWeek [BITMAP8]

• startHour - INT8U

• startMinute - INT8U

• endHour - INT8U

• endMinute - INT8U

Retrieve a weekday schedule for doorlock user activation for a specific schedule id and user id.

• scheduleId - INT8U

• userId - INT16U

Clear a weekday schedule for doorlock user activation for a specific schedule id and user id.

• scheduleId - INT8U

• userId - INT16U

Set a door lock user id activation schedule according to a specific absolute local start and end time

• scheduleId - INT8U

• userId - INT16U

• localStartTime - INT32U

• localEndTime - INT32U

Retrieve a yearday schedule for a specific scheduleId and userId

• scheduleId - INT8U

• userId - INT16U

Clear a yearday schedule for a specific scheduleId and userId

• scheduleId - INT8U

• userId - INT16U

Set the holiday schedule for a specific user

• scheduleId - INT8U

• localStartTime - INT32U

• localEndTime - INT32U

• operatingModeDuringHoliday - ENUM8

Retrieve a holiday schedule for a specific scheduleId

• scheduleId - INT8U

Clear a holiday schedule for a specific scheduleId

• scheduleId - INT8U

Set the type value for a user based on user ID.

• userId - INT16U

• userType - DoorLockUserType [ENUM8] See Also

  • EmberAfDoorLockUserType

Retrieve the type for a specific user based on the user ID.

• userId - INT16U

Set the PIN for a specified user id.

• userId - INT16U

• userStatus - DoorLockUserStatus [ENUM8]

• userType - DoorLockUserType [ENUM8]

• id - CHAR_STRING See Also

  • EmberAfDoorLockUserStatusEmberAfDoorLockUserType

Retrieve RFID ID information for a user with a specific user ID.

• userId - INT16U

Clear the RFID ID for a user with a specific user ID

• userId - INT16U

Clear all RFID ID codes on the lock for all users.

Set the Disposable Schedule by specifying local start time and local end time for the specific user.

• userId - INT16U

• localStartTime - INT32U

• localEndTime - INT32U

Retrieve the disposable schedule for the specific user.

• userId - INT16U

Clear the Disposable schedule for the specific user

• userId - INT16U

Clear the Biometric Credential for the specific user

• userId - INT16U

Clear out all Biometric Credentials on the lock