Skip to content

zhouzhuo810/OkUSB

Repository files navigation

OkUSB

一个简洁的Android串口通信框架。

功能简介

  • 支持设置波特率
  • 支持设置数据位
  • 支持设置停止位
  • 支持设置校验位
  • 支持DTS和RTS
  • 支持串口连接状态监听

## 用法简介

Gradle

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

	dependencies {
	        compile 'com.github.zhouzhuo810:OkUSB:1.0.0'
	}


具体用法

1.在AndroidManifest.xml中添加如下特性:

    <uses-feature android:name="android.hardware.usb.host" />

在需要连接串口的Activity中添加:

    <intent-filter>
        <action android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED" />
    </intent-filter>
    <meta-data
        android:name="android.hardware.usb.action.USB_DEVICE_ATTACHED"
        android:resource="@xml/device_filter" />

2.在res文件夹创建xml文件夹,新建device_filter.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <!-- 要进行通信的USB设备的供应商ID(VID)和产品识别码(PID)-->
    <usb-device vendor-id="0403" product-id="6001" />
</resources>

3.前面都是准备工作,这里才真正使用。

    //初始化
    usb = new USB.USBBuilder(this)
            .setBaudRate(115200)  //波特率
            .setDataBits(8)       //数据位
            .setStopBits(UsbSerialPort.STOPBITS_1) //停止位
            .setParity(UsbSerialPort.PARITY_NONE)  //校验位
            .setMaxReadBytes(20)   //接受数据最大长度
            .setReadDuration(500)  //读数据间隔时间
            .setDTR(false)    //DTR enable
            .setRTS(false)    //RTS enable
            .build();

    //实现监听连接状态和数据收发。
    usb.setOnUsbChangeListener(new USB.OnUsbChangeListener() {
        @Override
        public void onUsbConnect() {
            Toast.makeText(MainActivity.this, "conencted", Toast.LENGTH_SHORT).show();
        }

        @Override
        public void onUsbDisconnect() {
            Toast.makeText(MainActivity.this, "disconencted", Toast.LENGTH_SHORT).show();
        }

        @Override
        public void onDataReceive(byte[] data) {
            tvResult.setText(new String(data, Charset.forName("GB2312")));
        }

        @Override
        public void onUsbConnectFailed() {
            Toast.makeText(MainActivity.this, "connect fail", Toast.LENGTH_SHORT).show();
        }

        @Override
        public void onPermissionGranted() {
            Toast.makeText(MainActivity.this, "permission ok", Toast.LENGTH_SHORT).show();
        }

        @Override
        public void onPermissionRefused() {
            Toast.makeText(MainActivity.this, "permission fail", Toast.LENGTH_SHORT).show();
        }

        @Override
        public void onDriverNotSupport() {
            Toast.makeText(MainActivity.this, "no driver", Toast.LENGTH_SHORT).show();
        }

        @Override
        public void onWriteDataFailed(String error) {
            Toast.makeText(MainActivity.this, "write fail" + error, Toast.LENGTH_SHORT).show();
        }

        @Override
        public void onWriteSuccess(int num) {
            Toast.makeText(MainActivity.this, "write ok " + num, Toast.LENGTH_SHORT).show();
        }
    });

4.发送数据

        usb.writeData(byte[], 500);

5.如果是Activity,可以在onDestroy中调用如下代码关闭串口。

        if (usb != null) {
            usb.destroy();
        }

License

Copyright 2017 zhouzhuo810

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.

About

一个简洁的Android串口通信框架。

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages