Beacon API
ty.device.bluetoothCapabilityOfBLEBeacon
设备是否支持 BLEBeacon 能力
引入
需引入
DeviceKit
,且在>=1.2.6
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | 设备模型 deviceId 设备 Id | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.readBeaconFenceConfig
读取 beaconFence 配置
需引入
DeviceKit
,且在>=2.4.0
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | 设备模型 deviceId 设备 Id | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
object.success 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
deviceId | string | 设备模型 设备 id |
beaconFenceRssi | number | 最小信号强度 |
isOpenEventWhenApproachingBeaconFence | boolean | 设置是否打开进入范围强度区间发送 dp 功能 |
isOpenEventWhenLeaveBeaconFence | boolean | 设置是否打开离开范围强度区间发送 dp 功能 |
isOpenNotifyWhenLeaveBeaconFence | boolean | 设置是否打开离开范围强度区间发送本地通知 |
object.fail 回调参数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
errorMsg | string | 插件错误信息 |
errorCode | string | 错误码 |
innerError | object | 插件外部依赖错误信息 {errorMsg: string, errorCode: string } |
👉 立即开发。
ty.device.writeBeaconFenceConfig
写入 BeaconFence 配置
需引入
DeviceKit
,且在>=2.4.0
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | 设备模型 设备 id | |
beaconFenceRssi | number | 是 | 最小信号强度 | |
isOpenEventWhenApproachingBeaconFence | boolean | 是 | 设置是否打开进入范围强度区间发送 dp 功能 | |
isOpenEventWhenLeaveBeaconFence | boolean | 是 | 设置是否打开离开范围强度区间发送 dp 功能 | |
isOpenNotifyWhenLeaveBeaconFence | boolean | 是 | 设置是否打开离开范围强度区间发送本地通知 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.startBLEScanBeacon
启动扫描 Beacon 扫描
需引入
DeviceKit
,且在>=1.2.6
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | 设备模型 deviceId 设备 Id | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.stopBLEScanBeacon
停止扫描 Beacon 扫描。
需引入
DeviceKit
,且在>=1.2.6
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | 设备模型 deviceId 设备 Id | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.registerLeaveBeaconFenceEvent
注册监听远离 beacon 设备范围事件
需引入
DeviceKit
,且在>=2.4.0
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | 设备模型 设备 id | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.unregisterLeaveBeaconFenceEvent
注册监听远离 beacon 设备范围事件
需引入
DeviceKit
,且在>=2.4.0
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | 设备模型 设备 id | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.onLeaveBeaconFence
远离 beacon 设备的事件
需引入
DeviceKit
,且在>=2.4.0
版本才可使用
参数
function callback
远离 beacon 设备的事件的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | 设备模型 设备 id | |
text | string | 是 | 具体文案 |
ty.device.offLeaveBeaconFence
取消监听:远离 beacon 设备的事件
需引入
DeviceKit
,且在>=2.4.0
版本才可使用
参数
function callback
取消监听:远离 beacon 设备的事件的回调函数
回调参数 Object res
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | 设备模型 设备 id | |
text | string | 是 | 具体文案 |
其他 API
ty.device.startBLEMeshLowPowerConnection
发起蓝牙 mesh 设备直连
需引入
DeviceKit
,且在>=2.2.7
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | deviceId 设备 id | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
ty.device.stopBLEMeshLowPowerConnection
断开蓝牙 mesh 设备连接
需引入
DeviceKit
,且在>=2.2.7
版本才可使用
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
deviceId | string | 是 | deviceId 设备 id | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 |
👉 立即开发。