1
0
mirror of https://github.com/wjwwood/serial.git synced 2026-01-22 19:54:57 +08:00
serial/README.md

64 lines
2.1 KiB
Markdown
Raw Normal View History

2012-01-01 01:18:06 -06:00
# Serial Communication Library
2012-01-01 01:13:06 -06:00
2014-12-29 12:40:54 -08:00
[![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)*
2012-10-24 00:08:46 -07:00
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++.
2012-06-09 18:21:34 -05:00
2012-10-24 00:08:46 -07:00
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.
2012-06-09 18:21:34 -05:00
2012-10-24 00:08:46 -07:00
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.
2012-06-09 18:21:34 -05:00
2012-10-24 00:08:46 -07:00
### Documentation
2012-06-09 18:21:34 -05:00
2021-06-10 19:15:44 -03:00
Website: http://wjwwood.github.io/serial/
2012-06-09 18:21:34 -05:00
2021-06-10 19:15:44 -03:00
API Documentation: http://wjwwood.github.io/serial/doc/1.1.0/index.html
2012-01-01 01:18:06 -06:00
2012-10-24 00:08:46 -07:00
### Dependencies
2012-01-01 01:18:06 -06:00
Required:
2012-10-24 00:08:46 -07:00
* [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
2012-01-01 01:18:06 -06:00
2012-10-24 00:08:46 -07:00
### Install
2012-01-01 01:18:06 -06:00
2012-10-24 00:08:46 -07:00
Get the code:
2012-01-01 01:18:06 -06:00
2012-10-24 00:08:46 -07:00
git clone https://github.com/wjwwood/serial.git
2012-01-01 01:18:06 -06:00
2012-10-24 00:08:46 -07:00
Build:
2012-01-01 01:18:06 -06:00
make
2012-10-24 00:08:46 -07:00
Build and run the tests:
2012-01-01 01:18:06 -06:00
2012-10-24 00:08:46 -07:00
make test
2012-01-01 01:18:06 -06:00
Build the documentation:
make doc
2012-01-01 01:18:06 -06:00
2012-10-24 00:08:46 -07:00
Install:
2012-01-01 01:25:22 -06:00
2012-10-24 00:08:46 -07:00
make install
2012-01-01 01:25:22 -06:00
2012-10-24 00:08:46 -07:00
### License
2012-01-01 01:25:22 -06:00
[The MIT License](LICENSE)
2012-10-24 00:08:46 -07:00
### Authors
2012-01-01 01:18:06 -06:00
2012-10-24 00:08:46 -07:00
William Woodall <wjwwood@gmail.com>
John Harrison <ash.gti@gmail.com>
### Contact
2012-01-01 01:18:06 -06:00
2013-03-14 16:04:11 -07:00
William Woodall <william@osrfoundation.org>