monome_serial 1.0.0

data/lib/monome_serial/serial_communicator/communicator.rb

@@ -0,0 +1,16 @@
+module MonomeSerial
+  module SerialCommunicator
+    class Communicator
+      def write(strings)
+        raise ArgumentError, "The collection of stringified bytes passed into SerialCommunicator#write needs to respond to #[] and #size" unless strings.respond_to?("[]") && strings.respond_to?("size")
+      end
+
+      def read
+      end
+
+      def real?
+        raise "please implement me"
+      end
+    end
+  end
+end

data/lib/monome_serial/serial_communicator/dummy_communicator.rb

@@ -0,0 +1,30 @@
+module MonomeSerial
+  module SerialCommunicator
+    #Dummy class with no actual serial connection (so tests can execute
+    #in other Ruby environments)
+    class DummyCommunicator < Communicator
+      def initialize
+      end
+
+      def read
+        #super
+        [:keydown, 1, 1]
+      end
+
+      def write(strings)
+      end
+
+      def real?
+        false
+      end
+
+      def model
+        "256"
+      end
+
+      def serial
+        "007"
+      end
+    end
+  end
+end

data/lib/monome_serial/serial_communicator/real_communicator.rb

@@ -0,0 +1,97 @@
+module MonomeSerial
+  module SerialCommunicator
+    class RealCommunicator < Communicator
+      attr_reader :model, :serial
+      def initialize(tty_path)
+        #make sure tty_path exists (such as "/dev/tty.usbserial-m256-203")
+        raise ArgumentError, "path to tty IO file does not exist" unless File.exists?(tty_path)
+
+        #match = tty_path.match /m(\d+)-(\d+)/
+        #@model = match[1]
+
+        #pull out this Monome's individual serial number
+        #@serial = match[2]
+
+        #Open up the virtual serial port
+        @dev = dev_open(tty_path)
+
+        #bless the file with Termios powers
+        @dev.extend Termios
+
+        #create a new Termios struct
+        newtio = Termios::new_termios()
+        newtio.iflag = Termios::IGNPAR
+        newtio.oflag = 0
+        newtio.cflag = Termios::CLOCAL
+        newtio.lflag = 0
+        newtio.cc[Termios::VTIME] = 0
+        newtio.cc[Termios::VMIN] = 1
+        newtio.ispeed = Termios::B115200
+        newtio.ospeed = Termios::B115200
+
+        #discard data on both the input and output queues
+        flush
+
+        #set the termios struct in the OS with the newly
+        #defined info in newtio
+        @dev.tcsetattr(Termios::TCSANOW, newtio)
+      end
+
+      def real?
+        true
+      end
+
+      def read
+        #read action message
+        action_bin = @dev.read(1)
+
+        #interpret action:
+        #0000000 => keydown
+        #0001000 => keyup
+        action = action_bin.unpack('B8').first[3] == "1" ? :keyup : :keydown
+
+        #read position message
+        pos_bin    = @dev.read(1)
+
+        #convert it to a binary string
+        pos_bin_s = pos_bin.unpack('B8').first
+
+        #interpret position:
+        #xxxxyyyy => x position and y position in base 2
+        x = Integer("0b" + pos_bin_s[0..3])
+        y = Integer("0b" + pos_bin_s[4..8])
+
+        return action, x, y
+      end
+
+      def write(strings)
+
+        super
+
+        #convert integer params to 8bit binary representation
+        bin_strings = strings.map{|s| s.to_s}
+
+        case bin_strings.size
+        when 1 then @dev.write(bin_strings.pack('B8'))
+        when 2 then @dev.write(bin_strings.pack('B8B8'))
+        when 3 then @dev.write(bin_strings.pack('B8B8B8'))
+        when 9 then @dev.write(bin_strings.pack('B8B8B8B8B8B8B8B8B8'))
+        else raise ArgumentError, "SerialCommunicator#write only supports sending one, two, three or nine bytes at a time. You tried to send #{bin_strings.size} bytes."
+        end
+      end
+
+      private
+
+      def flush
+        @dev.tcflush(Termios::TCIOFLUSH)
+      end
+
+      def dev_open(path)
+        dev = open(path , File::RDWR | File::NONBLOCK)
+        mode = dev.fcntl(Fcntl::F_GETFL, 0)
+        dev.fcntl(Fcntl::F_SETFL, mode & ~File::NONBLOCK)
+        return dev
+      end
+    end
+  end
+end

data/monome_serial.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{monome_serial}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sam Aaron"]
+  s.date = %q{2009-12-02}
+  s.description = %q{Communicate directly with your monome with this handy Ruby library.}
+  s.email = %q{samaaron@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "docs/CONTRIBUTORS",
+     "docs/LICENSE",
+     "docs/TODO",
+     "lib/monome_serial.rb",
+     "lib/monome_serial/examples/toggle.rb",
+     "lib/monome_serial/monome_communicator.rb",
+     "lib/monome_serial/serial_communicator.rb",
+     "lib/monome_serial/serial_communicator/binary_patterns/fourtyh.rb",
+     "lib/monome_serial/serial_communicator/binary_patterns/series.rb",
+     "lib/monome_serial/serial_communicator/communicator.rb",
+     "lib/monome_serial/serial_communicator/dummy_communicator.rb",
+     "lib/monome_serial/serial_communicator/real_communicator.rb",
+     "monome_serial.gemspec",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/unit/monome_communicator_spec.rb",
+     "spec/unit/monome_serial_spec.rb"
+  ]
+  s.homepage = %q{http://sam.aaron.name/projects/ruby_monome_serial.html}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby serial library for communicating with a monome.}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/unit/monome_communicator_spec.rb",
+     "spec/unit/monome_serial_spec.rb",
+     "examples/toggler.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.3.4"])
+      s.add_runtime_dependency(%q<arika-ruby-termios>, [">= 0.9.6"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.3.4"])
+      s.add_dependency(%q<arika-ruby-termios>, [">= 0.9.6"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.3.4"])
+    s.add_dependency(%q<arika-ruby-termios>, [">= 0.9.6"])
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1,4 @@
+--colour
+--format nested
+--reverse
+--loadby mtime

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+#require tosca
+require 'rubygems'
+require 'monome_serial'
+
+
+#require rspec
+require 'spec'
+require 'spec/autorun'
+
+MonomeSerial::SerialCommunicator.suppress_warnings = true

data/spec/unit/monome_communicator_spec.rb

@@ -0,0 +1,84 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+include MonomeSerial
+
+describe MonomeCommunicator do
+  it "should exist" do
+    MonomeCommunicator.should_not be_nil
+  end
+
+  it "should raise an error when not initializing with a correct protocol name" do
+    lambda{MonomeCommunicator.new('/blah', "phonycol" )}.should raise_error(ArgumentError)
+  end
+
+  describe "A default monome with an unusual tty_path" do
+    before(:each) do
+      @monome = MonomeCommunicator.new('unusual_path')
+    end
+
+    it "should default to the series protocol" do
+      @monome.protocol.should == "series"
+    end
+
+    it "should default the serial to Serial Unknown" do
+      @monome.serial.should == "Serial Unknown"
+    end
+
+    it "should have a dummy communicator" do
+      @monome.communicator.class.should == SerialCommunicator::DummyCommunicator
+    end
+  end
+
+  describe "A default monome with the 40h protocol" do
+    before(:each) do
+      @monome = MonomeCommunicator.new('/foo/tty.usbserial-m256-203', '40h')
+    end
+
+    it "should raise an exception when a communicating method is used" do
+      lambda{@monome.illuminate_lamp(0,0)}.should raise_error(NotImplementedError)
+    end
+  end
+
+  describe "A monome with a normal tty_path and a dummy communicator" do
+    before(:each) do
+      SerialCommunicator.should_receive(:get_communicator).and_return SerialCommunicator::DummyCommunicator.new
+      @monome = MonomeCommunicator.new('/foo/tty.usbserial-m256-203')
+      @comm = @monome.communicator
+    end
+
+    describe "sending system calls" do
+
+      it "should send the correct binary string to light all lamps" do
+        @comm.should_receive(:write).with(["10010001"])
+        @monome.illuminate_all
+      end
+
+      it "should send the correct binary string to turn all lamps off" do
+        @comm.should_receive(:write).with(["10010000"])
+        @monome.extinguish_all
+      end
+
+      it "should send the correct binary string to set the brightness to 0" do
+        @comm.should_receive(:write).with(["10100000"])
+        @monome.brightness = 0
+      end
+
+      it "should send the correct binary string to set the brightness to 5" do
+        @comm.should_receive(:write).with(["10100101"])
+        @monome.brightness = 5
+      end
+
+      it "should send the correct binary string to set the brightness to 15" do
+        @comm.should_receive(:write).with(["10101111"])
+        @monome.brightness = 15
+      end
+
+      it "should raise an error if a negative brightness is set" do
+        lambda{@monome.brightness = -1}.should raise_error(ArgumentError)
+      end
+
+      it "should raise an error if a brightness is set to an integer greater than 15" do
+        lambda{@monome.brightness = 16}.should raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/unit/monome_serial_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+include MonomeSerial
+
+describe SerialCommunicator do
+  it "should exist" do
+    SerialCommunicator.should_not be_nil
+  end
+
+  describe "A dummy serial connection" do
+    before(:each) do
+      @comm = SerialCommunicator.get_communicator("fake")
+    end
+
+    it "should be a dummy connection" do
+      @comm.should_not be_real
+    end
+
+    describe "read" do
+      it "should raise an ArgumentError if a non-array-like collection is passed as an argument" do
+        lambda{@comm.read(1)}.should raise_error ArgumentError
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: monome_serial
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Sam Aaron
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-07 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: arika-ruby-termios
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.6
+    version: 
+description: Communicate directly with your monome with this handy Ruby library.
+email: samaaron@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- README
+- Rakefile
+- VERSION
+- assets/monome_serial_final.png
+- assets/monome_serial_logo.graffle
+- docs/CONTRIBUTORS
+- docs/LICENSE
+- docs/TODO
+- examples/toggler.rb
+- lib/monome_serial.rb
+- lib/monome_serial/examples/toggle.rb
+- lib/monome_serial/monome_communicator.rb
+- lib/monome_serial/serial_communicator.rb
+- lib/monome_serial/serial_communicator/binary_patterns/fourtyh.rb
+- lib/monome_serial/serial_communicator/binary_patterns/series.rb
+- lib/monome_serial/serial_communicator/communicator.rb
+- lib/monome_serial/serial_communicator/dummy_communicator.rb
+- lib/monome_serial/serial_communicator/real_communicator.rb
+- monome_serial.gemspec
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/unit/monome_communicator_spec.rb
+- spec/unit/monome_serial_spec.rb
+has_rdoc: true
+homepage: http://sam.aaron.name/projects/ruby_monome_serial.html
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby serial library for communicating with a monome.
+test_files: 
+- spec/spec_helper.rb
+- spec/unit/monome_communicator_spec.rb
+- spec/unit/monome_serial_spec.rb
+- examples/toggler.rb