Re-enabled all UNIX baud rates. Improved README.md documentation.

Author: gbmhunter

.gitignore

@@ -4,4 +4,7 @@ cmake-build-debug/
 .vscode/
 
 # Sphinx build dir
-docs/_build/
+docs/_build/
+
+# Build artifacts
+a.out

CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [v2.1.0] - 2020-11-08
+
+### Added
+- Support for custom baud rates.
+- Support for all standard UNIX baud rates.
+- Improved Doxygen documentation.
+- Improved README.md documentation.
+
+### Removed
+- Dependencies from the README, they weren't that useful and were not accurate anyway.
+
 ## [v2.0.3] - 2020-10-13
 
 ### Added

README.md

@@ -1,14 +1,16 @@
 # CppLinuxSerial
 
-Serial port library written in C++
+Linux serial port library written in C++.
 
 [![Build Status](https://travis-ci.org/gbmhunter/CppLinuxSerial.svg?branch=master)](https://travis-ci.org/gbmhunter/CppLinuxSerial)
 
 ## Description
 
 Library for communicating with COM ports on a Linux system.
 
-Uses fstream to the file I/O.
+* Simple API
+* Supports custom baud rates
+* cmake based build system
 
 ## Installation
 
@@ -67,13 +69,14 @@ using namespace mn::CppLinuxSerial;
 int main() {
 	// Create serial port object and open serial port
 	SerialPort serialPort("/dev/ttyUSB0", BaudRate::B_57600);
+	// Use SerialPort serialPort("/dev/ttyACM0", 13000); instead if you want to provide a custom baud rate
 	serialPort.SetTimeout(-1); // Block when reading until any data is received
 	serialPort.Open();
 
 	// Write some ASCII datae
 	serialPort.Write("Hello");
 
-	// Read some data back
+	// Read some data back (will block until at least 1 byte is received due to the SetTimeout(-1) call above)
 	std::string readData;
 	serialPort.Read(readData);
 
@@ -88,42 +91,15 @@ If the above code was in a file called `main.cpp` and you had installed `CppLinu
 g++ main.cpp -lCppLinuxSerial
 ```
 
-For more examples, see the `.cpp` files in `test/unit/`.
-
-## Dependencies
-
-The following table lists all of the libraries dependencies.
-
-<table>
-	<thead>
-		<tr>
-			<td>Dependency</td>
-			<td>Comments</td>
-		</tr>
-	</thead>
-	<tbody>
-		<tr>
-			<td>C++14</td>
-			<td>C++14 used for strongly typed enums, `std::chrono` and literals.</td>
-		</tr>
-		<tr>
-			<td>stdio.h</td>
-			<td>snprintf()</td>
-		</tr>
-		<tr>
-			<td>stty</td>
-			<td>Used in unit tests to verify the serial port is configured correctly.</td>
-		</tr>
-	</tbody>
-</table>
+For more examples, see the files in `test/`.
 
 ## Issues
 
 See GitHub Issues.
 
 ## FAQ
 
-1. My code stalls when calling functions like `SerialPort::Read()`. This is probably because the library is set up to do a blocking read, and not enough characters have been received to allow `SerialPort::Read()` to return. Use `SerialPort::SetNumCharsToWait()` to determine how many characters to wait for before returning (set to 0 for non-blocking mode).
+1. My code stalls when calling functions like `SerialPort::Read()`. This is probably because the library is set up to do a blocking read, and not enough characters have been received to allow `SerialPort::Read()` to return. Call `SerialPort::SetTimeout(0)` before the serial port is open to set a non-blocking mode.
 
 ## Changelog
 

include/CppLinuxSerial/SerialPort.hpp

@@ -24,22 +24,11 @@
 // User headers
 #include "Exception.hpp"
 
-
- typedef unsigned int speed_t;
-// typedef struct termios2 {
-// 	tcflag_t c_iflag;		/* input mode flags */
-// 	tcflag_t c_oflag;		/* output mode flags */
-// 	tcflag_t c_cflag;		/* control mode flags */
-// 	tcflag_t c_lflag;		/* local mode flags */
-// 	cc_t c_line;			/* line discipline */
-// 	cc_t c_cc[NCCS];		/* control characters */
-// 	speed_t c_ispeed;		/* input speed */
-// 	speed_t c_ospeed;		/* output speed */
-// } termios2_t;
-
 namespace mn {
     namespace CppLinuxSerial {
 
+        /// \brief      Represents the baud rate "types" that can be used with the serial port. STANDARD represents all
+        ///             the standard baud rates as provided by UNIX, CUSTOM represents a baud rate defined by an arbitray integer.
         enum class BaudRateType {
             STANDARD,
             CUSTOM,
@@ -72,6 +61,7 @@ namespace mn {
             B_CUSTOM, // Placeholder 
         };
 
+        /// \brief      Represents the state of the serial port.
         enum class State {
             CLOSED,
             OPEN,
@@ -90,13 +80,14 @@ namespace mn {
             /// \brief		Constructor that sets up serial port with the basic (required) parameters.
             SerialPort(const std::string &device, speed_t baudRate);
 
-            //! @brief		Destructor. Closes serial port if still open.
+            /// \brief		Destructor. Closes serial port if still open.
             virtual ~SerialPort();
 
             /// \brief		Sets the device to use for serial port communications.
             /// \details    Method can be called when serial port is in any state.
             void SetDevice(const std::string &device);
 
+            /// \brief      Allows the user to set a standard baud rate.
             void SetBaudRate(BaudRate baudRate);
 
             /// \brief      Allows the user to set a custom baud rate.
@@ -139,15 +130,16 @@ namespace mn {
             /// \brief		Returns a populated termios structure for the passed in file descriptor.
             // termios GetTermios();
 
-
-
             /// \brief		Configures the tty device as a serial port.
             /// \warning    Device must be open (valid file descriptor) when this is called.
             void ConfigureTermios();
 
             // void SetTermios(termios myTermios);
 
+            /// \brief		Returns a populated termios2 structure for the serial port pointed to by the file descriptor.
             termios2 GetTermios2();
+
+            /// \brief      Assigns the provided tty settings to the serial port pointed to by the file descriptor.
             void SetTermios2(termios2 tty);
 
             /// \brief      Keeps track of the serial port's state.