更新记录

1.0.0（2024-06-17）

初版

平台兼容性

sunmi-uhf

插件介绍

本插件用于uniapp、uniapp-x开发Sunmi L2k、L2s等Android设备上的UHF电子标签功能
当前插件支持对ISO-6C标签的盘存、读写等操作

插件使用

在script中引入插件

import * as uhf from '../../uni_modules/sunmi-uhf'

定义要使用的方法

methods:{
    //初始化sdk
    init() {
        uhf.initSdk({
            model(ret) {

            },
            sn(ret) {

            },
            softVersion(ret) {

            },
            hardwareVersion(ret) {

            }
        })
    }

    //标签盘存
    inventory() {
        uhf.realTimeInventory(1, {
            success: (ret) => {

            }
        })
    }
    //释放sdk
    deInit() {
        uhf.deInitSdk()
    }
}

API列表

initSdk(deviceInfo)

初始化SDK

参数

DevceInfo的属性值

示例

import * as uhf from '../../uni_modules/sunmi-uhf'
export default {
    //启动时初始化
    onReady() {
        let that = this
        uhf.initSdk({
            model : function(ret) {
                that.model = ret
            },
            sn(ret) {
                that.sn = ret
            },
            softVersion(ret) {
                that.soft = ret
            },
            hardwareVersion(ret) {
                that.hard = ret
            }
        })

    },
    //退出时反初始化
    onUnload() {
        uhf.deInitSdk()
    },
}

deInitSdk()

释放SDK，当不需要使用uhf时可以调用完全释放资源

getDeviceStatus(status)

获取模块运行时的配置状态

参数

DeviceStatus的属性值

RegionInfo的属性

MaskRule的属性

示例

//例如进入页面时查询当前的标签过滤信息
onLoad() {
    uhf.getDeviceStatus(["maskRule"], {
        maskRule(rules) {
            console.log(rules)
        }
    })
},

reset(complete)

复位模块，复位完成将通过异步回调返回

参数

realTimeInventory(repeate, result)

常规的盘存方法，每次使用API盘存将会激活标签，获取标签信息，实际使用中需要反复调用API来检索区域内的标签，repeate表示本次盘存过程中同一个标签的上报数量

参数

InventoryResult的属性
盘存结果

InventoryResultInfo的属性

TagInfo的属性

示例

uhf.realTimeInventory(1, {
                        success(inventory) {
                            //盘存执行成功完成
                        },
                        fail(error) {
                            //返回盘存失败结束
                        },
                        tag(info) {
                            //盘存过程中盘存到的标签信息
                        }
                    })

customInventory(strategy, result)

自定义盘存方法

参数

CustomStrategy的属性

示例

uhf.customInventory({
    repeate: 1,
    session: 1,
    target: 0,
    flag: 0,
    phase: 0,
    powersave: 0,
}, {
    success(inventory) {
        //盘存成功完成
    },
    fail(error) {
        //盘存失败结束
    },
    tag(info) {
        //盘存到的标签信息
    }
})

switchInventory(strategy, result)

轮询天线盘存方法

参数

SwitchStrategy的属性

示例

uhf.switchInventory({
        repeate: 1,
        firstId: 0,
        firstNums: 1,
        secondId: 1,
        secondNums: 1,
        thirdId: 2,
        thirdNums: 1,
        forthId: 3,
        forthNums: 1,
        intervalTime: 10,
    }, {
        success(inventory) {
            //盘存成功完成
        },
        fail(error) {
            //盘存失败结束
        },
        tag(info) {
            //盘存到的标签信息
        }
    })

accessTag(epc, result)

设置预操作的标签，对标签的读写等控制需要先指定标签

参数

OptResult的属性

OptResultInfo的属性

示例

uhf.accessTag(/* 盘存得到的EPC字符串 */, {
                success(opt) {
                    //仅需要关注是否成功
                    uni.showToast({
                        title: "access tag successfully",
                        icon:'none'
                    })
                },
                fail(error) {
                    //仅需要关注是否失败
                    uni.showToast({
                        title: error,
                        icon:'none'
                    })
                }
            })

cancelAccessTag(result)

取消要操作的标签

参数

getAccessTag(result)

获取当前正在操作的标签

参数

示例

uhf.getAccessTag({
    success(opt) {
        //获取记录的标签信息
        console.log(opt.accessTag)
    },
    fail(error) {
        console.log(error)
    }
})

readAccessTag(request, result)

读取指定的标签数据

参数

ReadOptRequest的属性

示例

uhf.readAccessTag({
        password: "1234",
        mem: 0,
        address: 0,
        length: 1
    }, {
        success(opt) {
            //可展示读取到的标签数据
            console.log(opt)
        },
        fail(error) {
            console.log(error)
        }
    })

writeAccessTag(request, result)

向指定标签写入数据

参数

WriteOptRequest的属性

示例

uhf.writeAccessTag({
                password: "1234"
                mem: 0,
                address: 0,
                length: 4,
                data: ""//即0123
            }, {
                success(opt) {
                    console.log(opt)
                },
                fail(error) {
                    console.log(error)
                }
            })

lockAccessTag(request, result)

锁定指定标签的存储区域

参数

LockOptRequest的属性

示例

uhf.lockAccessTag({
                    password: "1234",
                    lockMem: 0,
                    lockType: 0
                },{
                    success(opt) {
                        console.log(opt)
                    },
                    fail(error) {
                        console.log(error)
                    }
                })

killAccessag(password, result)

对指定的标签执行销毁操作,此操作是不可逆的，请谨慎使用

参数

示例

uhf.killAccessTag("1111", {
    success(opt) {
        console.log(opt)
    },
    fail(error) {
        console.log(error)
    }
})

cacheInventory(repeate, result)

缓存盘存方法，开启缓存盘存，使用此方法不会直接返回盘存到的标签结果，可在需要时通过读取方法获取缓存的标签数据

参数

getCacheInventory(clear, result)

获取缓存盘存到的标签

参数

getCacheInventoryNums(result)

获取缓存盘存到的有效标签数量

参数

resetCacheInventory(result)

重置缓存标签

参数

示例

//1、首先启动盘存
uhf.cacheInventory(1, {
        success(inventory) {
            //盘存成功完成
        },
        fail(error) {
            //盘存失败结束
        }
    })
//2、获取盘存到的标签信息
uhf.getCacheInventory(false, {
                success(inventory) {
                    //获取完成
                },
                tag(info) {
                    //标签信息
                },
                fail(error) {
                   //获取失败
                },
            })
//3、可选清除缓存到的标签信息
uhf.resetCacheInventory({
            success(inventory) {
                //清除成功
            },
            fail(error) {
                //清除失败
            }
        })

setImpinjFastTid(open, save, result)

针对Impinj Monza标签启用FastTID功能

参数

示例

uhf.setImpinjFastTid(false, false, {
        success(opt) {
            console.log("setImpinjFastTid success")
        },
        fail(error) {
            console.log(`setImpinjFastTid ${error}`)
        }
    })

setWorkAntenna(antId, result)

指定当前模块使用的天线

参数

setOutputAllPower(power, result)

设置所有天线的工作功率

参数

setOutputPower(power1, power2, power3, power4, result)

设置各个天线的工作功率

参数

setTemporaryOutputPower(power, result)

临时设置所有天线的工作功率，模块复位后将恢复

参数

setFrequencyRegion(region, start, end, result)

模块频段区域设置，指定模块使用的区域以及此区域下的频率范围

参数

setUserFrequencyRegion(interval, quantity, start, result)

设置自定义的频段范围

参数

setRfLinkProfile(profile, result)

射频链路配置

参数

setTagMask(maskRule, result)

设置标签盘存过滤规则，可根据设置的规则过滤掉盘存到的标签

参数

示例

uhf.setTagMask({
    maskNo: 1,
    session: 0,
    rules: 0,
    maskMem: 0,
    maskValue: [30,31,32,33],
    address: 0  //标签EPC内容过滤的位置
}, {
    success(opt) {
        console.log("set tag success")
    },
    fail(error) {
        console.log(error)
    }
})

clearTagMask(maskNo, result)

清除标签盘存过滤规则

参数

示例

TODO

详细说明

模块的型号

UHF模块的型号：
100 未识别
101 R2000
102 INNER
103 S700

充电状态

模块的充电状态：
0 未充电
1 预充电
2 快速充电
3 充电完成

射频链路

模块的射频链路配置信息：
0 Tari 25uS,FM0 40KHz
1 Tari 25uS,Miller 4 250KHz
2 Tari 25uS,Miller 4 300KHz
3 Tari 6.25uS,FM0 400KHz

频段区域

模块的区域频段类型：
1 美规频段 902~928MHz
2 欧规频段 865~868MHz
3 中规频段 920~925MHz
4 自定义频段

自定义盘存模式

当前盘存的模式： 0 S0模式 1 S1模式 2 S2模式 3 S3模式

标签过滤规则

设置或读取标签的过滤规则：
0 (匹配)确认 SL 标志或已盘标志 → A\n(不匹配)取消确认 SL 标志或已盘标志 → B
1 (匹配)确认 SL 标志或已盘标志 → A\n(不匹配)无作为
2 (匹配)无作为\n(不匹配)取消确认 SL 标志或已盘标志 → B
3 (匹配)否定 SL 标志或已盘标志 A → B，B → A\n(不匹配)无作为
4 (匹配)取消确认 SL 标志或已盘标志 → B\n(不匹配)确认 SL 标志或已盘标志 → A
5 (匹配)取消确认 SL 标志或已盘标志 → B\n(不匹配)无作为
6 (匹配)无作为\n(不匹配)确认 SL 标志或已盘标志 → A
7 (匹配)无作为\n(不匹配)否定 SL 标志或已盘标志 A → B，B → A

标签数据区域

设置或读取标签的过滤规则生效区域：
0 None
1 EPC
2 TID
3 USER

标签状态

盘存到的标签状态：
1 表示此标签为首次识别
2 表示此标签为再次识别

盘存次数

盘存次数表示每次使用盘存方法时，对同一个标签的返回次数，如果设置为1表示只上报一次标签，同一个标签在此标签生命周期中不再上报
为255则此存时间为最短时间。 如果射频区域内只有一张标签，则此轮的盘存约耗时为30-50ms。一般在四通道机器上快速轮询多个天线时使用此参数值

可锁定数据区域

对标签执行锁操作的数据区域
1 USER
2 TID
3 EPC
4 PASSWORD
5 KILL PASSWORD

锁定方法

对标签执行锁操作的类型，注意使用永久方式对标签是不可逆的，请谨慎使用
0 开放
1 锁定
2 永久开放
3 永久锁定