锁接口列表

1.用于判断蓝牙是否可用


1
public boolean isBLEEnabled(Context context)

2.请求打开蓝牙


xxxxxxxxxx
1
1
public void requestBleEnable(Activity activity)

3.蓝牙操作前的准备工作


xxxxxxxxxx
1
1
public void prepareBTService(Context context)

4.停止蓝牙服务并且释放资源


xxxxxxxxxx
1
1
public void stopBTService()

5.启动扫描锁


xxxxxxxxxx
1
1
public void startScanLock(ScanLockCallback callback)

6.停止扫描


xxxxxxxxxx
1
1
public void stopScanLock()

7.初始化锁


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

8.重置电子钥匙

重置电子钥匙,成功之后, lockFlagPos将会发生改变。


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

9.重置锁

重置锁意味着恢复出厂设置,如果你想要再次使用该锁,你需要重新初始化该锁。


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

10.开关锁操作(ControlAction.LOCK and ControlAction.UNLOCK)


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

11.获取音频的开关状态


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

12.设置音频开关状态

true – on, false – off


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

13.设置远程开锁开关

true – on, false – off


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

此设置会导致锁特征值改变，需要用返回的新的lockdata，调用更新锁数据接口同步到云端

14.获取远程开锁开关状态

true – on, false – off


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

15.校准锁时间


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

16.获取锁时间


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

17.获取锁日志

LogType.NEW – 获取最新的操作记录,既上次获取之后新增的。

LogType. ALL – 锁里面存储的完整记录。


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

18.获取锁电量


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

19.设置自动闭锁时间


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

20.设置自定义密码（4 – 9位密码）


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

21.修改密码

newPasscode为空表示不修改密码。

startDate 和endDate都为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.删除密码


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

23.重置密码(之前生成的密码都将失效)


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

24.获取锁里所有的有效密码


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

25.修改管理码


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

26.添加IC卡

startDate和endDate都为0表示添加永久期限的IC卡。

onEnterAddMode:进入添加IC模式，可以放入卡片进行添加操作。


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

27.修改IC卡有效期


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

28.获取所有有效的IC卡


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

29.删除IC卡


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

30.清空IC卡


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

31.添加指纹

startDate 和endDate都为0意味着添加永久指纹。

onEnterAddMode:锁进入添加模式可以添加指纹。

totalCount:需要采集指纹的总次数。

currentCount :当前采集指纹的次数。


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

32.获取所有有效的指纹


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

33.删除指纹


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

34.清空所有指纹


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

35.修改指纹有效期


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

36.获取常开模式数据


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

37.设置常开模式

PassageModeType.Weekly:1-周一，2-周二……，7-周日，0-每天


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

38.删除常开模式


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

39.清空常开模式


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

40. wifi锁扫描附近可用wifi

目前只支持2.4G wifi, 5G暂不支持


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

41. 配置wifi锁连接的wifi

目前只支持2.4G wifi, 5G暂不支持


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

42. 配置wifi锁连接的服务器

当前默认连接的服务器跟端口

serverAddress = "wifilock.ttlock.com";

portNumber = 4999;


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

43. 获取wifi锁的wifi信息


x
1
WifiLockInfo {
2
    /**
3
     * WiFi模块 MAC地址
4
     * （6 bytes）
5
     * 高在前，低在后
6
     */
7
    private String wifiMac;
8

9
    /**
10
     * 连接的wifi信号强度
11
     *
12
     * 未连接时，返回-127
13
     */
14
    private int wifiRssi;
15
}


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

44. wifi锁 ip设置

wifi锁需要支持静态ip的设置才可以使用该接口


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

参数说明：


xxxxxxxxxx
34
1
IpSetting {
2

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

6
    /**
7
     * 0 -固定ip
8
     * 1 -DHCP 自动获取ip地址
9
     */
10
    private int type;
11

12
    /**
13
     * 静态ip
14
     */
15
    private String ipAddress;
16
    /**
17
     * 子网掩码
18
     */
19
    private String subnetMask;
20
    /**
21
     * 默认网关
22
     */
23
    private String router;
24

25
    /**
26
     * 首选dns
27
     */
28
    private String preferredDns;
29

30
    /**
31
     * 备用dns
32
     */
33
    private String alternateDns;
34
}


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

45. 锁开关设置

类型说明:


xxxxxxxxxx
43
1
TTLockConfigType {
2
    /**
3
     * 防撬警报
4
     * 开启后锁被破坏将会发出警报声
5
     */
6
    TAMPER_ALERT(0x01),
7
    /**
8
     * 重置键
9
     * 关闭后，长按重置键 将无法重置锁(即无法被重新初始化)
10
     */
11
    RESET_BUTTON(0x02),
12
    /**
13
     * 反锁
14
     * 需要接口跟锁上同时开启才会生效，有一个未开启都不生效
15
     * 锁上跟接口都开启后，只有管理员钥匙、管理员密码、可开反锁的卡能够开锁
16
     * 其余的电子钥匙、服务端生成的密码、自定义密码、添加的IC、指纹都无法开锁
17
     */
18
    PRIVACY_LOCK(0x04),
19
    /**
20
     * 开门方向
21
     * UnlockDirection.LEFT : true
22
     * UnlockDirection.RIGHT : false
23
     */
24
    UNLOCK_DIRECTION(0x10),
25
    /**
26
     * 锁声音
27
     */
28
    LOCK_SOUND(0x05),
29
    /**
30
     * 国外客户保险箱锁是否显示密码
31
     */
32
    PASSCODE_VISIBLE(0x06),
33
    /**
34
     * 冻结锁
35
     */
36
    LOCK_FREEZE(0x07),
37
    /**
38
     * WiFi锁是否启用省电模式
39
     * false-长连接模式(所有远程操作可执行，耗电量增加)
40
     * true-省电模式(只能做记录的上传，所有的远程操作都无法执行)
41
     */
42
    WIFI_LOCK_POWER_SAVING_MODE(0x80);
43
}


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

46. 锁音量设置


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

音量枚举类说明：


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
    * 关闭
10
    */
11
    OFF(-1),
12
    /**
13
    * 开启
14
    */
15
    ON(-2);
16
}

47. 锁音量查询


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

48. 添加遥控设备


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

49. 修改遥控有效期


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

50. 删除遥控


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

51. 清空遥控


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

52. 添加门磁


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

53. 删除门磁


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

54. 获取网关的网络mac(只有锁处于连接状态下才可获取)


xxxxxxxxxx
1
1
public void getNetworkMac(GetNetworkMacCallback callback)

55. 配置酒店信息

hotelData: hotelData.setHotelInfo(hotelInfo); 通过接口从服务端获取hotelinfo hotelData.setBuildingNumber(buildingNumber); 楼栋号 hotelData.setFloorNumber(floorNumber); 楼层号


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

56. 配置锁扇区

sectorStr 从1开始计数数据格式 "1,2,3" 表示写入扇区1、2、3


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

57. 设置梯控工作模式

ttLiftWorkMode: ActivateAllFloors 刷卡可以控制所有关联的楼层 ActivateSpecificFloor 刷卡控制卡内数据对应的楼层


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

58. 设置梯控关联的楼层

controlableFloors 数据格式 "1,2,3" 表示关联楼层1、2、3


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

59. 设置梯控可到达的楼层

activateFloors 可达楼层列表 currentDate 当前系统时间。传入0，默认使用当前手机时间


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

60. 读取配件电量


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
}

配件类型枚举说明：


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

61. 添加人脸


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

62. 修改人脸有效期


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

63. 删除人脸


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

64. 清空人脸


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

65. 添加人脸数据

featureData; 人脸特征值数据


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

66. 获取锁上所有有效人脸数据


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

67. 添加掌静脉


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

68. 修改掌静脉有效期


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

69. 删除掌静脉


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

70. 清空掌静脉


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

71. 获取锁上所有有效的掌静脉


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

72. 修改识别人脸，掌静脉，二维码的灵敏度


xxxxxxxxxx
9
1
/**
2
 * 接近感应设置，3D人脸检测或者二维码检测时，有接近感应功能，当人体或者手机等物体靠近锁时，会自动启动人脸检测或者二维码检测，此功能用于设置开启或者关闭这个感应功能，或者设置感应的距离（远、中、近）
3
 * @param sensitivity
4
 * 0-  关闭
5
 * 1-  低灵敏度（近）
6
 * 2-  中灵敏度（中）
7
 * 3-  高灵敏度（远）
8
 */
9
public void setSensitivity(String lockData, int sensitivity, SetSensitivityCallback callback)

73. 获取识别人脸，掌静脉，二维码的灵敏度


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

74. 门未关报警时间设置

time 超时报警时间，单位秒


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

75. 设置取电开关工作模式

PowerSaveWorkMode: ALL_CARDS 所有卡 HOTEL_CARD 酒店卡 ROOM_CARD 房间卡


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

76.设置未授权报警


xxxxxxxxxx
15
1
/**
2
     * 设置未授权报警
3
     * Set unauthorized attempt alarm.
4
     *
5
     * 功能开启后，若指定开门方式开锁失败次数达到 attemptAlertCount，锁将锁定 lockoutDuration 秒；
6
     * attemptAlertCount 传 0 表示关闭该功能。
7
     * When enabled, the lock locks for lockoutDuration seconds after attemptAlertCount failed unlocks
8
     * of the given unlock modes; attemptAlertCount=0 disables the feature.
9
     *
10
     * @param data     报警配置（attemptAlertCount 0~50，0=关闭；lockoutDuration 0~900 秒）/ alert config
11
     * @param lockData 锁数据 / lock data
12
     * @param callback 回调 / callback
13
     */
14
    public void setUnauthorizedAttemptAlert(UnauthorizedAttemptAlertData data, String lockData,
15
                                            SetUnauthorizedAttemptAlertCallback callback)


xxxxxxxxxx
19
1
/**
2
 * 未授权报警配置数据（既作为 get 的返回，也作为 set 的入参载体）
3
 * <ul>
4
 *attemptAlertCount: 开锁失败次数上限（范围 0~50），0 表示关闭该功能。对应服务端字段 unauthorizedAttemptAlertCount。
5
 * lockoutDuration: 达到失败上限后的锁定时长（单位：秒，范围 0~900）。对应服务端字段 unauthorizedAttemptAlertLockTime。
6
 *unlockModes: 触发锁定的开门方式（密码/卡/指纹）。
7
 * </ul>
8
 */
9
public class UnauthorizedAttemptAlertData {
10

11
    /** 失败次数上限（0~50，0 表示关闭）**/
12
    private int attemptAlertCount;
13

14
    /** 锁定时长（秒，0~900）**/
15
    private int lockoutDuration;
16

17
    /** 触发锁定的开门方式 **/
18
    private List<UnlockMode> unlockModes;
19
}

77.获取未授权报警


xxxxxxxxxx
7
1
/**
2
     * 获取未授权报警配置
3
     *
4
     * @param lockData 锁数据 
5
     * @param callback 回调
6
     */
7
    public void getUnauthorizedAttemptAlert(String lockData, GetUnauthorizedAttemptAlertCallback callback)