Lock Interfaces

1.Judging whether Bluetooth is available

xxxxxxxxxx
1
1
public boolean isBLEEnabled(Context context)

2.Request to turn on Bluetooth

xxxxxxxxxx
1
1
public void requestBleEnable(Activity activity)

3.Init the Bluetooth configuration

xxxxxxxxxx
1
1
public void prepareBTService(Context context)

4.Stop the service to release Bluetooth resource

xxxxxxxxxx
1
1
public void stopBTService()

5.Start scan BT lock

xxxxxxxxxx
1
1
public void startScanLock(ScanLockCallback callback)

6.Stop the scan

xxxxxxxxxx
1
1
public void stopScanLock()

7.Init the lock

xxxxxxxxxx
1
1
public void initLock(ExtendedBluetoothDevice device, InitLockCallback callback)

8.Reset the ekey

Reset the ekey, and the lockFlagPos will change.

xxxxxxxxxx
1
1
public void resetEkey(String lockData, ResetKeyCallback callback)

9.Reset the lock

The lock will be reset to factory mode and if you want to use it,you should do initLock.

xxxxxxxxxx
1
1
public void resetLock(String lockData, ResetLockCallback callback)

10.Lock or unlock (ControlAction.LOCK and ControlAction.UNLOCK)

xxxxxxxxxx
5
1
public void controlLock(
2
    controlAction, 
3
    lockData, 
4
    lockMac, 
5
    ControlLockCallback callback)

11.Get Audio Switch State.

xxxxxxxxxx
4
1
public void getMuteModeState(
2
    String lockData,
3
    String lockMac,
4
    GetLockMuteModeStateCallback callback)

12.Set lock mute mode

true – on, false – off

xxxxxxxxxx
4
1
public void setMuteMode(
2
    boolean enable,
3
    String lockData,
4
    SetLockMuteModeCallback callback)

13.Set remote unlock switch state

true – on, false – off

xxxxxxxxxx
4
1
public void setRemoteUnlockSwitchState(
2
    boolean enable,
3
    String lockData,
4
    SetRemoteUnlockSwitchCallback callback)

This setting will change the lock feature value, you need to call Update lock data API to synchronize the cloud data with the new lockdata returned

14.Get remote unlock switch state

true – on, false – off

xxxxxxxxxx
3
1
public void getRemoteUnlockSwitchState(
2
    String lockData,
3
    GetRemoteUnlockStateCallback callback)

15.Set the lock time

xxxxxxxxxx
4
1
public void setLockTime(
2
    long timestamp,
3
    String lockData,
4
    SetLockTimeCallback callback)

16.Get the lock time

xxxxxxxxxx
3
1
public void getLockTime(
2
    String lockData,
3
    GetLockTimeCallback callback)

17.Get the lock log

LogType.NEW - only the new added operation record from last time you get log.

LogType. ALL - all the operation record from lock is initialized.

xxxxxxxxxx
4
1
public void getOperationLog(
2
    int logType,
3
    String lockData,
4
    GetOperationLogCallback callback)

18.Get lock battery

xxxxxxxxxx
3
1
public void getBatteryLevel(
2
    String lockData,
3
    GetBatteryLevelCallback callback)

19.Set Automatic locking period

xxxxxxxxxx
4
1
public void setAutomaticLockingPeriod(
2
    int seconds,
3
    String lockData,
4
    SetAutoLockingPeriodCallback callback)

20.Create custom passcode(Passcode range : 6 - 9 Digits in length)

xxxxxxxxxx
6
1
public void createCustomPasscode(
2
    String passcode,
3
    long startDate,
4
    long endDate,
5
    String lockData,
6
    CreateCustomPasscodeCallback callback)

21.Modify passcode

If newPasscode is null or "" means you do not want to change original passcode.

startDate and endDate values are both 0 means you do not want to change expired date,or both values should not be 0.

xxxxxxxxxx
7
1
public void modifyPasscode(
2
    String originalCode,
3
    String newCode,
4
    long startDate,
5
    long endDate,
6
    String lockData,
7
    ModifyPasscodeCallback callback)

22.Delete passcode

xxxxxxxxxx
5
1
public void deletePasscode(
2
    String passcode,
3
    String lockData,
4
    String lockMac,
5
    DeletePasscodeCallback callback)

23.Reset passcode(all passcodes will be invalid)

xxxxxxxxxx
3
1
public void resetPasscode(
2
    String lockData,
3
    ResetPasscodeCallback callback)

24.Get all valid passcodes in lock

xxxxxxxxxx
3
1
public void getAllValidPasscodes(
2
    String lockData,
3
    GetAllValidPasscodeCallback callback)

25.Modify admin passcode

xxxxxxxxxx
4
1
public void modifyAdminPasscode(
2
    String newPasscode,
3
    String lockData,
4
    ModifyAdminPasscodeCallback callback)

26.Add IC Card

startDate and endDate set 0 means the card will be valid for ever.

onEnterAddMode:the lock is ready to add a card.

xxxxxxxxxx
5
1
public void addICCard(
2
    long startDate,
3
    long endDate,
4
    String lockData,
5
    AddICCardCallback callback)

27.Modify IC Card Period

xxxxxxxxxx
6
1
public void modifyICCardValidityPeriod(
2
    long startDate,
3
    long endDate,
4
    String cardNum,
5
    String lockData,
6
    ModifyICCardPeriodCallback callback)

28.Get all valid IC Cards

xxxxxxxxxx
3
1
public void getAllValidICCards(
2
    String lockData,
3
    GetAllValidICCardCallback callback)

29.Delete IC Card

xxxxxxxxxx
4
1
public void deleteICCard(
2
    String cardNum,
3
    String lockData,
4
    DeleteICCardCallback callback)

30.Clear ic cards

xxxxxxxxxx
3
1
public void clearAllICCard(
2
    String lockData,
3
    ClearAllICCardCallback callback)

31.Add Fingerprint

startDate and endDate set 0 means the fingerprint will be valid for ever.

onEnterAddMode:the lock is ready to add a fingerprint.

totalCount: lock collect your fingerprint needed.

currentCount : current count the lock is collecting.

xxxxxxxxxx
5
1
public void addFingerprint(
2
    long startDate,
3
    long endDate,
4
    String lockData,
5
    AddFingerprintCallback callback)

32.Get all valid fingerprints

xxxxxxxxxx
3
1
public void getAllValidFingerprints(
2
    String lockData,
3
    GetAllValidFingerprintCallback callback)

33.Delete fingerprint

xxxxxxxxxx
4
1
public void deleteFingerprint(
2
    String fingerprintNum,
3
    String lockData,
4
    DeleteFingerprintCallback callback)

34.Clear all fingerprints

xxxxxxxxxx
3
1
public void clearAllFingerprints(
2
    String lockData,
3
    ClearAllFingerprintCallback callback)

35.Modify fingerprint period

xxxxxxxxxx
6
1
public void modifyFingerprintValidityPeriod(
2
    long startDate,
3
    long endDate,
4
    String fingerprintNum,
5
    String lockData,
6
    ModifyFingerprintPeriodCallback callback)

36.Get passage mode

xxxxxxxxxx
3
1
public void getPassageMode(
2
    String lockData,
3
    GetPassageModeCallback callback)

37.Set passage mode

PassageModeType.Weekly effective value from 1 to 7,1 means Monday 2 means Tuesday ,...,7 means Sunday, 0 means everydays

xxxxxxxxxx
4
1
public void setPassageMode(
2
    PassageModeConfig modeData,
3
    String lockData,
4
    SetPassageModeCallback callback)

38.Delete passage mode

xxxxxxxxxx
4
1
public void deletePassageMode(
2
    PassageModeConfig modeData,
3
    String lockData,
4
    DeletePassageModeCallback callback)

39.Clear passage mode

xxxxxxxxxx
3
1
public void clearPassageMode(
2
    String lockData,
3
    ClearPassageModeCallback callback)

40. Wifi lock scan nearby wifi

Currently, only support 2.4G wifi, 5 G don't support.

xxxxxxxxxx
1
1
public void scanWifi(String lockData, ScanWifiCallback callback)

41. Wifi lock config wifi

xxxxxxxxxx
1
1
public void configWifi(String wifiName, String wifiPassword, String lockData, ConfigWifiCallback callback)

42. Wifi lock config server

The server and port of the wifi lock

serverAddress = "wifilock.ttlock.com";

portNumber = 4999;

xxxxxxxxxx
2
1
public void configServer(String serverAddress, int portNumber, String lockData, 
2
                         ConfigServerCallback callback)

43. Get the wifi info the wifi lock

xxxxxxxxxx
11
1
WifiLockInfo {
2
    /**
3
     */
4
    private String wifiMac;
5

6
    /**
7
     *
8
     * disconnected return -127
9
     */
10
    private int wifiRssi;
11
}

xxxxxxxxxx
1
1
public void configWifi(String wifiName, String wifiPassword, String lockData, ConfigWifiCallback callback)

44. Wifi lock config ip

Need support below feature.

xxxxxxxxxx
1
1
FeatureValueUtil.isSupportFeature(lockData, FeatureValue.WIFI_LOCK_SUPPORT_STATIC_IP);

Para info：

xxxxxxxxxx
34
1
IpSetting {
2

3
    public static final int STATIC_IP = 0;
4
    public static final int DHCP = 1;
5

6
    /**
7
     * 0 -static ip
8
     * 1 -DHCP 
9
     */
10
    private int type;
11

12
    /**
13
     * static ip
14
     */
15
    private String ipAddress;
16
    /**
17
     * 
18
     */
19
    private String subnetMask;
20
    /**
21
     * 
22
     */
23
    private String router;
24

25
    /**
26
     * dns1
27
     */
28
    private String preferredDns;
29

30
    /**
31
     * dns2
32
     */
33
    private String alternateDns;
34
}

xxxxxxxxxx
1
1
public void configIp(IpSetting ipSetting, String lockData, ConfigIpCallback callback)

45. Lock config

Type info:

xxxxxxxxxx
39
1
TTLockConfigType {
2
    /**
3
     * By turning on，if the lock is destroyed by violence, it will sound an alarm.
4
     */
5
    TAMPER_ALERT(0x01),
6
    /**
7
     * By turning on, you can pair the lock again by long pressing the RESET button.
8
     * By turning off, the RESET button is disabled.
9
     */
10
    RESET_BUTTON(0x02),
11
    /**
12
     * Privacy lock api and privacy lock button on the lock both turning on, 
13
     * will enable the privacy function.
14
     * Only admin key、 admin super code and the privacy card can unlock the lock
15
     * 
16
     */
17
    PRIVACY_LOCK(0x04),
18
    /**
19
     * UnlockDirection.LEFT : true
20
     * UnlockDirection.RIGHT : false
21
     */
22
    UNLOCK_DIRECTION(0x10),
23
    /**
24
     * 
25
     */
26
    LOCK_SOUND(0x05),
27
    /**
28
     */
29
    PASSCODE_VISIBLE(0x06),
30
    /**
31
     */
32
    LOCK_FREEZE(0x07),
33
    /**
34
     * 
35
     * false-keep alive mode(can do all remote operations，need more power)
36
     * true-power saving mode(can only upload the records automatically by the wifi lock)
37
     */
38
    WIFI_LOCK_POWER_SAVING_MODE(0x80);
39
}

xxxxxxxxxx
1
1
public void setLockConfig(TTLockConfigType ttLockConfigType, boolean switchOn, String lockData, SetLockConfigCallback callback) 

46. Set sound volume

xxxxxxxxxx
1
1
public void setLockSoundWithSoundVolume(SoundVolume soundVolume, String lockData, SetLockSoundWithSoundVolumeCallback callback) 

para info

xxxxxxxxxx
16
1
SoundVolume {
2
    FIRST_LEVEL(1),
3
    SECOND_LEVEL(2),
4
    THIRD_LEVEL(3),
5
    FOUTH_LEVEL(4),
6
    FIFTH_LEVEL(5),
7

8
    /**
9
    * mute
10
    */
11
    OFF(-1),
12
    /**
13
    * open
14
    */
15
    ON(-2);
16
}

47. Get sound volume

xxxxxxxxxx
1
1
public void getLockSoundWithSoundVolume(String lockData, GetLockSoundWithSoundVolumeCallback callback)

48. Add remote control

xxxxxxxxxx
1
1
public void addRemote(String remoteMac, ValidityInfo validityInfo, String lockData, AddRemoteCallback callback)

49. Modify remote control

xxxxxxxxxx
1
1
public void modifyRemoteValidityPeriod(String remoteMac, ValidityInfo validityInfo, String lockData, ModifyRemoteValidityPeriodCallback callback)

50. Delete remote control

xxxxxxxxxx
1
1
public void deleteRemote(String remoteMac, String lockData, DeleteRemoteCallback callback)

51. Clear remote control

xxxxxxxxxx
1
1
public void clearRemote(String lockData, ClearRemoteCallback callback)

52. Add door sensor

xxxxxxxxxx
1
1
public void addDoorSensor(String doorSensorMac, String lockData, AddDoorSensorCallback callback)

53. Delete door sensor

xxxxxxxxxx
1
1
public void deleteDoorSensor(String lockData, DeleteDoorSensorCallback callback)

54. Get Wifi MAC of gateway(Only can use when lock is connected gateway)

xxxxxxxxxx
1
1
public void getNetworkMac(GetNetworkMacCallback callback)

55. Configure hotel data

hotelData: hotelData.setHotelInfo(hotelInfo); gain hotelinfo from cloud API hotelData.setBuildingNumber(buildingNumber); BuildingNo hotelData.setFloorNumber(floorNumber); FloorNo

xxxxxxxxxx
1
1
public void setHotelData(HotelData hotelData, String lockData, SetHotelDataCallback callback)

56. Set lock sector

sectorStr (start counting from 1, Data format "1,2,3" means write sector 1, 2, 3)

xxxxxxxxxx
1
1
public void setHotelCardSector(String sectorStr, String lockData, SetHotelCardSectorCallback callback)

57. Configure lift control wrok mode

ttLiftWorkMode: ActivateAllFloors (Allow control all floors after use card) ActivateSpecificFloor (Allow control floors that same as card data)

xxxxxxxxxx
1
1
public void setLiftWorkMode(TTLiftWorkMode ttLiftWorkMode, String lockData, SetLiftWorkModeCallback callback)

58. Set the floors associated with the lift control

controlableFloors (Data format "1,2,3" means the associated floor is 1、2、3)

xxxxxxxxxx
1
1
public void setLiftControlableFloors(String controlableFloors, String lockData, SetLiftControlableFloorsCallback callback)

59. Set the floors that lift control can be arrived

activateFloors (List of floors that can be arrived) currentDate (System current time)

xxxxxxxxxx
1
1
public void activateLiftFloors(List<Integer> activateFloors, long currentDate, String lockData, ActivateLiftFloorsCallback callback)

60. Obtain accessory battery level

xxxxxxxxxx
1
1
public void getAccessoryBatteryLevel(AccessoryInfo accessoryInfo, String lockData, GetAccessoryBatteryLevelCallback callback)

xxxxxxxxxx
6
1
public class AccessoryInfo implements Serializable {
2
    private AccessoryType accessoryType;
3
    private String accessoryMac;
4
    private long batteryDate;
5
    private int accessoryBattery;
6
}

para info：

xxxxxxxxxx
5
1
AccessoryType{
2
    WIRELESS_KEYPAD(1),
3
    REMOTE(2),
4
    DOOR_SENSOR(3);
5
}

61. Add face

xxxxxxxxxx
1
1
public void addFace(String lockData, ValidityInfo validityInfo, AddFaceCallback callback)

62. Modify face period

xxxxxxxxxx
1
1
public void modifyFaceValidityPeriod(String lockData, long faceNumber, ValidityInfo validityInfo, ModifyFacePeriodCallback callback)

63. Delete face

xxxxxxxxxx
1
1
public void deleteFace(String lockData, long faceNumber, DeleteFaceCallback callback)

64. Clear face

xxxxxxxxxx
1
1
public void clearFace(String lockData, ClearFaceCallback callback)

65. Add face feature data

featureData; Human face feature data

xxxxxxxxxx
1
1
public void addFaceFeatureData(String lockData, String featureData, ValidityInfo validityInfo, AddFaceCallback callback)

66. Gain all valid face in the lock

xxxxxxxxxx
1
1
public void getAllValidFaces(String lockData, GetAllFacesCallback callback)

67. Add palm vein

xxxxxxxxxx
1
1
public void addPalmVein(String lockData, ValidityInfo validityInfo, AddPalmVeinCallback callback)

68. Modify palm vein period

xxxxxxxxxx
1
1
public void modifyPalmVeinValidityPeriod(String lockData, long palmVeinNumber, ValidityInfo validityInfo, ModifyPalmVeinPeriodCallback callback)

69. Delete palm vein

xxxxxxxxxx
1
1
public void deletePalmVein(String lockData, long palmVeinNumber, DeletePalmVeinCallback callback)

70. Claer plam vein

xxxxxxxxxx
1
1
public void clearPalmVein(String lockData, ClearPalmVeinCallback callback)

71. Gain all valid palm vein in the lock

xxxxxxxxxx
1
1
public void getAllValidPalmVeins(String lockData, GetAllPalmVeinsCallback callback)

72. Modify the sensitivity of recognizing face, palm vein and QR code.

xxxxxxxxxx
9
1
/**
2
 * Proximity sensor setting, when 3D face detection or QR code detection is enabled, there is a proximity sensor function. When an object such as a human or a mobile phone approaches the lock, the face detection or QR code detection will be automatically started. This function is used to set whether to turn on or off this sensor function, or to set the sensing distance (far, medium, near).
3
 * @param sensitivity
4
 * 0-  off
5
 * 1-  low sensitivity（near）
6
 * 2-  medium sensitivity（medium）
7
 * 3-  high sensiticity（far）
8
 */
9
public void setSensitivity(String lockData, int sensitivity, SetSensitivityCallback callback)

73. Gain the sensitivity of recognizing face, palm vein and QR code.

xxxxxxxxxx
1
1
public void getSensitivity(String lockData, GetSensitivityCallback callback)

74. Door unclosed alarm time setting

time (Door unclosed alarm time, unit of seconds)

xxxxxxxxxx
1
1
public void setDoorSensorAlertTime(int time, String lockData, SetDoorSensorAlertTimeCallback callback)

75. Setting power saver work mode

PowerSaveWorkMode: ALL_CARDS (All cards can active the power saver) HOTEL_CARD (Only hotel card can active the power saver) ROOM_CARD (Only room card can active the power saver)

xxxxxxxxxx
1
1
public void setPowerSaverWorkMode(PowerSaverWorkMode powerSaverWorkMode, String lockData, SetPowerSaverWorkModeCallback callback)

76.Set unauthorized attempt alert

xxxxxxxxxx
12
1
/**
2
     * Set unauthorized attempt alarm.
3
     *
4
     * When enabled, the lock locks for lockoutDuration seconds after attemptAlertCount failed unlocks
5
     * of the given unlock modes; attemptAlertCount=0 disables the feature.
6
     *
7
     * @param data    （attemptAlertCount 0~50，0=关闭；lockoutDuration 0~900 秒）/ alert config
8
     * @param lockData  / lock data
9
     * @param callback / callback
10
     */
11
    public void setUnauthorizedAttemptAlert(UnauthorizedAttemptAlertData data, String lockData,
12
                                            SetUnauthorizedAttemptAlertCallback callback)

xxxxxxxxxx
17
1
/**
2
 * Unauthorized attempt alert config data (used both as the get result and the set input carrier).
3
 *     Max failed unlock attempts (range 0~50); 0 means the feature is disabled. Maps to server field unauthorizedAttemptAlertCount.
4
 *     Lockout duration after reaching the failed attempt limit (unit: second, range 0~900). Maps to server field unauthorizedAttemptAlertLockTime.
5
 *     Unlock modes that trigger lockout (passcode/card/fingerprint).
6
 */
7
public class UnauthorizedAttemptAlertData {
8

9
    /** / Max failed attempts (0~50; 0 means disabled) */
10
    private int attemptAlertCount;
11

12
    /** Lockout duration in seconds (0~900) */
13
    private int lockoutDuration;
14

15
    /** Unlock modes that trigger lockout */
16
    private List<UnlockMode> unlockModes;
17
}

77.Get unauthorized attempt alert config.

xxxxxxxxxx
7
1
/**
2
     * Get unauthorized attempt alert config.
3
     *
4
     * @param lockData  / lock data
5
     * @param callback / callback
6
     */
7
    public void getUnauthorizedAttemptAlert(String lockData, GetUnauthorizedAttemptAlertCallback callback)