File: README.md

package info (click to toggle)
ruby-serialport 1.3.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid, stretch
  • size: 188 kB
  • ctags: 132
  • sloc: ansic: 1,524; ruby: 72; makefile: 2
file content (43 lines) | stat: -rw-r--r-- 1,304 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# Ruby/SerialPort

[![Build Status](https://travis-ci.org/hparra/ruby-serialport.png?branch=v1.2.2)](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 <http://rubydoc.info/gems/serialport/SerialPort> or run `yard`

## Issues

See <https://github.com/hparra/ruby-serialport/issues>

## Alternatives

The [Hybrid Group](http://hybridgroup.com/)'s MRI, JRuby, & Rubinius compatible [rubyserial](https://github.com/hybridgroup/rubyserial) gem may provide improved compatibilty in modern environments.

## License

GPL

## Authors

* Guillaume Pierronnet <moumar@netcourrier.com>
* Alan Stern <stern@rowland.harvard.edu>
* Tobin Richard <tobin.richard@gmail.com>
* Hector Parra <hector@hectorparra.com>
* Ryan C. Payne <rpayne-oss@bullittsystems.com>