Java串口通信-JSerialComm

Java串口通信-JSerialComm

目前网上的Java串口通信主要使用RXTXComm，但是这个库已经很久没有更新（最近的更新似乎在2012年），并且与JavaFX集成打包时会出现BUG。JSerialComm是一个较新的串口通信库，其主页为jSerialComm (fazecast.github.io)。JSerialComm与平台无关，所以不需要配置dll文件，只需要引入jar文件即可使用，更为方便。

一、引入JSerialComm包

JSerialComm可以直接通过Maven引入，也可以复制jar包到lib目录下直接使用。Maven的依赖可以在JSerialComm的主页上看到，目前为：

<dependency>
   <groupId>com.fazecast</groupId>
   <artifactId>jSerialComm</artifactId>
   <version>[2.0.0,3.0.0)</version>
</dependency>

主页上同时也有其他类型的引入方法

二、使用JSerialComm

2.1 寻找、设置、打开及关闭串口

SerialPort[] serialPorts = SerialPort.getCommPorts();//查找所有串口
for(SerialPort port:serialPorts){
    System.out.println("Port:"+port.getSystemPortName());//打印串口名称，如COM4
    System.out.println("PortDesc:"+port.getPortDescription());//打印串口类型，如USB Serial
    System.out.println("PortDesc:"+port.getDescriptivePortName());//打印串口的完整类型，如USB-SERIAL CH340(COM4)
}
SerialPort serialPort = serialPorts[0];//获取到第一个串口
serialPort.setBaudRate(112500);//设置波特率为112500
serialPort.setComPortTimeouts(SerialPort.TIMEOUT_READ_BLOCKING | SerialPort.TIMEOUT_WRITE_BLOCKING, 1000, 1000);//设置超时
serialPort.serRTS();//设置RTS。也可以设置DTR
serialPort.setFlowControl(SerialPort.FLOW_CONTROL_DISABLED);//设置串口的控制流，可以设置为disabled，或者CTS, RTS/CTS, DSR, DTR/DSR, Xon, Xoff, Xon/Xoff等
serialPort.setComPortParameters(112500, 8, SerialPort.ONE_STOP_BIT, SerialPort.NO_PARITY);//一次性设置所有的串口参数，第一个参数为波特率，默认9600；第二个参数为每一位的大小，默认8，可以输入5到8之间的值；第三个参数为停止位大小，只接受内置常量，可以选择(ONE_STOP_BIT, ONE_POINT_FIVE_STOP_BITS, TWO_STOP_BITS)；第四位为校验位，同样只接受内置常量，可以选择 NO_PARITY, EVEN_PARITY, ODD_PARITY, MARK_PARITY,SPACE_PARITY。
if(!serialPort.isOpen){
    boolean isCommOpeded = serialPort.openPort()//判断串口是否打开，如果没打开，就打开串口。打开串口的函数会返回一个boolean值，用于表明串口是否成功打开了
}
serialPort.closePort();//关闭串口。该函数同样会返回一个boolean值，表明串口是否成功关闭

2.2 发送及接收数据

数据的发送函数是SerialPort.writeBytes(byte[] bytes,int length)，第一个参数是要发送的字节数组，第二个参数是要发送的数据长度。

数据的读取函数是SerialPort.readBytes(byte[] bytes,int length)，第一个参数是要将数据读入的字节数组，第二个参数是要接收的数据长度。

可以用SerialPort.bytesAvailable来获取目前串口中可以读取的字符长度。如果目前没有可读取的数据，则会返回-1

使用示例如下

if(serialPort.isOpen()){
    String writeData = "hello world";//要发送的字符串
    byte[] bytes = writeData.getBytes();//将字符串转换为字节数组
    serialPort.writeBytes(bytes,bytes.length);//将字节数组全部写入串口
    Thread.sleep(100);//休眠0.1秒，等待下位机返回数据。如果不休眠直接读取，有可能无法成功读到数据
    String readData = "";
    while(port.bytesAvailable>0){//循环读取所有的返回数据。如果可读取数据长度为0或-1，则停止读取
        byte[] newData = new byte[port.bytesAvailable()];//创建一个字节数组，长度为可读取的字节长度
        int numRead = port.readBytes(newData, newData.length);//将串口中可读取的数据读入字节数组，返回值为本次读取到的字节长度
        String newDataString = new String(newData);//将新数据转为字符串
        readData = readData + newDataString;//组合字符串
        Thread.sleep(20);//休眠0.02秒，等待下位机传送数据到串口。如果不休眠，直接再次使用port.bytesAvailable()函数会因为下位机还没有返回数据而返回-1，并跳出循环导致数据没读完。休眠时间可以自行调试，时间越长，单次读取到的数据越多。
    }
    System.out.println("readString:"+readData);
}

2.3 监听串口

可以对串口添加一个监听器来实时监听串口。监听器位于一个独立的线程，使用时需要注意多线程通信的问题；

if(serialPort.isOpen){
    serialPort.addDataListener(new SerialPortDataListener() {//添加监听器。由于该监听器有两个函数，无法使用Lambda表达式

			@Override
			public int getListeningEvents() {
				// TODO Auto-generated method stub
				return SerialPort.LISTENING_EVENT_DATA_AVAILABLE;//返回要监听的事件类型，以供回调函数使用。可发回的事件包括：SerialPort.LISTENING_EVENT_DATA_AVAILABLE，SerialPort.LISTENING_EVENT_DATA_WRITTEN,SerialPort.LISTENING_EVENT_DATA_RECEIVED。分别对应有数据在串口（不论是读的还是写的），有数据写入串口，从串口读取数据。如果AVAILABLE和RECEIVED同时被监听，优先触发RECEIVED
			}

			@Override
			public void serialEvent(SerialPortEvent event) {//事件处理函数
				// TODO Auto-generated method stub
				String data = "";
				if (event.getEventType() != SerialPort.LISTENING_EVENT_DATA_AVAILABLE){
					return;//判断事件的类型
                }
				while(port.bytesAvailable()!=0) {
					byte[] newData = new byte[port.bytesAvailable()];
					int numRead = port.readBytes(newData, newData.length);
					String newDataString = new String(newData);
					data = data + string;
					try {
						Thread.sleep(20);
					} catch (InterruptedException e) {
						// TODO Auto-generated catch block
						e.printStackTrace();
					}
				}//同样使用循环读取法读取所有数据
                //由于这里是监听函数，所以也可以不使用循环读取法，在监听器外创建一个全局变量，然后将每次读取到的数据添加到全局变量里
			}
			
		})
}

参考文档：

Java jSerialComm串口操作 - 简书 (jianshu.com)

java SerialPort串口通讯的使用_bhudy的博客-CSDN博客_java serialport