serialport 0.8.0 → 1.0.0

data/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+/pkg
+/doc
+/ext/native/*.bundle
+/ext/native/*.log
+/ext/native/*.o
+/ext/native/*.so
+/ext/native/Makefile
+.*.swp
+tags

data/CHANGELOG

@@ -1,4 +1,6 @@
-0.7.4 => 10/12/2009:	Conditional 1.8.6 & 1.9 support (POSIX only). MinGW support.
+1.0.0 => 01/12/2010:    Fixed x86_64 segmentation fault issues. Windows 1.9 support.
+
+0.7.4 => 10/12/2009:    Conditional 1.8.6 & 1.9 support (POSIX only). MinGW support.
 
 0.7.3 => 10/09/2009:    http://makrotopia.org/browser/makrosys/makrobe/ruby-serialport/patches/10-fix-for-ruby-1.9 
                         applied for 1.9 support (POSIX only)

data/LICENSE

@@ -0,0 +1,339 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/MANIFEST

@@ -1,11 +1,13 @@
 CHANGELOG
-README
 MANIFEST
+README
+Rakefile
 serialport.gemspec
-extconf.rb
+VERSION
+ext/native/extconf.rb
+ext/native/posix_serialport_impl.c
+ext/native/serialport.c
+ext/native/serialport.h
+ext/native/win_serialport_impl.c
 lib/serialport.rb
-src/posix_serialport_impl.c
-src/serialport.c
-src/serialport.h
-src/win_serialport_impl.c
-test/miniterm.rb
+test/miniterm.rb

data/README

@@ -154,3 +154,4 @@ 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>

data/Rakefile

@@ -9,11 +9,16 @@ begin
     gemspec.description = "Ruby/SerialPort is a Ruby library that provides a class for using RS-232 serial ports."
     gemspec.email = "hector@hectorparra.com"
     gemspec.homepage = 'http://github.com/hparra/ruby-serialport/'
-    gemspec.authors = ['Guillaume Pierronnet', 'Alan Stern', 'Daniel E. Shipton', 'Tobin Richard']
-    gemspec.has_rdoc = false
-    gemspec.extensions << 'extconf.rb'
+    gemspec.authors = ['Guillaume Pierronnet', 'Alan Stern', 'Daniel E. Shipton', 'Tobin Richard', 'Hector Parra', 'Ryan C. Payne']
+    gemspec.has_rdoc = true
+    gemspec.extensions << 'ext/native/extconf.rb'
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end
+
+task :clean do
+  rm_rf(Dir['doc'], :verbose => true)
+  rm_rf(Dir['pkg'], :verbose => true)
 end

data/VERSION

@@ -1 +1 @@
-0.8.0
+1.0.0

data/{extconf.rb → ext/native/extconf.rb}

@@ -5,10 +5,10 @@ STDOUT.flush
 os = /-([a-z]+)/.match(RUBY_PLATFORM)[1]
 puts(os)
 $CFLAGS += " -DOS_#{os.upcase}"
-$CFLAGS += " -DRUBY_19" if RUBY_VERSION =~ /^1\.9/
+$CFLAGS += " -DRUBY_1_9" if RUBY_VERSION =~ /^1\.9/
 
 if !(os == 'mswin' or os == 'bccwin' or os == 'mingw')
   exit(1) if not have_header("termios.h") or not have_header("unistd.h")
 end
 
-create_makefile('serialport','src')
+create_makefile('serialport')

data/{src → ext/native}/posix_serialport_impl.c

@@ -1,7 +1,8 @@
-/* Ruby/SerialPort $Id$
+/* Ruby/SerialPort
  * Guillaume Pierronnet <moumar@netcourrier.com>
  * Alan Stern <stern@rowland.harvard.edu>
  * Daniel E. Shipton <dshipton@redshiptechnologies.com>
+ * Ryan C. Payne <rpayne-oss@bullittsystems.com>
  *
  * This code is hereby licensed for public consumption under either the
  * GNU GPL v2 or greater.
@@ -43,26 +44,26 @@ static char sIoctl[] = "ioctl";
 int get_fd_helper(obj)
    VALUE obj;
 {
-#ifdef RUBY_19
-	rb_io_t *fptr;
+#ifdef RUBY_1_9
+   rb_io_t *fptr;
 #else
-	OpenFile *fptr;
+   OpenFile *fptr;
 #endif
    GetOpenFile(obj, fptr);
-#ifdef RUBY_19
-	return (fptr->fd);
+#ifdef RUBY_1_9
+   return (fptr->fd);
 #else
-	return (fileno(fptr->f));
+   return (fileno(fptr->f));
 #endif
 }
 
 VALUE sp_create_impl(class, _port)
    VALUE class, _port;
 {
-#ifdef RUBY_19
-	rb_io_t *fp;
+#ifdef RUBY_1_9
+   rb_io_t *fp;
 #else
-	OpenFile *fp;
+   OpenFile *fp;
 #endif
 
    int fd;
@@ -72,8 +73,8 @@ VALUE sp_create_impl(class, _port)
 #if defined(OS_LINUX) || defined(OS_CYGWIN)
       "/dev/ttyS0", "/dev/ttyS1", "/dev/ttyS2", "/dev/ttyS3",
       "/dev/ttyS4", "/dev/ttyS5", "/dev/ttyS6", "/dev/ttyS7"
-#elif defined(OS_FREEBSD) || defined(OS_NETBSD) || defined(OS_OPENBSD)
-         "/dev/cuaa0", "/dev/cuaa1", "/dev/cuaa2", "/dev/cuaa3",
+#elif defined(OS_FREEBSD) || defined(OS_NETBSD) || defined(OS_OPENBSD) || defined(OS_DARWIN)
+      "/dev/cuaa0", "/dev/cuaa1", "/dev/cuaa2", "/dev/cuaa3",
       "/dev/cuaa4", "/dev/cuaa5", "/dev/cuaa6", "/dev/cuaa7"
 #elif defined(OS_SOLARIS)
          "/dev/ttya", "/dev/ttyb", "/dev/ttyc", "/dev/ttyd",
@@ -106,10 +107,10 @@ VALUE sp_create_impl(class, _port)
 
       case T_STRING:
          Check_SafeStr(_port);
-#ifdef RUBY_19
-			port = RSTRING_PTR(_port);
+#ifdef RUBY_1_9
+         port = RSTRING_PTR(_port);
 #else
-			port = RSTRING(_port)->ptr;
+         port = RSTRING(_port)->ptr;
 #endif
          break;
 
@@ -151,10 +152,10 @@ VALUE sp_create_impl(class, _port)
       rb_sys_fail(sTcsetattr);
    }
 
-#ifdef RUBY_19
-	fp->fd = fd;
+#ifdef RUBY_1_9
+   fp->fd = fd;
 #else
-	fp->f = rb_fdopen(fd, "r+");
+   fp->f = rb_fdopen(fd, "r+");
 #endif
    fp->mode = FMODE_READWRITE | FMODE_SYNC;
 

data/{src → ext/native}/serialport.c

@@ -1,7 +1,9 @@
-/* Ruby/SerialPort $Id$
+/* Ruby/SerialPort
  * Guillaume Pierronnet <moumar@netcourrier.com>
  * Alan Stern <stern@rowland.harvard.edu>
  * Daniel E. Shipton <dshipton@redshiptechnologies.com>
+ * Jonas Bähr <jonas.baehr@fs.ei.tum.de>
+ * Ryan C. Payne <rpayne-oss@bullittsystems.com>
  *
  * This code is hereby licensed for public consumption under either the
  * GNU GPL v2 or greater.
@@ -24,6 +26,7 @@ VALUE sBaud, sDataBits, sStopBits, sParity; /* strings */
 VALUE sRts, sDtr, sCts, sDsr, sDcd, sRi;
 
 /*
+ * :nodoc: This method is private and will be called by SerialPort#new or SerialPort#open.
  */
 static VALUE sp_create(class, _port)
    VALUE class, _port;
@@ -32,6 +35,21 @@ static VALUE sp_create(class, _port)
 }
 
 /*
+ * Configure the serial port. You can pass a hash or multiple values
+ * as separate arguments. Invalid or unsupported values will raise
+ * an ArgumentError.
+ *
+ * When using a hash the following keys are recognized:
+ * ["baud"] Integer from 50 to 256000, depends on platform
+ * ["data_bits"] Integer from 5 to 8 (4 is allowed on Windows too)
+ * ["stop_bits"] An integer, only allowed values are 1 or 2 (1.5 is not supported)
+ * ["parity"] One of the constants NONE, EVEN or ODD (Windows allows also MARK and SPACE)
+ *
+ * When using separate arguments, they are interpreted as:
+ * (baud, data_bits = 8, stop_bits = 1, parity = (previous_databits==8 ? NONE : EVEN))
+ *
+ * Nota: A baudrate of nil will keep the old value. The default parity depends on the
+ * number of databits configured before this function call.
  */
 static VALUE sp_set_modem_params(argc, argv, self)
    int argc;
@@ -41,6 +59,11 @@ static VALUE sp_set_modem_params(argc, argv, self)
 }
 
 /*
+ * Send a break for the given time.
+ *
+ * <tt>time</tt> is an integer of tenths-of-a-second for the break.
+ *
+ * Note: Under Posix, this value is very approximate.
  */
 static VALUE sp_break(self, time)
    VALUE self, time;
@@ -49,6 +72,7 @@ static VALUE sp_break(self, time)
 }
 
 /*
+ * Get the state (0 or 1) of the DTR line (not available on Windows)
  */
 static VALUE sp_get_dtr(self)
    VALUE self;
@@ -57,6 +81,7 @@ static VALUE sp_get_dtr(self)
 }
 
 /*
+ * Get the flow control. The result is either NONE, HARD, SOFT or (HARD | SOFT)
  */
 static VALUE sp_get_flow_control(self)
    VALUE self;
@@ -65,6 +90,8 @@ static VALUE sp_get_flow_control(self)
 }
 
 /*
+ * Get the timeout value (in milliseconds) for reading.
+ * See SerialPort#set_read_timeout for details.
  */
 static VALUE sp_get_read_timeout(self)
    VALUE self;
@@ -73,6 +100,7 @@ static VALUE sp_get_read_timeout(self)
 }
 
 /*
+ * Get the state (0 or 1) of the RTS line (not available on Windows)
  */
 static VALUE sp_get_rts(self)
    VALUE self;
@@ -81,6 +109,9 @@ static VALUE sp_get_rts(self)
 }
 
 /*
+ * Get the write timeout (in milliseconds)
+ *
+ * Note: Under Posix, write timeouts are not implemented.
  */
 static VALUE sp_get_write_timeout(self)
    VALUE self;
@@ -89,36 +120,59 @@ static VALUE sp_get_write_timeout(self)
 }
 
 /*
+ * Set the state (0 or 1) of the DTR line
  */
 static VALUE sp_set_dtr(self, val)
+   VALUE self, val;
 {
    return sp_set_dtr_impl(self, val);
 }
 
 /*
+ * Set the flow control to either NONE, HARD, SOFT or (HARD | SOFT)
+ *
+ *  Note: SerialPort::HARD mode is not supported on all platforms.
+ *  SerialPort::HARD uses RTS/CTS handshaking; DSR/DTR is not
+ *  supported.
  */
 static VALUE sp_set_flow_control(self, val)
+   VALUE self, val;
 {
    return sp_set_flow_control_impl(self, val);
 }
 
 /*
+ * Set the timeout value (in milliseconds) for reading.
+ * 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.
  */
 static VALUE sp_set_read_timeout(self, val)
+   VALUE self, val;
 {
    return sp_set_read_timeout_impl(self, val);
 }
 
 /*
+ * Set the state (0 or 1) of the RTS line
  */
 static VALUE sp_set_rts(self, val)
+   VALUE self, val;
 {
    return sp_set_rts_impl(self, val);
 }
 
 /*
+ * Set a write timeout (in milliseconds)
+ *
+ * Note: Under Posix, write timeouts are not implemented.
  */
 static VALUE sp_set_write_timeout(self, val)
+   VALUE self, val;
 {
    return sp_set_write_timeout_impl(self, val);
 }
@@ -133,6 +187,7 @@ static void get_modem_params(self, mp)
 }
 
 /*
+ * Set the baud rate, see SerialPort#set_modem_params for details.
  */
 static VALUE sp_set_data_rate(self, data_rate)
    VALUE self, data_rate;
@@ -147,6 +202,7 @@ static VALUE sp_set_data_rate(self, data_rate)
 }
 
 /*
+ * Set the data bits, see SerialPort#set_modem_params for details.
  */
 static VALUE sp_set_data_bits(self, data_bits)
    VALUE self, data_bits;
@@ -161,6 +217,7 @@ static VALUE sp_set_data_bits(self, data_bits)
 }
 
 /*
+ * Set the stop bits, see SerialPort#set_modem_params for details.
  */
 static VALUE sp_set_stop_bits(self, stop_bits)
    VALUE self, stop_bits;
@@ -175,6 +232,7 @@ static VALUE sp_set_stop_bits(self, stop_bits)
 }
 
 /*
+ * Set the parity, see SerialPort#set_modem_params for details.
  */
 static VALUE sp_set_parity(self, parity)
    VALUE self, parity;
@@ -189,6 +247,7 @@ static VALUE sp_set_parity(self, parity)
 }
 
 /*
+ * Get the current baud rate, see SerialPort#get_modem_params for details.
  */
 static VALUE sp_get_data_rate(self)
    VALUE self;
@@ -201,6 +260,7 @@ static VALUE sp_get_data_rate(self)
 }
 
 /*
+ * Get the current data bits, see SerialPort#get_modem_params for details.
  */
 static VALUE sp_get_data_bits(self)
    VALUE self;
@@ -213,6 +273,7 @@ static VALUE sp_get_data_bits(self)
 }
 
 /*
+ * Get the current stop bits, see SerialPort#get_modem_params for details.
  */
 static VALUE sp_get_stop_bits(self)
    VALUE self;
@@ -225,6 +286,7 @@ static VALUE sp_get_stop_bits(self)
 }
 
 /*
+ * Get the current parity, see SerialPort#get_modem_params for details.
  */
 static VALUE sp_get_parity(self)
    VALUE self;
@@ -237,6 +299,13 @@ static VALUE sp_get_parity(self)
 }
 
 /*
+ * Get the configure of the serial port.
+ *
+ * Returned is a hash with the following keys:
+ * ["baud"] Integer with the baud rate
+ * ["data_bits"] Integer from 5 to 8 (4 is possible on Windows too)
+ * ["stop_bits"] Integer, 1 or 2 (1.5 is not supported)
+ * ["parity"] One of the constants NONE, EVEN or ODD (on Windows may also MARK or SPACE)
  */
 static VALUE sp_get_modem_params(self)
    VALUE self;
@@ -264,6 +333,7 @@ void get_line_signals_helper(obj, ls)
 }
 
 /*
+ * Get the state (0 or 1) of the CTS line
  */
 static VALUE sp_get_cts(self)
    VALUE self;
@@ -276,6 +346,7 @@ static VALUE sp_get_cts(self)
 }
 
 /*
+ * Get the state (0 or 1) of the DSR line
  */
 static VALUE sp_get_dsr(self)
    VALUE self;
@@ -288,6 +359,7 @@ static VALUE sp_get_dsr(self)
 }
 
 /*
+ * Get the state (0 or 1) of the DCD line
  */
 static VALUE sp_get_dcd(self)
    VALUE self;
@@ -300,6 +372,7 @@ static VALUE sp_get_dcd(self)
 }
 
 /*
+ * Get the state (0 or 1) of the RI line
  */
 static VALUE sp_get_ri(self)
    VALUE self;
@@ -312,6 +385,10 @@ static VALUE sp_get_ri(self)
 }
 
 /*
+ * 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.
  */
 static VALUE sp_signals(self)
    VALUE self;
@@ -335,6 +412,11 @@ static VALUE sp_signals(self)
    return hash;
 }
 
+/*
+ * This class is used for communication over a serial port.
+ * In addition to the methods here, you can use everything
+ * Ruby's IO-class provides (read, write, getc, readlines, ...)
+ */
 void Init_serialport()
 {
    sBaud = rb_str_new2("baud");
@@ -405,5 +487,6 @@ void Init_serialport()
    rb_define_const(cSerialPort, "EVEN", INT2FIX(EVEN));
    rb_define_const(cSerialPort, "ODD", INT2FIX(ODD));
 
+   /* the package's version as a string "X.Y.Z", beeing major, minor and patch level */
    rb_define_const(cSerialPort, "VERSION", rb_str_new2(RUBY_SERIAL_PORT_VERSION));
 }

data/{src → ext/native}/serialport.h

@@ -1,8 +1,9 @@
-/* Ruby/SerialPort $Id$
+/* Ruby/SerialPort
  * Guillaume Pierronnet <moumar@netcourrier.com>
  * Alan Stern <stern@rowland.harvard.edu>
  * Daniel E. Shipton <dshipton@redshiptechnologies.com>
  * Tobin Richard <tobin.richard@gmail.com>
+ * Ryan C. Payne <rpayne-oss@bullittsystems.com>
  *
  * This code is hereby licensed for public consumption under either the
  * GNU GPL v2 or greater.
@@ -20,14 +21,13 @@
 #ifndef _RUBY_SERIAL_PORT_H_
 #define _RUBY_SERIAL_PORT_H_
 
-#define RUBY_SERIAL_PORT_VERSION   "0.7.3"
+#define RUBY_SERIAL_PORT_VERSION   "1.0.0"
 
 #include <ruby.h>    /* ruby inclusion */
-
-#ifdef RUBY_19
-	#include <ruby/io.h>
+#ifdef RUBY_1_9      /* ruby io inclusion */
+   #include <ruby/io.h>
 #else
-	#include <rubyio.h>
+   #include <rubyio.h>
 #endif
 
 struct modem_params
@@ -57,10 +57,13 @@ struct line_signals
    #define MARK   MARKPARITY
    #define EVEN   EVENPARITY
    #define ODD    ODDPARITY
-   
+
+/* Not entirely sure why this was commented out, but it has been tested */   
+/*
    #ifndef RB_SERIAL_EXPORT
-	 #define RB_SERIAL_EXPORT __declspec(dllexport)
+   #define RB_SERIAL_EXPORT __declspec(dllexport)
    #endif
+*/
 #else
    #define SPACE  0
    #define MARK   0

data/{src → ext/native}/win_serialport_impl.c

@@ -1,4 +1,4 @@
-/* Ruby/SerialPort $Id$
+/* Ruby/SerialPort
  * Guillaume Pierronnet <moumar@netcourrier.com>
  * Alan Stern <stern@rowland.harvard.edu>
  * Daniel E. Shipton <dshipton@redshiptechnologies.com>
@@ -35,16 +35,28 @@ static char sSetCommTimeouts[] = "SetCommTimeouts";
 static HANDLE get_handle_helper(obj)
    VALUE obj;
 {
+#ifdef RUBY_1_9
+   rb_io_t *fptr;
+#else
    OpenFile *fptr;
+#endif
 
    GetOpenFile(obj, fptr);
+#ifdef RUBY_1_9
+   return (HANDLE) _get_osfhandle(fptr->fd);
+#else
    return (HANDLE) _get_osfhandle(fileno(fptr->f));
+#endif
 }
 
 VALUE RB_SERIAL_EXPORT sp_create_impl(class, _port)
    VALUE class, _port;
 {
+#ifdef RUBY_1_9
+   rb_io_t *fp;
+#else
    OpenFile *fp;
+#endif
    int fd;
    HANDLE fh;
    int num_port;
@@ -75,7 +87,11 @@ VALUE RB_SERIAL_EXPORT sp_create_impl(class, _port)
 
       case T_STRING:
          Check_SafeStr(_port);
+#ifdef RUBY_1_9
+         port = RSTRING_PTR(_port);
+#else
          port = RSTRING(_port)->ptr;
+#endif
          break;
 
       default:
@@ -121,7 +137,11 @@ VALUE RB_SERIAL_EXPORT sp_create_impl(class, _port)
 
    errno = 0;
    fp->mode = FMODE_READWRITE | FMODE_BINMODE | FMODE_SYNC;
+#ifdef RUBY_1_9
+   fp->fd = fd;
+#else
    fp->f = fdopen(fd, "rb+");
+#endif
    return (VALUE) sp;
 }
 

data/lib/serialport.rb

@@ -1,8 +1,17 @@
-require "serialport.so"
+require 'serialport.so'
 
 class SerialPort
    private_class_method(:create)
 
+   # Creates a serial port object.
+   #
+   # <tt>port</tt> may be a port number
+   # or the file name of a defice.
+   # The number is portable; so 0 is mapped to "COM1" on Windows,
+   # "/dev/ttyS0" on Linux, "/dev/cuaa0" on Mac OS X, etc.
+   #
+   # <tt>params</tt> can be used to configure the serial port.
+   # See SerialPort#set_modem_params for details
    def SerialPort::new(port, *params)
       sp = create(port)
       begin
@@ -14,6 +23,9 @@ class SerialPort
       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.
    def SerialPort::open(port, *params)
       sp = create(port)
       begin

data/serialport.gemspec

@@ -5,31 +5,35 @@
 
 Gem::Specification.new do |s|
   s.name = %q{serialport}
-  s.version = "0.8.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Guillaume Pierronnet", "Alan Stern", "Daniel E. Shipton", "Tobin Richard"]
-  s.date = %q{2009-10-14}
+  s.authors = ["Guillaume Pierronnet", "Alan Stern", "Daniel E. Shipton", "Tobin Richard", "Hector Parra", "Ryan C. Payne"]
+  s.date = %q{2010-01-19}
   s.description = %q{Ruby/SerialPort is a Ruby library that provides a class for using RS-232 serial ports.}
   s.email = %q{hector@hectorparra.com}
-  s.extensions = ["extconf.rb"]
+  s.extensions = ["ext/native/extconf.rb"]
   s.extra_rdoc_files = [
-    "README"
+    "LICENSE",
+     "README"
   ]
   s.files = [
-    "CHANGELOG",
+    ".gitignore",
+     "CHANGELOG",
+     "LICENSE",
      "MANIFEST",
      "README",
      "Rakefile",
      "VERSION",
-     "extconf.rb",
+     "ext/native/extconf.rb",
+     "ext/native/posix_serialport_impl.c",
+     "ext/native/serialport.c",
+     "ext/native/serialport.h",
+     "ext/native/win_serialport_impl.c",
      "lib/serialport.rb",
      "serialport.gemspec",
-     "src/posix_serialport_impl.c",
-     "src/serialport.c",
-     "src/serialport.h",
-     "src/win_serialport_impl.c",
-     "test/miniterm.rb"
+     "test/miniterm.rb",
+     "test/set_readtimeout.rb"
   ]
   s.homepage = %q{http://github.com/hparra/ruby-serialport/}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -37,7 +41,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Library for using RS-232 serial ports.}
   s.test_files = [
-    "test/miniterm.rb"
+    "test/miniterm.rb",
+     "test/set_readtimeout.rb"
   ]
 
   if s.respond_to? :specification_version then

data/test/set_readtimeout.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby
+require "rubygems"
+require "serialport"
+
+sp = SerialPort.new("/dev/tty.usbserial", "9600".to_i)
+sp.read_timeout = 100
+sp.close

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification 
 name: serialport
 version: !ruby/object:Gem::Version 
-  version: 0.8.0
+  version: 1.0.0
 platform: ruby
 authors: 
 - Guillaume Pierronnet
 - Alan Stern
 - Daniel E. Shipton
 - Tobin Richard
+- Hector Parra
+- Ryan C. Payne
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-10-14 00:00:00 -07:00
+date: 2010-01-19 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -21,23 +23,27 @@ email: hector@hectorparra.com
 executables: []
 
 extensions: 
-- extconf.rb
+- ext/native/extconf.rb
 extra_rdoc_files: 
+- LICENSE
 - README
 files: 
+- .gitignore
 - CHANGELOG
+- LICENSE
 - MANIFEST
 - README
 - Rakefile
 - VERSION
-- extconf.rb
+- ext/native/extconf.rb
+- ext/native/posix_serialport_impl.c
+- ext/native/serialport.c
+- ext/native/serialport.h
+- ext/native/win_serialport_impl.c
 - lib/serialport.rb
 - serialport.gemspec
-- src/posix_serialport_impl.c
-- src/serialport.c
-- src/serialport.h
-- src/win_serialport_impl.c
 - test/miniterm.rb
+- test/set_readtimeout.rb
 has_rdoc: true
 homepage: http://github.com/hparra/ruby-serialport/
 licenses: []
@@ -68,3 +74,4 @@ specification_version: 3
 summary: Library for using RS-232 serial ports.
 test_files: 
 - test/miniterm.rb
+- test/set_readtimeout.rb