https://github.com/wjwwood/serial

Cross-platform, Serial Port library written in C++
https://github.com/wjwwood/serial

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/wjwwood/serial
• Owner: wjwwood
• License: mit
• Created: 2011-03-18T22:51:53.000Z (over 14 years ago)
• Default Branch: main
• Last Pushed: 2024-08-21T05:20:23.000Z (about 1 year ago)
• Last Synced: 2025-05-12T19:49:13.651Z (6 months ago)
• Language: C++
• Homepage: http://wjwwood.github.com/serial/
• Size: 1.54 MB
• Stars: 2,255
• Watchers: 111
• Forks: 1,090
• Open Issues: 99
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

• fucking-awesome-cpp - Serial Communication Library - Cross-platform, Serial Port library written in C++. [MIT] [website](http://wjwwood.io/serial/) (Serial Port)
• awesome-cpp-cn - Serial Communication Library
• awesome-cpp - Serial Communication Library - C++语言编写的跨平台，串口库. [MIT] (多项混杂)
• awesome-cpp - Serial Communication Library - Cross-platform, Serial Port library written in C++. [MIT] (Miscellaneous)
• awesome-cpp - Serial Communication Library - Cross-platform, Serial Port library written in C++. [MIT] [website](http://wjwwood.io/serial/) (Serial Port)

README

          
# Serial Communication Library

[![Build Status](https://travis-ci.org/wjwwood/serial.svg?branch=master)](https://travis-ci.org/wjwwood/serial)*(Linux and OS X)* [![Build Status](https://ci.appveyor.com/api/projects/status/github/wjwwood/serial)](https://ci.appveyor.com/project/wjwwood/serial)*(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](http://www.ros.org/wiki/catkin) - cmake and Python based buildsystem

* [cmake](http://www.cmake.org) - buildsystem

* [Python](http://www.python.org) - scripting language

  * [empy](http://www.alcyone.com/pyos/empy/) - Python templating library

  * [catkin_pkg](http://pypi.python.org/pypi/catkin_pkg/) - Runtime Python library for catkin

Optional (for documentation):

* [Doxygen](http://www.doxygen.org/) - Documentation generation tool

* [graphviz](http://www.graphviz.org/) - 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](LICENSE)

### Authors

William Woodall 

John Harrison 

### Contact

William Woodall