SerialPortHelper

更新日志v3.0

• 取消单例模式，支持同时打开多个串口
• 以建造者模式创建Parameter
• so以Cmake动态生成，新增支持设置停止位，校验位，数据位...等等扩展参数
• 新增无协议的串口读写（协议逻辑要自己处理）

目录

• 引入
• 使用说明
• 属性说明
• 效果演示
• 项目成品
• 联系方式

引入

• Android Studio

将serialportlib引入

dependencies {
     implementation project(path: ':serialportlib')
}

也可以直接

allprojects {
		repositories {
			...
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

dependencies {
     implementation 'com.github.alanqjt:SerialPortHelper:v3.0.0'
}

• Eclipse

还在使用Eclipse的你可以回家了!(把代码复制下来自己导入过去，但是还是建议赶紧把项目开发切换到Android Studio)

使用说明

串口协议一般分为两种，第一种为固定长度，第二种为可变长度，而可变长度又分为两种。 所以此库能帮助您快速适配三种类型的协议,如果还是不能满足开发需求，可以使用无协议模式 PROTOCOLMODEL_NONE ，自行处理协议

• 无协议模式 PROTOCOLMODEL_NONE

        Parameter parameter = new Parameter.Builder(SERIALPATH, BAUDRATE, null, Parameter.PROTOCOLMODEL_NONE, new OnSerialPortDataListener() {
            @Override
            public void onDataReceived(byte[] bytes, int length, String hexData) {

            }

            @Override
            public void onDataSend(byte[] bytes, int length, String hexData) {

            }
        }).setDebug(true).build();
        SerialHelper serialHelper = new SerialHelper();
        serialHelper.serialStart(parameter);
        serialHelper.getAllSerialDevices();
        serialHelper.getAllSerialDevicesPath();
        serialHelper.sendData("生活不易，井盖叹气".getBytes());

• 第一种协议固定长度 PROTOCOLMODEL_FIXED

//协议模版
//请在串口调试助手发送E1 09 8A 01 01 00 01 08 EF

List<Integer> protocolHead = new ArrayList<>();
protocolHead.add(0xE1);
Parameter parameter = new Parameter(SERIALPATH, BAUDRATE, protocolHead, Parameter.PROTOCOLMODEL_FIXED, new OnSerialPortDataListener() {
    @Override
    public void onDataReceived(byte[] bytes, int length, String hexData) {
               
    }

    @Override
    public void onDataSent(byte[] bytes, int length, String hexData) {
                
    }
});
parameter.setProLenIndex(1);
parameter.setProtocolLength(9);
SerialHelper.getInstance().serialStart(parameter);

• 第二种协议固定长度 PROTOCOLMODEL_VARIABLE
  
  1.data包含了所要截取的长度

//协议模版
//请在串口调试助手发送E1 09 8A 01 01 00 01 08 EF
//ProLenIndex 所在的下标是1，  值为0x09
List<Integer> protocolHead = new ArrayList<>();
protocolHead.add(0xE1);
Parameter parameter = new Parameter(SERIALPATH, BAUDRATE, protocolHead, Parameter.PROTOCOLMODEL_VARIABLE, new OnSerialPortDataListener() {
    @Override
    public void onDataReceived(byte[] bytes, int length, String hexData) {
               
    }

    @Override
    public void onDataSent(byte[] bytes, int length, String hexData) {
               
    }
});
parameter.setProLenIndex(1);//设置LEN下标
SerialHelper.getInstance().serialStart(parameter);

2.data不包含了所要截取的长度，指的是有意义的数据长度

//协议模版
//请在串口调试助手发送E1 05 8A 01 01 00 01 08 EF
//请在串口调试助手发送55 05 8A 01 01 00 01 08 EF
        List<Integer> protocolHead = new ArrayList<>();
        protocolHead.add(0xE1);
        Parameter parameter = new Parameter.Builder(SERIALPATH, BAUDRATE, protocolHead, Parameter.PROTOCOLMODEL_VARIABLE, new OnSerialPortDataListener() {
            @Override
            public void onDataReceived(byte[] bytes, int length, String hexData) {

            }

            @Override
            public void onDataSend(byte[] bytes, int length, String hexData) {

            }
        }).setProLenIndex(1).setDebug(true).build();
        byte[] p = {0x55, 1, 1, 0, 1, 0, 1, 0};
        SerialHelper serialHelper = new SerialHelper();
        serialHelper.serialStart(parameter);
        serialHelper.sendData(p);

• 发送数据

SerialHelper.getInstance().sendData(data);

• 监听多种协议开头

List<Integer> protocolHead = new ArrayList<>();
protocolHead.add(0xE1);
protocolHead.add(0x55);

Parameter parameter = new Parameter.Builder(SERIALPATH, BAUDRATE, protocolHead, Parameter.PROTOCOLMODEL_VARIABLE, this)
          .setProLenIndex(1)//设置LEN下标
          .setUselessLength(4)//除了data有效数据外的长度
          .setDebug(true).build();

• 读写线程消息队列缓存长度

//发送数据队列长度
parameter.setQueueSizeBySend(100);//默认缓存100

//监听数据队列长度
parameter.setQueueSizeByReceived(100);//默认缓存100

• 读写线程消息处理并发处理速度

//发送数据间隔
parameter.setFrequencyBySend(200);//默认间隔为200毫秒

//监听数据间隔
parameter.setFrequencyByReceived(200);//默认间隔为200毫秒

• 修改权限地址

parameter.setSuPath("/system/xbin/su");

• 启动串口

serialHelper.serialStart(parameter);

• 关闭串口

serialHelper.close();

• 获取串口设备

serialHelper.getAllSerialDevices();

• 获取串口设备地址

serialHelper.getAllSerialDevicesPath();

• 查看日志

parameter.setDebug(true);

属性说明

属性	说明
debug	是否显示log
suPath	权限地址
serialPath	串口地址
baudrate	波特率
stopBit	停止位，默认 B1
dataBit	数据位，默认 CS8
parity	奇偶校验，默认 NONE
flowCon	流控，默认 NONE
flags	打开串口标志位，默认 0
protocolHead	协议开头
protocolEnd	协议结尾
protocolLength	协议长度
proLenIndex	协议长度截取的下标 从0开始
protocolModel	协议模型
uselessLength	无用的数据长度
frequencyBySend	写线程处理速度, 只能大于0 默认为200毫秒
frequencyByReceived	读线程处理速度, 只能大于0 默认为200毫秒
queueSizeBySend	写线程队列缓存长度, 只能大于0 默认为100
queueSizeByReceived	读线程队列缓存长度, 只能大于0 默认为100
onSerialPortDataListener	数据监听
PROTOCOLMODEL_FIXED	固定长度协议, proLenIndex就没有意义了
PROTOCOLMODEL_VARIABLE	可变长度协议, proLenIndex才有意义
PROTOCOLMODEL_NONE	无协议

联系方式

• Email: jiantaoqu@gmail.com
• QQ: 490787193（添加的时候请注明是GitHub）
  
  
  
  

效果演示

• 并发粘包分包处理
  
  
  
  

项目成品

地心科技-色秀口红机

网红口红机

云际科技-游云魔盒

一种游艺设备，支持使用摇杆玩王者荣耀，和各种cocos2d,unity3d游戏。

逗买科技-逗买智能售货机

弹簧售货机

味都好-味都好智能售餐机

智能售餐机

如果你觉得不错，对你有帮助，欢迎点个star，follow，也可以帮忙分享给你更多的朋友，或请我喝杯咖啡，这是给我们最大的动力与支持。有问题或建议可以给我邮件

• 扶贫方式
  
  

License

Copyright 2019 屈健涛

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.