Unlock

UNLOCK_COMMAND code is 0x51.

The command is used to unlock the lock. The response is encrypted so before parsing should be decrypted.

Input parameters

param[0]: if not attached to the command then the default value is NONE.

Param name	Value	Description
NONE	0x00	Unlock lock
AUTO	0x01	Unlock from auto unlock feature.
FORCE	0x02	Forces lock to unlock lock till jam. Should be used only in emergency case.

Result

Result name	Value	Description
SUCCESS	0x00	Operation accepted.
INVALID_PARAM	0x01	Invalid params passed to lock.
ERROR	0x02	Error occured.
BUSY	0x03	Lock is currently performing other operations. Wait for changing state.
NOT_CALIBRATED	0x05	Lock does not have calibration. Please calibrate the lock.
ALREADY_CALLED_BY_AUTOUNLOCK	0x06	Last unlock operation was auto unlock and it happened < 3min (current lock state does not matter).
ALREADY_CALLED_BY_OTHER_OPERATION	0x0A	Last unlock operation was different than auto unlock and it happened < 3min (current lock state does not matter).
NOT_CONFIGURED	0x08	Lock auto pull spring feature is turned off.
DISMOUNTED	0x09	Lock is not mounted on doors.

Output parameters

The output parameter will indicate a number of seconds since the last “unlock command” operation. The value is passed as 4 bytes in Big-endian format. (UNLOCK_ALREADY_CALLED_BY_AUTOUNLOCK and UNLOCK_ALREADY_CALLED_BY_OTHER_OPERATION).

Example

1. Form message for encryption,

Command Value	param
0x51	0x00 (NONE)

2. Encrypt prepared message,

3. Send it on API commands characteristic,

4. Receive response on API commands characteristic,

5. Decrypt received response discarding first header byte,

6. Parse response

Response

0x00 (SUCCESS)