Skip to content

tessonics/serial

 
 

Repository files navigation

Note

This is a fork of https://github.com/wjwwood/serial The issues with the original are that it's using catkin - a build tool that would just incur an additional dependency for the build host. We removed that dependency from the CMakelists but left the code as is. This will make rebasing on the origin repo simple. Consider any references to catkin below as invalid.

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 [email protected] John Harrison [email protected]

Contact

William Woodall [email protected]

About

Cross-platform, Serial Port library written in C++

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C++ 94.4%
  • C 2.0%
  • CMake 1.9%
  • Makefile 1.5%
  • Python 0.2%