Skip to content

锁接口列表 ​

1.用于判断蓝牙是否可用 ​
c
public boolean isBLEEnabled(Context context)
2.请求打开蓝牙 ​
c
public void requestBleEnable(Activity activity)
3.蓝牙操作前的准备工作 ​
c
public void prepareBTService(Context context)
4.停止蓝牙服务并且释放资源 ​
c
public void stopBTService()
5.启动扫描锁 ​
c
public void startScanLock(ScanLockCallback callback)
6.停止扫描 ​
c
public void stopScanLock()
7.初始化锁 ​
c
public void initLock(ExtendedBluetoothDevice device, InitLockCallback callback)
8.重置电子钥匙 ​

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

c
public void resetEkey(String lockData,ResetKeyCallback callback)
9.重置锁 ​

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

c
public void resetLock(String lockData,ResetLockCallback callback)
10.开关锁操作(ControlAction.LOCK and ControlAction.UNLOCK) ​
c
public void controlLock(
    controlAction, 
    lockData, 
    lockMac, 
    ControlLockCallback callback)
11.获取音频的开关状态 ​
c
public void getMuteModeState(
    String lockData,
    String lockMac,
    GetLockMuteModeStateCallback callback)
12.设置音频开关状态 ​

true – on, false – off

c
public void setMuteMode(
    boolean enable,
    String lockData,
    String lockMac,
    SetLockMuteModeCallback callback)
13.设置远程开锁开关 ​

true – on, false – off

c
public void setRemoteUnlockSwitchState(
    boolean enable,
    String lockData,
    SetRemoteUnlockSwitchCallback callback)

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

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

true – on, false – off

c
public void getRemoteUnlockSwitchState(
    String lockData,
    GetRemoteUnlockStateCallback callback)
15.校准锁时间 ​
c
public void setLockTime(
    long timestamp,
    String lockData,
    SetLockTimeCallback callback)
16.获取锁时间 ​
c
public void getLockTime(
    String lockData,
    GetLockTimeCallback callback)
17.获取锁日志 ​

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

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

c
public void getOperationLog(
    int logType,
    String lockData,
    GetOperationLogCallback callback)
18.获取锁电量 ​
c
public void getBatteryLevel(
    String lockData,
    GetBatteryLevelCallback callback)
19.设置自动闭锁时间 ​
c
public void setAutomaticLockingPeriod(
    int seconds,
    String lockData,
    SetAutoLockingPeriodCallback callback)
20.设置自定义密码(4 – 9位密码) ​
c
public void createCustomPasscode(
    String passcode,
    long startDate,
    long endDate,
    String lockData,
    CreateCustomPasscodeCallback callback)
21.修改密码 ​

newPasscode为空表示不修改密码。

startDate 和endDate都为0表示不修改有效期。

c
public void modifyPasscode(
    String originalCode,
    String newCode,
    long startDate,
    long endDate,
    String lockData,
    ModifyPasscodeCallback callback)
22.删除密码 ​
c
public void deletePasscode(
    String passcode,
    String lockData,
    DeletePasscodeCallback callback)
23.重置密码(之前生成的密码都将失效) ​
c
public void resetPasscode(
    String lockData,
    ResetPasscodeCallback callback)
24.获取锁里所有的有效密码 ​
c
public void getAllValidPasscodes(
    String lockData,
    GetAllValidPasscodeCallback callback)
25.修改管理码 ​
c
public void modifyAdminPasscode(
    String newPasscode,
    String lockData,
    ModifyAdminPasscodeCallback callback)
26.添加IC卡 ​

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

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

c
public void addICCard(
    long startDate,
    long endDate,
    String lockData,
    AddICCardCallback callback)
27.修改IC卡有效期 ​
c
public void modifyICCardValidityPeriod(
    long startDate,
    long endDate,
    String cardNum,
    String lockData,
    ModifyICCardPeriodCallback callback)
28.获取所有有效的IC卡 ​
c
public void getAllValidICCards(
    String lockData,
    GetAllValidICCardCallback callback)
29.删除IC卡 ​
c
public void deleteICCard(
    String cardNum,
    String lockData,
    DeleteICCardCallback callback)
30.清空IC卡 ​
c
public void clearAllICCard(
    String lockData,
    ClearAllICCardCallback callback)
31.添加指纹 ​

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

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

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

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

public void addFingerprint(
    long startDate,
    long endDate,
    String lockData,
    AddFingerprintCallback callback)
32.获取所有有效的指纹 ​
c
public void getAllValidFingerprints(
    String lockData,
    GetAllValidFingerprintCallback callback)
33.删除指纹 ​
c
public void deleteFingerprint(
    String fingerprintNum,
    String lockData,
    DeleteFingerprintCallback callback)
34.清空所有指纹 ​
c
public void clearAllFingerprints(
    String lockData,
    ClearAllFingerprintCallback callback)
35.修改指纹有效期 ​
c
public void modifyFingerprintValidityPeriod(
    long startDate,
    long endDate,
    String fingerprintNum,
    String lockData,
    ModifyFingerprintPeriodCallback callback)
36.获取常开模式数据 ​
c
public void getPassageMode(
    String lockData,
    GetPassageModeCallback callback)
37.设置常开模式 ​

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

c
public void setPassageMode(
    PassageModeConfig modeData,
    String lockData,
    SetPassageModeCallback callback)
38.删除常开模式 ​
c
public void deletePassageMode(
    PassageModeConfig modeData,
    String lockData,
    String lockMac,
    DeletePassageModeCallback callback)
39.清空常开模式 ​
c
public void clearPassageMode(
    String lockData,
    ClearPassageModeCallback callback)
40. wifi锁扫描附近可用wifi ​

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

java
public void scanWifi(String lockData, ScanWifiCallback callback)
41. 配置wifi锁连接的wifi ​

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

java
public void configWifi(String wifiName, String wifiPassword, String lockData, ConfigWifiCallback callback)
42. 配置wifi锁连接的服务器 ​

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

serverAddress = "wifilock.ttlock.com";

portNumber = 4999;

java
public void configServer(String serverAddress, int portNumber, String lockData, 
                         ConfigServerCallback callback)
43. 获取wifi锁的wifi信息 ​
java
WifiLockInfo {
    /**
     * WiFi模块 MAC地址
     * (6 bytes)
     * 高在前,低在后
     */
    private String wifiMac;


    /**
     * 连接的wifi信号强度
     *
     * 未连接时,返回-127
     */
    private int wifiRssi;
}
java
public void configWifi(String wifiName, String wifiPassword, String lockData, ConfigWifiCallback callback)
44. wifi锁 ip设置 ​

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

java
FeatureValueUtil.isSupportFeature(lockData, FeatureValue.WIFI_LOCK_SUPPORT_STATIC_IP);

参数说明:

java
IpSetting {


    public static final int STATIC_IP = 0;
    public static final int DHCP = 1;


    /**
     * 0 -固定ip
     * 1 -DHCP 自动获取ip地址
     */
    private int type;


    /**
     * 静态ip
     */
    private String ipAddress;
    /**
     * 子网掩码
     */
    private String subnetMask;
    /**
     * 默认网关
     */
    private String router;


    /**
     * 首选dns
     */
    private String preferredDns;


    /**
     * 备用dns
     */
    private String alternateDns;
}
java
public void configIp(IpSetting ipSetting, String lockData, ConfigIpCallback callback)
45. 锁开关设置 ​

类型说明:

java
TTLockConfigType {
    /**
     * 防撬警报
     * 开启后锁被破坏将会发出警报声
     */
    TAMPER_ALERT(0x01),
    /**
     * 重置键
     * 关闭后,长按重置键 将无法重置锁(即无法被重新初始化)
     */
    RESET_BUTTON(0x02),
    /**
     * 反锁
     * 需要接口跟锁上同时开启才会生效,有一个未开启都不生效
     * 锁上跟接口都开启后,只有管理员钥匙、管理员密码、可开反锁的卡能够开锁
     * 其余的电子钥匙、服务端生成的密码、自定义密码、添加的IC、指纹都无法开锁
     */
    PRIVACY_LOCK(0x04),
    /**
     * 开门方向
     * UnlockDirection.LEFT : true
     * UnlockDirection.RIGHT : false
     */
    UNLOCK_DIRECTION(0x10),
    /**
     * 锁声音
     */
    LOCK_SOUND(0x05),
    /**
     * 国外客户保险箱锁是否显示密码
     */
    PASSCODE_VISIBLE(0x06),
    /**
     * 冻结锁
     */
    LOCK_FREEZE(0x07),
    /**
     * WiFi锁是否启用省电模式
     * false-长连接模式(所有远程操作可执行,耗电量增加)
     * true-省电模式(只能做记录的上传,所有的远程操作都无法执行)
     */
    WIFI_LOCK_POWER_SAVING_MODE(0x80);
}
java
public void setLockConfig(TTLockConfigType ttLockConfigType, boolean switchOn, String lockData, SetLockConfigCallback callback)
46. 锁音量设置 ​
java
public void setLockSoundWithSoundVolume(SoundVolume soundVolume, String lockData, SetLockSoundWithSoundVolumeCallback callback)

音量枚举类说明:

java
SoundVolume {
    FIRST_LEVEL(1),
    SECOND_LEVEL(2),
    THIRD_LEVEL(3),
    FOUTH_LEVEL(4),
    FIFTH_LEVEL(5),


    /**
    * 关闭
    */
    OFF(-1),
    /**
    * 开启
    */
    ON(-2);
}
47. 锁音量查询 ​
java
public void getLockSoundWithSoundVolume(String lockData, GetLockSoundWithSoundVolumeCallback callback)
48. 添加遥控设备 ​
java
public void addRemote(String remoteMac, ValidityInfo validityInfo, String lockData, AddRemoteCallback callback)
49. 修改遥控有效期 ​
java
public void modifyRemoteValidityPeriod(String remoteMac, ValidityInfo validityInfo, String lockData, ModifyRemoteValidityPeriodCallback callback)
50. 删除遥控 ​
java
public void deleteRemote(String remoteMac, String lockData, DeleteRemoteCallback callback)
51. 清空遥控 ​
java
public void clearRemote(String lockData, ClearRemoteCallback callback)
52. 添加门磁 ​
java
public void addDoorSensor(String doorSensorMac, String lockData, AddDoorSensorCallback callback)
53. 删除门磁 ​
java
public void deleteDoorSensor(String lockData, DeleteDoorSensorCallback callback)
54. 获取网关的网络mac(只有锁处于连接状态下才可获取) ​
java
public void getNetworkMac(GetNetworkMacCallback callback)
55. 配置酒店信息 ​

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

java
public void setHotelData(HotelData hotelData, String lockData, SetHotelDataCallback callback)
56. 配置锁扇区 ​

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

java
public void setHotelCardSector(String sectorStr, String lockData, SetHotelCardSectorCallback callback)
57. 设置梯控工作模式 ​

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

java
public void setLiftWorkMode(TTLiftWorkMode ttLiftWorkMode, String lockData, SetLiftWorkModeCallback callback)
58. 设置梯控关联的楼层 ​

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

java
public void setLiftControlableFloors(String controlableFloors, String lockData, SetLiftControlableFloorsCallback callback)
59. 设置梯控可到达的楼层 ​

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

java
public void activateLiftFloors(List<Integer> activateFloors, long currentDate, String lockData, ActivateLiftFloorsCallback callback)
60. 读取配件电量 ​
java
public void getAccessoryBatteryLevel(AccessoryInfo accessoryInfo, String lockData, GetAccessoryBatteryLevelCallback callback)
java
public class AccessoryInfo implements Serializable {
    private AccessoryType accessoryType;
    private String accessoryMac;
    private long batteryDate;
    private int accessoryBattery;
}

配件类型枚举说明:

java
AccessoryType{
    WIRELESS_KEYPAD(1),
    REMOTE(2),
    DOOR_SENSOR(3);
}
61. 添加人脸 ​
java
public void addFace(String lockData, ValidityInfo validityInfo, AddFaceCallback callback)
62. 修改人脸有效期 ​
java
public void modifyFaceValidityPeriod(String lockData, long faceNumber, ValidityInfo validityInfo, ModifyFacePeriodCallback callback)
63. 删除人脸 ​
java
public void deleteFace(String lockData, long faceNumber, DeleteFaceCallback callback)
64. 清空人脸 ​
java
public void clearFace(String lockData, ClearFaceCallback callback)
65. 添加人脸数据 ​

featureData; 人脸特征值数据

java
public void addFaceFeatureData(String lockData, String featureData, ValidityInfo validityInfo, AddFaceCallback callback)
66. 获取锁上所有有效人脸数据 ​
java
public void getAllValidFaces(String lockData, GetAllFacesCallback callback)
67. 添加掌静脉 ​
java
public void addPalmVein(String lockData, ValidityInfo validityInfo, AddPalmVeinCallback callback)
68. 修改掌静脉有效期 ​
java
public void modifyPalmVeinValidityPeriod(String lockData, long palmVeinNumber, ValidityInfo validityInfo, ModifyPalmVeinPeriodCallback callback)
69. 删除掌静脉 ​
java
public void deletePalmVein(String lockData, long palmVeinNumber, DeletePalmVeinCallback callback)
70. 清空掌静脉 ​
java
public void clearPalmVein(String lockData, ClearPalmVeinCallback callback)
71. 获取锁上所有有效的掌静脉 ​
java
public void getAllValidPalmVeins(String lockData, GetAllPalmVeinsCallback callback)
72. 修改识别人脸,掌静脉,二维码的灵敏度 ​
java
/**
 * 接近感应设置,3D人脸检测或者二维码检测时,有接近感应功能,当人体或者手机等物体靠近锁时,会自动启动人脸检测或者二维码检测,此功能用于设置开启或者关闭这个感应功能,或者设置感应的距离(远、中、近)
 * @param sensitivity
 * 0-  关闭
 * 1-  低灵敏度(近)
 * 2-  中灵敏度(中)
 * 3-  高灵敏度(远)
 */
public void setSensitivity(String lockData, int sensitivity, SetSensitivityCallback callback)
73. 获取识别人脸,掌静脉,二维码的灵敏度 ​
java
public void getSensitivity(String lockData, GetSensitivityCallback callback)
74. 门未关报警时间设置 ​

time 超时报警时间,单位秒

java
public void setDoorSensorAlertTime(int time, String lockData, SetDoorSensorAlertTimeCallback callback)
75. 设置取电开关工作模式 ​

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

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

76.设置未授权报警

java
/**
     * 设置未授权报警
     * Set unauthorized attempt alarm.
     *
     * 功能开启后,若指定开门方式开锁失败次数达到 attemptAlertCount,锁将锁定 lockoutDuration 秒;
     * attemptAlertCount 传 0 表示关闭该功能。
     * When enabled, the lock locks for lockoutDuration seconds after attemptAlertCount failed unlocks
     * of the given unlock modes; attemptAlertCount=0 disables the feature.
     *
     * @param data     报警配置(attemptAlertCount 0~50,0=关闭;lockoutDuration 0~900 秒)/ alert config
     * @param lockData 锁数据 / lock data
     * @param callback 回调 / callback
     */
    public void setUnauthorizedAttemptAlert(UnauthorizedAttemptAlertData data, String lockData,
                                            SetUnauthorizedAttemptAlertCallback callback)
java
/**
 * 未授权报警配置数据(既作为 get 的返回,也作为 set 的入参载体)
 * <ul>
 *attemptAlertCount: 开锁失败次数上限(范围 0~50),0 表示关闭该功能。对应服务端字段 unauthorizedAttemptAlertCount。
 * lockoutDuration: 达到失败上限后的锁定时长(单位:秒,范围 0~900)。对应服务端字段 unauthorizedAttemptAlertLockTime。
 *unlockModes: 触发锁定的开门方式(密码/卡/指纹)。
 * </ul>
 */
public class UnauthorizedAttemptAlertData {


    /** 失败次数上限(0~50,0 表示关闭)**/
    private int attemptAlertCount;


    /** 锁定时长(秒,0~900)**/
    private int lockoutDuration;


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

77.获取未授权报警

java
/**
     * 获取未授权报警配置
     *
     * @param lockData 锁数据 
     * @param callback 回调
     */
    public void getUnauthorizedAttemptAlert(String lockData, GetUnauthorizedAttemptAlertCallback callback)