ccutrer-serialport 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5883d7fba69f81de31f8f8d2a21f25e1734fb25adce3a3ec9f873a67c9e96b43
+  data.tar.gz: 780c226269254d5d413445159cdd8a3603d5e835c315eb00cc9c50557d1b1fbf
+SHA512:
+  metadata.gz: 27f8bb29ca45fff55a30b0825dc1087f74259de5a81bb1a6671f90c95a52bf4e832f21ca40c79e84e1e486d5da362199d631a90134df34e09ce4b2162721acdc
+  data.tar.gz: '08619960bba97f86e4752a14587b3b9d2a9b68723a76e681d7afe1e6f1f72a490c7cc23c9d43fc0155cc582db2e98e1323be9fcff23c45ce17a4d33dad711d1b'

data/.gitignore

@@ -0,0 +1,2 @@
+/pkg
+/socat.log

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,11 @@
+sudo: false
+language: ruby
+addons:
+  apt:
+    packages:
+      - socat
+rvm:
+  - 2.7
+  - 2.6
+script:
+  - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    ccutrer-serialport (1.0.0)
+      ffi (~> 1.9, >= 1.9.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    ffi (1.13.1)
+    rake (13.0.1)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ccutrer-serialport!
+  rake (~> 13.0)
+  rspec (~> 3.0.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Cody Cutrer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# ccutrer-serialport
+
+SerialPort is a simple Ruby gem for interacting with serial ports.
+
+It does not require an extension thanks to using [FFI](https://github.com/ffi/ffi).
+
+SerialPort objects inherit from `File` (and thus `IO`), so are compatible with all
+IO methods, in particular `read_partial`, and asynchronous IO.
+
+It was inspired by the [rubyserial](https://github.com/hybridgroup/rubyserial) gem.
+
+## Usage
+
+```ruby
+require 'ccutrer-rubyserial'
+serialport = CCutrer::SerialPort.new '/dev/ttyACM0' # Defaults to 9600 baud, 8 data bits, and no parity
+serialport = CCutrer::SerialPort.new '/dev/ttyACM0', baud: 57600
+serialport = CCutrer::SerialPort.new '/dev/ttyACM0', baud: 19200, data_bits: 8, parity: :even
+
+serialport.read(4096)
+serialport.gets
+
+require 'io/wait'
+serialport.ready?
+serialport.wait_readable(1)
+```
+
+## Running the tests
+
+The test suite is written using rspec, just use the `rspec` command.
+
+### Test dependencies
+
+To run the tests, you must also have `socat` installed.
+
+## License
+
+MIT. See `LICENSE` for more details.

data/Rakefile

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

data/ccutrer-serialport.gemspec

@@ -0,0 +1,24 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "ccutrer/serial_port/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ccutrer-serialport"
+  s.version     = CCutrer::SerialPort::VERSION
+  s.summary     = "Linux/OS X RS-232 serial port communication"
+  s.description = "Ruby only library that relies on FFI instead of an extension, and inherits from IO"
+  s.homepage    = "https://github.com/ccutrer/ccutrer-serialport"
+  s.authors     = ["Cody Cutrer"]
+  s.platform    = Gem::Platform::RUBY
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'ffi', '~> 1.9', '>= 1.9.3'
+
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rspec', '~> 3.0.0'
+end

data/lib/ccutrer-serialport.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2014-2016 The Hybrid Group, 2020 Cody Cutrer
+
+require 'rbconfig'
+require 'ffi'
+
+module CCutrer
+  class SerialPort < File
+    ON_WINDOWS = RbConfig::CONFIG['host_os'] =~ /mswin|windows|mingw/i
+    ON_LINUX = RbConfig::CONFIG['host_os'] =~ /linux/i
+
+    if ON_WINDOWS
+      raise "rubyserial is not currently supported on windows"
+    elsif ON_LINUX
+      require 'ccutrer/serial_port/linux'
+    else
+      require 'ccutrer/serial_port/osx'
+    end
+  end
+end
+
+require 'ccutrer/serial_port'
+require 'ccutrer/serial_port/version'

data/lib/ccutrer/serial_port.rb

@@ -0,0 +1,45 @@
+# Copyright (c) 2014-2016 The Hybrid Group, 2020 Cody Cutrer
+
+require 'fcntl'
+
+class CCutrer::SerialPort < File
+  def initialize(address, baud: 9600, data_bits: 8, parity: :none, stop_bits: 1)
+    super(address, IO::RDWR | IO::NOCTTY | IO::NONBLOCK)
+
+    raise IOError, "Not a serial port" unless tty?
+
+    fl = fcntl(Fcntl::F_GETFL, 0)
+    fcntl(Fcntl::F_SETFL, ~Fcntl::O_NONBLOCK & fl)
+
+    @config = build_config(baud, data_bits, parity, stop_bits)
+
+    err = Posix.tcsetattr(fileno, Posix::TCSANOW, @config)
+    if err == -1
+      raise SystemCallError, FFI.errno
+    end
+  end
+
+  private
+
+  def build_config(baud_rate, data_bits, parity, stop_bits)
+    config = Posix::Termios.new
+
+    config[:c_iflag]  = Posix::IGNPAR
+    config[:c_ispeed] = Posix::BAUD_RATES[baud_rate]
+    config[:c_ospeed] = Posix::BAUD_RATES[baud_rate]
+    config[:c_cflag]  = Posix::DATA_BITS[data_bits] |
+      Posix::CREAD |
+      Posix::CLOCAL |
+      Posix::PARITY[parity] |
+      Posix::STOPBITS[stop_bits]
+
+    # Masking in baud rate on OS X would corrupt the settings.
+    if ON_LINUX
+      config[:c_cflag] = config[:c_cflag] | Posix::BAUD_RATES[baud_rate]
+    end
+
+    config[:cc_c][Posix::VMIN] = 0
+
+    config
+  end
+end

data/lib/ccutrer/serial_port/linux.rb

@@ -0,0 +1,84 @@
+# Copyright (c) 2014-2016 The Hybrid Group, 2020 Cody Cutrer
+
+module CCutrer::SerialPort::Posix
+  extend FFI::Library
+  ffi_lib FFI::Library::LIBC
+
+  VTIME = 5
+  TCSANOW = 0
+  TCSETS = 0x5402
+  IGNPAR = 0000004
+  PARENB = 0000400
+  PARODD = 0001000
+  CSTOPB = 0000100
+  CREAD  = 0000200
+  CLOCAL = 0004000
+  VMIN = 6
+  NCCS = 32
+
+  DATA_BITS = {
+    5 => 0000000,
+    6 => 0000020,
+    7 => 0000040,
+    8 => 0000060
+  }
+
+  BAUD_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
+  }
+
+  PARITY = {
+    :none => 0000000,
+    :even => PARENB,
+    :odd => PARENB | PARODD,
+  }
+
+  STOPBITS = {
+    1 => 0x00000000,
+    2 => CSTOPB
+  }
+
+  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 :tcsetattr, [ :int, :int, Termios ], :int, blocking: true
+  attach_function :tcgetattr, [ :int, Termios ], :int, blocking: true
+end

data/lib/ccutrer/serial_port/osx.rb

@@ -0,0 +1,76 @@
+# Copyright (c) 2014-2016 The Hybrid Group, 2020 Cody Cutrer
+
+module CCutrer::SerialPort::Posix
+  extend FFI::Library
+  ffi_lib FFI::Library::LIBC
+
+  IGNPAR = 0x00000004
+  PARENB = 0x00001000
+  PARODD = 0x00002000
+  VMIN = 16
+  VTIME = 17
+  CLOCAL = 0x00008000
+  CSTOPB = 0x00000400
+  CREAD  = 0x00000800
+  CCTS_OFLOW = 0x00010000 # Clearing this disables RTS AND CTS.
+  TCSANOW = 0
+  NCCS = 20
+
+  DATA_BITS = {
+    5 => 0x00000000,
+    6 => 0x00000100,
+    7 => 0x00000200,
+    8 => 0x00000300
+  }
+
+  BAUD_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
+  }
+
+  PARITY = {
+    :none => 0x00000000,
+    :even => PARENB,
+    :odd => PARENB | PARODD,
+  }
+
+  STOPBITS = {
+    1 => 0x00000000,
+    2 => CSTOPB
+  }
+
+  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, Termios ], :int, blocking: true
+  attach_function :tcgetattr, [ :int, Termios ], :int, blocking: true
+end

data/lib/ccutrer/serial_port/version.rb

@@ -0,0 +1,7 @@
+# Copyright (c) 2014-2018 The Hybrid Group and Friends
+
+module CCutrer
+  class SerialPort < File
+    VERSION = "1.0.0"
+  end
+end

data/spec/serialport_spec.rb

@@ -0,0 +1,177 @@
+require 'ccutrer-serialport'
+
+describe CCutrer::SerialPort do
+  before do
+    @ports = []
+    File.delete('socat.log') if File.file?('socat.log')
+
+    raise 'socat not found' unless (`socat -h` && $? == 0)
+
+    Thread.new do
+      system('socat -lf socat.log -d -d pty,raw,echo=0 pty,raw,echo=0')
+    end
+
+    @ptys = nil
+
+    loop do
+      if File.file? 'socat.log'
+        @file = File.open('socat.log', "r")
+        @fileread = @file.read
+
+        unless @fileread.count("\n") < 3
+          @ptys = @fileread.scan(/PTY is (.*)/)
+          break
+        end
+      end
+    end
+
+    @ports = [@ptys[1][0], @ptys[0][0]]
+
+    @sp2 = CCutrer::SerialPort.new(@ports[0])
+    @sp = CCutrer::SerialPort.new(@ports[1])
+  end
+
+  after do
+   @sp2.close
+   @sp.close
+  end
+
+  it "should read and write" do
+    @sp2.write('hello')
+    # small delay so it can write to the other port.
+    sleep 0.1
+    check = @sp.read(5)
+    expect(check).to eql('hello')
+  end
+
+  it "should convert ints to strings" do
+    expect(@sp2.write(123)).to eql(3)
+    sleep 0.1
+    expect(@sp.read(3)).to eql('123')
+  end
+
+  it "write should return bytes written" do
+    expect(@sp2.write('hello')).to eql(5)
+  end
+
+  it "reading nothing should be blank" do
+    expect(@sp.read(5)).to be_nil
+  end
+
+  it "should give me nil on getbyte" do
+    expect(@sp.getbyte).to be_nil
+  end
+
+  it 'should give me a zero byte from getbyte' do
+    @sp2.write("\x00")
+    sleep 0.1
+    expect(@sp.getbyte).to eql(0)
+  end
+
+  it "should give me bytes" do
+    @sp2.write('hello')
+    # small delay so it can write to the other port.
+    sleep 0.1
+    check = @sp.getbyte
+    expect([check].pack('C')).to eql('h')
+  end
+
+  describe "giving me lines" do
+    it "should give me a line" do
+      @sp.write("no yes \n hello")
+      sleep 0.1
+      expect(@sp2.gets).to eql("no yes \n")
+    end
+
+    it "should give me a line with block" do
+      @sp.write("no yes \n hello")
+      sleep 0.1
+      result = ""
+      @sp2.each_line do |line|
+        result = line
+        break if !result.empty?
+      end
+      expect(result).to eql("no yes \n")
+    end
+
+    it "should accept a sep param" do
+      @sp.write('no yes END bleh')
+      sleep 0.1
+      expect(@sp2.gets('END')).to eql("no yes END")
+    end
+
+    it "should accept a limit param" do
+      @sp.write("no yes \n hello")
+      sleep 0.1
+      expect(@sp2.gets(4)).to eql("no y")
+    end
+
+    it "should accept limit and sep params" do
+      @sp.write("no yes END hello")
+      sleep 0.1
+      expect(@sp2.gets('END', 20)).to eql("no yes END")
+      @sp2.read(1000)
+      @sp.write("no yes END hello")
+      sleep 0.1
+      expect(@sp2.gets('END', 4)).to eql('no y')
+    end
+
+    it "should read a paragraph at a time" do
+      @sp.write("Something \n Something else \n\n and other stuff")
+      sleep 0.1
+      expect(@sp2.gets('')).to eql("Something \n Something else \n\n")
+    end
+  end
+
+  describe 'config' do
+    it 'should accept EVEN parity' do
+      @sp2.close
+      @sp.close
+      @sp2 = CCutrer::SerialPort.new(@ports[0], baud: 19200, data_bits: 8, parity: :even)
+      @sp = CCutrer::SerialPort.new(@ports[1], baud: 19200, data_bits: 8, parity: :even)
+      @sp.write("Hello!\n")
+      sleep 0.1
+      expect(@sp2.gets).to eql("Hello!\n")
+    end
+
+    it 'should accept ODD parity' do
+      @sp2.close
+      @sp.close
+      @sp2 = CCutrer::SerialPort.new(@ports[0], baud: 19200, data_bits: 8, parity: :odd)
+      @sp = CCutrer::SerialPort.new(@ports[1], baud: 19200, data_bits: 8, parity: :odd)
+      @sp.write("Hello!\n")
+      sleep 0.1
+      expect(@sp2.gets).to eql("Hello!\n")
+    end
+
+    it 'should accept 1 stop bit' do
+      @sp2.close
+      @sp.close
+      @sp2 = CCutrer::SerialPort.new(@ports[0], baud: 19200, data_bits: 8, parity: :none, stop_bits: 1)
+      @sp = CCutrer::SerialPort.new(@ports[1], baud: 19200, data_bits: 8, parity: :none, stop_bits: 1)
+      @sp.write("Hello!\n")
+      sleep 0.1
+      expect(@sp2.gets).to eql("Hello!\n")
+    end
+
+    it 'should accept 2 stop bits' do
+      @sp2.close
+      @sp.close
+      @sp2 = CCutrer::SerialPort.new(@ports[0], baud: 19200, data_bits: 8, parity: :none, stop_bits: 2)
+      @sp = CCutrer::SerialPort.new(@ports[1], baud: 19200, data_bits: 8, parity: :none, stop_bits: 2)
+      @sp.write("Hello!\n")
+      sleep 0.1
+      expect(@sp2.gets).to eql("Hello!\n")
+    end
+
+    it 'should set baud rate, check #46 fixed' do
+      @sp.close
+      rate = 600
+      @sp = CCutrer::SerialPort.new(@ports[1], baud: rate)
+      fd = @sp.fileno
+      termios = CCutrer::SerialPort::Posix::Termios.new
+      CCutrer::SerialPort::Posix.tcgetattr(fd, termios)
+      expect(termios[:c_ispeed]).to eql(CCutrer::SerialPort::Posix::BAUD_RATES[rate])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: ccutrer-serialport
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Cody Cutrer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Ruby only library that relies on FFI instead of an extension, and inherits
+  from IO
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- ccutrer-serialport.gemspec
+- lib/ccutrer-serialport.rb
+- lib/ccutrer/serial_port.rb
+- lib/ccutrer/serial_port/linux.rb
+- lib/ccutrer/serial_port/osx.rb
+- lib/ccutrer/serial_port/version.rb
+- spec/serialport_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ccutrer/ccutrer-serialport
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Linux/OS X RS-232 serial port communication
+test_files: []