一个跨平台、接口灵活的C++串口通信库

/*! * \file serial/serial.h * \author William Woodall <wjwwood@gmail.com> * \author John Harrison <ash.gti@gmail.com> * \version 0.1 * * \section LICENSE * * The MIT License * * Copyright (c) 2012 William Woodall * * Permission is hereby granted, free of charge, to any person obtaining a * copy of this software and associated documentation files (the "Software"), * to deal in the Software without restriction, including without limitation * the rights to use, copy, modify, merge, publish, distribute, sublicense, * and/or sell copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER * DEALINGS IN THE SOFTWARE. * * \section DESCRIPTION * * This provides a cross platform interface for interacting with Serial Ports. */ #ifndef SERIAL_H #define SERIAL_H #include <limits> #include <vector> #include <string> #include <cstring> #include <sstream> #include <exception> #include <stdexcept> #include <serial/v8stdint.h> #define THROW(exceptionClass, message) throw exceptionClass(__FILE__, \ __LINE__, (message) ) namespace serial { /*! * Enumeration defines the possible bytesizes for the serial port. */ typedef enum { fivebits = 5, sixbits = 6, sevenbits = 7, eightbits = 8 } bytesize_t; /*! * Enumeration defines the possible parity types for the serial port. */ typedef enum { parity_none = 0, parity_odd = 1, parity_even = 2, parity_mark = 3, parity_space = 4 } parity_t; /*! * Enumeration defines the possible stopbit types for the serial port. */ typedef enum { stopbits_one = 1, stopbits_two = 2, stopbits_one_point_five } stopbits_t; /*! * Enumeration defines the possible flowcontrol types for the serial port. */ typedef enum { flowcontrol_none = 0, flowcontrol_software, flowcontrol_hardware } flowcontrol_t; /*! * Structure for setting the timeout of the serial port, times are * in milliseconds. * * In order to disable the interbyte timeout, set it to Timeout::max(). */ struct Timeout { #ifdef max # undef max #endif static uint32_t max() {return std::numeric_limits<uint32_t>::max();} /*! * Convenience function to generate Timeout structs using a * single absolute timeout. * * \param timeout A long that defines the time in milliseconds until a * timeout occurs after a call to read or write is made. * * \return Timeout struct that represents this simple timeout provided. */ static Timeout simpleTimeout(uint32_t timeout) { return Timeout(max(), timeout, 0, timeout, 0); } /*! Number of milliseconds between bytes received to timeout on. */ uint32_t inter_byte_timeout; /*! A constant number of milliseconds to wait after calling read. */ uint32_t read_timeout_constant; /*! A multiplier against the number of requested bytes to wait after * calling read. */ uint32_t read_timeout_multiplier; /*! A constant number of milliseconds to wait after calling write. */ uint32_t write_timeout_constant; /*! A multiplier against the number of requested bytes to wait after * calling write. */ uint32_t write_timeout_multiplier; explicit Timeout (uint32_t inter_byte_timeout_=0, uint32_t read_timeout_constant_=0, uint32_t read_timeout_multiplier_=0, uint32_t write_timeout_constant_=0, uint32_t write_timeout_multiplier_=0) : inter_byte_timeout(inter_byte_timeout_), read_timeout_constant(read_timeout_constant_), read_timeout_multiplier(read_timeout_multiplier_), write_timeout_constant(write_timeout_constant_), write_timeout_multiplier(write_timeout_multiplier_) {} }; /*! * Class that provides a portable serial port interface. */ class Serial { public: /*! * Creates a Serial object and opens the port if a port is specified, * otherwise it remains closed until serial::Serial::open is called. * * \param port A std::string containing the address of the serial port, * which would be something like 'COM1' on Windows and '/dev/ttyS0' * on Linux. * * \param baudrate An unsigned 32-bit integer that represents the baudrate * * \param timeout A serial::Timeout struct that defines the timeout * conditions for the serial port. \see serial::Timeout * * \param bytesize Size of each byte in the serial transmission of data, * default is eightbits, possible values are: fivebits, sixbits, sevenbits, * eightbits * * \param parity Method of parity, default is parity_none, possible values * are: parity_none, parity_odd, parity_even * * \param stopbits Number of stop bits used, default is stopbits_one, * possible values are: stopbits_one, stopbits_one_point_five, stopbits_two * * \param flowcontrol Type of flowcontrol used, default is * flowcontrol_none, possible values are: flowcontrol_none, * flowcontrol_software, flowcontrol_hardware * * \throw serial::PortNotOpenedException * \throw serial::IOException * \throw std::invalid_argument */ Serial (const std::string &port = "", uint32_t baudrate = 9600, Timeout timeout = Timeout(), bytesize_t bytesize = eightbits, parity_t parity = parity_none, stopbits_t stopbits = stopbits_one, flowcontrol_t flowcontrol = flowcontrol_none); /*! Destructor */ virtual ~Serial (); /*! * Opens the serial port as long as the port is set and the port isn't * already open. * * If the port is provided to the constructor then an explicit call to open * is not needed. * * \see Serial::Serial * * \throw std::invalid_argument * \throw serial::SerialException * \throw serial::IOException */ void open (); /*! Gets the open status of the serial port. * * \return Returns true if the port is open, false otherwise. */ bool isOpen () const; /*! Closes the serial port. */ void close (); /*! Return the number of characters in the buffer. */ size_t available (); /*! Block until there is serial data to read or read_timeout_constant * number of milliseconds have elapsed. The return value is true when * the function exits with the port in a readable state, false otherwise * (due to timeout or select interruption). */ bool waitReadable (); /*! Block for a period of time corresponding to the transmission time of * count characters at present serial settings. This may be used in con- * junction with waitReadable to read larger blocks of data from the * port. */ void waitByteTimes (size_t count); /*! Read a given amount of bytes from the serial port into a given buffer. * * The read function will return in one of three cases: * * The number of requested bytes was read. * * In this case the number of bytes requested will match the size_t * returned by read. * * A timeout occurred, in this case the number of bytes read will not * match the amount requested, but no exception will be thrown. One of * two possible timeouts occurred: * * The inter byt