Skip to content

wjwwood/serial

Folders and files

NameName
Last commit message
Last commit date
Jan 13, 2018
Apr 24, 2014
Jan 9, 2018
Jun 10, 2021
Jun 10, 2021
Sep 22, 2015
Jul 19, 2014
Feb 6, 2018
Apr 22, 2015
Jan 6, 2020
Mar 9, 2022
Feb 6, 2018
Mar 9, 2022
Oct 24, 2012
Jun 10, 2021
Jan 13, 2018

Repository files navigation

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:

  • catkin - cmake and Python based buildsystem
  • cmake - buildsystem
  • Python - scripting language
    • empy - Python templating library
    • catkin_pkg - Runtime Python library for catkin

Optional (for documentation):

  • Doxygen - Documentation generation tool
  • graphviz - Graph visualization software

Install

Get the code:

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

Build:

make

Build and run the tests:

make test

Build the documentation:

make doc

Install:

make install

License

The MIT License

Authors

William Woodall wjwwood@gmail.com John Harrison ash.gti@gmail.com

Contact

William Woodall william@osrfoundation.org