rubyserial 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d014cad0d8238b82bf39b107e4a68c3ff7e2d16
-  data.tar.gz: ee8f9b64e23413ebceab097643078f0df1afb2e5
+  metadata.gz: 363ae6f9ed63c3a190ef6cfd82af0407dbb40685
+  data.tar.gz: 30cac498e9e60636c04cdd1089a0106ab5e58361
 SHA512:
-  metadata.gz: c4ca69b2cb366a8a86cfcd898010af66f1fb69c33b4ae53a83d52c9e7cc4e5b56ca45bd3a13bd8bef0c3a511bf7a224a9926a63269c544521d1742a5775c00a3
-  data.tar.gz: 22216f7ec08c00d115c1760e104304639a5d86ed721db4cc646b844b64954581e92a350df43343e4edef79d863766542e60088150c811f5bdc4a8804985cadfb
+  metadata.gz: 828439f9181b7d642f297835e1c2f4c7c8d14bd3a99f142e29d46f23e4229ee3d44ad3540f53920f5a7b281c1e04d16c0c2491dfea45cb115fb11e397f391fcc
+  data.tar.gz: 06e3f3263b8a9bebf19dce538387b5518adc40d61c2ffa48175f1f489ace10b06c25b8652330f985608ae57887a3b936b14ff894a7970ebe54276ed85c176936

data/README.md

@@ -49,25 +49,28 @@ A wrapper error type that returns the underlying system error code and inherits
 
 The test suite is written using rspec, just use the `rspec` command.
 
-However, to run the tests, you must also have the `socat` utility program installed.
+### Test dependencies
 
-### Installing socat on OS X
+To run the tests on OS X and Linux, you must also have the `socat` utility program installed.
+
+#### Installing socat on OS X
 
 ```
 brew install socat
 ```
 
-### Installing socat on Linux
+#### Installing socat on Linux
 
 ```
 sudo apt-get install socat
 ```
 
-### Installing socat on Windows
+#### Test on Windows
+
+To run the tests on Windows requires com0com which can be downloaded from here:
 
-You might need to build from source... the latest build of socat for Windows is quite old. Get source from here:
+https://github.com/hybridgroup/rubyserial/raw/appveyor_deps/setup_com0com_W7_x64_signed.exe
 
-http://www.dest-unreach.org/socat/download/
 
 ## License
 

data/lib/rubyserial/linux_constants.rb

@@ -16,10 +16,11 @@ module RubySerial
     IGNPAR = 0000004
     PARENB = 0000400
     PARODD = 0001000
-    CREAD = 0000200
+    CSTOPB = 0000100
+    CREAD  = 0000200
     CLOCAL = 0004000
     VMIN = 6
-    NCCS = 19
+    NCCS = 32
 
     DATA_BITS = {
       5 => 0000000,
@@ -68,6 +69,11 @@ module RubySerial
       :odd => PARENB | PARODD,
     }
 
+    STOPBITS = {
+      1 => 0x00000000,
+      2 => CSTOPB
+    }
+
     ERROR_CODES = {
       1 => "EPERM",
       2 => "ENOENT",

data/lib/rubyserial/osx_constants.rb

@@ -16,7 +16,9 @@ module RubySerial
     VMIN = 16
     VTIME = 17
     CLOCAL = 0x00008000
-    CREAD = 0x00000800
+    CSTOPB = 0x00000400
+    CREAD  = 0x00000800
+    CCTS_OFLOW = 0x00010000 # Clearing this disables RTS AND CTS.
     TCSANOW = 0
     NCCS = 20
 
@@ -59,6 +61,11 @@ module RubySerial
       :odd => PARENB | PARODD,
     }
 
+    STOPBITS = {
+      1 => 0x00000000,
+      2 => CSTOPB
+    }
+
     ERROR_CODES = {
       1 => "EPERM",
       2 => "ENOENT",

data/lib/rubyserial/posix.rb

@@ -1,7 +1,7 @@
 # Copyright (c) 2014-2016 The Hybrid Group
 
 class Serial
-  def initialize(address, baude_rate=9600, data_bits=8, parity=:none)
+  def initialize(address, baude_rate=9600, data_bits=8, parity=:none, stop_bits=1)
     file_opts = RubySerial::Posix::O_RDWR | RubySerial::Posix::O_NOCTTY | RubySerial::Posix::O_NONBLOCK
     @fd = RubySerial::Posix.open(address, file_opts)
 
@@ -21,7 +21,7 @@ class Serial
       raise RubySerial::Error, RubySerial::Posix::ERROR_CODES[FFI.errno]
     end
 
-    @config = build_config(baude_rate, data_bits, parity)
+    @config = build_config(baude_rate, data_bits, parity, stop_bits)
 
     err = RubySerial::Posix.tcsetattr(@fd, RubySerial::Posix::TCSANOW, @config)
     if err == -1
@@ -108,7 +108,7 @@ class Serial
     bytes.map { |e| e.chr }.join
   end
 
-  def build_config(baude_rate, data_bits, parity)
+  def build_config(baude_rate, data_bits, parity, stop_bits)
     config = RubySerial::Posix::Termios.new
 
     config[:c_iflag]  = RubySerial::Posix::IGNPAR
@@ -117,8 +117,13 @@ class Serial
     config[:c_cflag]  = RubySerial::Posix::DATA_BITS[data_bits] |
       RubySerial::Posix::CREAD |
       RubySerial::Posix::CLOCAL |
-      RubySerial::Posix::BAUDE_RATES[baude_rate] |
-      RubySerial::Posix::PARITY[parity]
+      RubySerial::Posix::PARITY[parity] |
+      RubySerial::Posix::STOPBITS[stop_bits]
+
+    # Masking in baud rate on OS X would corrupt the settings.
+    if RubySerial::ON_LINUX
+      config[:c_cflag] = config[:c_cflag] | RubySerial::Posix::BAUDE_RATES[baude_rate]
+    end
 
     config[:cc_c][RubySerial::Posix::VMIN] = 0
 

data/lib/rubyserial/version.rb

@@ -1,7 +1,7 @@
-# Copyright (c) 2014-2017 The Hybrid Group and Friends
+# Copyright (c) 2014-2018 The Hybrid Group and Friends
 
 module RubySerial
   unless const_defined?('VERSION')
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

data/lib/rubyserial/windows.rb

@@ -1,10 +1,7 @@
 # Copyright (c) 2014-2016 The Hybrid Group
 
 class Serial
-  def initialize(address, baude_rate=9600, data_bits=8, parity=:none)
-    if parity != :none
-      warn "warning: parity #{parity} is not supported on Windows.  Ignoring."
-    end
+  def initialize(address, baude_rate=9600, data_bits=8, parity=:none, stop_bits=1)
     file_opts = RubySerial::Win32::GENERIC_READ | RubySerial::Win32::GENERIC_WRITE
     @fd = RubySerial::Win32.CreateFileA("\\\\.\\#{address}", file_opts, 0, nil, RubySerial::Win32::OPEN_EXISTING, 0, nil)
     err = FFI.errno
@@ -22,8 +19,8 @@ class Serial
       end
       dcb[:baudrate] = baude_rate
       dcb[:bytesize] = data_bits
-      dcb[:stopbits] = RubySerial::Win32::DCB::ONESTOPBIT
-      dcb[:parity]   = RubySerial::Win32::DCB::NOPARITY
+      dcb[:stopbits] = RubySerial::Win32::DCB::STOPBITS[stop_bits]
+      dcb[:parity]   = RubySerial::Win32::DCB::PARITY[parity]
       err = RubySerial::Win32.SetCommState @fd, dcb
       if err == 0
         raise RubySerial::Error, RubySerial::Win32::ERROR_CODES[FFI.errno]

data/lib/rubyserial/windows_constants.rb

@@ -252,7 +252,21 @@ module RubySerial
                                         #   uint32 fDummy2 :17;
       Sizeof      = 28
       ONESTOPBIT  = 0
+      TWOSTOPBITS  = 2
+
+      STOPBITS = {
+        1 => ONESTOPBIT,
+        2 => TWOSTOPBITS
+      }
+
       NOPARITY    = 0
+      ODDPARITY   = 1
+      EVENPARITY  = 2
+      PARITY = {
+        :none => NOPARITY,
+        :odd  => ODDPARITY,
+        :even => EVENPARITY
+      }
     end
 
     class CommTimeouts < FFI::Struct

data/spec/rubyserial_spec.rb

@@ -148,5 +148,39 @@ describe "rubyserial" do
       @sp.write("Hello!\n")
       expect(@sp2.gets).to eql("Hello!\n")
     end
+
+    it 'should accept 1 stop bit' do
+      @sp2.close
+      @sp.close
+      @sp2 = Serial.new(@ports[0], 19200, 8, :none, 1)
+      @sp = Serial.new(@ports[1], 19200, 8, :none, 1)
+      @sp.write("Hello!\n")
+      expect(@sp2.gets).to eql("Hello!\n")
+    end
+
+    it 'should accept 2 stop bits' do
+      @sp2.close
+      @sp.close
+      @sp2 = Serial.new(@ports[0], 19200, 8, :none, 2)
+      @sp = Serial.new(@ports[1], 19200, 8, :none, 2)
+      @sp.write("Hello!\n")
+      expect(@sp2.gets).to eql("Hello!\n")
+    end
+
+    it 'should set baude rate, check #46 fixed' do
+      skip 'Not a bug on Windows' if RubySerial::ON_WINDOWS
+      @sp.close
+      rate = 600
+      @sp = Serial.new(@ports[1], rate)
+      fd = @sp.instance_variable_get(:@fd)
+      module RubySerial
+        module Posix
+          attach_function :tcgetattr, [ :int, RubySerial::Posix::Termios ], :int, blocking: true
+        end
+      end
+      termios = RubySerial::Posix::Termios.new
+      RubySerial::Posix::tcgetattr(fd, termios)
+      expect(termios[:c_ispeed]).to eql(RubySerial::Posix::BAUDE_RATES[rate])
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyserial
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Adrian Zankich
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-09 00:00:00.000000000 Z
+date: 2018-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: FFI Ruby library for RS-232 serial port communication