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
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_LOCK

zcl lock lock [PIN:-1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_UNLOCK

zcl lock unlock [PIN:-1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_TOGGLE

zcl lock toggle [pin:-1]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_UNLOCK_WITH_TIMEOUT

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_LOG_RECORD

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_PIN

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_PIN

zcl lock get-pin [userId:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_PIN

zcl lock clear-pin [userId:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_ALL_PINS

zcl lock clear-all-pins

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_USER_STATUS

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_USER_STATUS

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

#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]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_WEEKDAY_SCHEDULE

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_WEEKDAY_SCHEDULE

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_YEARDAY_SCHEDULE

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_YEARDAY_SCHEDULE

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_YEARDAY_SCHEDULE

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_HOLIDAY_SCHEDULE

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_HOLIDAY_SCHEDULE

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_HOLIDAY_SCHEDULE

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_USER_TYPE

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_USER_TYPE

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_RFID

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_RFID

zcl lock get-rfid [userId:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_RFID

zcl lock clear-rfid [userId:2]

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_ALL_RFIDS

zcl lock clear-all-rfids

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_DISPOSABLE_SCHEDULE

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_GET_DISPOSABLE_SCHEDULE

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_DISPOSABLE_SCHEDULE

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_BIOMETRIC_CREDENTIAL

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

#define
EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_CLEAR_ALL_BIOMETRIC_CREDENTIALS

zcl lock clear-all-biometric-credentials