# usb-serial-for-uniappDemo

**Repository Path**: jindao666/usb-serial-for-uniapp-demo

## Basic Information

- **Project Name**: usb-serial-for-uniappDemo
- **Description**: uniApp USB 串口通信插件，vue Demo
- **Primary Language**: Android
- **License**: OSL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 8
- **Created**: 2023-08-31
- **Last Updated**: 2023-08-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# usbSerialForUniAPP

### usb-serial-for-uniapp

## 一、简介

uniApp USB 串口通信插件，基于[usb-serial-for-android ](https://github.com/mik3y/usb-serial-for-android)

无需ROOT，支持OTG USB串口、CP210X、CH34X等

串口参数支持波特率、数据位、校验位、停止位、流控

## 二、使用说明

### 1、下载安装

- 点击右侧按钮“下载插件并导入HBuilderX”
- 打开HBuilderX 并选择需要引入插件的项目

### 2、方法调用说明

- 引入组件

  ```js
  var usbSerial = uni.requireNativePlugin("usb-serial-for-uniapp");
  var globalEvent = uni.requireNativePlugin('globalEvent');
  ```

- 获取USB驱动信息

- 建立串口连接

- 设置参数

- 发送数据

- 读取数据

- 或使用监听读取数据

### 3、代码示例

```vue
<script>
	var usbSerial = uni.requireNativePlugin("usb-serial-for-uniapp");
	var globalEvent = uni.requireNativePlugin('globalEvent');
	export default {
		data() {
			return {
				callback: 'Usb Serial callback',
				listeningToUsb: 'Usb Serial listener callback',
				snedData:"Data format string or hexString",
				usbDevice:"usb device name",
				options:"{'baudRate':9600,'dataBits':8,'stopBits':1,'parity':0}",
				formatS:"String/HexString",
				formatL:"String/HexString",
				formatR:"String/HexString",
				intervalTime: 1000,
				readLength: 8192,
			}
		},
		onLoad() {
			var that = this;
			/**
			 * 端口监听方法，调用uniapp 监听事件 usbListener
			 * @param e 监听到的数据
			 */
			globalEvent.addEventListener('usbListener', function(e) {
			  that.listeningToUsb =e.time + ":\n" + e.data;
			});
		},
		methods: {
			/**
			 * 获取可用USB端口
			 * @return 所有USB驱动的列表
			 */
			getUsbDevices(){
				this.messageText="getUsbDevices";
				this.$refs.message.open()
				let json = usbSerial.getUsbDevices();
				this.callback=JSON.stringify(json);
				this.usbDevice=json.data[0].name;
			},
			/**
			 * 获取某个USB端口
			 * @param usbDevice 要打开的Usb Device name
			 * @return 成功或失败的提示，以JSON格式返回
			 */
			connect(){
				this.messageText="connect";
				this.$refs.message.open()
				let json = usbSerial.connect(this.usbDevice);
				this.callback=JSON.stringify(json);
			},
			/**
			 * 获取某个USB端口
			 * @return 成功或失败的提示，以JSON格式返回
			 */
			disconnect(){
				this.messageText="disconnect";
				this.$refs.message.open()
				let json = usbSerial.disconnect();
				this.callback=JSON.stringify(json);
			},
			/**
			 * 获取某个USB端口
			 * @return 关闭串口，成功或失败的提示，以JSON格式返回
			 * baudRate 波特率
			 * dataBits 数据位
			 * stopBits 停止位
			 * parity 校验位
			 */
			getUsbConf(){
				this.messageText="getUsbConf";
				this.$refs.message.open()
				let json = usbSerial.getUsbConf();
				this.options=json.data;
				this.callback=JSON.stringify(json);
			},
			/**
			 * 配置某个USB端口
			 * @param jsonStr JsonString 格式的参数
			 *      baudRate 波特率
			 *      dataBits 数据位
			 *      stopBits 停止位
			 *      parity 校验位
			 * @return 成功或失败的提示，以JSON格式返回
			 */
			setUsbConf(){
				this.messageText="setUsbConf";
				this.$refs.message.open()
				let json = usbSerial.setUsbConf(this.options);
				this.callback=JSON.stringify(json);
			},
			/**
			 * 发送数据到USB端口
			 * @param data 要发送到端口的数据
			 * @param format 数据的格式 String or HxeString
			 * @param intervalTime 轮询时间间隔 ms
			 * @return 成功或失败的提示，以JSON格式返回
			 */
			sned(){
				this.messageText="sned";
				this.$refs.message.open();
				let json;
				if(this.intervalTime!=0 && this.intervalTime!="0"){
					json = usbSerial.snedData(this.snedData,this.formatS,this.intervalTime);
				}else{
					json = usbSerial.snedData(this.snedData,this.formatS);
				}	
				this.callback=JSON.stringify(json);
			},
			/**
			 * 读取USB端口数据
			 * @param format 数据的格式 String or HxeString
			 * @param readLength 读取数据的长度（16进制位数）
			 * @return 读取的数据，以JSON格式返回
			 */
			read(){
				this.messageText="read";
				this.$refs.message.open();
				let json = usbSerial.readData(this.formatR,this.readLength);
				this.callback=JSON.stringify(json);
			},
			/**
			 * 添加USB端口监听器
			 * @param format 返回值格式 String or HexString
			 * @return 成功或失败的提示，以JSON格式返回
			 */
			addUsblistener(){
				this.messageText="addUsblistener";
				this.$refs.message.open();
                this.setUDPSend();
				let json = usbSerial.addUsblistener(this.formatL);
				this.callback=JSON.stringify(json);
				
			},
            setUDPSend(){
				usbSerial.setUDPSend("Code","192.168.10.230",44555,true);
			}
		}
	}
</script>
```



## 三、源码地址

### 1、插件源码

https://gitee.com/jason_hua/usb-serial-for-uniapp

### 2、uniapp Demo

https://gitee.com/jason_hua/usb-serial-for-uniapp-demo