Path: | README.md |
Last Update: | Fri Aug 22 03:47:58 +0000 2014 |
# Ruby/SerialPort
[](https://travis-ci.org/hparra/ruby-serialport)
## Description
Ruby/SerialPort is a Ruby library that provides a class for using RS-232 serial ports. This class also contains low-level functions to check and set the current state of the signals on the line.
The native Windows version of this library supports the Microsoft Visual C++, Borland C++, and MinGW compilers.
There is an alternative gem with MRI, JRuby, and Rubinius support. See below.
## Installation
Install the gem as normal: `sudo gem install serialport`
## Testing
Use Ruby‘s version of miniterm: `ruby test/miniterm.rb`
## API
See <rubydoc.info/gems/serialport/SerialPort> or run `yard`
## Issues
See <github.com/hparra/ruby-serialport/issues>
## Alternatives
The [Hybrid Group](hybridgroup.com/)'s MRI, JRuby, & Rubinius compatible [rubyserial](github.com/hybridgroup/rubyserial) gem may provide improved compatibilty in modern environments.
## License
GPL
## Authors