# SmartSerial

**Repository Path**: shuai132/SmartSerial

## Basic Information

- **Project Name**: SmartSerial
- **Description**: 通用串口编程库高层次封装 全平台支持
- **Primary Language**: C++
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 10
- **Forks**: 9
- **Created**: 2019-09-23
- **Last Updated**: 2025-01-06

## Categories & Tags

**Categories**: hardware

**Tags**: None

## README

# SmartSerial

[![Build Status](https://github.com/shuai132/SmartSerial/workflows/Windows/badge.svg)](https://github.com/shuai132/SmartSerial/actions?workflow=Windows)
[![Build Status](https://github.com/shuai132/SmartSerial/workflows/macOS/badge.svg)](https://github.com/shuai132/SmartSerial/actions?workflow=macOS)
[![Build Status](https://github.com/shuai132/SmartSerial/workflows/Ubuntu/badge.svg)](https://github.com/shuai132/SmartSerial/actions?workflow=Ubuntu)

简化串口编程 提供方便的接口和严格的线程安全特性

## Requirements

* C++11
* CMake 3.1

## Features

* 数据自动回调
* 异常自动重连
* 自动连接设备 通过串口名、VID_PID
* 全平台支持: macOS、Linux、Windows
* 所有方法严格线程安全

## Usage

* clone repository
```bash
git clone --recursive https://github.com/shuai132/SmartSerial.git
```
* simple usage
```cpp
#include "SmartSerial.h"

SmartSerial smartSerial("/dev/ttyUSB0");
smartSerial.setOnOpenHandle([](bool isOpen) {
    // handle very likely on other thread
});
smartSerial.setOnReadHandle([](const uint8_t* data, size_t size) {
    // on read data(other thread)
});

smartSerial.write("hello world");
```
* example  
[example/smartserial_example.cpp](example/smartserial_example.cpp)

## Hardware

任选一种方式

* 短接Rx与Tx
* arduino
```cpp
void setup() {
    Serial.begin(115200);
}

void loop() {
    if (Serial.available()) {
        Serial.write(Serial.read());
    }
}                                         
```

## Other

如果需要对数据打包和解包，可配合下面的库使用：

[https://github.com/shuai132/PacketProcessor](https://github.com/shuai132/PacketProcessor)