串口通信库cserialport的使用指南

一、cserialport简介

cserialport是一个基于C++语言编写的串口通信库，可以用于Windows、Linux和Mac OS X操作系统。它提供了简单易用的接口，可以方便地实现串口通信功能。cserialport支持波特率、数据位、停止位、校验位等常见串口参数的设置，同时支持同步和异步模式的数据传输。在使用cserialport之前，需要先安装相关的驱动和开发环境。

二、cserialport的安装

在Windows操作系统中，可以从cserialport官方网站（https://github.com/manashmndl/cserialport）下载最新版的安装程序，直接运行即可。在Linux和Mac OS X操作系统中，可以通过源代码编译和安装cserialport。

// Linux系统下编译和安装cserialport
$ tar zxvf cserialport-1.0.tar.gz
$ cd cserialport-1.0
$ ./configure
$ make
$ sudo make install

在安装完成后，可以在开发环境中引入相关头文件和链接库文件，就可以开始使用cserialport了。

三、cserialport的使用

1. 打开和关闭串口

cserialport提供了serialport类，可以通过该类的成员函数打开和关闭串口。

#include 
using namespace std;

int main()
{
    // 创建serialport对象
    CSerialPort sp;

    // 打开串口
    if (sp.Open("[SERIAL_PORT_NAME]")) {
        printf("Serial port opened.\n");
    } else {
        printf("Failed to open serial port.\n");
    }

    // 关闭串口
    sp.Close();
    printf("Serial port closed.\n");

    return 0;
}

其中，[SERIAL_PORT_NAME]是串口的名称，如Windows系统下的COM1、Linux系统下的/dev/ttyS0等。

2. 设置串口参数

cserialport提供了SetBaudRate()、SetDataBits()、SetStopBits()和SetParity()等成员函数，可以设置串口的波特率、数据位、停止位和校验位等参数。

#include 
using namespace std;

int main()
{
    // 创建serialport对象
    CSerialPort sp;
   
    // 打开串口
    if (sp.Open("[SERIAL_PORT_NAME]")) {
        printf("Serial port opened.\n");

        // 设置串口参数
        sp.SetBaudRate(CBR_9600);   // 波特率9600
        sp.SetDataBits(8);          // 数据位8
        sp.SetStopBits(STOPBITS_1); // 停止位1
        sp.SetParity(NOPARITY);     // 无校验位 
    } else {
        printf("Failed to open serial port.\n");
    }

    // 关闭串口
    sp.Close();
    printf("Serial port closed.\n");

    return 0;
}

3. 同步发送数据

通过WriteData()函数，可以在同步模式下发送数据。

#include 
using namespace std;

int main()
{
    // 创建serialport对象
    CSerialPort sp;
   
    // 打开串口
    if (sp.Open("[SERIAL_PORT_NAME]")) {
        printf("Serial port opened.\n");

        // 设置串口参数
        sp.SetBaudRate(CBR_9600);   // 波特率9600
        sp.SetDataBits(8);          // 数据位8
        sp.SetStopBits(STOPBITS_1); // 停止位1
        sp.SetParity(NOPARITY);     // 无校验位 

        // 发送数据
        char data[] = "Hello, world!";
        DWORD dataSize = strlen(data);
        DWORD bytesWritten = 0;
        if (sp.WriteData(data, dataSize, bytesWritten)) {
            printf("%d bytes written.\n", bytesWritten);
        } else {
            printf("Failed to write data.\n");
        }
    } else {
        printf("Failed to open serial port.\n");
    }

    // 关闭串口
    sp.Close();
    printf("Serial port closed.\n");

    return 0;
}

4. 同步接收数据

通过ReadData()函数，可以在同步模式下接收数据。

#include 
using namespace std;

int main()
{
    // 创建serialport对象
    CSerialPort sp;
   
    // 打开串口
    if (sp.Open("[SERIAL_PORT_NAME]")) {
        printf("Serial port opened.\n");

        // 设置串口参数
        sp.SetBaudRate(CBR_9600);   // 波特率9600
        sp.SetDataBits(8);          // 数据位8
        sp.SetStopBits(STOPBITS_1); // 停止位1
        sp.SetParity(NOPARITY);     // 无校验位 

        // 接收数据
        char buf[256] = {0};
        DWORD bytesRead = 0;
        if (sp.ReadData(buf, sizeof(buf) - 1, bytesRead)) {
            printf("%d bytes read: %s\n", bytesRead, buf);
        } else {
            printf("Failed to read data.\n");
        }
    } else {
        printf("Failed to open serial port.\n");
    }

    // 关闭串口
    sp.Close();
    printf("Serial port closed.\n");

    return 0;
}

5. 异步发送数据

通过StartAsyncWrite()和StopAsyncWrite()函数，可以在异步模式下发送数据。

#include 
using namespace std;

void AsyncWriteCallback(DWORD bytesWritten, void* userData)
{
    printf("%d bytes written.\n", bytesWritten);
}

int main()
{
    // 创建serialport对象
    CSerialPort sp;
   
    // 打开串口
    if (sp.Open("[SERIAL_PORT_NAME]")) {
        printf("Serial port opened.\n");

        // 设置串口参数
        sp.SetBaudRate(CBR_9600);   // 波特率9600
        sp.SetDataBits(8);          // 数据位8
        sp.SetStopBits(STOPBITS_1); // 停止位1
        sp.SetParity(NOPARITY);     // 无校验位 

        // 异步发送数据
        char data[] = "Hello, world!";
        DWORD dataSize = strlen(data);
        if (sp.StartAsyncWrite(data, dataSize, AsyncWriteCallback, NULL)) {
            Sleep(1000);
            // 停止异步发送数据
            sp.StopAsyncWrite();
        } else {
            printf("Failed to start async write.\n");
        }
    } else {
        printf("Failed to open serial port.\n");
    }

    // 关闭串口
    sp.Close();
    printf("Serial port closed.\n");

    return 0;
}

异步发送数据需要指定回调函数AsyncWriteCallback()，回调函数会在数据发送完成时自动调用。

6. 异步接收数据

通过StartAsyncRead()和StopAsyncRead()函数，可以在异步模式下接收数据。

#include 
using namespace std;

void AsyncReadCallback(char* buf, DWORD bytesRead, void* userData)
{
    printf("%d bytes read: %s\n", bytesRead, buf);
}

int main()
{
    // 创建serialport对象
    CSerialPort sp;
   
    // 打开串口
    if (sp.Open("[SERIAL_PORT_NAME]")) {
        printf("Serial port opened.\n");

        // 设置串口参数
        sp.SetBaudRate(CBR_9600);   // 波特率9600
        sp.SetDataBits(8);          // 数据位8
        sp.SetStopBits(STOPBITS_1); // 停止位1
        sp.SetParity(NOPARITY);     // 无校验位 

        // 异步接收数据
        char buf[256] = {0};
        if (sp.StartAsyncRead(buf, sizeof(buf) - 1, AsyncReadCallback, NULL)) {
            Sleep(1000);
            // 停止异步接收数据
            sp.StopAsyncRead();
        } else {
            printf("Failed to start async read.\n");
        }
    } else {
        printf("Failed to open serial port.\n");
    }

    // 关闭串口
    sp.Close();
    printf("Serial port closed.\n");

    return 0;
}

异步接收数据需要指定回调函数AsyncReadCallback()，回调函数会在数据接收完成时自动调用。