rubyserial-with-blocking 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d6381caf1cc6b6fcebd72e2c632a92bfbaa46f5c
+  data.tar.gz: 0ec74868ab6b407eb1c6c85af4b910de845a55d7
+SHA512:
+  metadata.gz: adc8fcf13dce6cc2f6715a3cb0a0198754698ca45d7d53c98d0f37745c8d135b65a57c042aa889c43ac60664a7238d1735c628f4f0d9366d6dee45b9b2a05694
+  data.tar.gz: a06a5331e0b171e7995b5eff36b64e28b5209b4af8fc2778727f4a3666ecad446676a22cece19a5df99c6a97dc713bd00220be252ed8782fc470d95178fcd2bb

data/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+/vendor
+Gemfile.lock
+socat.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+  - jruby
+  - jruby-head
+  - rbx-2.2.10
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: ruby-head
+install:
+    #- sudo apt-get update && sudo apt-get install --force-yes socat
+script:
+  - bundle install
+  - bundle exec rspec -fd

data/Gemfile

@@ -0,0 +1,5 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+gemspec
+gem 'rspec', '~> 3.0.0'

data/Guardfile

@@ -0,0 +1,7 @@
+#guard(:rspec, all_on_start: true) do #, cli: '--format nested --debug --color' do
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+[_-]spec\.rb$})
+  watch(%r{^lib/rubyserial/(.+)\.rb$})       { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')    { "spec" }
+  watch('lib/rubyserial.rb')    { "spec" }
+end

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2014 The Hybrid Group
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,76 @@
+# THIS IS ONLY THE FORK!
+
+it is adding blocking read functionality. I added a config hash to the c'tor so
+that you can control VMIN & VTIME termio settings for the device. VMIN was fixed
+to 0 before resulting in effectively always returning immediatly from the read
+call and you could not just block wait for input. But polling is bad. The other
+thing i did was to add a getter for the file descriptor. This makes it possible
+to use the serial device in a select call. You can also use select to avoid
+polling but much more it is useful to use it to let the OS block wait on
+multiple IO sources simultaneously.
+
+It made the changes in a way which will not break existing code. Old code just
+does what it did before. 
+
+To block reading add vmin:  Serial.new(path, nil, nil, vmin: 1). This will block
+until at least one character was read. 
+
+To wait for multiple input sources use select:
+
+  sp = Serial.new(path)
+  # combine some sources in1, in2, and the serial port
+  result = IO.select([in1, in2, IO.new(sp.fd)])
+
+The IO#select call returns and array of arrays with file descriptors ready for
+reading (it's more complex, see IO#select manual)
+
+
+----
+
+# rubyserial
+
+RubySerial is a simple Ruby gem for reading from and writing to serial ports. 
+
+Unlike other Ruby serial port implementations, it supports all of the most popular Ruby implementations (MRI, JRuby, & Rubinius) on the most popular operating systems (OSX, Linux, & Windows). And it does not require any native compilation thanks to using RubyFFI [https://github.com/ffi/ffi](https://github.com/ffi/ffi).
+
+The interface to RubySerial should be (mostly) compatible with other Ruby serialport gems, so you should be able to drop in the new gem, change the `require` and use it as a replacement. If not, please let us know so we can address any issues.
+
+[![Build Status](https://travis-ci.org/hybridgroup/rubyserial.svg)](https://travis-ci.org/hybridgroup/rubyserial)
+[![Build status](https://ci.appveyor.com/api/projects/status/946nlaqy4443vb99/branch/master?svg=true)](https://ci.appveyor.com/project/zankich/rubyserial/branch/master)
+
+## Installation
+
+    $ gem install rubyserial
+
+## Usage
+
+```ruby
+require 'rubyserial'
+serialport = Serial.new '/dev/ttyACM0', 57600
+```
+
+## Methods
+
+**write(data : String) -> Int**
+
+Returns the number of bytes written.
+Emits a `RubySerial::Exception` on error.
+
+**read(length : Int) -> String**
+
+Returns a string up to `length` long. It is not guaranteed to return the entire
+length specified, and will return an empty string if no data is
+available. Emits a `RubySerial::Exception` on error.
+
+**getbyte -> Fixnum or nil**
+
+Returns an 8 bit byte or nil if no data is available. 
+Emits a `RubySerial::Exception` on error.
+
+**RubySerial::Exception**
+
+A wrapper exception type, that returns the underlying system error code.
+
+## License
+
+Apache 2.0. See `LICENSE` for more details.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/appveyor.yml

@@ -0,0 +1,25 @@
+platform:
+  - x64
+
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - ruby -v
+  - gem install bundler
+  - bundle install
+  - ps: Start-FileDownload https://github.com/hybridgroup/rubyserial/raw/appveyor_deps/com0com.cer
+  - ps: C:\"Program Files"\"Microsoft SDKs"\Windows\v7.1\Bin\CertMgr.exe /add com0com.cer /s /r localMachine root
+  - ps: C:\"Program Files"\"Microsoft SDKs"\Windows\v7.1\Bin\CertMgr.exe /add com0com.cer /s /r localMachine trustedpublisher
+  - ps: Start-FileDownload https://github.com/hybridgroup/rubyserial/raw/appveyor_deps/setup_com0com_W7_x64_signed.exe
+  - ps: $env:CNC_INSTALL_CNCA0_CNCB0_PORTS="YES"
+  - ps: .\setup_com0com_W7_x64_signed.exe /S
+  - ps: sleep 60
+
+test_script:
+  - ps: rspec spec -fd
+
+environment:
+  matrix:
+    - ruby_version: "200-x64"
+    - ruby_version: "21-x64"
+
+build: off

data/lib/rubyserial.rb

@@ -0,0 +1,21 @@
+$:.unshift(File.dirname(__FILE__))
+require 'rbconfig'
+require 'ffi'
+include RbConfig
+
+module RubySerial
+  class Exception < Exception
+  end
+end
+
+if CONFIG['host_os'] =~ /mswin|windows|mingw/i
+  require 'rubyserial/windows_constants'
+  require 'rubyserial/windows'
+else
+  if CONFIG['host_os'] =~ /linux/i
+    require 'rubyserial/linux_constants'
+  else
+    require 'rubyserial/osx_constants'
+  end
+  require 'rubyserial/posix'
+end

data/lib/rubyserial/linux_constants.rb

@@ -0,0 +1,214 @@
+require 'ffi'
+
+module RubySerial
+  module Posix
+  extend FFI::Library
+    ffi_lib FFI::Library::LIBC
+
+    O_NONBLOCK = 00004000
+    O_NOCTTY = 00000400
+    O_RDWR = 00000002
+    F_GETFL = 3
+    F_SETFL = 4
+    VTIME = 5
+    TCSANOW = 0
+    TCSETS = 0x5402
+    IGNPAR = 0000004
+    CREAD = 0000200
+    CLOCAL = 0004000
+    VMIN = 6
+    NCCS = 19
+
+    DATA_BITS = {
+      5 => 0000000,
+      6 => 0000020,
+      7 => 0000040,
+      8 => 0000060
+    }
+
+    BAUDE_RATES = {
+      0 => 0000000,
+      50 => 0000001,
+      75 => 0000002,
+      110 => 0000003,
+      134 => 0000004,
+      150 => 0000005,
+      200 => 0000006,
+      300 => 0000007,
+      600 => 0000010,
+      1200 => 0000011,
+      1800 => 0000012,
+      2400 => 0000013,
+      4800 => 0000014,
+      9600 => 0000015,
+      19200 => 0000016,
+      38400 => 0000017,
+      57600 => 0010001,
+      115200 => 0010002,
+      230400 => 0010003,
+      460800 => 0010004,
+      500000 => 0010005,
+      576000 => 0010006,
+      921600 => 0010007,
+      1000000 => 0010010,
+      1152000 => 0010011,
+      1500000 => 0010012,
+      2000000 => 0010013,
+      2500000 => 0010014,
+      3000000 => 0010015,
+      3500000 => 0010016,
+      4000000 => 0010017
+    }
+
+    ERROR_CODES = {
+      1 => "EPERM",
+      2 => "ENOENT",
+      3 => "ESRCH",
+      4 => "EINTR",
+      5 => "EIO",
+      6 => "ENXIO",
+      7 => "E2BIG",
+      8 => "ENOEXEC",
+      9 => "EBADF",
+      10 => "ECHILD",
+      11 => "EAGAIN",
+      12 => "ENOMEM",
+      13 => "EACCES",
+      14 => "EFAULT",
+      15 => "ENOTBLK",
+      16 => "EBUSY",
+      17 => "EEXIST",
+      18 => "EXDEV",
+      19 => "ENODEV",
+      20 => "ENOTDIR ",
+      21 => "EISDIR",
+      22 => "EINVAL",
+      23 => "ENFILE",
+      24 => "EMFILE",
+      25 => "ENOTTY",
+      26 => "ETXTBSY",
+      27 => "EFBIG",
+      28 => "ENOSPC",
+      29 => "ESPIPE",
+      30 => "EROFS",
+      31 => "EMLINK",
+      32 => "EPIPE",
+      33 => "EDOM",
+      34 => "ERANGE",
+      35 => "EDEADLK",
+      36 => "ENAMETOOLONG",
+      37 => "ENOLCK ",
+      38 => "ENOSYS",
+      39 => "ENOTEMPTY",
+      40 => "ELOOP",
+      42 => "ENOMSG",
+      43 => "EIDRM",
+      44 => "ECHRNG",
+      45 => "EL2NSYNC",
+      46 => "EL3HLT",
+      47 => "EL3RST",
+      48 => "ELNRNG",
+      49 => "EUNATCH",
+      50 => "ENOCSI",
+      51 => "EL2HLT",
+      52 => "EBADE",
+      53 => "EBADR",
+      54 => "EXFULL",
+      55 => "ENOANO",
+      56 => "EBADRQC",
+      57 => "EBADSLT",
+      59 => "EBFONT",
+      60 => "ENOSTR",
+      61 => "ENODATA",
+      62 => "ETIME",
+      63 => "ENOSR",
+      64 => "ENONET",
+      65 => "ENOPKG",
+      66 => "EREMOTE",
+      67 => "ENOLINK",
+      68 => "EADV",
+      69 => "ESRMNT",
+      70 => "ECOMM",
+      71 => "EPROTO",
+      72 => "EMULTIHOP",
+      73 => "EDOTDOT",
+      74 => "EBADMSG",
+      75 => "EOVERFLOW",
+      76 => "ENOTUNIQ",
+      77 => "EBADFD",
+      78 => "EREMCHG",
+      79 => "ELIBACC",
+      80 => "ELIBBAD",
+      81 => "ELIBSCN",
+      82 => "ELIBMAX",
+      83 => "ELIBEXEC",
+      84 => "EILSEQ",
+      85 => "ERESTART",
+      86 => "ESTRPIPE",
+      87 => "EUSERS",
+      88 => "ENOTSOCK",
+      89 => "EDESTADDRREQ",
+      90 => "EMSGSIZE",
+      91 => "EPROTOTYPE",
+      92 => "ENOPROTOOPT",
+      93 => "EPROTONOSUPPORT",
+      94 => "ESOCKTNOSUPPORT",
+      95 => "EOPNOTSUPP",
+      96 => "EPFNOSUPPORT",
+      97 => "EAFNOSUPPORT",
+      98 => "EADDRINUSE",
+      99 => "EADDRNOTAVAIL",
+      100 => "ENETDOWN",
+      101 => "ENETUNREACH",
+      102 => "ENETRESET",
+      103 => "ECONNABORTED",
+      104 => "ECONNRESET",
+      105 => "ENOBUFS",
+      106 => "EISCONN",
+      107 => "ENOTCONN",
+      108 => "ESHUTDOWN",
+      109 => "ETOOMANYREFS",
+      110 => "ETIMEDOUT",
+      111 => "ECONNREFUSED",
+      112 => "EHOSTDOWN",
+      113 => "EHOSTUNREACH",
+      114 => "EALREADY",
+      115 => "EINPROGRESS",
+      116 => "ESTALE",
+      117 => "EUCLEAN",
+      118 => "ENOTNAM",
+      119 => "ENAVAIL",
+      120 => "EISNAM",
+      121 => "EREMOTEIO",
+      122 => "EDQUOT",
+      123 => "ENOMEDIUM",
+      124 => "EMEDIUMTYPE",
+      125 => "ECANCELED",
+      126 => "ENOKEY",
+      127 => "EKEYEXPIRED",
+      128 => "EKEYREVOKED",
+      129 => "EKEYREJECTED",
+      130 => "EOWNERDEAD",
+      131 => "ENOTRECOVERABLE"
+    }
+
+    class Termios < FFI::Struct
+      layout  :c_iflag, :uint,
+              :c_oflag, :uint,
+              :c_cflag, :uint,
+              :c_lflag, :uint,
+              :c_line, :uchar,
+              :cc_c, [ :uchar, NCCS ],
+              :c_ispeed, :uint,
+              :c_ospeed, :uint
+    end
+
+    attach_function :ioctl, [ :int, :ulong, RubySerial::Posix::Termios], :int
+    attach_function :tcsetattr, [ :int, :int, RubySerial::Posix::Termios ], :int
+    attach_function :fcntl, [:int, :int, :varargs], :int
+    attach_function :open, [:pointer, :int], :int
+    attach_function :close, [:int], :int
+    attach_function :write, [:int, :pointer,  :int],:int
+    attach_function :read, [:int, :pointer,  :int],:int
+  end
+end

data/lib/rubyserial/osx_constants.rb

@@ -0,0 +1,181 @@
+require 'ffi'
+
+module RubySerial
+  module Posix
+  extend FFI::Library
+    ffi_lib FFI::Library::LIBC
+
+    O_RDWR = 0x0002
+    O_NOCTTY = 0x20000
+    O_NONBLOCK = 0x0004
+    F_GETFL = 3
+    F_SETFL = 4
+    IGNPAR = 0x00000004
+    VMIN = 16
+    VTIME = 17
+    CLOCAL = 0x00008000
+    CREAD = 0x00000800
+    TCSANOW = 0
+    NCCS = 20
+
+    DATA_BITS = {
+      5 => 0x00000000,
+      6 => 0x00000100,
+      7 => 0x00000200,
+      8 => 0x00000300
+    }
+
+    BAUDE_RATES = {
+      0 => 0,
+      50 => 50,
+      75 => 75,
+      110 => 110,
+      134 => 134,
+      150 => 150,
+      200 => 200,
+      300 => 300,
+      600 => 600,
+      1200 => 1200,
+      1800 => 1800,
+      2400 => 2400,
+      4800 => 4800,
+      9600 => 9600,
+      19200 => 19200,
+      38400 => 38400,
+      7200 =>  7200,
+      14400 => 14400,
+      28800 => 28800,
+      57600 => 57600,
+      76800 => 76800,
+      115200 => 115200,
+      230400 => 230400
+    }
+
+    ERROR_CODES = {
+      1 => "EPERM",
+      2 => "ENOENT",
+      3 => "ESRCH",
+      4 => "EINTR",
+      5 => "EIO",
+      6 => "ENXIO",
+      7 => "E2BIG",
+      8 => "ENOEXEC",
+      9 => "EBADF",
+      10 => "ECHILD",
+      11 => "EDEADLK",
+      12 => "ENOMEM",
+      13 => "EACCES",
+      14 => "EFAULT",
+      15 => "ENOTBLK",
+      16 => "EBUSY",
+      17 => "EEXIST",
+      18 => "EXDEV",
+      19 => "ENODEV",
+      20 => "ENOTDIR",
+      21 => "EISDIR",
+      22 => "EINVAL",
+      23 => "ENFILE",
+      24 => "EMFILE",
+      25 => "ENOTTY",
+      26 => "ETXTBSY",
+      27 => "EFBIG",
+      28 => "ENOSPC",
+      29 => "ESPIPE",
+      30 => "EROFS",
+      31 => "EMLINK",
+      32 => "EPIPE",
+      33 => "EDOM",
+      34 => "ERANGE",
+      35 => "EAGAIN",
+      36 => "EINPROGRESS",
+      37 => "EALREADY",
+      38 => "ENOTSOCK",
+      39 => "EDESTADDRREQ",
+      40 => "EMSGSIZE",
+      41 => "EPROTOTYPE",
+      42 => "ENOPROTOOPT",
+      43 => "EPROTONOSUPPORT",
+      44 => "ESOCKTNOSUPPORT",
+      45 => "ENOTSUP",
+      46 => "EPFNOSUPPORT",
+      47 => "EAFNOSUPPORT",
+      48 => "EADDRINUSE",
+      49 => "EADDRNOTAVAIL",
+      50 => "ENETDOWN",
+      51 => "ENETUNREACH",
+      52 => "ENETRESET",
+      53 => "ECONNABORTED",
+      54 => "ECONNRESET",
+      55 => "ENOBUFS",
+      56 => "EISCONN",
+      57 => "ENOTCONN",
+      58 => "ESHUTDOWN",
+      59 => "ETOOMANYREFS",
+      60 => "ETIMEDOUT",
+      61 => "ECONNREFUSED",
+      62 => "ELOOP",
+      63 => "ENAMETOOLONG",
+      64 => "EHOSTDOWN",
+      65 => "EHOSTUNREACH",
+      66 => "ENOTEMPTY",
+      67 => "EPROCLIM",
+      68 => "EUSERS",
+      69 => "EDQUOT",
+      70 => "ESTALE",
+      71 => "EREMOTE",
+      72 => "EBADRPC",
+      73 => "ERPCMISMATCH",
+      74 => "EPROGUNAVAIL",
+      75 => "EPROGMISMATCH",
+      76 => "EPROCUNAVAIL",
+      77 => "ENOLCK",
+      78 => "ENOSYS",
+      79 => "EFTYPE",
+      80 => "EAUTH",
+      81 => "ENEEDAUTH",
+      82 => "EPWROFF",
+      83 => "EDEVERR",
+      84 => "EOVERFLOW",
+      85 => "EBADEXEC",
+      86 => "EBADARCH",
+      87 => "ESHLIBVERS",
+      88 => "EBADMACHO",
+      89 => "ECANCELED",
+      90 => "EIDRM",
+      91 => "ENOMSG",
+      92 => "EILSEQ",
+      93 => "ENOATTR",
+      94 => "EBADMSG",
+      95 => "EMULTIHOP",
+      96 => "ENODATA",
+      97 => "ENOLINK",
+      98 => "ENOSR",
+      99 => "ENOSTR",
+      100 => "EPROTO",
+      101 => "ETIME",
+      102 => "EOPNOTSUPP",
+      103 => "ENOPOLICY",
+      104 => "ENOTRECOVERABLE",
+      105 => "EOWNERDEAD",
+      106 => "ELAST"
+    }
+
+    class Termios < FFI::Struct
+      layout  :c_iflag, :ulong,
+              :c_oflag, :ulong,
+              :c_cflag, :ulong,
+              :c_lflag, :ulong,
+              :c_line, :uchar,
+              :cc_c, [ :uchar, NCCS ],
+              :c_ispeed, :ulong,
+              :c_ospeed, :ulong
+    end
+
+    attach_function :tcsetattr, [ :int, :int, RubySerial::Posix::Termios ], :int
+    attach_function :fcntl, [:int, :int, :varargs], :int
+    attach_function :open, [:pointer, :int], :int
+    attach_function :close, [:int], :int
+    attach_function :write, [:int, :pointer,  :int],:int
+    attach_function :read, [:int, :pointer,  :int],:int
+  end
+end