kuro-rs 0.0.1

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.0.1 2011-10-31
+
+* newgem kuro-rs

data/Manifest.txt

@@ -0,0 +1,16 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/kuro-rs.rb
+lib/kuro-rs/main.rb
+script/console
+script/destroy
+script/generate
+spec/kuro-rs_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+tasks/rspec.rake
+examples/read.rb
+examples/write.rb
+bin/kuro-rs

data/README.rdoc

@@ -0,0 +1,60 @@
+= kuro-rs
+
+* http://github.com/shokai/ruby-kuro-rs
+
+== DESCRIPTION:
+
+control KURO-RS (http://www.kuroutoshikou.com/modules/display/?iid=928) and PC-OP-RS1 (http://buffalo.jp/products/catalog/item/p/pc-op-rs1/)
+
+== SYNOPSIS:
+
+
+  require 'rubygems'
+  require 'kuro-rs'
+  
+  # open KURO-RS
+  kr = KuroRs.open('/dev/tty.usbserial-0012a3b4')
+
+  # read
+  puts kr.read 
+  ## => hex dump (ffffffff0300f0e0018083...)
+
+  # write
+  kr.write 'ffffffff0300f0e0018083'
+
+  # close
+  kr.close
+
+
+== REQUIREMENTS:
+
+* KURO-RS or PC-OP-RS1
+
+== INSTALL:
+
+* gem install kuro-rs
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2011 Sho Hashimoto
+
+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,25 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/kuro-rs'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'kuro-rs' do
+  self.developer 'Sho Hashimoto', 'hashimoto@shokai.org'
+  self.rubyforge_name       = self.name # TODO this is default value
+  self.extra_deps         = [['serialport','>= 1.0.4']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/bin/kuro-rs

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'kuro-rs'
+
+if ARGV.size < 1
+  puts '!!Device Name and Hex String required'
+  puts 'read  -  kuro-rs /dev/tty.usbserial-0012a3b4'
+  puts 'write -  kuro-rs /dev/tty.usbserial-0012a3b4 ffffffff0300f0e0018083...'
+  exit 1
+end
+
+device_name = ARGV.shift
+hex_str = ARGV.shift
+
+begin
+  kr = KuroRs.open device_name
+rescue KuroRs::Error, StandardError => e
+  STDERR.puts e
+  exit 1
+end
+
+kr.verbose = true
+if hex_str.to_s.size > 0
+  kr.write hex_str  
+else
+  puts kr.read
+end
+

data/examples/read.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+#require 'kuro-rs'
+require File.dirname(__FILE__)+'/../lib/kuro-rs'
+
+if ARGV.size < 1
+  puts '!!Device Name required'
+  puts 'e.g.  ruby read.rb /dev/tty.usbserial-0012a3b4'
+  exit 1
+end
+
+device_name = ARGV.shift
+
+begin
+  kr = KuroRs.open device_name
+rescue KuroRs::Error, StandardError => e
+  STDERR.puts e
+  exit 1
+end
+
+kr.verbose = true
+puts kr.read ## => hex dump

data/examples/write.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+#require 'kuro-rs'
+require File.dirname(__FILE__)+'/../lib/kuro-rs'
+
+if ARGV.size < 2
+  puts '!!Device Name and Hex String required'
+  puts 'e.g.  ruby write.rb /dev/tty.usbserial-0012a3b4 ffffffff0300f0e0018083...'
+  exit 1
+end
+
+device_name = ARGV.shift
+hex_str = ARGV.shift
+
+begin
+  kr = KuroRs.open device_name
+rescue KuroRs::Error, StandardError => e
+  STDERR.puts e
+  exit 1
+end
+
+kr.verbose = true
+kr.write hex_str

data/lib/kuro-rs.rb

@@ -0,0 +1,14 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+gem 'serialport','>=1.0.4'
+require 'serialport'
+require 'timeout'
+
+Dir.glob(File.dirname(__FILE__)+'/kuro-rs/*.rb').each do |f|
+  require f
+end
+
+module KuroRs
+  VERSION = '0.0.1'
+end

data/lib/kuro-rs/main.rb

@@ -0,0 +1,107 @@
+module KuroRs
+  def KuroRs.open(device_name)
+    KuroRs.new(device_name)
+  end
+
+  class Error < Exception
+  end
+  
+  class KuroRs
+    attr_accessor :verbose
+
+    def busy? 
+      @busy
+    end
+
+    def serialport
+      @sp
+    end
+
+    def initialize(device_name)
+      @device_name = device_name
+      @verbose = false
+      @busy = false
+      if !File.exists? device_name.to_s
+        device_name = "nil" if device_name.to_s.size < 1
+        raise Error.new "device not found (#{device_name})"
+      end
+      @sp = SerialPort.new(device_name, 115200, 8, 1, 0)
+    end
+
+    def close
+      @sp.close
+    end
+    
+    def read
+      @busy = true
+      begin
+        ## request reading mode
+        @sp.write 'c'
+        @sp.write 'r'
+        puts 'read mode' if @verbose
+        raise Error.new 'response is not "Y"' unless @sp.getc.chr == 'Y'
+        timeout(30) do
+          while @sp.getc.chr != 'S' do end
+        end
+
+        ## read data
+        puts 'reading data..' if @verbose
+        data = (0...240).to_a.map{|i| @sp.getc} # read 240 Bytes
+        raise Error.new 'response is not "E"' unless @sp.getc.chr == 'E'
+      rescue Error, StandardError => e
+        @busy = false
+        raise Error.new e
+      rescue Timeout::Error
+        @busy = false
+        raise Error.new 'no response'
+      end
+      
+      ## hex dump
+      hex_str = data.map{|i|
+        h = i.to_s(16)
+        h = "0#{h}" if h.size < 2
+        h
+      }.join('')
+      @busy = false
+      return hex_str
+    end
+    
+    def write(hex_str)
+      @busy = true
+      ## request writing mode
+      begin
+        @sp.write 'c'
+        @sp.write 't'
+        raise Error.new 'response is not "Y"' unless @sp.getc.chr == 'Y'
+        @sp.write '1'
+        raise Error.new 'response is not "Y"' unless @sp.getc.chr == 'Y'
+      rescue Error, StandardError => e
+        @busy = false
+        raise Error.new e
+      end
+
+      ## write hex string
+      cmd_arr = []
+      arr = hex_str.split('')
+      loop do
+        s = arr.shift + arr.shift
+        cmd_arr << s.hex
+        break if arr.empty?
+      end
+      
+      puts "command size:#{cmd_arr.size}(Bytes)" if @verbose
+      puts 'writing data...' if @verbose
+      begin
+        cmd_arr.each{|c|
+          @sp.putc c
+        }
+        raise Error.new 'response is not E' unless @sp.getc.chr == 'E'
+      rescue => e
+        @busy = false
+        raise Error.new e
+      end
+    end
+    
+  end
+  
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/kuro-rs.rb'}"
+puts "Loading kuro-rs gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/kuro-rs_spec.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+# Time to add your specs!
+# http://rspec.info/
+describe "Place your specs here" do
+  
+  it "find this spec in spec directory" do
+    # violated "Be sure to write your specs"
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'kuro-rs'

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification 
+name: kuro-rs
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Sho Hashimoto
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-31 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: serialport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 1
+        - 0
+        - 4
+        version: 1.0.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 12
+        version: "2.12"
+  type: :development
+  version_requirements: *id002
+description: control KURO-RS (http://www.kuroutoshikou.com/modules/display/?iid=928) and PC-OP-RS1 (http://buffalo.jp/products/catalog/item/p/pc-op-rs1/)
+email: 
+- hashimoto@shokai.org
+executables: 
+- kuro-rs
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/kuro-rs.rb
+- lib/kuro-rs/main.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/kuro-rs_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+- examples/read.rb
+- examples/write.rb
+- bin/kuro-rs
+- .gemtest
+has_rdoc: true
+homepage: http://github.com/shokai/ruby-kuro-rs
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: kuro-rs
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: control KURO-RS (http://www.kuroutoshikou.com/modules/display/?iid=928) and PC-OP-RS1 (http://buffalo.jp/products/catalog/item/p/pc-op-rs1/)
+test_files: []
+