# AndroidSerialPort

**Repository Path**: wxynf4/AndroidSerialPort

## Basic Information

- **Project Name**: AndroidSerialPort
- **Description**: Android串口通信，由 Google 官方串口通信库迁移而来，并扩展支持设置 su 路径、串口路径、波特率、校验位、数据位、停止位
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 6
- **Forks**: 3
- **Created**: 2021-01-12
- **Last Updated**: 2025-07-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## AndroidSerialPort

### 说明

AndroidSerialPort 用于串口通信，由 Google 官方串口通信库迁移而来，并在此基础上做了扩展。

AndroidSerialPort 支持设置 su 路径、串口路径、波特率、校验位、数据位、停止位。

更多相关信息，请查看 [Android 串口通信](https://deemons.cn/2018/05/14/Android-%E4%B8%B2%E5%8F%A3%E9%80%9A%E4%BF%A1/)

<br>

### Demo
通过这个串口库，做了一个串口调试工具。
![SerialPort](https://ws1.sinaimg.cn/large/006tKfTcgy1frwt6xkjk4j30qg0fh76l.jpg)

[下载apk](https://fir.im/dv9j)
<br>

### 使用

1. 在 modul 下的 build.gradle 中添加

   ```groovy
   implementation "com.deemons.serialport:serialport:1.2.0"	//替换版本号
   ```

2. 打开串口

   ```java
   SerialPort mSerialPort = new SerialPort("/dev/ttyS1", 9600);
   //获取串口文件的输入输出流，以便数据的收发
   InputStream is = mSerialPort.getInputStream();
   OutputStream os = mSerialPort.getOutputStream();
   ```

<br>

### API

#### 设置 su 路径

Android 主板在与其它硬件进行串口通信时，串口作为底层实现，Android 系统把设备作为一个文件，与其他设备进行串口通信就相当于读写此文件。

因此需要 root 权限来操作串口文件，默认的 su 文件路径在 `/system/bin/su` ，你可以重新设置 su 的文件路径，以便获取 root 权限，例如，设置路径`/system/xbin/su`

```java
//需要在打开串口前调用
SerialPort.setSuPath("/system/xbin/su");
```

<br>

#### 查看串口设备列表

Android 串口文件都在 ``/proc/tty/drivers`` 目录下，因此可以获取所有串口文件。

```java
SerialPortFinder serialPortFinder = new SerialPortFinder();
String[] allDevices = serialPortFinder.getAllDevices();
String[] allDevicesPath = serialPortFinder.getAllDevicesPath();
```

<br>

#### 打开串口

如果你需要设置更多参数，请使用以下构造函数

```java
/**
 * 打开串口
 * @param device 串口设备文件
 * @param baudRate 波特率
 * @param parity 奇偶校验，0 None（默认）； 1 Odd； 2 Even
 * @param dataBits 数据位，5 ~ 8  （默认8）
 * @param stopBit 停止位，1 或 2  （默认 1）
 * @param flags 标记 0（默认）
 */
public SerialPort(File device, int baudRate, int parity, int dataBits, int stopBit, int flags)
```

检验位一般默认是0（NONE），数据位一般默认为8，停止位默认为1。

<br>

#### 读写串口

##### 读数据

```java
// 配合 Rxjava2 ，处理异常更方便
mReceiveDisposable = Flowable.create((FlowableOnSubscribe<byte[]>) emitter -> {
    InputStream is = mSerialPort.getInputStream();
    int available;
    int first;
    while (!isInterrupted && mSerialPort != null 
           && is != null && (first = is.read()) != -1) {
        do {
            available = is.available();
            SystemClock.sleep(1);
        } while (available != is.available());

        byte[] bytes = new byte[is.available()+1];
        is.read(bytes,1,is.available());
        bytes[0] = (byte) (first & 0xFF);
        emitter.onNext(bytes);
    }
    close();
}, BackpressureStrategy.MISSING)
```


##### 写数据

```java
//获取输出流
OutputStream os = mSerialPort.getOutputStream();
os.write(ByteUtils.hexStringToBytes("CCAA0300"));
```

<br>

#### 关闭串口

```java
 mSerialPort.close();
```