Skip to content

Latest commit

 

History

History
62 lines (37 loc) · 1.92 KB

README.md

File metadata and controls

62 lines (37 loc) · 1.92 KB

Serial Communication Library

Build Status(Linux and OS X) Build Status(Windows)

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, 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 because it is a catkin project it can also be built along side other catkin projects in a catkin workspace.

Serial is a class that provides the basic interface common to serial libraries (open, close, read, write, etc..) and requires no extra dependencies. It also provides tight control over timeouts and control over handshaking lines.

Documentation

Website: http://wjwwood.github.io/serial/

API Documentation: http://wjwwood.github.io/serial/doc/1.1.0/index.html

Dependencies

Required:

Install

Get the code:

git clone https://github.com/GoLeRobotics/serial.git

Build:

mkdir build
cd build
cmake ..
make -j4

Install:

sudo make install
# or
sudo checkinstall # if checkinstall is installed via apt

Reference from another CMake Project

find_library(LIBSERIAL serial)

add_executable(<PROJ_NAME> <PROJ_SOURCE>)
target_link_libraries(<PROJ_NAME> LIBSERIAL)

License

The MIT License - Original License by W. Woodall

Authors

William Woodall [email protected] John Harrison [email protected] -- CMake modification part: Hosik Chae [email protected]

Contact

William Woodall [email protected]