From 1d6a5ac07948b7f287d3890289478769a12fa548 Mon Sep 17 00:00:00 2001 From: William Woodall Date: Mon, 23 Jan 2012 13:26:49 -0800 Subject: [PATCH] Created gh-pages branch via GitHub --- index.html | 142 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 142 insertions(+) create mode 100644 index.html diff --git a/index.html b/index.html new file mode 100644 index 0000000..5d33f5c --- /dev/null +++ b/index.html @@ -0,0 +1,142 @@ + + + + + + wjwwood/serial @ GitHub + + + + + + Fork me on GitHub + +
+ +
+ + + + +
+ +

serial + by wjwwood

+ +
+ Cross-platform, Serial Port library for C++ +
+ + +

This is a cross-platform library for interfacing with rs-232 serial like ports written in C++. It provides a modern C++ interface with a workflow designed to look and feel like PySerial (http://pyserial.sourceforge.net/), but with the speed and control provided by C++. This library is in use in several robotics related projects and can be built and installed to the OS like most unix libraries with `make` and then `sudo make install`, but if you wish to use it with ROS then it will build as a unary stack. The library has two main components currently: Serial and SerialListener. Serial is a class that provides the basic interface common to serial libraries (open, close, read, write, etc..) and requires no extra dependencies. The SerialListener class is a convenience class that provides a method for easily asynchronously reading from a serial port, we have found this setup useful when interfacing with devices that send data asynchronously as well as use command-response type message interleaved. The SerialListener has an extra dependency of Boost for C++, which provides some feature not yet fully adopted by all C++ compilers like function types, shared_ptr's, and convenient threading.

+ + + +

Dependencies

+

* cmake - for the build system +* boost - for SerialListener only (optional) +* ROS - for building in a ROS ecosystem (optional)

+ + + +

Install

+

Get the code: + + git clone https://github.com/wjwwood/serial.git + +Build (without ROS): + + make + +Build and run the tests: + + make test + +Build the docs: + + make docs + +Install: + + sudo make install + +Uninstall: + + sudo make uninstall +

+ + + +

License

+

Copyright (c) 2011 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.

+ + + +

Authors

+

William Woodall (wjwwood@gmail.com)
John Harrison (ash@greaterthaninfinity.com)

+ + + +

Contact

+

William Woodall (wjwwood@gmail.com)

+ + +

Download

+

+ You can download this project in either + zip or + tar formats. +

+

You can also clone the project with Git + by running: + 

$ git clone git://github.com/wjwwood/serial
+

+ +
+ get the source code on GitHub : wjwwood/serial +
+ +
+ + +