更新记录
1.5.0(2023-04-04)
本次主要更新: 1.修复KJ-NFCTag找不到这个插件的bug
1.4.0(2023-04-03)
本次主要更新: 1.KJ-NFCTag 增加 ISO15693 读与写数据
1.3.0(2022-08-26)
本次主要更新: 1.修复KJ-NFCTag,方法回调错误
查看更多平台兼容性
Android | iOS |
---|---|
× | 适用版本区间:11 - 16 |
原生插件通用使用流程:
- 购买插件,选择该插件绑定的项目。
- 在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原生插件配置”->”云端插件“列表中删除该插件重新选择
KJ-NFC
NFC完整版、同步读与写、读取连接标签、查询NDEF状态、读写NDEF(ios)
注意
1. 需要在 manifest.json 开启 “使用NFC” 权限,bundleid也要开启NFC Tag Reading
2. 请使用合适再购买,卡能读取就支持,不能读取就不支持
证书配置教程:https://docs.qq.com/doc/DWnhYQ1hSVmd4anhJ
KJ-NFC使用
<template>
<view class="content">
<button type="primary" @click="isSupportsNFCRead">是否支持NFC读</button>
<button type="primary" @click="isSupportsNFCWrite">是否支持NFC写</button>
<button type="primary" @click="beginSession">开始会话</button>
<button type="primary" @click="restartPolling">重启会话</button>
<button type="primary" @click="invalidateSession">结束会话</button>
<button type="primary" @click="setAlertMessage">修改提示信息</button>
</view>
</template>
<script>
const KJNFC = uni.requireNativePlugin('KJ-NFC');
export default {
data() {
return {
title: 'Hello'
}
},
onLoad() {
},
methods: {
isSupportsNFCRead() {
KJNFC.isSupportsNFCRead((res) => {
console.log("isSupportsNFCRead:" + JSON.stringify(res))
});
},
isSupportsNFCWrite() {
KJNFC.isSupportsNFCWrite((res) => {
console.log("isSupportsNFCWrite:" + JSON.stringify(res))
});
},
beginSession() {
/**
* ios11-ios12,只有读取,ios13及以上,有读与写
* */
var dic = {
"alertMessage": "准备扫描,请将标签贴近手机", //提示的信息
"invalidateAfterFirstRead": false, //是否第一个NDEF标签读取成功后,会话将自动失效
}
KJNFC.beginSession(dic, (res) => {
console.log(JSON.stringify(res));
if (res.type == "beginSession") {
console.log("开始:" + JSON.stringify(res))
} else if (res.type == "readerSessionDidBecomeActive") { //ios13及以上才会回调
console.log("开始完成:" + JSON.stringify(res))
} else if (res.type == "didInvalidateWithError") {
console.log("扫描失败:" + JSON.stringify(res))
if (res.errorCode == 200) {
console.log("取消扫描")
} else if (res.errorCode == 201) {
console.log("扫描超时")
}
} else if (res.type == "didDetectNDEFs") { //ios11-ios12,才会回调
console.log("检测NDEF:" + JSON.stringify(res))
} else if (res.type == "didDetectTags") { //从这里开始,某个环节失败,都不会往下执行,ios13及以上才会回调
console.log("读取标签:" + JSON.stringify(res))
var tags = res.tags; //返回读取到的所有标签,isAvailable-是否可用
if (tags.length > 0) {
var tagIndex = 0; //传tags数组的索引
KJNFC.connectToTag({
"tagIndex": tagIndex
}, (res) => {
console.log("连接到标签:" + JSON.stringify(res))
if (res.result == true) {
KJNFC.queryNDEFStatus({
"tagIndex": tagIndex
}, (res) => {
console.log("查询NDEF状态:" + JSON.stringify(res))
if (res.result == true) {
var status = res
.status; //NDEF状态 1-不允许NDEF读取和写入 2-可读写 3-只读
if (status == 2 || status == 3) {
KJNFC.readNDEF({
"tagIndex": tagIndex
}, (res) => {
//res.records
console.log("读NDEF:" + JSON.stringify(
res))
});
}
if (status == 2) {
/**
* typeNameFormat: 类型名称 Empty NFCWellKnown Media AbsoluteURI NFCExternal Unknown Unchanged
* type: //类型 1代表:http://www. 2代表:https://www. 3代表:http:// 4代表:https:// 5代表:tel: 6代表:mailto: 大于6代表写入ndef内容
* 当类型为U是,payload可以填入-https://www.example.com -mailto:user@example.com -tel:+1851000888 -sms:+1851000888 -facetime://:user@example.com
* identifier: 唯一id,可以随便设置
* payload: 内容
* */
var dic = {
"tagIndex": tagIndex,
"records": [{
"typeNameFormat": "NFCWellKnown",
"type": "U",
"identifier": "123456",
"payload": "-https://www.example.com"
}]
}
KJNFC.writeNDEF(dic, (res) => {
console.log("写NDEF:" + JSON.stringify(
res))
});
}
}
})
}
})
}
}
});
},
restartPolling() {
KJNFC.restartPolling((res) => { //ios13及以上支持
console.log("restartPolling:" + JSON.stringify(res))
});
},
invalidateSession() {
KJNFC.invalidateSession((res) => {
console.log("invalidateSession:" + JSON.stringify(res))
});
},
setAlertMessage() {
KJNFC.setAlertMessage({
"alertMessage": ""
}, (res) => {
console.log("setAlertMessage:" + JSON.stringify(res))
});
}
}
}
</script>
KJ-NFCTag使用
<template>
<view class="content">
<button type="primary" @click="isSupportsNFCRead">是否支持NFC读</button>
<button type="primary" @click="isSupportsNFCWrite">是否支持NFC写</button>
<button type="primary" @click="beginSession">开始会话</button>
<button type="primary" @click="restartPolling">重启会话</button>
<button type="primary" @click="invalidateSession">结束会话</button>
<button type="primary" @click="setAlertMessage">修改提示信息</button>
</view>
</template>
<script>
const KJNFC = uni.requireNativePlugin('KJ-NFCTag');
export default {
data() {
return {
title: 'Hello'
}
},
onLoad() {
},
methods: {
isSupportsNFCRead() {
KJNFC.isSupportsNFCRead((res) => {
console.log("isSupportsNFCRead:" + JSON.stringify(res))
});
},
isSupportsNFCWrite() {
KJNFC.isSupportsNFCWrite((res) => {
console.log("isSupportsNFCWrite:" + JSON.stringify(res))
});
},
beginSession() {
/**
* ios13及以上,有读与写
* 支持 ISO14443 ISO15693 ISO18092
* */
var dic = {
"alertMessage": "准备扫描,请将标签贴近手机" //提示的信息
}
KJNFC.beginSession(dic, (res) => {
console.log(JSON.stringify(res));
if (res.type == "beginSession") {
console.log("开始:" + JSON.stringify(res))
} else if (res.type == "readerSessionDidBecomeActive") { //ios13及以上才会回调
console.log("开始完成:" + JSON.stringify(res))
} else if (res.type == "didInvalidateWithError") {
console.log("扫描失败:" + JSON.stringify(res))
if (res.errorCode == 200) {
console.log("取消扫描")
} else if (res.errorCode == 201) {
console.log("扫描超时")
}
} else if (res.type == "didDetectTags") { //从这里开始,某个环节失败,都不会往下执行,ios13及以上才会回调
console.log("读取标签:" + JSON.stringify(res))
/**
* 返回字段说明:
* isAvailable - 是否可用
* type - 1(ISO15693) 2(FeliCa) 3(ISO7816Compatible) 4(MiFare)
* identifier - uid FeliCa没有这个字段
* */
var tags = res.tags; //返回读取到的所有标签,
if (tags.length > 0) {
var tagIndex = 0; //传tags数组的索引
var tag = tags[tagIndex];
KJNFC.connectToTag({
"tagIndex": tagIndex
}, (res) => {
console.log("连接到标签:" + JSON.stringify(res))
if (res.result == true) {
KJNFC.queryNDEFStatus({
"tagIndex": tagIndex
}, (res) => {
console.log("查询NDEF状态:" + JSON.stringify(res))
if (res.result == true) {
var status = res
.status; //NDEF状态 1-不允许NDEF读取和写入 2-可读写 3-只读
if (status == 2 || status == 3) {
if (tag.type == 1) { //ISO15693
/**
* flags - 请求标记 1 << 0(双子载波) 1 << 1(高数据速率) 1 << 3(协议扩展) 1 << 4(选择) 1 << 5(地址) 1 << 6(选项) 1 << 7(命令特定位8)
* */
KJNFC
.readMultipleBlocksWithRequestFlags_ISO15693({
"tagIndex": tagIndex,
"flags": 1 << 0 | 1 << 1 | 1 << 3 |
1 << 4 | 1 << 5 | 1 << 6 | 1 <<
7,
"blockRange": { //块范围
"location": 0, //起始位置 0到255
"length": 255 //长度 1到256
}
}, (res) => {
//res.records
console.log("读ISO15693:" + JSON
.stringify(
res))
});
} else {
KJNFC.readNDEF({
"tagIndex": tagIndex
}, (res) => {
//res.records
console.log("读NDEF:" + JSON
.stringify(
res))
});
}
}
if (status == 2) {
if (tag.type == 1) { //ISO15693
/**
* flags - 请求标记 1 << 0(双子载波) 1 << 1(高数据速率) 1 << 3(协议扩展) 1 << 4(选择) 1 << 5(地址) 1 << 6(选项) 1 << 7(命令特定位8)
* */
KJNFC
.writeMultipleBlocksWithRequestFlags_ISO15693({
"tagIndex": tagIndex,
"flags": 1 << 0 | 1 << 1 | 1 << 3 |
1 << 4 | 1 << 5 | 1 << 6 | 1 <<
7,
"blockRange": { //块范围
"location": 0, //起始位置 0到255
"length": 255 //长度 1到256
},
"dataBlocks": [
"xxxxx"
] //16进制字符串数组
}, (res) => {
//res.records
console.log("写ISO15693:" + JSON
.stringify(res))
});
} else {
/**
* typeNameFormat: 类型名称 Empty NFCWellKnown Media AbsoluteURI NFCExternal Unknown Unchanged
* type: //类型 1代表:http://www. 2代表:https://www. 3代表:http:// 4代表:https:// 5代表:tel: 6代表:mailto: 大于6代表写入ndef内容
* 当类型为U是,payload可以填入-https://www.example.com -mailto:user@example.com -tel:+1851000888 -sms:+1851000888 -facetime://:user@example.com
* identifier: 唯一id,可以随便设置
* payload: 内容
* */
var dic = {
"tagIndex": tagIndex,
"records": [{
"typeNameFormat": "NFCWellKnown",
"type": "U",
"identifier": "123456",
"payload": "-https://www.example.com"
}]
}
KJNFC.writeNDEF(dic, (res) => {
console.log("写NDEF:" + JSON
.stringify(
res))
});
}
}
}
})
}
})
}
}
});
},
restartPolling() {
KJNFC.restartPolling((res) => { //ios13及以上支持
console.log("restartPolling:" + JSON.stringify(res))
});
},
invalidateSession() {
KJNFC.invalidateSession((res) => {
console.log("invalidateSession:" + JSON.stringify(res))
});
},
setAlertMessage() {
KJNFC.setAlertMessage({
"alertMessage": ""
}, (res) => {
console.log("setAlertMessage:" + JSON.stringify(res))
});
}
}
}
</script>