artoo-keyboard 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f41477fdff80e45257fb74795bec70cd8197556
+  data.tar.gz: 4776bd4442a24100f51a8576eafaaf542b25bcf2
+SHA512:
+  metadata.gz: 5546d761ba4cf5219626e6f73467d0d89fbeffaa2a9626b51897494910ea58714fb139bcd0e0255d4fd05504392e8e24deb0f8c587028769604137224f9ac7a4
+  data.tar.gz: 1a801fe44686b793f2d2347c110e4fc8410d35495f0b8c4ea599aaf3fb6d60056f9cfeeb6c200ad313287f597aaf2010620dd09c2766377d7e53f75fb7c0c9fc

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in artoo-keyboard.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2014 The Hybrid Group
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,55 @@
+# Artoo Adaptor For Keyboard Input
+
+This repository contains the Artoo (http://artoo.io/) adaptor for keyboard input.
+
+Artoo is a open source micro-framework for robotics using Ruby.
+
+For more information about Artoo, check out our repo at https://github.com/hybridgroup/artoo
+
+## Installing
+
+```
+gem install artoo-keyboard
+```
+
+## Using
+
+```ruby
+require 'artoo'
+
+connection :keyboard, adaptor: :keyboard
+device :keyboard, driver: :keyboard, connection: :keyboard
+
+work do
+  on keyboard, :key => :keypress
+end
+
+def keypress(sender, key)
+  puts key
+end
+```
+
+## Documentation
+
+Check out our [documentation](http://artoo.io/documentation/) for lots of information about how to use Artoo.
+
+## IRC
+
+Need more help? Just want to say "Hello"? Come visit us on IRC freenode #artoo
+
+## Contributing
+
+* All patches must be provided under the Apache 2.0 License
+* Please use the -s option in git to "sign off" that the commit is your work and you are providing it under the Apache 2.0 License
+* Submit a Github Pull Request to the appropriate branch and ideally discuss the changes with us in IRC.
+* We will look at the patch, test it out, and give you feedback.
+* Avoid doing minor whitespace changes, renamings, etc. along with merged content. These will be done by the maintainers from time to time but they can complicate merges and should be done seperately.
+* Take care to maintain the existing coding style.
+* Add unit tests for any new or changed functionality.
+* All pull requests should be "fast forward"
+  * If there are commits after yours use “git rebase -i <new_head_branch>”
+  * If you have local changes you may need to use “git stash”
+  * For git help see [progit](http://git-scm.com/book) which is an awesome (and free) book on git
+
+
+(c) 2012-2014 The Hybrid Group

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test

data/artoo-keyboard.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "artoo-keyboard/version"
+
+Gem::Specification.new do |s|
+  s.name        = "artoo-keyboard"
+  s.version     = Artoo::Keyboard::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Andrew Stewart", "Ron Evans"]
+  s.email       = ["artoo@hybridgroup.com"]
+  s.homepage    = "https://github.com/hybridgroup/artoo-keyboard"
+  s.summary     = %q{Artoo adaptor for keyboard input}
+  s.description = %q{Artoo adaptor for keyboard input}
+
+  s.rubyforge_project = "artoo-keyboard"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency 'artoo', '>= 1.6.0'
+  s.add_development_dependency 'minitest', '>= 5.0'
+  s.add_development_dependency 'minitest-happy'
+  s.add_development_dependency 'mocha', '>= 1.0.0'
+end

data/docs/commands.md

@@ -0,0 +1 @@
+# Commands

data/docs/events.md

@@ -0,0 +1,11 @@
+# Events
+
+## start_driver
+
+Start driver and any required connections.
+
+## key
+
+Gets triggered when we press a key on the keyboard.
+
+- **keys supported** - up arrow, down arrow, left arrow, right arrow, esc and any alphanumeric characters.

data/examples/keyboard.rb

@@ -0,0 +1,14 @@
+require 'artoo'
+
+connection :keyboard, adaptor: :keyboard
+device :keyboard, driver: :keyboard, connection: :keyboard
+
+work do
+  puts "working now..."
+
+  on keyboard, :key => :keypress
+end
+
+def keypress(sender, key)
+  puts key
+end

data/lib/artoo-keyboard.rb

@@ -0,0 +1,3 @@
+require 'lib/artoo/adaptors/keyboard'
+require 'lib/artoo/drivers/keyboard'
+require 'lib/artoo-keyboard/version'

data/lib/artoo-keyboard/version.rb

@@ -0,0 +1,5 @@
+module Artoo
+  module Keyboard
+    VERSION = '0.1.0'
+  end
+end

data/lib/artoo/adaptors/keyboard.rb

@@ -0,0 +1,133 @@
+require 'artoo/adaptors/adaptor'
+
+module Artoo
+  module Adaptors
+    # Connect to a keyboard device
+    # @see device documentation for more information
+    class Keyboard < Adaptor
+      KEY_CTRL_C = ?\C-c
+      KEY_ESCAPE = 0x1B
+      KEY_ARROW_UP = 0x41
+      KEY_ARROW_DOWN = 0x42
+      KEY_ARROW_RIGHT = 0x43
+      KEY_ARROW_LEFT = 0x44
+
+      attr_reader :tty, :chars, :buffer
+
+      # Creates a connection with device
+      # @return [Boolean]
+      def connect
+        @tty = TTY.new
+        @tty.configure
+
+        @chars = Queue.new
+        @buffer = []
+
+        super
+      end
+
+      # Closes connection with device
+      # @return [Boolean]
+      def disconnect
+        tty.restore
+        tty.puts
+
+        super
+      end
+
+      # Name of device
+      # @return [String]
+      def name
+        "keyboard"
+      end
+
+      # Version of device
+      # @return [String]
+      def version
+        Artoo::Keyboard::VERSION
+      end
+
+      def get_char
+        parse_char tty.get_char
+        chars.pop
+      end
+
+      private
+
+      def quit
+        puts "QUITTING"
+        tty.restore
+        Artoo::Master.stop_work
+        exit(0)
+      end
+
+      def parse_char(char)
+        case char
+        when KEY_CTRL_C then quit
+        when " " then chars.push("space")
+        when KEY_ESCAPE.chr then
+          next_char = tty.get_char
+          if next_char
+            next_char = tty.get_char
+            case next_char
+            when KEY_ARROW_UP.chr then chars.push('up')
+            when KEY_ARROW_DOWN.chr then chars.push('down')
+            when KEY_ARROW_RIGHT.chr then chars.push('right')
+            when KEY_ARROW_LEFT.chr then chars.push('left')
+            end
+          else
+            chars.push(char) # just escape
+          end
+        when /[[:print:]]/ then chars.push(char)
+        else chars.push(nil) # unknown or non-qwerty char
+        end
+      end
+    end
+  end
+end
+
+class TTY
+  attr_reader :original_stty_state, :in_file, :out_file
+
+  def initialize
+    @in_file = File.open("/dev/tty", "r")
+    @out_file = File.open("/dev/tty", "w")
+  end
+
+  def get_char
+    in_file.getc
+  end
+
+  def puts
+    out_file.puts
+  end
+
+  def stty(args)
+    command("stty #{args}")
+  end
+
+  def configure
+    @original_stty_state = stty "-g"
+    # raw: Disable input and output processing
+    # -echo: Don't echo keys back
+    # cbreak: Set up lots of standard stuff, including INTR signal on ^C
+    stty "raw -echo cbreak"
+  end
+
+  def restore
+    stty "#{@original_stty_state}"
+  end
+
+  private
+
+  # Run a command with the TTY as stdin, capturing the output via a pipe
+  def command(command)
+    IO.pipe do |read_io, write_io|
+      pid = Process.spawn(command, :in => "/dev/tty", :out => write_io)
+      Process.wait(pid)
+      raise "Command failed: #{command.inspect}" unless $?.success?
+      write_io.close
+      read_io.read
+    end
+  end
+end

data/lib/artoo/drivers/keyboard.rb

@@ -0,0 +1,21 @@
+require 'artoo/drivers/driver'
+
+module Artoo
+  module Drivers
+    # The keyboard driver behaviors
+    class Keyboard < Driver
+
+      # Public: Start driver and any required connections.
+      #
+      # Returns null.
+      def start_driver
+        every(0.05) do
+          key = connection.get_char # get the next char if any...
+          publish(event_topic_name("key"), key) if key
+        end
+
+        super
+      end
+    end
+  end
+end

data/test/adaptors/keyboard_adaptor_test.rb

@@ -0,0 +1,95 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+require 'artoo/adaptors/keyboard'
+
+class MockTTY
+  attr_reader :chars
+
+  def initialize
+    @chars = []
+  end
+
+  def get_char
+    chars.pop
+  end
+
+  # no-op methods
+  def configure ; end
+  def restore ; end
+  def puts ; end
+end
+
+describe Artoo::Adaptors::Keyboard do
+  before do
+    @adaptor = Artoo::Adaptors::Keyboard.new
+    @tty = MockTTY.new
+    TTY.stubs(:new).returns(@tty)
+  end
+
+  describe "#name" do
+    it "identifies as 'keyboard'" do
+      @adaptor.name.must_equal 'keyboard'
+    end
+  end
+
+  describe "#connect" do
+    before do
+      @tty.expects(:configure)
+      @adaptor.connect
+    end
+
+    it "sets up a TTY" do
+      @adaptor.tty.must_equal @tty
+    end
+
+    it 'creates a queue' do
+      @adaptor.chars.must_be_instance_of Thread::Queue
+    end
+
+    it 'creates a buffer array' do
+      @buffer = []
+    end
+  end
+
+  describe "#get_char" do
+    before do
+      @adaptor.connect
+    end
+
+    it "parses chars from the TTY" do
+      @tty.chars << "a"
+      @adaptor.get_char.must_equal "a"
+    end
+
+    it "catches the spacebar" do
+      @tty.chars << " "
+      @adaptor.get_char.must_equal "space"
+    end
+
+    it "passes through escape" do
+      @tty.chars << "\e"
+      @adaptor.get_char.must_equal "\e"
+    end
+
+    describe "arrow keys" do
+      it "recognizes the up arrow key" do
+        ["A", "[", "\e"].each { |chr| @tty.chars << chr }
+        @adaptor.get_char.must_equal "up"
+      end
+
+      it "recognizes the down arrow key" do
+        ["B", "[", "\e"].each { |chr| @tty.chars << chr }
+        @adaptor.get_char.must_equal "down"
+      end
+
+      it "recognizes the left arrow key" do
+        ["D", "[", "\e"].each { |chr| @tty.chars << chr }
+        @adaptor.get_char.must_equal "left"
+      end
+
+      it "recognizes the right arrow key" do
+        ["C", "[", "\e"].each { |chr| @tty.chars << chr }
+        @adaptor.get_char.must_equal "right"
+      end
+    end
+  end
+end

data/test/drivers/keyboard_driver_test.rb

@@ -0,0 +1,4 @@
+require File.expand_path(File.dirname(__FILE__) + "/../test_helper")
+require 'artoo/drivers/keyboard'
+
+# TODO: test for your driver goes here...

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+require 'mocha/mini_test'
+require 'artoo/robot'
+
+Celluloid.logger = nil
+
+MiniTest::Spec.before do
+  Celluloid.shutdown
+  Celluloid.boot
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: artoo-keyboard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Stewart
+- Ron Evans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: artoo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-happy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Artoo adaptor for keyboard input
+email:
+- artoo@hybridgroup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- artoo-keyboard.gemspec
+- docs/commands.md
+- docs/events.md
+- examples/keyboard.rb
+- lib/artoo-keyboard.rb
+- lib/artoo-keyboard/version.rb
+- lib/artoo/adaptors/keyboard.rb
+- lib/artoo/drivers/keyboard.rb
+- test/adaptors/keyboard_adaptor_test.rb
+- test/drivers/keyboard_driver_test.rb
+- test/test_helper.rb
+homepage: https://github.com/hybridgroup/artoo-keyboard
+licenses: []
+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: artoo-keyboard
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Artoo adaptor for keyboard input
+test_files: []