Sha256: ad0792b883ce5986af1cab1b8373281bbbaab10d3acacd267c5cf3f9498818fd
Contents?: true
Size: 1.79 KB
Versions: 11
Compression:
Stored size: 1.79 KB
Contents
require 'serialport.so'
require 'serialport/version'
# This class is used for communication over a serial port.
# In addition to the methods here, you can use Ruby IO methods, e.g. read, write, getc, readlines, etc.
#
# @see http://rubydoc.info/stdlib/core/IO Ruby IO class
# @see http://www.cmrr.umn.edu/~strupp/serial.html "Serial Programming Guide for POSIX Operating Systems"
class SerialPort
private_class_method(:create)
# Creates a serial port object.
# Accepts the port identifier and a variable list for configuration as paramaters or hash.
# Please see SerialPort#set_modem_params
#
# @overload new(port, *params)
# @param port [Integer] the serial port number,
# where 0 is mapped to "COM1" on Windows, "/dev/ttyS0" on Linux, "/dev/cuaa0" on Mac OS X, etc.
# @overload new(port, *params)
# @param port [String] the serial port file e.g. "/dev/ttyS0"
# @return [SerialPort]
# @see SerialPort#set_modem_params
def SerialPort::new(port, *params)
sp = create(port)
begin
sp.set_modem_params(*params)
rescue
sp.close
raise
end
return sp
end
# This behaves like SerialPort#new, except that you can pass a block
# to which the new serial port object will be passed. In this case
# the connection is automaticaly closed when the block has finished.
#
# @yield [serial_port] the serial port number or filename
# @see SerialPort#new
# @see SerialPort#set_modem_params
def SerialPort::open(port, *params)
sp = create(port)
begin
sp.set_modem_params(*params)
rescue
sp.close
raise
end
if (block_given?)
begin
yield sp
ensure
sp.close
end
return nil
end
return sp
end
end
Version data entries
11 entries across 11 versions & 5 rubygems