JavaDemo——java使用RXTX读写串口

对RXTX的介绍，copy自https://blog.youkuaiyun.com/u011728105/article/details/48085615

RXTX

RXTX是一个提供串口和并口通信的开源java类库，由该项目发布的文件均遵循LGPL协议。

RXTX项目提供了Windows,Linux,Mac os X,Solaris操作系统下的兼容javax.comm串口通讯包API的实现，为其他开发人员在此类系统下开发串口应用提供了相当的方便。

RXTX的使用上与sun提供的comm.jar基本相同,编程时最明显的不同是要包含的包名由javax.comm.*改成了gnu.io.*

RxtxAPI 的核心是抽象的CommPort类(用于描述一个被底层系统支持的端口的抽象类，它包含一些高层的IO控制方法，这些方法对于所有不同的通讯端口来说是通用的)及其两个子类：SerialPort类和ParallePort类。其中，SerialPort类是用于串口通信的类，ParallePort类是用于并行口通信的类。CommPort类还提供了常规的通信模式和方法，例如:getInputStream( )方法和getOutputStream( )方法，专用于与端口上的设备进行通信。

然而，这些类的构造方法都被有意的设置为非公有的(non-public)。所以，不能直接构造对象，而是先通过静态的CommPortIdentifer.getPortIdentifiers()获得端口列表，再从这个端口列表中选择所需要的端口，并调用CommPortIdentifer对象的Open( )方法，这样，就能得到一个CommPort对象。当然，还要将这个CommPort对象的类型转换为某个非抽象的子类，表明是特定的通讯设备，该子类可以是SerialPort类和ParallePort类中的一个。下面将分别对CommPortIdentifier类，串口类SerialPort进行详细的介绍。

接口

CommDriver可负载设备（the loadable device）驱动程序接口的一部分

CommPortOwnershipListener传递各种通讯端口的所有权事件

ParallelPortEventListener传递并行端口事件

SerialPortEventListener传递串行端口事件

类

CommPort通讯端口

CommPortIdentifier通讯端口管理

ParallelPort并行通讯端口

ParallelPortEvent并行端口事件

SerialPortRS-232串行通讯端口

SerialPortEvent 串行端口事件

异常类

NoSuchPortException当驱动程序不能找到指定端口时抛出

PortInUseException当碰到指定端口正在使用中时抛出

UnsupportedCommOperationException驱动程序不允许指定操作时抛出

CommPortIdentifier类

这个类主要用于对通信端口进行管理和设置，是对端口进行访问控制的核心类，主要包括以下方法：

addPortName(String,int, CommDriver) 添加端口名到端口列表里

addPortOwnershipListener(CommPortOwnershipListener)添加端口拥有的监听器

removePortOwnershipListener(CommPortOwnershipListener)移除端口拥有的监听器

getCurrentOwner()获取当前占有端口的对象或应用程序

getName()获取端口名称

getPortIdentifier(CommPort)获取指定打开的端口的CommPortIdentifier类型对象

getPortIdentifier(String)获取以参数命名的端口的CommPortIdentifier类型对象

getPortIdentifiers()获取系统中的端口列表

getPortType()获取端口的类型

isCurrentlyOwned()判断当前端口是否被占用

open(FileDescriptor)用文件描述的类型打开端口

open(String,int) 打开端口，两个参数：程序名称，延迟时间(毫秒数)

SerialPort类

这个类用于描述一个RS-232串行通信端口的底层接口，它定义了串口通信所需的最小功能集。通过它，用户可以直接对串口进行读、写及设置工作。

SerialPort类中关于串口参数的静态成员变量说明:

DATABITS_5 数据位为5

DATABITS_6 数据位为6

DATABITS_7 数据位为7

DATABITS_8 数据位为8

PARITY_NONE 空格检验

PARITY_ODD 奇检验

PARITY_EVEN 偶检验

PARITY_MARK 标记检验

PARITY_SPACE 无检验

STOPBITS_1 停止位为1

STOPBITS_2 停止位为2

STOPBITS_1_5 停止位为1.5



SerialPort类中关于串口参数的方法说明:

getBaudRate()得到波特率

getParity()得到检验类型

getDataBits()得到数据位数

getStopBits()得到停止位数

setSerialPortParams(int,int, int, int) 设置串口参数依次为(波特率,数据位,停止位,奇偶检验)

SerialPort类中关于事件的静态成员变量说明：

BI Break interrupt 通讯中断

FE Framing error 帧错误

CD Carrier detect 载波侦听

OE Overrun error 溢位错误

CTS Clear to send 清除发送

PE Parity error 奇偶检验错误

DSR Data set ready 数据设备准备好

RI Ring indicator 响铃侦测

DATA_AVAILABLE 串口中的可用数据

OUTPUT_BUFFER_EMPTY 输出缓冲区已清空

 

SerialPort类中关于事件的方法说明：

isCD()是否有载波

isCTS()是否清除以传送

isDSR()数据是否备妥

isDTR()是否数据端备妥

isRI()是否响铃侦测

isRTS()是否要求传送

addEventListener(SerialPortEventListener)向SerialPort对象中添加串口事件监听器

removeEventListener()移除SerialPort对象中的串口事件监听器

notifyOnBreakInterrupt(boolean)设置中断事件true有效,false无效

notifyOnCarrierDetect(boolean)设置载波监听事件true有效,false无效

notifyOnCTS(boolean)设置清除发送事件true有效,false无效

notifyOnDataAvailable(boolean)设置串口有数据的事件true有效,false无效

notifyOnDSR(boolean)设置数据备妥事件true有效,false无效

notifyOnFramingError(boolean)设置发生错误事件true有效,false无效

notifyOnOutputEmpty(boolean)设置发送缓冲区为空事件true有效,false无效

notifyOnParityError(boolean)设置发生奇偶检验错误事件true有效,false无效

notifyOnRingIndicator(boolean)设置响铃侦测事件true有效,false无效

getEventType()得到发生的事件类型返回值为int型

sendBreak(int)设置中断过程的时间，参数为毫秒值

setRTS(boolean)设置或清除RTS位

setDTR(boolean)设置或清除DTR位

SerialPort中的其他常用方法说明：

close()关闭串口

getOutputStream()得到OutputStream类型的输出流

getInputStream()得到InputStream类型的输入流

准备工作：

• RXTX包：mfz-rxtx-2.2-20081207-win-x64.zip，解压，RXTXcomm.jar加入项目依赖库里，rxtxParallel.dll和rxtxSerial.dll放入jdk的bin目录下（我使用的jdk1.7，jdk9好像不兼容）
• 虚拟串口工具：VSPD+6.9.zip，
• 串口调试工具：SerialDebug.exe

安装RXTX包：

工具创建一对虚拟串口：

串口调试工具打开COM3：

测试Demo：

/**
 * createtime : 2018年6月1日 上午9:47:36
 */
package com.testRXTX;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.TooManyListenersException;

import gnu.io.CommPort;
import gnu.io.CommPortIdentifier;
import gnu.io.NoSuchPortException;
import gnu.io.PortInUseException;
import gnu.io.SerialPort;
import gnu.io.SerialPortEvent;
import gnu.io.SerialPortEventListener;
import gnu.io.UnsupportedCommOperationException;

/**
 * TODO
 * @author XWF
 */
public final class RXTXtest {

	/**
	 * @param args
	 */
	public static void main(String[] args) {
		//获得系统端口列表
		getSystemPort();
		//开启端口COM2，波特率9600
		final SerialPort serialPort = openSerialPort("COM2",9600);
		//启动一个线程每2s向串口发送数据，发送1000次hello
		new Thread(new Runnable() {
			@Override
			public void run() {
				int i = 1;
				while(i<1000) {
					String s = "hello";
					byte[] bytes = s.getBytes();
					RXTXtest.sendData(serialPort, bytes);//发送数据
					i++;
					try {
						Thread.sleep(2000);
					} catch (InterruptedException e) {
						e.printStackTrace();
					}
				}
			}
		}).start();
		//设置串口的listener
                RXTXtest.setListenerToSerialPort(serialPort, new SerialPortEventListener() {
			@Override
			public void serialEvent(SerialPortEvent arg0) {
				if(arg0.getEventType() == SerialPortEvent.DATA_AVAILABLE) {//数据通知
					byte[] bytes = RXTXtest.readData(serialPort);
					System.out.println("收到的数据长度："+bytes.length);
					System.out.println("收到的数据："+new String(bytes));
				}
			}
		});
//        closeSerialPort(serialPort);
	}
	
	/**
	 * 获得系统可用的端口名称列表
	 * @return 可用端口名称列表
	 */
	@SuppressWarnings("unchecked")
	public static List<String> getSystemPort(){
		List<String> systemPorts = new ArrayList<>();
		//获得系统可用的端口
		Enumeration<CommPortIdentifier> portList = CommPortIdentifier.getPortIdentifiers();
		while(portList.hasMoreElements()) {
			String portName = portList.nextElement().getName();//获得端口的名字
			systemPorts.add(portName);
		}
		System.out.println("系统可用端口列表："+systemPorts);
		return systemPorts;
	}
	
	/**
	 * 开启串口
	 * @param serialPortName 串口名称
	 * @param baudRate 波特率
	 * @return 串口对象
	 */
	public static SerialPort openSerialPort(String serialPortName,int baudRate) {
		try {
			//通过端口名称得到端口
			CommPortIdentifier portIdentifier = CommPortIdentifier.getPortIdentifier(serialPortName);
			//打开端口，（自定义名字，打开超时时间）
			CommPort commPort = portIdentifier.open(serialPortName, 2222);
			//判断是不是串口
            if (commPort instanceof SerialPort) {
                SerialPort serialPort = (SerialPort) commPort;
                //设置串口参数（波特率，数据位8，停止位1，校验位无）
                serialPort.setSerialPortParams(baudRate, SerialPort.DATABITS_8, SerialPort.STOPBITS_1, SerialPort.PARITY_NONE);                              
                System.out.println("开启串口成功，串口名称："+serialPortName);
                return serialPort;
            }        
            else {
                //是其他类型的端口
                throw new NoSuchPortException();
            }
		} catch (NoSuchPortException e) {
			e.printStackTrace();
		} catch (PortInUseException e) {
			e.printStackTrace();
		} catch (UnsupportedCommOperationException e) {
			e.printStackTrace();
		}
		return null;
	}
	
	/**
	 * 关闭串口
	 * @param serialPort 要关闭的串口对象
	 */
	public static void closeSerialPort(SerialPort serialPort) {
		if(serialPort != null) {
			serialPort.close();
			System.out.println("关闭了串口："+serialPort.getName());
			serialPort = null;
		}
	}

	/**
	 * 向串口发送数据
	 * @param serialPort 串口对象 
	 * @param data 发送的数据
	 */
	public static void sendData(SerialPort serialPort, byte[] data) {
		OutputStream os = null;
        try {
        	os = serialPort.getOutputStream();//获得串口的输出流
        	os.write(data);
        	os.flush();
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            try {
                if (os != null) {
                	os.close();
                	os = null;
                }                
            } catch (IOException e) {
            	e.printStackTrace();
            }
        }
	}
	
	/**
	 * 从串口读取数据
	 * @param serialPort 要读取的串口
	 * @return 读取的数据
	 */
	public static byte[] readData(SerialPort serialPort) {
		InputStream is = null;
        byte[] bytes = null;
        try {
        	is = serialPort.getInputStream();//获得串口的输入流
            int bufflenth = is.available();//获得数据长度
            while (bufflenth != 0) {                             
                bytes = new byte[bufflenth];//初始化byte数组
                is.read(bytes);
                bufflenth = is.available();
            } 
        } catch (IOException e) {
        	e.printStackTrace();
        } finally {
            try {
                if (is != null) {
                	is.close();
                	is = null;
                }
            } catch(IOException e) {
            	e.printStackTrace();
            }
        }
        return bytes;
	}
	
	/**
	 * 给串口设置监听
	 * @param serialPort
	 * @param listener
	 */
	public static void setListenerToSerialPort(SerialPort serialPort, SerialPortEventListener listener) {
		try {
			//给串口添加事件监听
			serialPort.addEventListener(listener);
		} catch (TooManyListenersException e) {
			e.printStackTrace();
		}
		serialPort.notifyOnDataAvailable(true);//串口有数据监听
		serialPort.notifyOnBreakInterrupt(true);//中断事件监听
	}
	
}

结果：