lib_serial 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1adcd9b62946210edc66a311e87100786bd33af6
+  data.tar.gz: 6296ceba5addfc2d8a56aa0557e0e9e3e6938e0b
+SHA512:
+  metadata.gz: 36d4dd743db945b5d3168d9bfe577cca3fdaba702e9e9e0149f7c056f4c46e4cc90041182b7e6105db8c896c804cfe1c55c6526fd08370603b0bbbb7a5e8b441
+  data.tar.gz: 499d742b9b0f83878ad36186da1656b8cd4f11c8dc4e11675840d65496d75c80027a795521634d1d851cac695f90853f5298cdb70281880c15c4c430d4d87a5b

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lib_serial.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Dustin Ward
+
+MIT License
+
+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,34 @@
+# LibSerial
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lib_serial'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lib_serial
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/lib_serial/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+=======
+lib_serial
+==========
+
+Serial Port library for Linux/MacOS

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/lib_serial/driver.rb

@@ -0,0 +1,26 @@
+require 'lib_serial/drivers/linux'
+require 'lib_serial/drivers/mac_os'
+
+module LibSerial
+  module Drivers
+    def baud_rates
+      [110,150,300,600,1200,2400,4800,9600,19200,38400,57600,115200]
+    end
+
+    def parity
+      {
+        none:     '-parenb',
+        odd:      'parenb parodd',
+        even:     'parenb -parodd'
+      }
+    end
+
+    def flow_control
+      {
+        none:     'clocal -crtscts -ixon -ixoff',
+        rts_cts:  '-clocal crtscts -ixon -ixoff',
+        xon_xoff: '-clocal -crtscts ixon ixoff'
+      }
+    end
+  end
+end

data/lib/lib_serial/drivers/linux.rb

@@ -0,0 +1,64 @@
+module LibSerial
+  module Drivers
+    class Linux
+      attr_accessor :file_descriptor, :device
+
+      def initialize(device)
+        self.device = device
+        self.open
+        self.execute("stty -F #{self.device} raw")
+        self.set_baud_rate
+        self.set_parity
+        self.set_char_length
+        self.set_stop_bits
+        self.set_flow_control
+      end
+
+      def open
+        self.file_descriptor = File.open(self.device, 'r+')
+      end
+
+      def read
+        buffer = ''
+        buffer << self.file_descriptor.readchar
+        buffer
+      end
+
+      def write(data)
+        ret = self.file_descriptor.write(data)
+        self.file_descriptor.flush
+        ret
+      end
+
+      def close
+      end
+
+      def set_baud_rate(rate = 38400)
+        ## TODO: Check for valid baud rate
+        self.execute("stty -F #{self.device} #{rate.to_i}")
+      end
+
+      def set_parity(parity = :none)
+        ## TODO: Check for valid parity here
+        self.execute("stty -F #{self.device} #{LibSerial::Drivers.parity[parity]}")
+      end
+
+      def set_char_length(length = 8)
+        self.execute("stty -F #{self.device} cs#{length.to_i}")
+      end
+
+      def set_stop_bits(length = 1)
+        self.execute("stty -F #{self.device} #{(length == 1) ? '-' : ''}cstopb")
+      end
+
+      def set_flow_control(flow = :none)
+        self.execute("stty -F #{self.device} #{LibSerial::Drivers.flow_control[flow]}")
+      end
+
+      private
+      def execute(cmd)
+        system(cmd)
+      end
+    end
+  end
+end

data/lib/lib_serial/drivers/mac_os.rb

@@ -0,0 +1,64 @@
+module LibSerial
+  module Drivers
+    class MacOS
+      attr_accessor :file_descriptor, :device
+
+      def initialize(device)
+        self.device = device
+        self.open
+        self.execute("stty -f #{self.device} raw")
+        self.set_baud_rate
+        self.set_parity
+        self.set_char_length
+        self.set_stop_bits
+        self.set_flow_control
+      end
+
+      def open
+        self.file_descriptor = File.open(self.device, 'r+')
+      end
+
+      def read
+        buffer = ''
+        buffer << self.file_descriptor.readchar
+        buffer
+      end
+
+      def write(data)
+        ret = self.file_descriptor.write(data)
+        self.file_descriptor.flush
+        ret
+      end
+
+      def close
+      end
+
+      def set_baud_rate(rate = 38400)
+        ## TODO: Check for valid baud rate
+        self.execute("stty -f #{self.device} #{rate.to_i}")
+      end
+
+      def set_parity(parity = :none)
+        ## TODO: Check for valid parity here
+        self.execute("stty -f #{self.device} #{LibSerial::Drivers.parity[parity]}")
+      end
+
+      def set_char_length(length = 8)
+        self.execute("stty -f #{self.device} cs#{length.to_i}")
+      end
+
+      def set_stop_bits(length = 1)
+        self.execute("stty -f #{self.device} #{(length == 1) ? '-' : ''}cstopb")
+      end
+
+      def set_flow_control(flow = :none)
+        self.execute("stty -f #{self.device} #{LibSerial::Drivers.flow_control[flow]}")
+      end
+
+      private
+      def execute(cmd)
+        system(cmd)
+      end
+    end
+  end
+end

data/lib/lib_serial/serial_port.rb

@@ -0,0 +1,26 @@
+module LibSerial
+  class SerialPort
+    attr_accessor :driver
+
+    def initialize(device = '/dev/ttyAMA0', options = {})
+      if LibSerial.mac?
+        self.driver = LibSerial::Drivers::MacOS.new(device)
+      elsif LibSerial.linux? || LibSerial.unix?
+        self.driver = LibSerial::Drivers::Linux.new(device)
+      else
+        raise 'Invalid Platform'
+      end
+    end
+
+    def read
+      loop do
+        data = self.driver.read
+        yield data
+      end
+    end
+
+    def write(data)
+      self.driver.write(data)
+    end
+  end
+end

data/lib/lib_serial/version.rb

@@ -0,0 +1,3 @@
+module LibSerial
+  VERSION = '0.0.2'
+end

data/lib/lib_serial.rb

@@ -0,0 +1,21 @@
+require 'lib_serial/version'
+require 'lib_serial/driver'
+require 'lib_serial/serial_port'
+
+module LibSerial
+  def windows?
+    (/cygwin|mswin|mingw|bccwin|wince|emx/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def mac?
+    (/darwin/ =~ RUBY_PLATFORM) != nil
+  end
+
+  def unix?
+    !LibSerial.windows?
+  end
+
+  def linux?
+    LibSerial.unix? and not LibSerial.mac?
+  end
+end

data/lib_serial.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lib_serial/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lib_serial'
+  spec.version       = LibSerial::VERSION
+  spec.authors       = ['Dustin Ward']
+  spec.email         = ['dustin.n.ward@gmail.com']
+  spec.summary       = 'Linux/MacOS serial port gem'
+  spec.description   = 'Linux/MacOS serial port gem without native c code'
+  spec.homepage      = 'http://www.boxcar21.com'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: lib_serial
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Dustin Ward
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-14 00:00:00.000000000 Z
+dependencies: []
+description: Linux/MacOS serial port gem without native c code
+email:
+- dustin.n.ward@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/lib_serial.rb
+- lib/lib_serial/driver.rb
+- lib/lib_serial/drivers/linux.rb
+- lib/lib_serial/drivers/mac_os.rb
+- lib/lib_serial/serial_port.rb
+- lib/lib_serial/version.rb
+- lib_serial.gemspec
+homepage: http://www.boxcar21.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Linux/MacOS serial port gem
+test_files: []