toholio-serialport 0.7.1

data/CHANGELOG

@@ -0,0 +1,20 @@
+0.7.1 => 31/08/2008:    Change to gemspec creation and fix posix compilation.
+
+0.7.0 => 03/07/2008:    Major Code Cleanup
+
+0.6.1 => 25/03/2003:    Minor changes
+
+0.6 => 12/02/2003:      Windows support
+                        Get/set modem parameters
+                        Read and write timeouts
+                        Open method
+
+0.5 => 25/10/2002:      Cygwin support
+
+0.4 => 19/09/2002:      Added more serial ports (total of 8 ports)
+
+0.3 => 15/03/2002:      Damn, another bug found
+
+0.2 => 14/03/2002:      A bug fixed (read() was not blocking)
+
+0.1 => 14/03/2002:      First release

data/MANIFEST

@@ -0,0 +1,11 @@
+CHANGELOG
+README
+MANIFEST
+serialport.gemspec
+extconf.rb
+lib/serialport.rb
+src/posix_serialport_impl.c
+src/serialport.c
+src/serialport.h
+src/win_serialport_impl.c
+test/miniterm.rb

data/README

@@ -0,0 +1,156 @@
+-----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 Microsoft's Visual C++
+and Borland's C++ compilers.
+
+-- Installation --
+
+This gem is hosted at GitHub. Before you can install this, or any other GitHub gem you must
+add it as a repository:
+  gem sources -a http://gems.github.com
+
+Then you can install the gem as normal:
+  sudo gem install toholio-serialport
+
+-- Testing --
+
+* test/miniterm.rb
+
+Ruby's copy of miniterm.c !
+
+
+-- API --
+
+  **** Class SerialPort, Parent IO ****
+
+    ** Class constants **
+
+       VERSION -> aString (this release is "0.6")
+       NONE, HARD, SOFT, SPACE, MARK, EVEN, ODD -> anInteger
+
+    ** Class methods **
+
+      * new(port_num [, modem_parameters]) -> aSerialPort
+      * open(port_num [, modem_parameters]) -> aSerialPort
+      * open(port_num [, modem_parameters]) {|aSerialPort| block} ->
+                value of the block
+
+        port_num -> anInteger: port number, 0 for first port which is
+                      "/dev/ttyS0" on GNU/Linux and "COM1" on Windows,
+                or  aString: file name of the device (example: "/dev/ttyS2")
+
+        Optional modem_parameters:
+
+        baudrate -> anInteger: from 50 to 256000, depends on platform.
+
+        databits -> anInteger: from 5 to 8 (4 is allowed on Windows)
+
+        stopbits -> anInteger: 1 or 2 (1.5 is not supported)
+
+        parity -> anInteger: SerialPort::NONE, SerialPort::EVEN,
+                  SerialPort::ODD, SerialPort::MARK, SerialPort::SPACE
+                  (MARK and SPACE are not supported on Posix)
+
+        Raise an argError on bad argument.
+
+        SerialPort::new and SerialPort::open without a block return an
+        instance of SerialPort.  SerialPort::open with a block passes
+        a SerialPort to the block and closes it when the block exits
+        (like File::open).
+
+
+    ** Instance methods **
+
+      * modem_params() -> aHash
+      * modem_params=(aHash) -> aHash
+      * get_modem_params() -> aHash
+      * set_modem_params(aHash) -> aHash
+      * set_modem_params(baudrate [, databits [, stopbits [, parity]]])
+
+        Get and set the modem parameters.  Hash keys are "baud", "data_bits",
+        "stop_bits", and "parity" (see above).
+
+        Parameters not present in the hash or set to nil remain unchanged.
+        Default parameter values for the set_modem_params method are:
+        databits = 8, stopbits = 1, parity = (databits == 8 ?
+        SerialPort::NONE : SerialPort::EVEN).
+
+      * baud() -> anInteger
+      * baud=(anInteger) -> anInteger
+      * data_bits() -> 4, 5, 6, 7, or 8
+      * data_bits=(anInteger) -> anInteger
+      * stop_bits() -> 1 or 2
+      * stop_bits=(anInteger) -> anInteger
+      * parity() -> anInteger: SerialPort::NONE, SerialPort::EVEN,
+          SerialPort::ODD, SerialPort::MARK, or SerialPort::SPACE
+      * parity=(anInteger) -> anInteger
+
+        Get and set the corresponding modem parameter.
+
+      * flow_control() -> anInteger
+      * flow_control=(anInteger) -> anInteger
+
+        Get and set the flow control: SerialPort::NONE, SerialPort::HARD,
+        SerialPort::SOFT, or (SerialPort::HARD | SerialPort::SOFT).
+
+        Note: SerialPort::HARD mode is not supported on all platforms.
+        SerialPort::HARD uses RTS/CTS handshaking; DSR/DTR is not
+        supported.
+
+      * read_timeout() -> anInteger
+      * read_timeout=(anInteger) -> anInteger
+      * write_timeout() -> anInteger
+      * write_timeout=(anInteger) -> anInteger
+
+        Get and set timeout values (in milliseconds) for reading and writing.
+        A negative read timeout will return all the available data without
+        waiting, a zero read timeout will not return until at least one
+        byte is available, and a positive read timeout returns when the
+        requested number of bytes is available or the interval between the
+        arrival of two bytes exceeds the timeout value.
+
+        Note: Read timeouts don't mix well with multi-threading.
+
+        Note: Under Posix, write timeouts are not implemented.
+
+      * break(time) -> nil
+
+        Send a break for the given time.  
+
+        time -> anInteger: tenths-of-a-second for the break.
+        Note: Under Posix, this value is very approximate.
+
+      * signals() -> aHash
+
+        Return a hash with the state of each line status bit.  Keys are
+        "rts", "dtr", "cts", "dsr", "dcd", and "ri".
+
+        Note: Under Windows, the rts and dtr values are not included.
+
+      * rts()
+      * dtr()
+      * cts()
+      * dsr()
+      * dcd()
+      * ri() -> 0 or 1
+
+      * rts=(0 or 1)
+      * dtr=(0 or 1) -> 0 or 1
+
+        Get and set the corresponding line status bit.
+
+        Note: Under Windows, rts() and dtr() are not implemented.
+
+-- License --
+
+GPL
+
+Guillaume Pierronnet <moumar@netcourrier.com>
+Alan Stern <stern@rowland.harvard.edu>
+Tobin Richard <tobin.richard@gmail.com>

data/extconf.rb

@@ -0,0 +1,13 @@
+require 'mkmf'
+
+printf("checking for OS... ")
+STDOUT.flush
+os = /-([a-z]+)/.match(RUBY_PLATFORM)[1]
+puts(os)
+$CFLAGS += " -DOS_#{os.upcase}"
+
+if !(os == 'mswin' or os == 'bccwin')
+  exit(1) if not have_header("termios.h") or not have_header("unistd.h")
+end
+
+create_makefile('serialport','src')

data/lib/serialport.rb

@@ -0,0 +1,32 @@
+require "serialport.so"
+
+class SerialPort
+   private_class_method(:create)
+
+   def SerialPort::new(port, *params)
+      sp = create(port)
+      begin
+         sp.set_modem_params(*params)
+      rescue
+         sp.close
+         raise
+      end
+      return sp
+   end
+
+   def SerialPort::open(port, *params)
+      sp = create(port)
+      begin
+         sp.set_modem_params(*params)
+         if (block_given?)
+            yield sp
+            sp.close
+            return nil
+         end
+      rescue
+         sp.close
+         raise
+      end
+      return sp
+   end
+end

data/serialport.gemspec

@@ -0,0 +1,24 @@
+SPEC = Gem::Specification.new do |s|
+  s.name = 'serialport'
+  s.version = '0.7.1'
+  s.summary  = 'Library for using RS-232 serial ports.'
+  s.description = 'SerialPort is a Ruby library that provides a class for using RS-232 serial ports.'
+  s.files = [ 'CHANGELOG',
+              'MANIFEST',
+              'README',
+              'serialport.gemspec',
+              'extconf.rb',
+              'lib/serialport.rb',
+              'src/posix_serialport_impl.c',
+              'src/serialport.c',
+              'src/serialport.h',
+              'src/win_serialport_impl.c' ]
+  s.test_files = [ 'test/miniterm.rb' ]
+  s.extensions << 'extconf.rb'
+  s.has_rdoc = true
+  s.extra_rdoc_files = [ 'README', 'src/serialport.c', 'src/serialport.h' ]
+  s.rdoc_options = [ '--main', 'README' ]
+  s.authors = ['Guillaume Pierronnet', 'Alan Stern', 'Daniel E. Shipton', 'Tobin Richard']
+  s.email = 'tobin.richard@gmail.com'
+  s.homepage = 'http://github.com/toholio/ruby-serialport/'
+end