• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 传输数据开发指导
2
3## 简介
4SPP是Serial Port Profile（串口协议）的缩写，是一种蓝牙协议，用于在蓝牙设备之间建立串行通信连接。通过SPP，蓝牙设备可以像使用串口一样进行数据传输，例如传输文件、文本等。
5
6## 场景介绍
7
8主要场景有：
9- 服务端向客户端发送数据。
10- 通过socket建立与对端设备的连接。
11
12## 接口说明
13
14完整的JS API说明以及示例代码请参考：[SPP接口](../../reference/apis-connectivity-kit/js-apis-bluetooth-socket.md)。
15
16具体接口说明如下表。
17
18| 接口名                             | 功能描述                                                                       |
19| ---------------------------------- | ------------------------------------------------------------------------------ |
20| sppListen()                        | 创建一个服务端监听socket。                                                       |
21| sppAccept()                        | 服务端监听socket等待客户端连接。                                                  |
22| sppConnect()                       | 客户端向远端设备发起spp连接。                                                     |
23| sppCloseServerSocket()             | 关闭服务端监听socket。                                                           |
24| sppCloseClientSocket()             | 关闭客户端socket。                                                               |
25| sppWrite()                         | 通过socket向远端发送数据。                                                       |
26| on(type: 'sppRead')                | 订阅spp读请求事件。                                                              |
27| off(type: 'sppRead')               | 取消订阅spp读请求事件。                                                           |
28
29## 主要场景开发步骤
30
31### 服务端向客户端发送数据
321. 导入所需的socket模块。
332. 需要SystemCapability.Communication.Bluetooth.Core系统能力。
343. 需要申请权限ohos.permission.ACCESS_BLUETOOTH。
354. 开启设备蓝牙。
365. 创建服务端socket，并返回serverId。
376. 服务端等待客户端连接，并返回clientId。
387. 服务端向客户端发送数据。
398. （可选）服务端订阅客户端发送的数据。
409. 注销服务端socket。
4110. 注销客户端socket。
4211. 示例代码：
43
44    ```ts
45    import { socket } from '@kit.ConnectivityKit';
46    import { AsyncCallback, BusinessError } from '@kit.BasicServicesKit';
47
48    // 创建服务器监听Socket, 返回serverId
49    let serverNumber = -1;
50    let sppOption: socket.SppOptions = {
51      uuid: '00001101-0000-1000-8000-00805f9b34fb',
52      secure: true,
53      type: 0
54    };
55    socket.sppListen('server1', sppOption, (code, serverSocketID) => {
56      if (code != null) {
57        console.error('sppListen error, code is ' + (code as BusinessError).code);
58        return;
59      } else {
60        serverNumber = serverSocketID;
61        console.info('sppListen success, serverNumber = ' + serverNumber);
62      }
63    });
64
65    // socket等待客户端连接，连接成功返回clientId
66    let clientNumber = -1;
67    socket.sppAccept(serverNumber, (code, clientSocketID) => {
68      if (code != null) {
69        console.error('sppAccept error, code is ' + (code as BusinessError).code);
70        return;
71      } else {
72        clientNumber = clientSocketID;
73        console.info('accept the client success');
74      }
75    })
76    console.info('waiting for client connection');
77
78    // 服务端向客户端发送数据
79    let array = new Uint8Array(990);
80    array[0] = 'A'.charCodeAt(0);
81    array[1] = 'B'.charCodeAt(0);
82    array[2] = 'C'.charCodeAt(0);
83    array[3] = 'D'.charCodeAt(0);
84    socket.sppWrite(clientNumber, array.buffer);
85    console.info('sppWrite success');
86
87    // 订阅读请求事件
88    socket.on('sppRead', clientNumber, (dataBuffer: ArrayBuffer) => {
89      const data = new Uint8Array(dataBuffer);
90      if (data != null) {
91        console.info('sppRead success, data = ' + JSON.stringify(data));
92      } else {
93        console.error('sppRead error, data is null');
94      }
95    });
96
97    // 取消订阅读请求事件
98    socket.off('sppRead', clientNumber, (dataBuffer: ArrayBuffer) => {
99      const data = new Uint8Array(dataBuffer);
100      if (data != null) {
101        console.info('offSppRead success, data = ' + JSON.stringify(data));
102      } else {
103        console.error('offSppRead error, data is null');
104      }
105    });
106
107    // 注销服务端socket
108    socket.sppCloseServerSocket(serverNumber);
109    console.info('sppCloseServerSocket success');
110
111    // 注销客户端socket
112    socket.sppCloseClientSocket(clientNumber);
113    console.info('sppCloseClientSocket success');
114    ```
115
11611. 错误码请参见[蓝牙服务子系统错误码](../../reference/apis-connectivity-kit/errorcode-bluetoothManager.md)。
117
118### 通过socket连接对端设备
1191. 导入所需的socket模块。
1202. 需要SystemCapability.Communication.Bluetooth.Core系统能力。
1213. 开启设备蓝牙。
1224. 启用BLE扫描功能，获取对端设备的MAC地址。
1235. 建立与对端设备的连接。
1246. 示例代码：
125
126    ```ts
127    import { socket } from '@kit.ConnectivityKit';
128    import { AsyncCallback, BusinessError } from '@kit.BasicServicesKit';
129
130    // 开启ble扫描，获取对端设备mac地址
131    let deviceId = 'xx:xx:xx:xx:xx:xx';
132
133    // 连接对端设备
134    socket.sppConnect(deviceId, {
135      uuid: '00001101-0000-1000-8000-00805f9b34fb',
136      secure: true,
137      type: 0
138    }, (code, socketID) => {
139      if (code != null) {
140        console.error('sppConnect error, code = ' + (code as BusinessError).code);
141        return;
142      }
143      console.info('sppConnect success, socketId = ' + socketID);
144    })
145    ```
146
1477. 错误码请参见[蓝牙服务子系统错误码](../../reference/apis-connectivity-kit/errorcode-bluetoothManager.md)。