接口名	描述
createPort(uuid: string): void	注册端口通道。
destroyPort(uuid: string): void	销毁端口通道。
connect(params: ConnectionParams): Promise<void>	连接远端设备，建立端口通道。使用Promise异步回调。
disconnect(params: ConnectionParams): Promise<void>	断开端口通道连接。使用Promise异步回调。
writeData(params: DataParams): Promise<void>	通过设备地址和UUID向远端设备发数据。使用Promise异步回调。
onConnectionStateChanged(callback: Callback<ConnectionResult>): void	订阅端口通道连接状态变更事件。使用callback异步回调。
onReadData(callback: Callback<DataParams>): void	订阅端口通道数据接收事件。使用callback异步回调。

开发步骤

导入相关模块。

import { hilog } from '@kit.PerformanceAnalysisKit';
import { BusinessError } from '@kit.BasicServicesKit';
import { dataTransfer } from '@kit.ConnectivityKit';

定义端口UUID与设备地址变量，供后续步骤使用。

let serviceUuid: string = 'FFFFFFFF-1234-5678-ABCD-000000001244';
let chosenDeviceAddr: string;

注册端口通道，发送端和接收端均需注册。

try {
  dataTransfer.createPort(serviceUuid);
  // ...
} catch (err) {
  hilog.error(0x0000, 'testTag',
    `errCode: ${(err as BusinessError).code}, errMessage: ${(err as BusinessError).message}`);
  // ...
}

订阅端口通道连接状态变更事件。不再需要订阅事件时，调用offConnectionStateChanged()取消订阅。

try {
  dataTransfer.onConnectionStateChanged((data: dataTransfer.ConnectionResult) => {
    hilog.info(0x0000, 'testTag', `Connection state: ${JSON.stringify(data)}`);
    // ...
  });
} catch (err) {
  hilog.error(0x0000, 'testTag',
    `errCode: ${(err as BusinessError).code}, errMessage: ${(err as BusinessError).message}`);
}

订阅端口通道数据接收事件。不再需要订阅事件时，调用offReadData()取消订阅。

try {
  dataTransfer.onReadData((data: dataTransfer.DataParams) => {
    hilog.info(0x0000, 'testTag', `Data received: ${JSON.stringify(data)}`);
    // ...
  });
} catch (err) {
  hilog.error(0x0000, 'testTag',
    `errCode: ${(err as BusinessError).code}, errMessage: ${(err as BusinessError).message}`);
}

连接远端设备，建立端口通道。其中chosenDeviceAddr为从发起星闪扫描结果中选择的设备地址，UUID需与步骤3中注册的保持一致。

try {
  let params: dataTransfer.ConnectionParams = {
    address: chosenDeviceAddr,
    uuid: serviceUuid,
    transferMode: dataTransfer.TransferMode.BASIC
  };
  await dataTransfer.connect(params);
  // ...
} catch (err) {
  hilog.error(0x0000, 'testTag',
    `errCode: ${(err as BusinessError).code}, errMessage: ${(err as BusinessError).message}`);
  // ...
}

通过设备地址和UUID向远端设备发数据。

连续多次调用writeData可能导致发送队列拥塞而发送失败。建议通过setInterval设置数据发送时间间隔，推荐间隔为10ms（参见星闪常见问题 > 连续调用writeData为什么会发送失败）。

try {
  // 使用固定示例数据填充负载，实际开发中替换为业务数据
  let dataBuffer = new ArrayBuffer(4);
  let data = new Uint8Array(dataBuffer);
  data[0] = 0x01;
  data[1] = 0x02;
  data[2] = 0x03;
  data[3] = 0x04;

  let params: dataTransfer.DataParams = {
    address: chosenDeviceAddr,
    uuid: serviceUuid,
    data: dataBuffer
  };
  await dataTransfer.writeData(params);
  // ...
} catch (err) {
  hilog.error(0x0000, 'testTag',
    `errCode: ${(err as BusinessError).code}, errMessage: ${(err as BusinessError).message}`);
  // ...
}

断开端口通道连接。

try {
  let params: dataTransfer.ConnectionParams = {
    address: chosenDeviceAddr,
    uuid: serviceUuid
  };
  await dataTransfer.disconnect(params);
  // ...
} catch (err) {
  hilog.error(0x0000, 'testTag',
    `errCode: ${(err as BusinessError).code}, errMessage: ${(err as BusinessError).message}`);
  // ...
}

销毁端口。数据传输完成后，应用销毁端口，释放端口通道及相关资源。

try {
  dataTransfer.destroyPort(serviceUuid);
  // ...
} catch (err) {
  hilog.error(0x0000, 'testTag',
    `errCode: ${(err as BusinessError).code}, errMessage: ${(err as BusinessError).message}`);
  // ...
}

目录

使用星闪传输数据

场景介绍

接口说明

开发步骤