Cluster Commands: Door Lock
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_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_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
|
|
Detailed Description
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.
Macro Definition Documentation
| #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.
| #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
| #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
| #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
| #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
| #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
| #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
| #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
| #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
| #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
| #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
| #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
| #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
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_LOCK |
zcl lock lock [PIN:-1]
-
Locks the door
- PIN - CHAR_STRING
| #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
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_PIN |
zcl lock set-pin [userId:2] [userStatus:1] [userType:1] [pin:-1]
-
Set the PIN for a specified user id.
- userId - INT16U
- userStatus - DoorLockUserStatus [ENUM8]
- userType - DoorLockUserType [ENUM8]
- pin - CHAR_STRING
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_SET_RFID |
zcl lock set-rfid [userId:2] [userStatus:1] [userType:1] [id:-1]
-
Set the PIN for a specified user id.
- userId - INT16U
- userStatus - DoorLockUserStatus [ENUM8]
- userType - DoorLockUserType [ENUM8]
- id - CHAR_STRING
| #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.
- userId - INT16U
-
userType - DoorLockUserType [ENUM8]
- See also
- EmberAfDoorLockUserType
| #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
| #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
| #define EMBER_AF_DOXYGEN_CLI_COMMAND_DOOR_LOCK_UNLOCK |
zcl lock unlock [PIN:-1]
-
Unlocks the door
- PIN - CHAR_STRING
| #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