金万码蓝牙电子钥匙SDK

更新记录

1.0.11（2024-08-23）下载此版本

sdk 中增加钥匙安全认证。

1.0.10（2024-08-12）下载此版本

增加新钥匙

1.0.9（2024-08-05）下载此版本

增加支持新钥匙

平台兼容性

Android	Android CPU类型	iOS
适用版本区间：4.4 - 14.0	armeabi-v7a：支持，arm64-v8a：支持，x86：支持	适用版本区间：9 - 17

原生插件通用使用流程：

购买插件，选择该插件绑定的项目。
在HBuilderX里找到项目，在manifest的app原生插件配置中勾选模块，如需要填写参数则参考插件作者的文档添加。
根据插件作者的提供的文档开发代码，在代码中引用插件，调用插件功能。
打包自定义基座，选择插件，得到自定义基座，然后运行时选择自定义基座，进行log输出测试。
开发完毕后正式云打包

付费原生插件目前不支持离线打包。
Android 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/android
iOS 离线打包原生插件另见文档 https://nativesupport.dcloud.net.cn/NativePlugin/offline_package/ios

注意事项：使用HBuilderX2.7.14以下版本，如果同一插件且同一appid下购买并绑定了多个包名，提交云打包界面提示包名绑定不一致时，需要在HBuilderX项目中manifest.json->“App原生插件配置”->”云端插件“列表中删除该插件重新选择

沈阳金万码蓝牙电子钥匙二次开发插件使用说明

使用方法

导出插件方法

    const blesdk = uni.requireNativePlugin('Vanma-BleKeyModule');
    const globalEvent = uni.requireNativePlugin('globalEvent');

相关函数说明

扫描蓝牙钥匙

参数说明：

timeout 扫描时间单位为毫秒 scanBleCallback 回调函数扫描结果 startScan(timeout, scanBleCallback); 例子:

......

blesdk.startScan(20000,(res)=>{
      let device = res.device;
      //device.deviceId,device.keyid,device.RSSI
      this.data.devices.push(device);
      let devices = this.data.devices;
      this.setData({devices});      
  });

停止扫描蓝牙钥匙

参数说明

无 stopScan()

连接蓝牙钥匙

参数说明

options: {mac:string,secret:string,sign:int} mac 扫描到的蓝牙设备 secret 钥匙密钥(20位，由0..9,A..F组成) sign 钥匙标志(一般默认为0)

connectToKey(options,callback)

例:

    blesdk.connectToKey({mac:this.mac,secret:"FFFFFFFFFFFFFFFFFFFF",sign:0},res=>{
        console.log(JSON.stringify(res));
    });

读取钥匙信息

readKeyInfo();

    blesdk.readKeyInfo(res=>{
        console.log(JSON.stringify(res));
    });

读取钥匙记录

参数说明

clearFlag boolean 型,true 读取成功后删除钥匙记录

readKeyRecords(clearFlag,callback);

    blesdk.readKeyRecords(false,res=>{
        console.log(JSON.stringify(res));
    });

记录说明：

{"cmd": int,"lockid": string,"time": yyyy-MM-dd HH:mm:ss,"status":int,"user": [int],"taskId": int,"finger": int,"flag1": int}

cmd:当前钥匙模式 9.管理钥匙, 10.开关锁钥匙，17.设置锁密钥钥匙,18.黑名单钥匙,19.采集锁号钥匙
flag1:  
254.标志匹配失败记录
255.该钥匙为黑名单钥匙
252.钥匙已经转动到开锁位置，但是没有弹出锁梁
0.成功
4. 开关锁失败
16.时区不匹配
18.黑名单标记钥匙
33.与下载的锁号不匹配
64.钥匙与锁密码不匹配
114.任务无效
128.采集的锁为防火门锁芯，左开
144.采集的锁为防火门锁芯，右开

status:锁状态 0 开启状态，1关闭状态
lockid: 锁号
time: 开关锁时间

如果flag1 = 0 并且 status = 0 开锁操作,并且开锁成功。
如果flag1 = 0 并且 status = 1 为关锁操作，并且关锁成功。
如果 flag1!=0 并且 status = 0 为关锁操作， 关锁失败，当前锁状体为开启状态。
如果 flag1!=0 并且 status = 1 为开锁操作，开锁失败，当前锁体状体为关闭状态。

删除钥匙中的记录

clearRecords();

    blesdk.clearRecords(res=>{
        console.log(JSON.stringify(res));
    });

设置用户钥匙(开关锁钥匙)

参数说明

options:{"userKeyInfo":UserKeyInfo,"isOnline":boolean} userKeyInfo 任务内容格式例:

{
"lockIds":["202209059905","202209060369"],
"timeBlocks":[
              {"from":"2022-10-24","to":"2025-10-24",
                "times":[
                    {"from":"00:00:00","to":"23:59:59"}
                    ]
              }
            ]
}
其中 lockIds 需要开关的锁的id,由12位数字组成
timeBlocks 为开关锁的 日期段和时间段
isOnline boolean 型，钥匙是否在线 true 为在线使用，钥匙与app断开后不能在进行开关锁。false 离线模式，钥匙与app断开后可以继续开关锁。

setUserKey(options, callback) 例

    blesdk.setUserKey({"userKeyInfo":userKeyInfo,"isOnline":true},res=>{
        console.log(JSON.stringify(res));
    });

设置采集锁号钥匙

setReadLockIdKey()

    blesdk.setReadLockIdKey(res=>{
        console.log(JSON.stringify(res));
    });

设置成功后，用钥匙接触锁，会在onReport事件中返回采集记录。

设置管理钥匙

参数说明

options: {from:"yyyy-MM-dd HH:mm:ss",to:"yyyy-MM-dd HH:mm:ss"} 钥匙的有效期(sdk中只取日期部分) 如：

{"from":"2022-10-24 00:00:00","to":"2025-10-24 23:59:59"}

setManagerKey(options,callback); 例

    blesdk.setManagerKey(res=>{
        console.log(JSON.stringify(res));
    });

管理钥匙具有最高权限，可以开同一密钥下的所有锁。

设置事件钥匙

参数说明

options: {from:"yyyy-MM-dd HH:mm:ss",to:"yyyy-MM-dd HH:mm:ss"} 钥匙的有效期(sdk中只取日期部分) 如：

{"from":"2022-10-24 00:00:00","to":"2025-10-24 23:59:59"}

setEventsKey(options,callback) 例

    blesdk.setManagerKey(res=>{
        console.log(JSON.stringify(res));
    });

设置成功后，用钥匙接触锁，会将锁中的数据读取到钥匙中。

设置黑名单钥匙

参数说明

options: {from:"yyyy-MM-dd HH:mm:ss",to:"yyyy-MM-dd HH:mm:ss",keyIds:[string]} from,to钥匙的有效期(sdk中只取日期部分) keyIds:黑名单钥匙列表

如：

{"from":"2022-10-24","to":"2025-10-24","keyIds": ["200007270001"]}

setBlockListKey(options,callback)

例

    blesdk.setBlockListKey({"from":"2022-10-24","to":"2025-10-24","keyIds": ["200007270001"]},
    res=>{
        console.log(JSON.stringify(res));
    });

先将黑名单钥匙下载到钥匙中，然后用钥匙接触锁，将黑名单钥匙列表写入到锁中。其中有效时间段，为钥匙作为黑名单钥匙的有效时间。清空锁中的黑名单，keyIds:[]

设置空白单钥匙

将钥匙里面的所有信息清空。 setBlankKey(callback) 例

    blesdk.setBlankKey(res=>{
        console.log(JSON.stringify(res));
    });

设置注册锁钥匙

参数说明

options:{from:"yyyy-MM-dd HH:mm:ss",to:"yyyy-MM-dd HH:mm:ss", "secretInfo":{"oldSecret":string,"nowSecret":string} } from,to钥匙的有效期(sdk中只取日期部分) oldSecret 锁的原密钥 newSecret 锁的新密钥其中密钥由 A..F,0..9 共20个字符组成如：

{"from":"2022-10-24","to":"2025-10-24","secretInfo":{"oldSecret":"FFFFFFFFFFFFFFFFFFFF","nowSecret":"FFFFFFFFFFFFFFFFFFFF"}}

setRegisterKey(options,callback) ;

例

    let options = {"from":"2022-10-24","to":"2025-10-24","secretInfo":{"oldSecret":"FFFFFFFFFFFFFFFFFFFF","nowSecret":"FFFFFFFFFFFFFFFFFFFF"}};
    blesdk.setBlankKey(options,res=>{
        console.log(JSON.stringify(res));
    });

将钥匙设置为注册钥匙后，钥匙的密钥也会被修改为新密钥。将钥匙设置为注册钥匙后，用钥匙接触锁，修改锁的密钥。

蓝牙钥匙在线授权

如果制作开关锁钥匙 setUserKey 的 isOnline=true,则需要将钥匙在线授权才能开关锁

setOnline(callback); 例

    blesdk.setOnline(res=>{
        console.log(JSON.stringify(res));
    });

清除钥匙的黑名单标志

清除钥匙中的黑名单标记 clearBlocklistFlag(callback) 例

    blesdk.clearBlocklistFlag(res=>{
        console.log(JSON.stringify(res));
    });

钥匙校时

参数说明

options: yyyy-MM-dd HH:mm:ss setDateTime(options,callback)

    blesdk.setDateTime("2022-12-18 19:20:33",res=>{
        console.log(JSON.stringify(res));
    });

设置钥匙密钥

参数说明

options: {"nowSecret":string,"oldSecret":string}; nowSecret 钥匙的新密钥 oldSecret 钥匙的原密钥其中密钥由 A..F,0..9 共20个字符组成

setKeySecret(options,callback)

    blesdk.setKeySecret({"nowSecret":"FFFFFFFFFFFFFFFFFFFF","oldSecret":"FFFFFFFFFFFFFFFFFFFF"},
    res=>{
        console.log(JSON.stringify(res));
    });

下载指纹到钥匙

参数说明

options:{param = {id:1,fea:string} id 型，指纹id fea 指纹特征值 setFingerprint(options,callback)

    let options = {id:1,fea:"eJybHRVS5............................"}
    blesdk.setFingerprint(options,
    res=>{
        console.log(JSON.stringify(res));
    });

指纹授权

参数说明

options:[int] int 型数组,最多20个，只有针对授权的指纹id,指纹才能识别成功

setFingers(options,callback) 如：

blesdk.setFingers([5,6,29,30],res=>{
    console.log(JSON.stringify(res));
});

删除指纹授权

参数说明

options: int 指纹id 当指纹id == 0 时，删除全部指纹，否则删除指定的指纹

deleteFingerprint(options,callback)

blesdk.deleteFingerprint(10,res=>{
    console.log(JSON.stringify(res));
});

下载任务（任务版本）

参数说明

options: 格式
[ { "taskId": int,"users": [ {"id": int,"request": int} ],
        "timeBlocks":[{"dateSection":{"from":"yyyy-MM-dd","to": "yyyy-MM-dd"},
        "timeSection": [{"from": "yyyy-MM-dd HH:mm:ss","to": "yyyy-MM-dd HH:mm:ss"}]}],
        "restdays": ["yyyy-MM-dd HH:mm:ss"],
        "locks": [{"id": string,"mode": int,"num": int,"dateSectionIndex": [int]}]
      }
    ]
tasks: 任务列表
taskId 任务id
users.id 人员id
users.request 是否是必须人员(针对指纹钥匙有效)
timeBlocks.dateSection 任务有效日期段
timeBlocks.timeSection 任务有效时间段
（一个任务最多有8个日期段，10个时间段）
restdays 休息日，最多200个
locks.id 锁号(12位 由 0..1,A..F 组成)
locks.mode 锁类型(开关锁模式，0.表示任意人开、关,1.表示指定人开、关，可多人，任务中所有指定  的人员必须进行指纹认证、2.表示谁关谁开3.表示指定      人+任意多人开、关)
locks.num 开关锁人数
locks.dateSectionIndex 有效时间段，对应 timeBlock 第几个 dateSection。为空则全部有效。

setTasks(options,callback);

    param = [{"taskId": 1,"users": [{"userId": 1,"request": 1}],
            "timeBlocks": [{"from": "2022-01-08 00:00:00","to": "2023-12-31 00:00:00",
                    "times": [{"from": "2022-01-01 00:00:00","to": "2022-01-01 08:00:00"},
                        {"from": "2022-01-01 08:30:00","to": "2022-01-01 12:00:00"},
                        {"from": "2022-01-01 13:00:00","to": "2022-01-01 23:59:59"}
                    ]
            }],
            "restdays": ["2024-05-01 00:00:00","2025-06-03 00:00:00","2026-10-01 00:00:00"],
            "locks": [
                        {"lockId": "000022010001","mode": 0,"num": 1,"dateSectionIndex": [1]},
                        {"lockId": "202309070002","mode": 1,"num": 1,"dateSectionIndex": [1]}]
                        }
            ];
    let options = {"tasks":param,"isOnline":true}
        vanKeySdk.setTasks(options,res=>{
        console.log(JSON.stringify(res));
    });

删除任务（任务版本）

参数说明

options:[int]
当为空时，删除全部任务

delTask(options,callback);

    vanKeySdk.delTask([1,3],res=>{
        console.log(JSON.stringify(res));
    });

断开app与蓝牙钥匙的连接

参数说明

disconnectFromKey(callback)

blesdk.disconnectFromKey(10,res=>{
    console.log(JSON.stringify(res));
});

事件

onReport 事件

自动上报开关锁记录事件例

  globalEvent.addEventListener('onReport', function(data) {
        console.log(JSON.stringify(data));  
  });

名词解释

空白钥匙：空白模式，钥匙不起任何作用
用户钥匙：在给定的时间范围内，开指定的的锁。
管理钥匙：具有最高权限，在指定的时间内可以开密钥一直的所有的锁。
采集锁号钥匙：采集模式，用来采集锁具的（唯一）锁号。
注册钥匙：初始化模式，用来设置锁的密钥。需要被设置的锁的原始密钥要与注册钥匙的原始密钥一致。
事件钥匙：事件模式，采集锁具的开关锁记录记录。
黑名单钥匙：黑名单模式，将黑名单（丢失）钥匙（最多100个）下载到锁具中。
注：模式只有一个起作用