launchpad 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,2 @@
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Thomas Jachmann
+
+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.rdoc

@@ -0,0 +1,26 @@
+= launchpad
+
+This gem provides an interface to access novation's launchpad programmatically. LEDs can be lighted and button presses can be evaluated using launchpad's MIDI input/output.
+
+This is the first version, nothing sophisticated, but you can access the launchpad already. In and out. The API might change quite a bit during the next releases, so don't rely on it, this is work in progress. If you need anything or think the interface could be improved in any way, please contact me.
+
+Sometimes, the launchpad won't react to anything. Don't despair, just dis- and reconnect the thing. It seems that some (unexpected) MIDI signals make it hickup.
+
+
+== Requirements
+
+* Jan Krutisch's portmidi gem
+* Roger B. Dannenberg's portmidi library
+
+
+== Near future plans
+
+* dedicated interaction with control buttons (top and right row)
+* listeners for presses on single buttons/button areas
+* double buffering (already there but has some glitches)
+* bitmap rendering
+
+
+== Copyright
+
+Copyright (c) 2009 Thomas Jachmann. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'rake'
+
+require File.join(File.dirname(__FILE__), 'lib', 'launchpad', 'version')
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'launchpad'
+    gem.summary = 'A gem for accessing novation\'s launchpad programmatically and easily.'
+    gem.description = 'This gem provides an interface to access novation\'s launchpad programmatically. LEDs can be lighted and button presses can be evaluated using launchpad\'s MIDI input/output.'
+    gem.email = 'tom.j@gmx.net'
+    gem.homepage = 'http://github.com/thomasjachmann/launchpad'
+    gem.version = Launchpad::VERSION
+    gem.authors = ['Thomas Jachmann']
+    gem.add_dependency('portmidi')
+    #gem.add_development_dependency 'thoughtbot-shoulda', '>= 0'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler'
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort 'RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov'
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "launchpad #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/examples/colors.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), 'setup')
+
+l = Launchpad.new(:input => false, :output => true)
+
+sleep 1
+
+pos_x = pos_y = 0
+4.times do |red|
+  4.times do |green|
+    l.single :x => pos_x, :y => pos_y, :red => red, :green => green, :mode => :buffering
+    l.single :x => 7 - pos_x, :y => pos_y, :red => red, :green => green, :mode => :buffering
+    l.single :x => pos_x, :y => 7 - pos_y, :red => red, :green => green, :mode => :buffering
+    l.single :x => 7 - pos_x, :y => 7 - pos_y, :red => red, :green => green, :mode => :buffering
+    pos_y += 1
+  end
+  pos_x += 1
+  pos_y = 0
+end
+
+sleep 1

data/examples/feedback.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), 'setup')
+
+Launchpad.start do |l, x, y, state|
+  l.single(:x => x, :y => y, :red => state ? 3 : 0)
+end

data/examples/setup.rb

@@ -0,0 +1,4 @@
+# normally, this is done by rubygems (or whatever you use for your library management)
+require 'rubygems'
+require 'portmidi'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'launchpad')

data/experiments/wandering_dot.rb

@@ -0,0 +1,116 @@
+require 'rubygems'
+require 'midiator'
+
+@midi = MIDIator::Interface.new
+@midi.autodetect_driver
+
+def note_for(x, y)
+  y * 16 + x
+end
+
+def on_all(&block)
+  (0..7).each do |row|
+    row_start = row * 16
+    (row_start..(row_start+7)).each(&block)
+  end
+end
+
+def rand_pos
+  rand(8)
+end
+
+def rand_dir
+  rand(3) - 1
+end
+
+def new_dir(dir, pos)
+  if (dir <= 0 && pos == 0) || pos == 7
+    new_dir = rand_dir.abs
+    new_dir = -new_dir if dir > 0
+    new_dir
+  else
+    dir
+  end
+end
+
+def change_dir(dir, pos, change)
+  if (dir <= 0 && pos == 0) || pos == 7
+    -dir
+  elsif change
+    case dir
+    when -1 then -rand(2)
+    when 0  then rand(2) == 0 ? -1 : 1
+    when 1  then rand(2)
+    end
+  else
+    dir
+  end
+end
+
+def new_pos(pos, dir)
+  [0, [pos + dir, 7].min].max
+end
+
+def end_it
+  sleep 1
+  final_note = note_for(@pos_x, @pos_y)
+  4.times do
+    on_all {|note| @midi.note_on(note, 0, 1) unless note == final_note}
+    sleep 0.5
+    on_all {|note| @midi.note_on(note, 0, 16) unless note == final_note}
+    sleep 0.5
+  end
+  on_all {|note| @midi.note_off(note, 0)}
+  sleep 0.5
+end
+
+remaining_notes = []
+on_all do |note|
+  remaining_notes << note
+  @midi.note_off(note, 0)
+end
+remaining_notes.uniq!
+
+sleep (ARGV[0] || 0).to_i
+
+@pos_x = rand_pos
+@pos_y = rand_pos
+@dir_x = rand_dir
+@dir_y = rand_dir
+
+new_note = note_for(@pos_x, @pos_y)
+old_note = nil
+
+on_all {|note| @midi.note_on(note, 0, 3)}
+on_all {|note| @midi.note_off(note, 0) unless note == new_note}
+
+sleep 2
+sleep_time = 1
+
+loop do
+  unless old_note == new_note || old_note.nil?
+    @midi.note_off(old_note, 0)
+    @midi.note_on(old_note, 0, 16)
+    @midi.note_on(new_note, 0, 3)
+  end
+  remaining_notes.delete(new_note)
+  end_it && break if remaining_notes.empty?
+  change = rand(1)
+  @dir_x = change_dir(@dir_x, @pos_x, change == 0)
+  @dir_y = change_dir(@dir_y, @pos_y, change != 0)
+  #@dir_x = new_dir(@dir_x, @pos_x)
+  #@dir_y = new_dir(@dir_y, @pos_y)
+  #while @dir_x == 0 && @dir_y == 0 || (old_note.nil? && (@dir_x == 0 || @dir_y == 0))
+  #  if rand(1) == 0
+  #    @dir_x = new_dir(@dir_x, @pos_x)
+  #  else
+  #    @dir_y = new_dir(@dir_y, @pos_y)
+  #  end
+  #end
+  @pos_x = new_pos(@pos_x, @dir_x)
+  @pos_y = new_pos(@pos_y, @dir_y)
+  old_note = new_note
+  new_note = note_for(@pos_x, @pos_y)
+  sleep sleep_time
+  sleep_time *= 0.96
+end

data/launchpad.gemspec

@@ -0,0 +1,61 @@
+# 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{launchpad}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Thomas Jachmann"]
+  s.date = %q{2009-11-08}
+  s.description = %q{This gem provides an interface to access novation's launchpad programmatically. LEDs can be lighted and button presses can be evaluated using launchpad's MIDI input/output.}
+  s.email = %q{tom.j@gmx.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "examples/colors.rb",
+     "examples/feedback.rb",
+     "examples/setup.rb",
+     "experiments/wandering_dot.rb",
+     "launchpad.gemspec",
+     "lib/launchpad.rb",
+     "lib/launchpad/version.rb",
+     "test/helper.rb",
+     "test/test_launchpad-gem.rb"
+  ]
+  s.homepage = %q{http://github.com/thomasjachmann/launchpad}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A gem for accessing novation's launchpad programmatically and easily.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_launchpad-gem.rb",
+     "examples/colors.rb",
+     "examples/feedback.rb",
+     "examples/setup.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<portmidi>, [">= 0"])
+    else
+      s.add_dependency(%q<portmidi>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<portmidi>, [">= 0"])
+  end
+end
+

data/lib/launchpad.rb

@@ -0,0 +1,165 @@
+class Launchpad
+  
+  class LaunchpadError < StandardError; end
+  class NoInputAllowed < LaunchpadError; end
+  class NoOutputAllowed < LaunchpadError; end
+  class NoLocationError < LaunchpadError; end
+  class CommunicationError < LaunchpadError
+    attr_accessor :source
+    def initialize(e)
+      super(e.portmidi_error)
+      self.source = e
+    end
+  end
+  
+  OFF = 0x80
+  ON = 0x90
+  CC = 0xB0
+  
+  def initialize(opts = nil)
+    opts = {
+      :device_name  => 'Launchpad',
+      :input        => true,
+      :output       => true
+    }.merge(opts || {})
+    Portmidi.start
+    if opts[:input]
+      input_device = Portmidi.input_devices.select {|device| device.name == opts[:device_name]}.first
+      @input = Portmidi::Input.new(input_device.device_id)
+    end
+    if opts[:output]
+      output_device = Portmidi.output_devices.select {|device| device.name == opts[:device_name]}.first
+      @output = Portmidi::Output.new(output_device.device_id)
+      reset
+    end
+    @buffering = false
+  end
+  
+  def self.start(opts = nil, &block)
+    opts ||= {}
+    latency = (opts.delete(:latency) || 0.001).to_f
+    launchpad = Launchpad.new(opts.merge({:input => true, :output => true}))
+    loop do
+      messages = launchpad.input
+      if messages
+        messages.each do |message|
+          message = parse_message(message)
+          if message[:code] == ON
+            block.call(launchpad, message[:x], message[:y], message[:state])
+          end
+        end
+      end
+      sleep latency
+    end
+  rescue Portmidi::DeviceError => e
+    raise CommunicationError.new(e)
+  ensure
+    launchpad.reset if launchpad
+  end
+  
+  # Reset the launchpad - all settings are reset and all LEDs are switched off
+  def reset
+    output(CC, 0x00, 0x00)
+  end
+  
+  # Light all LEDs (for testing purposes)
+  # takes an optional parameter brightness (1-3, defaults to 3)
+  def light_all(brightness = 3)
+    output(CC, 0x00, 124 + min_max_color(brightness, false))
+  end
+  
+  def start_buffering
+    output(CC, 0x00, 0x31)
+    @buffering = true
+  end
+  
+  def flush_buffer(end_buffering = true)
+    output(CC, 0x00, 0x34)
+    if end_buffering
+      output(CC, 0x00, 0x30)
+      @buffering = false
+    end
+  end
+  
+  # Switches a single LED
+  # * :x      => x coordinate (0 based from top left, mandatory)
+  # * :y      => y coordinate (0 based from top left, mandatory)
+  # * :red    => brightness of red LED (0-3, optional, defaults to 0)
+  # * :green  => brightness of red LED (0-3, optional, defaults to 0)
+  # * :mode   => button behaviour (:normal, :flashing, :buffering, optional, defaults to :normal)
+  def single(opts)
+    location = location(opts)
+    velocity = velocity(opts)
+    output(ON, location, velocity)
+  end
+  
+  def multi(*velocities)
+    output(CC, 0x01, 0x00)
+    output(0x92, *velocities)
+  end
+  
+  # Switches LEDs marked as flashing on (when using custom timer for flashing)
+  def custom_flashing_on
+    output(CC, 0x00, 0x20)
+  end
+  
+  # Switches LEDs marked as flashing off (when using custom timer for flashing)
+  def custom_flashing_off
+    output(CC, 0x00, 0x21)
+  end
+  
+  # Starts flashing LEDs marked as flashing automatically
+  def start_auto_flashing
+    output(CC, 0x00, 0x28)
+  end
+  
+  # Stops flashing LEDs marked as flashing automatically (turning them on)
+  alias_method :stop_auto_flashing, :custom_flashing_on
+  
+  def coordinates(location)
+    [location % 16, location / 16]
+  end
+  
+  def input
+    raise NoInputAllowed if @input.nil?
+    @input.read(16)
+  end
+  
+  def output(*args)
+    raise NoOutputAllowed if @output.nil?
+    @output.write([{:message => args, :timestamp => 0}])
+  end
+  
+  private
+  
+  def self.parse_message(message)
+    message = message[:message]
+    {
+      :code   => message[0],
+      :x      => message[1] % 16,
+      :y      => message[1] / 16,
+      :state  => message[2] == 127
+    }
+  end
+  
+  def location(opts)
+    raise NoLocationError.new('you need to specify a location (x/y, 0 based from top left)') if (y = opts[:y]).nil? || (x = opts[:x]).nil?
+    y * 16 + x
+  end
+  
+  def velocity(opts)
+    red = min_max_color(opts[:red] || 0)
+    green = min_max_color(opts[:green] || 0)
+    flags = case opts[:mode]
+    when :flashing  then  8
+    when :buffering then  0
+    else                  12
+    end
+    (16 * (green)) + red + flags
+  end
+  
+  def min_max_color(color, with_off = true)
+    [[with_off ? 0 : 1, color.to_i].max, 3].min
+  end
+  
+end

data/lib/launchpad/version.rb

@@ -0,0 +1,3 @@
+class Launchpad
+  VERSION = '0.0.1'
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+#require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'launchpad'
+
+class Test::Unit::TestCase
+end

data/test/test_launchpad-gem.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestLaunchpadGem < Test::Unit::TestCase
+  #should "probably rename this file and start testing for real" do
+  #  flunk "hey buddy, you should probably rename this file and start testing for real"
+  #end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: launchpad
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Thomas Jachmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-08 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: portmidi
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: This gem provides an interface to access novation's launchpad programmatically. LEDs can be lighted and button presses can be evaluated using launchpad's MIDI input/output.
+email: tom.j@gmx.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- examples/colors.rb
+- examples/feedback.rb
+- examples/setup.rb
+- experiments/wandering_dot.rb
+- launchpad.gemspec
+- lib/launchpad.rb
+- lib/launchpad/version.rb
+- test/helper.rb
+- test/test_launchpad-gem.rb
+has_rdoc: true
+homepage: http://github.com/thomasjachmann/launchpad
+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: A gem for accessing novation's launchpad programmatically and easily.
+test_files: 
+- test/helper.rb
+- test/test_launchpad-gem.rb
+- examples/colors.rb
+- examples/feedback.rb
+- examples/setup.rb