Cluster Commands: Door Lock#

This group describes the CLI commands for the Door Lock cluster. Listed below is a description of the cluster:

Provides an interface into a generic way to secure a door.

Macros#

#define
#define
#define
#define

zcl lock unlock-with-timeout [timeoutInSeconds:2] [pin:-1]

#define

zcl lock get-log-record [logIndex:2]

#define

zcl lock set-pin [userId:2] [userStatus:1] [userType:1] [pin:-1]

#define
#define
#define

zcl lock set-user-status [userId:2] [userStatus:1]

#define

zcl lock get-user-status [userId:2]

#define

zcl lock set-weekday-schedule [scheduleId:1] [userId:2] [daysMask:1] [startHour:1] [startMinute:1] [endHour:1] [endMinute:1]

#define

zcl lock get-weekday-schedule [scheduleId:1] [userId:2]

#define

zcl lock clear-weekday-schedule [scheduleId:1] [userId:2]

#define

zcl lock set-yearday-schedule [scheduleId:1] [userId:2] [localStartTime:4] [localEndTime:4]

#define

zcl lock get-yearday-schedule [scheduleId:1] [userId:2]

#define

zcl lock clear-yearday-schedule [scheduleId:1] [userId:2]

#define

zcl lock set-holiday-schedule [scheduleId:1] [localStartTime:4] [localEndTime:4] [operatingModeDuringHoliday:1]

#define

zcl lock get-holiday-schedule [scheduleId:1]

#define

zcl lock clear-holiday-schedule [scheduleId:1]

#define

zcl lock set-user-type [userId:2] [userType:1]

#define

zcl lock get-user-type [userId:2]

#define

zcl lock set-rfid [userId:2] [userStatus:1] [userType:1] [id:-1]

#define
#define
#define

zcl lock set-disposable-schedule [userId:2] [localStartTime:4] [localEndTime:4]

#define

zcl lock get-disposable-schedule [userId:2]

#define

zcl lock clear-disposable-schedule [userId:2]

#define

zcl lock clear-biometric-credential [userId:2]

#define

Macro Definition Documentation#

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_LOCK#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_LOCK

zcl lock lock [PIN:-1]

  • Locks the door

    • PIN - CHAR_STRING


Definition at line 824 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_UNLOCK#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_UNLOCK

zcl lock unlock [PIN:-1]

  • Unlocks the door

    • PIN - CHAR_STRING


Definition at line 830 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_TOGGLE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_TOGGLE

zcl lock toggle [pin:-1]

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

    • pin - CHAR_STRING


Definition at line 836 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_UNLOCK_WITH_TIMEOUT#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_UNLOCK_WITH_TIMEOUT

zcl lock unlock-with-timeout [timeoutInSeconds:2] [pin:-1]

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

    • timeoutInSeconds - INT16U

    • pin - CHAR_STRING


Definition at line 843 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_LOG_RECORD#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_LOG_RECORD

zcl lock get-log-record [logIndex:2]

  • Retrieve a log record at a specified index.

    • logIndex - INT16U


Definition at line 849 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_PIN#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_PIN

zcl lock set-pin [userId:2] [userStatus:1] [userType:1] [pin:-1]


Definition at line 861 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_PIN#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_PIN

zcl lock get-pin [userId:2]

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

    • userId - INT16U


Definition at line 867 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_PIN#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_PIN

zcl lock clear-pin [userId:2]

  • Clear the PIN for a user with a specific user ID

    • userId - INT16U


Definition at line 873 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_ALL_PINS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_ALL_PINS

zcl lock clear-all-pins

  • Clear all PIN codes on the lock for all users.


Definition at line 878 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_USER_STATUS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_USER_STATUS

zcl lock set-user-status [userId:2] [userStatus:1]

  • Set the status value for a specified user ID.

    • userId - INT16U

    • userStatus - INT8U


Definition at line 885 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_USER_STATUS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_USER_STATUS

zcl lock get-user-status [userId:2]

  • Retrieve the status byte for a specific user.

    • userId - INT16U


Definition at line 891 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_WEEKDAY_SCHEDULE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_WEEKDAY_SCHEDULE

zcl lock set-weekday-schedule [scheduleId:1] [userId:2] [daysMask:1] [startHour:1] [startMinute:1] [endHour:1] [endMinute:1]

  • 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


Definition at line 903 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_WEEKDAY_SCHEDULE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_WEEKDAY_SCHEDULE

zcl lock get-weekday-schedule [scheduleId:1] [userId:2]

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

    • scheduleId - INT8U

    • userId - INT16U


Definition at line 910 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_WEEKDAY_SCHEDULE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_WEEKDAY_SCHEDULE

zcl lock clear-weekday-schedule [scheduleId:1] [userId:2]

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

    • scheduleId - INT8U

    • userId - INT16U


Definition at line 917 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_YEARDAY_SCHEDULE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_YEARDAY_SCHEDULE

zcl lock set-yearday-schedule [scheduleId:1] [userId:2] [localStartTime:4] [localEndTime:4]

  • 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


Definition at line 926 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_YEARDAY_SCHEDULE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_YEARDAY_SCHEDULE

zcl lock get-yearday-schedule [scheduleId:1] [userId:2]

  • Retrieve a yearday schedule for a specific scheduleId and userId

    • scheduleId - INT8U

    • userId - INT16U


Definition at line 933 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_YEARDAY_SCHEDULE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_YEARDAY_SCHEDULE

zcl lock clear-yearday-schedule [scheduleId:1] [userId:2]

  • Clear a yearday schedule for a specific scheduleId and userId

    • scheduleId - INT8U

    • userId - INT16U


Definition at line 940 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_HOLIDAY_SCHEDULE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_HOLIDAY_SCHEDULE

zcl lock set-holiday-schedule [scheduleId:1] [localStartTime:4] [localEndTime:4] [operatingModeDuringHoliday:1]

  • Set the holiday schedule for a specific user

    • scheduleId - INT8U

    • localStartTime - INT32U

    • localEndTime - INT32U

    • operatingModeDuringHoliday - ENUM8


Definition at line 949 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_HOLIDAY_SCHEDULE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_HOLIDAY_SCHEDULE

zcl lock get-holiday-schedule [scheduleId:1]

  • Retrieve a holiday schedule for a specific scheduleId

    • scheduleId - INT8U


Definition at line 955 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_HOLIDAY_SCHEDULE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_HOLIDAY_SCHEDULE

zcl lock clear-holiday-schedule [scheduleId:1]

  • Clear a holiday schedule for a specific scheduleId

    • scheduleId - INT8U


Definition at line 961 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_USER_TYPE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_USER_TYPE

zcl lock set-user-type [userId:2] [userType:1]

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


Definition at line 970 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_USER_TYPE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_USER_TYPE

zcl lock get-user-type [userId:2]

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

    • userId - INT16U


Definition at line 976 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_RFID#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_RFID

zcl lock set-rfid [userId:2] [userStatus:1] [userType:1] [id:-1]


Definition at line 988 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_RFID#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_RFID

zcl lock get-rfid [userId:2]

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

    • userId - INT16U


Definition at line 994 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_RFID#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_RFID

zcl lock clear-rfid [userId:2]

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

    • userId - INT16U


Definition at line 1000 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_ALL_RFIDS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_ALL_RFIDS

zcl lock clear-all-rfids

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


Definition at line 1005 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_DISPOSABLE_SCHEDULE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_DISPOSABLE_SCHEDULE

zcl lock set-disposable-schedule [userId:2] [localStartTime:4] [localEndTime:4]

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

    • userId - INT16U

    • localStartTime - INT32U

    • localEndTime - INT32U


Definition at line 1013 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_DISPOSABLE_SCHEDULE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_DISPOSABLE_SCHEDULE

zcl lock get-disposable-schedule [userId:2]

  • Retrieve the disposable schedule for the specific user.

    • userId - INT16U


Definition at line 1019 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_DISPOSABLE_SCHEDULE#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_DISPOSABLE_SCHEDULE

zcl lock clear-disposable-schedule [userId:2]

  • Clear the Disposable schedule for the specific user

    • userId - INT16U


Definition at line 1025 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_BIOMETRIC_CREDENTIAL#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_BIOMETRIC_CREDENTIAL

zcl lock clear-biometric-credential [userId:2]

  • Clear the Biometric Credential for the specific user

    • userId - INT16U


Definition at line 1031 of file app/framework/test/headers/cli.doc

EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_ALL_BIOMETRIC_CREDENTIALS#

#define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_ALL_BIOMETRIC_CREDENTIALS

zcl lock clear-all-biometric-credentials

  • Clear out all Biometric Credentials on the lock


Definition at line 1036 of file app/framework/test/headers/cli.doc