uart 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 420b84bb7b98fbb48d2903cb131a786de7abf2fa59701508caa2af31eb2bc84a
+  data.tar.gz: 0dc729e9d484f02989030f1439443482aae3ef20cfa3c75837cc1d5bf704d1a6
+SHA512:
+  metadata.gz: 981faa3038d236252babca6e52b0c99c2aebcc1b9b19e5bae521f8498688b3e031eda492b34be2df3747469b328cccf1f90ff5340a82ee5fdc1ba7038adde4a3
+  data.tar.gz: c34504e3892300e0a8489ccd9ca83e9aa4c8a9e2b656f9c614560f6e07be3e4ad715f956009cb8e4c69f56d96c769bffbf7006284125b0a9b51522810fa98010

data/Manifest.txt

@@ -0,0 +1,5 @@
+Manifest.txt
+README.md
+Rakefile
+lib/uart.rb
+test/test_uart.rb

data/README.md

@@ -0,0 +1,65 @@
+# UART
+
+* https://github.com/tenderlove/uart
+
+## DESCRIPTION:
+
+UART is a simple wrapper around the ruby-termios gem that gives you an easy
+interface for setting up a UART or serial connection.  This gem is written in
+pure Ruby.  This gem relies on ruby-termios to provide bindings to the termios
+system call, but uses those bindings to set up a serial connection in pure Ruby.
+
+## FEATURES/PROBLEMS:
+
+* No C code
+* No FFI code
+* Seems to work
+
+## SYNOPSIS:
+
+Here is an example of writing to an LCD screen over UART.  The speed is 9600,
+8 data bits, no parity, and one stop bit:
+
+```ruby
+require 'uart'
+
+UART.open '/dev/tty.usbserial-00000000' do |serial|
+  str = 'Hello World!'
+  serial.write [0x8A, 0xA8, 0x00, 0x00, str.bytesize].pack 'C5'
+  serial.write str.b
+  p serial.read(4).unpack('C4').map { |x| x.to_s(16) }
+end
+```
+
+## REQUIREMENTS:
+
+* ruby-termios
+
+## INSTALL:
+
+* `gem install uart`
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2018 Aaron Patterson
+
+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/Rakefile

@@ -0,0 +1,17 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :minitest
+Hoe.plugin :gemspec # `gem install hoe-gemspec`
+Hoe.plugin :git     # `gem install hoe-git`
+
+Hoe.spec 'uart' do
+  developer('Aaron Patterson', 'tenderlove@ruby-lang.org')
+  self.readme_file   = 'README.md'
+  self.extra_rdoc_files  = FileList['*.md']
+  self.extra_deps << ['ruby-termios']
+end
+
+# vim: syntax=ruby

data/lib/uart.rb

@@ -0,0 +1,121 @@
+require 'termios'
+require 'fcntl'
+
+module UART
+  VERSION = '1.0.0'
+
+  ##
+  # Open a UART as a file.
+  #
+  # For example, we have a serial connection on `/dev/tty.usbserial-00000000'.
+  # It's speed is 9600, 8 data bits, 1 stop bit, and no parity:
+  #
+  #   serial = UART.open '/dev/tty.usbserial-00000000', 9600, '8N1'
+  #   serial.write 'whatever'
+  #
+  # A speed of 9600, 8 data bits, no parity, and 1 stop bit is default, so
+  # we can reduce the code to this:
+  #
+  #   serial = UART.open '/dev/tty.usbserial-00000000'
+  #   serial.write 'whatever'
+  #
+  # Finally, we can give a block and the file will be automatically closed for
+  # us like this:
+  #
+  #   UART.open '/dev/tty.usbserial-00000000' do |serial|
+  #     serial.write 'whatever'
+  #   end
+  def open filename, speed = 9600, mode = '8N1'
+    f = File.open filename, File::RDWR|Fcntl::O_NOCTTY|Fcntl::O_NDELAY
+    f.binmode
+    f.sync = true
+
+    # enable blocking reads, otherwise read timeout won't work
+    f.fcntl Fcntl::F_SETFL, f.fcntl(Fcntl::F_GETFL, 0) & ~Fcntl::O_NONBLOCK
+
+    t = Termios.tcgetattr f
+    t.iflag = 0
+    t.oflag = 0
+    t.lflag = 0
+
+    if mode =~ /^(\d)(\w)(\d)$/
+      t = data_bits    t, $1.to_i
+      t = stop_bits    t, $3.to_i
+      t = parity       t, { 'N' => :none, 'E' => :even, 'O' => :odd }[$2]
+      t = speed        t, speed
+      t = read_timeout t, 5
+      t = reading      t
+    else
+      raise ArgumentError, "Invalid format for mode"
+    end
+
+    Termios.tcsetattr f, Termios::TCSANOW, t
+    Termios.tcflush f, Termios::TCIOFLUSH
+
+    if block_given?
+      begin
+        yield f
+      ensure
+        f.close
+      end
+    else
+      f
+    end
+  end
+  module_function :open
+
+  def data_bits t, val
+    t.cflag &= ~Termios::CSIZE               # clear previous values
+    t.cflag |= Termios.const_get("CS#{val}") # Set the data bits
+    t
+  end
+  module_function :data_bits
+
+  def stop_bits t, val
+    case val
+    when 1 then t.cflag &= ~Termios::CSTOPB
+    when 2 then t.cflag |= Termios::CSTOPB
+    else
+      raise
+    end
+    t
+  end
+  module_function :stop_bits
+
+  def parity t, val
+    case val
+    when :none
+      t.cflag &= ~Termios::PARENB
+    when :even
+      t.cflag |= Termios::PARENB  # Enable parity
+      t.cflag &= ~Termios::PARODD # Make it not odd
+    when :odd
+      t.cflag |= Termios::PARENB  # Enable parity
+      t.cflag |= Termios::PARODD  # Make it odd
+    else
+      raise
+    end
+    t
+  end
+  module_function :parity
+
+  def speed t, speed
+    t.ispeed = Termios.const_get("B#{speed}")
+    t.ospeed = Termios.const_get("B#{speed}")
+    t
+  end
+  module_function :speed
+
+  def read_timeout t, val
+    t.cc[Termios::VTIME] = val
+    t.cc[Termios::VMIN] = 0
+    t
+  end
+  module_function :read_timeout
+
+  def reading t
+    t.cflag |= Termios::CLOCAL | Termios::CREAD
+    t
+  end
+  module_function :reading
+end

data/test/test_uart.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+require 'uart'
+
+class TestUart < MiniTest::Test
+  def test_sanity
+    assert "lol, I need to figure out a good way to make a fake serial port"
+    assert "but I don't want to use mocks"
+    assert "I think there is a way to do that without mocks"
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: uart
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Aaron Patterson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-termios
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+description: |-
+  UART is a simple wrapper around the ruby-termios gem that gives you an easy
+  interface for setting up a UART or serial connection.  This gem is written in
+  pure Ruby.  This gem relies on ruby-termios to provide bindings to the termios
+  system call, but uses those bindings to set up a serial connection in pure Ruby.
+email:
+- tenderlove@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files:
+- Manifest.txt
+- README.md
+files:
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/uart.rb
+- test/test_uart.rb
+homepage: https://github.com/tenderlove/uart
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: UART is a simple wrapper around the ruby-termios gem that gives you an easy
+  interface for setting up a UART or serial connection
+test_files: []