【小程序开发】蓝牙设备API——单点蓝牙应用程序编程接口整理（一）

ty.device.connectBluetoothDevice

蓝牙连接

聚合接口，支持 Bluetooth LE、双模中 Bluetooth LE、Beacon、Mesh、Mesh 单火类连接。

需引入 DeviceKit，且在 >=3.1.0 版本才可使用。

参数

Object object

属性	类型	默认值	必填	说明
devId	string		是	设备 ID
timeoutMillis	number		否	连接超时时限 单位: 毫秒
souceType	number		否	来源类型，如果是面板进来的自动连接，输入 1；否则默认 0，为主动连接
connectType	number		否	蓝牙连接方式,默认 0。0：网关和 app 都需要，默认值，本地和网关两个途径任何一个可用均可生效。1：仅 app，只会判定本地是否在线，以及本地连接是否成功。2：仅网关连接，只会判定网关是否在线，以及坚持网关连接是否成功
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 蓝牙连接
 *聚合接口，Bluetooth LE、双模中 Bluetooth LE、Beacon、Mesh、Mesh 单火类连接。
 */
export function connectBluetoothDevice(params: {
  /** 设备 ID */
  devId: string;
  /**
   * 连接超时时限
   * 单位: 毫秒
   */
  timeoutMillis?: number;
  /**
   * 来源类型
   * 如果是面板进来的自动连接, 输入 1; 否则，默认 0，为主动连接
   */
  souceType?: number;
  /**
   * 蓝牙连接方式,默认0
   * 0：网关和 app 都需要，默认值，本地和网关两个途径任何一个可用均可生效
   * 1：仅 app，只会判定本地是否在线，以及本地连接是否成功
   * 2：仅网关连接，只会判定网关是否在线，以及坚持网关连接是否成功
   */
  connectType?: number;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: null) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

👉 立即开发。 

ty.device.disconnectBluetoothDevice

蓝牙断开连接

聚合接口, 支持 Bluetooth LE、双模中的 Bluetooth LE、Mesh 单火类以及 Mesh 连接断开。Beacon 设备调用无效。

需引入 DeviceKit，且在 >=3.1.0 版本才可使用。

参数

Object object

属性	类型	默认值	必填	说明
devId	string		是	设备 ID
connectType	number		否	蓝牙连接方式，默认 0。0：网关和 app 都需要，默认值，本地和网关两个途径任何一个可用均可生效。1：仅 app，只会判定本地是否在线，以及本地连接是否成功。2：仅网关连接，只会判定网关是否在线，以及坚持网关连接是否成功
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

函数定义示例

/**
 * 蓝牙断开连接
 *聚合接口，支持 Bluetooth LE、双模中的 Bluetooth LE、Mesh 单火类以及 Mesh连接断开。Beacon 设备调用无效。
 */
export function disconnectBluetoothDevice(params: {
  /** 设备 ID */
  devId: string;
  /**
   * 蓝牙连接方式，默认 0
   * 0：网关和 app 都需要，默认值，本地和网关两个途径任何一个可用均可生效
   * 1：仅 app，只会判定本地是否在线，以及本地连接是否成功
   * 2：仅网关连接，只会判定网关是否在线，以及坚持网关连接是否成功
   */
  connectType?: number;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: null) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.device.bluetoothCapabilityIsSupport

蓝牙设备是否支持某个能力 5->定时 6->BT

需引入DeviceKit，且在>=2.2.1版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	设备 Id
capability	number		是	能力值标位 5：定时
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性	类型	说明
isSupport	boolean	是否支持蓝牙相关能力的结果回调 isSupport 是否支持

object.fail 回调参数

参数

Object res

属性	类型	说明
errorMsg	string	插件错误信息
errorCode	string	错误码
innerError	object	插件外部依赖错误信息 {errorMsg: string, errorCode: string }

ty.device.bluetoothIsPowerOn

判断手机蓝牙是否打开

需引入DeviceKit，且在>=1.2.6版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

ty.device.cancelBLEFileTransfer

取消文件传输到蓝牙设备 仅 IOS 支持

需引入DeviceKit，且在>=3.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 设备 id
fileId	number		是	文件 id
fileIdentifier	string		是	文件标识符
fileVersion	number		是	文件版本
filePath	string		是	文件地址
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

ty.device.connectBLEDevice

连接 BLE(thing)设备，【Android 特有：与 directConnectBLEDevice 方法的区别在于，该方法会先进行扫描的动作，扫描到设备之后才会进行连接。】

需引入DeviceKit，且在>=3.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

ty.device.directConnectBLEDevice

直连 BLE(thing)设备，【Android 特有：与 connectBLEDevice 方法的区别在于，该方法在连接设备时并不会进行扫描的动作。换言之，需要先扫描到设备之后，方可调用该方法进行连接】

需引入DeviceKit，且在>=2.1.6版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

ty.device.disconnectBLEDevice

断开 BLE(thing)设备

需引入DeviceKit，且在>=3.0.0版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

 👉 立即开发。