# MGS.SerialPort

**Repository Path**: Mogoson/MGS.SerialPort

## Basic Information

- **Project Name**: MGS.SerialPort
- **Description**: Unity communicate with serialport.
- **Primary Language**: C#
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 25
- **Forks**: 20
- **Created**: 2017-04-09
- **Last Updated**: 2024-12-12

## Categories & Tags

**Categories**: web-dev-toolkits

**Tags**: None

## README

# MGS.SerialPort

## Summary
- Unity communicate with serialport.

## Demand
- Serialport asynchronous read and write data; 
- parameters of serialport config in local file.

## Environment
- Unity 5.3 or above.

- .Net Framework 2.0(Set the "Api Compatibility Level" as ".NET 2.0". Find in the path
  "Build Settings -> Player Settings -> Other Settings").

## Background
- Current Unity can not read serialport data in "Update" or "FixedUpdate" method.
- Current Unity not implemented the "SerialPort.ReceivedBytesThreshold" property.
- Current Unity can not callback the "SerialPort.DataReceived" event.
- Current Unity can not read the "SerialPort.BytesToRead" property.
- Current Unity can not execute the "SerialPort.DiscardInBuffer" method effectively.
- Current Unity can not execute the "SerialPort.DiscardOutBuffer" method effectively.

## Design

- Config SerialPort parameters in local file.
- Thread to read and write data buffer to SerialPort continued.
- Mark data Head and Tail to recognize data frame.

## Usage

```C#
//Read size bytes from serialport buffer once.
SerialPortAPI.SerialPorter.Read(size);

//Write bytes to serialport buffer once.
SerialPortAPI.SerialPorter.Write(bytes);

//Begin read bytes form SerialPort (Continued).
SerialPortAPI.SerialPorter.BeginRead();

//End read bytes form SerialPort.
SerialPortAPI.SerialPorter.EndRead();

//Begin write bytes to SerialPort (Continued).
SerialPortAPI.SerialPorter.BeginWrite();

//End write bytes to SerialPort.
SerialPortAPI.SerialPorter.EndWrite();
```

------

Copyright © 2022 Mogoson.	mogoson@outlook.com