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. import需要的socket模块。
332. 需要SystemCapability.Communication.Bluetooth.Core系统能力。
343. 开启设备蓝牙。
354. 创建服务端socket，返回serverId。
365. 服务端等待客户端连接，返回clientId。
376. 服务端向客户端写入数据。
387. （可选）服务端订阅客户端写入的数据。
398. 注销服务端socket。
409. 注销客户端socket。
4110. 示例代码：
42
43    ```ts
44    import { socket } from '@kit.ConnectivityKit';
45    import { AsyncCallback, BusinessError } from '@kit.BasicServicesKit';
46
47    // 创建服务器监听Socket, 返回serverId
48    let serverNumber = -1;
49    let sppOption: socket.SppOptions = {
50      uuid: '00001101-0000-1000-8000-00805f9b34fb',
51      secure: true,
52      type: 0
53    };
54    socket.sppListen('server1', sppOption, (code, serverSocketID) => {
55      if (code != null) {
56        console.error('sppListen error, code is ' + (code as BusinessError).code);
57        return;
58      } else {
59        serverNumber = serverSocketID;
60        console.info('sppListen success, serverNumber = ' + serverNumber);
61      }
62    });
63
64    // socket等待客户端连接，连接成功返回clientId
65    let clientNumber = -1;
66    socket.sppAccept(serverNumber, (code, clientSocketID) => {
67      if (code != null) {
68        console.error('sppAccept error, code is ' + (code as BusinessError).code);
69        return;
70      } else {
71        clientNumber = clientSocketID;
72        console.info('accept the client success');
73      }
74    })
75    console.info('waiting for client connection');
76
77    // 向客户端写入数据
78    let array = new Uint8Array(990);
79    array[0] = 'A'.charCodeAt(0);
80    array[1] = 'B'.charCodeAt(0);
81    array[2] = 'C'.charCodeAt(0);
82    array[3] = 'D'.charCodeAt(0);
83    socket.sppWrite(clientNumber, array.buffer);
84    console.info('sppWrite success');
85
86    // 订阅读请求事件
87    socket.on('sppRead', clientNumber, (dataBuffer: ArrayBuffer) => {
88      const data = new Uint8Array(dataBuffer);
89      if (data != null) {
90        console.info('sppRead success, data = ' + JSON.stringify(data));
91      } else {
92        console.error('sppRead error, data is null');
93      }
94    });
95
96    // 取消订阅读请求事件
97    socket.off('sppRead', clientNumber, (dataBuffer: ArrayBuffer) => {
98      const data = new Uint8Array(dataBuffer);
99      if (data != null) {
100        console.info('offSppRead success, data = ' + JSON.stringify(data));
101      } else {
102        console.error('offSppRead error, data is null');
103      }
104    });
105
106    // 注销服务端socket
107    socket.sppCloseServerSocket(serverNumber);
108    console.info('sppCloseServerSocket success');
109
110    // 注销客户端socket
111    socket.sppCloseClientSocket(clientNumber);
112    console.info('sppCloseClientSocket success');
113    ```
114
11511. 错误码请参见[蓝牙服务子系统错误码](../../reference/apis-connectivity-kit/errorcode-bluetoothManager.md)。
116
117### 通过socket连接对端设备
1181. import需要的socket模块。
1192. 需要SystemCapability.Communication.Bluetooth.Core系统能力。
1203. 开启设备蓝牙。
1214. 开启ble扫描，获取对端设备mac地址。
1225. 连接对端设备。
1236. 示例代码：
124
125    ```ts
126    import { socket } from '@kit.ConnectivityKit';
127    import { AsyncCallback, BusinessError } from '@kit.BasicServicesKit';
128
129    // 开启ble扫描，获取对端设备mac地址
130    let deviceId = 'xx:xx:xx:xx:xx:xx';
131
132    // 连接对端设备
133    socket.sppConnect(deviceId, {
134      uuid: '00001101-0000-1000-8000-00805f9b34fb',
135      secure: true,
136      type: 0
137    }, (code, socketID) => {
138      if (code != null) {
139        console.error('sppConnect error, code = ' + (code as BusinessError).code);
140        return;
141      }
142      console.info('sppConnect success, socketId = ' + socketID);
143    })
144    ```
145
1467. 错误码请参见[蓝牙服务子系统错误码](../../reference/apis-connectivity-kit/errorcode-bluetoothManager.md)。