em-printer-serialport 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e7d4117aab80956fbcf052f106f73efadf9253e6
+  data.tar.gz: 0cc74bb214d9604438c016bbbd497aef89e5a510
+SHA512:
+  metadata.gz: 6b543f80d9b007129eeaae79705c2e5d577ffd28cdd2a5c1a89761427f805a94cda7dd3952521fba5bc52823aaf392a5803c3d287f27e22ae40672897d46d8f5
+  data.tar.gz: 21f793d53534ea80f210535b77ed236075c9af4f343132aeea1a50056be462306972c2fec07d29d2faa2e0677c27c0cdc48bd12bf1aca19ea4fab9db6ad832d1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/bin/serial-monitor

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+require 'em-printer-serialport'
+
+EM.run do
+  if ARGV.size < 1
+    STDERR.print "Usage: #{$0} /dev/tty.usbserial-ABCDEFGH\n"
+    exit(1)
+  end
+
+  serial = EventMachine.open_serial(ARGV[0], 9600, 8, 1, SerialPort::NONE)
+  serial.on_data do |data|
+    puts 'received: ' + data.to_s
+  end
+
+  Thread.new do
+    while TRUE do
+      serial.send_data STDIN.gets.chomp
+    end
+  end
+
+  puts 'Serial monitor initialized. Enter data followed by a newline character.'
+  puts 'Ctrl-C to stop'
+end

data/em-printer-serialport.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'em-printer-serialport/version'
+
+Gem::Specification.new do |gem|
+  gem.name        = 'em-printer-serialport'
+  gem.version     = Em::Serialport::VERSION
+  gem.authors     = ['Anup Narkhede', 'Kaz Walker']
+  gem.email       = ['kaz@printtopeer.com']
+  gem.summary     = %q{EventMachine compatible serialport library}
+  gem.description = %q{}
+  gem.homepage    = 'https://github.com/PrintToPeer/em-printer-serialport'
+  gem.license = 'GPLv3'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'eventmachine', '~> 1.0.0'
+  gem.add_dependency 'serialport'
+  gem.add_development_dependency 'bundler', '~> 1.3.0'
+  gem.add_development_dependency 'rake', '~> 10.1.0'
+  gem.add_development_dependency 'rspec', '~> 2.14.0'
+end

data/lib/em-printer-serialport.rb

@@ -0,0 +1,7 @@
+$eventmachine_library = :pure_ruby
+require 'em/pure_ruby'
+require 'serialport'
+
+%w(serial_port connection).each do |file|
+  require "em-printer-serialport/#{file}"
+end

data/lib/em-printer-serialport/connection.rb

@@ -0,0 +1,19 @@
+module EventMachine
+  class Connection
+    def on_data(&blk)
+      @on_data = blk
+    end
+
+    def trigger_on_data(data)
+      @on_data.call(data) if @on_data
+    end
+
+    def receive_data data
+      trigger_on_data(data)
+    end
+
+    def associate_callback_target(sig)
+      return(nil)
+    end
+  end
+end

data/lib/em-printer-serialport/serial_port.rb

@@ -0,0 +1,31 @@
+module EventMachine
+  class << self
+    def connect_serial(dev, baud, databits, stopbits, parity)
+      SerialPort.open(dev, baud, databits, stopbits, parity).uuid
+    end
+
+    def open_serial(dev, baud, databits, stopbits, parity, handler=nil)
+      klass = if(handler and handler.is_a?(Class))
+        handler
+      else
+        Class.new(Connection) {handler and include handler}
+      end
+      uuid          = connect_serial(dev, baud, databits, stopbits, parity)
+      connection    = klass.new uuid
+      @conns[uuid]  = connection
+      block_given? and yield connection
+      connection
+    end
+  end
+
+  class SerialPort < StreamObject
+    def self.open(dev, baud, databits, stopbits, parity)
+      io = ::SerialPort.new(dev, baud, databits, stopbits, parity)
+      self.new(io)
+    end
+
+    def initialize(io)
+      super
+    end
+  end
+end

data/lib/em-printer-serialport/version.rb

@@ -0,0 +1,5 @@
+module Em
+  module Serialport
+    VERSION = '0.1.0'
+  end
+end

data/readme.md

@@ -0,0 +1,39 @@
+# em-printer-serialport
+
+Eventmachine compatible asynchronous, ruby-serialport library. A fork of em-serialport that is maintained by PrintToPeer.
+
+## Installation
+
+    gem install em-printer-serialport
+
+## Usage
+
+If you are on Mac, you need to set up a virtual USB serial port by installing a driver from [http://www.ftdichip.com/Drivers/VCP.htm](http://www.ftdichip.com/Drivers/VCP.htm). Identify your serial port device. For ex: /dev/tty.usbserial-xxxxxxxx
+
+    EM.run do
+      serial = EventMachine.open_serial('/dev/tty.usbserial-xxxxxxxx', 9600, 8, 1, 0)
+      serial.send_data 'foo'
+
+      serial.on_data do |data|
+        # do something with data
+      end
+    end
+
+## Serial Monitor
+
+The gem comes with a simple command line Serial Monitor. Launch it as:
+
+    bundle exec serial-monitor /dev/tty.usbserial-xxxxxxxx
+
+Here is a working example, tested with [arduino echo server](https://github.com/railsbob/arduino-examples/tree/master/echo_server). It simply reads and writes data to serial port from command line.
+
+    Serial monitor initialized. Enter data followed by a newline character.
+    Ctrl-C to stop
+    hello
+    received: hello
+    A very long sentence
+    received: A v
+    received: ery long
+    received:  sentence
+
+    

data/spec/echo_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+# Tested with arduino echo server on USB serial port driver
+describe 'Echo server test' do
+  it 'should send and receive data over serial port' do
+    @data = nil
+    serial_device = '/dev/tty.usbserial-A100QDRR'
+
+    EM.run do
+      serial = EventMachine.open_serial(serial_device, 9600, 8, 1, SerialPort::NONE)
+      serial.send_data 'an'
+
+      serial.on_data do |data|
+        data.should == 'an'
+        EM.stop
+      end
+    end
+  end
+end

data/spec/em_serialport_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe 'EM::Serialport' do
+  it 'should use pure_ruby as library_type' do
+    EventMachine.library_type.should eql(:pure_ruby)
+  end
+
+  it 'should load dependencies' do
+    defined?(EventMachine::StreamObject).should eql('constant')
+    defined?(SerialPort).should eql('constant')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'em-printer-serialport'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: em-printer-serialport
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anup Narkhede
+- Kaz Walker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: serialport
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+description: ''
+email:
+- kaz@printtopeer.com
+executables:
+- serial-monitor
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- bin/serial-monitor
+- em-printer-serialport.gemspec
+- lib/em-printer-serialport.rb
+- lib/em-printer-serialport/connection.rb
+- lib/em-printer-serialport/serial_port.rb
+- lib/em-printer-serialport/version.rb
+- readme.md
+- spec/echo_spec.rb
+- spec/em_serialport_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/PrintToPeer/em-printer-serialport
+licenses:
+- GPLv3
+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.0.7
+signing_key: 
+specification_version: 4
+summary: EventMachine compatible serialport library
+test_files:
+- spec/echo_spec.rb
+- spec/em_serialport_spec.rb
+- spec/spec_helper.rb
+has_rdoc: