launchpad_mk2 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 66358055a34d22fc58af54828d732c74d489e88e
+  data.tar.gz: 6f4a31bcb5eca94c4959d00d4e962817dd022880
+SHA512:
+  metadata.gz: cc52a3b22776aa47684998163e02c5661da310fc2d397fe475f17e40b376fb072930a7c8f1691f0a752280d9487a4232867519ac3b048b7edd5853500ec1e859
+  data.tar.gz: 0018de9688efec8d10ccdf5a9b96a2c32c4d7ea33e1faf34f3e4646d83dda698b4eaf903a69f8ef573d856ce3f5495bb94468fd1a294149d685754674afb05b6

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.0.0
+before_install:
+  - sudo apt-get update
+  - sudo apt-get install libportmidi-dev

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2017 Andy Marks
+
+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,75 @@
+= launchpad
+
+{<img src="https://travis-ci.org/andeemarks/launchpad.png?branch=master" alt="Build Status" />}[https://travis-ci.org/andeemarks/launchpad]
+
+[https://github.com/andeemarks/launchpad/blob/master/launchpad-gem-overview.gif]
+
+This gem provides a Ruby interface to access the {Novation Launchpad MK2}[https://global.novationmusic.com/launch/launchpad#] programmatically.  The code started life as a clone of {Thomas Jachman's gem}[https://github.com/thomasjachmann/launchpad] and was subsequently updated to handle the MK2 version of the Launchpad.  The mapping of buttons and specification of colours completely changed when the MK2 was released, so lots of the original code in these areas has been re-written, but the interaction code is still largely intact.
+
+== More Info
+
+* Novation's Launchpad MK2 MIDI programmer's reference {here}[https://global.novationmusic.com/sites/default/files/novation/downloads/10529/launchpad-mk2-programmers-reference-guide_0.pdf] was the sole source for helping me understand how to interact with the Launchpad.
+
+* Due to limitations in the Portmidi gem, it's not possible to specify which channel is used to send MIDI messages.  As such, all interaction with the Launchpad are done over the default channel 1.  This means some workarounds have been needed to access functionality like flash and pulse, which usually require channel 2 messages.  All of these workarounds have been implemented via sending {System Exclusive messages}[http://electronicmusic.wikia.com/wiki/System_exclusive] as per the above reference guide.
+
+== Requirements
+
+* Roger B. Dannenberg's {portmidi library}[http://sourceforge.net/projects/portmedia/]
+* Jan Krutisch's {portmidi gem}[http://github.com/halfbyte/portmidi]
+
+== Compatibility
+
+The gem is known to be compatible with the following ruby versions:
+
+* MRI 2.3.1
+
+== Installation
+
+The gem is hosted on RubyGems[https://rubygems.org/], so in order to use it, you're gonna gem install it:
+
+  gem install launchpad
+
+
+== Usage
+
+There are two main entry points:
+
+* <code>require 'launchpad/device'</code>, providing <code>Launchpad::Device</code>, which handles all the basic input/output stuff
+* <code>require 'launchpad/interaction'</code> or just 'launchpad', additionally providing <code>Launchpad::Interaction</code>, which lets you respond to actions (button presses/releases)
+
+This is a simple example (only requiring the device for output) that resets the launchpad and then lights the grid button at position 4/4 (from bottom left of 0/0).
+
+  require 'launchpad/device'
+  
+  device = Launchpad::Device.new
+  sleep 1
+  device.reset_all
+  sleep 1
+  device.change :grid, :x => 4, :y => 4, :color => 72
+
+This is an interaction example lighting all grid buttons in red when pressed and keeping them lit.
+
+  require 'launchpad'
+  
+  interaction = Launchpad::Interaction.new
+  interaction.response_to(:grid, :down) do |interaction, action|
+    interaction.device.change(:grid, action.merge(:color => 72))
+  end
+  interaction.response_to(:mixer, :down) do |interaction, action|
+    interaction.stop
+  end
+  
+  interaction.start
+
+
+For more details, see the examples. examples/color_picker.rb is the most complex example with interaction.
+
+== To Do
+
+* Rename gem to avoid name clashes with original version
+* Ensure all examples are working
+* Update examples in README
+
+== Copyright
+
+Copyright (c) 2017 Andy Marks. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test

data/examples/binary_clock.rb

@@ -0,0 +1,41 @@
+require 'launchpad_mk2'
+
+device = Launchpad::Device.new
+
+on = { :color => 16 }
+off = { :color => 72 }
+
+digit_map = [
+  [off, off, off, off],
+  [on , off, off, off],
+  [off, on , off, off],
+  [on , on , off, off],
+  [off, off, on , off],
+  [on , off, on , off],
+  [off, on , on , off],
+  [on , on , on , off],
+  [off, off, off, on ],
+  [on , off, off, on ]
+]
+
+def offset_x(x)
+  if (x == 0 or x == 1)
+    return x
+  end
+
+  if (x == 2 or x == 3)
+    return (x + 1)
+  end
+
+  return (x + 2)
+end
+
+while true do
+  Time.now.strftime('%H%M%S').split('').each_with_index do |digit, x|
+    digit_map[digit.to_i].each_with_index do |color, y|
+      device.change :grid, color.merge(:x => offset_x(x), :y => (y + 2))
+    end
+  end
+
+  sleep 0.25
+end

data/examples/color_picker.rb

@@ -0,0 +1,96 @@
+require 'launchpad_mk2'
+
+interaction = Launchpad::Interaction.new
+
+# build color arrays for color display views
+colors_single = [
+  [ 0,  1,  2,  3,  0,  0,  0,  0],
+  [16, 17, 18, 19,  0,  0,  0,  0],
+  [32, 33, 34, 35,  0,  0,  0,  0],
+  [48, 49, 50, 51,  0,  0,  0,  0],
+  [0] * 8,
+  [0] * 8,
+  [0] * 8,
+  [0] * 8,
+  [0] * 8
+]
+colors_double = [
+  [ 0,  0,  1,  1,  2,  2,  3,  3],
+  [ 0,  0,  1,  1,  2,  2,  3,  3],
+  [16, 16, 17, 17, 18, 18, 19, 19],
+  [16, 16, 17, 17, 18, 18, 19, 19],
+  [32, 32, 33, 33, 34, 34, 35, 35],
+  [32, 32, 33, 33, 34, 34, 35, 35],
+  [48, 48, 49, 49, 50, 50, 51, 51],
+  [48, 48, 49, 49, 50, 50, 51, 51],
+  [0] * 8
+]
+colors_mirrored = [
+  [ 0,  1,  2,  3,  3,  2,  1,  0],
+  [16, 17, 18, 19, 19, 18, 17, 16],
+  [32, 33, 34, 35, 35, 34, 33, 32],
+  [48, 49, 50, 51, 51, 50, 49, 48],
+  [48, 49, 50, 51, 51, 50, 49, 48],
+  [32, 33, 34, 35, 35, 34, 33, 32],
+  [16, 17, 18, 19, 19, 18, 17, 16],
+  [ 0,  1,  2,  3,  3,  2,  1,  0],
+  [0] * 8
+]
+
+# setup color display views
+def display_color_view(colors)
+  lambda do |interaction, action|
+    # set color
+    interaction.device.change_all(colors)
+    # register mute interactor on scene buttons
+    interaction.response_to(%w(scene1 scene2 scene3 scene4 scene5 scene6 scene7 scene8), :down, :exclusive => true, &@mute)
+  end
+end
+interaction.response_to(:up, :down, &display_color_view(colors_single + [48, 16, 16, 16]))
+interaction.response_to(:down, :down, &display_color_view(colors_double + [16, 48, 16, 16]))
+interaction.response_to(:left, :down, &display_color_view(colors_mirrored + [16, 16, 48, 16]))
+
+# setup color picker view
+def display_color(opts)
+  lambda do |interaction, action|
+    @red = opts[:red] if opts[:red]
+    @green = opts[:green] if opts[:green]
+    colors = [(@green * 16 + @red)] * 64
+    scenes = [@red == 3 ? 51 : 3, @red == 2 ? 51 : 2, @red == 1 ? 51 : 1, @red == 0 ? 51 : 0, @green == 3 ? 51 : 48, @green == 2 ? 51 : 32, @green == 1 ? 51 : 16, @green == 0 ? 51 : 0]
+    interaction.device.change_all(colors + scenes + [16, 16, 16, 48])
+  end
+end
+interaction.response_to(:right, :down) do |interaction, action|
+  @red = 0
+  @green = 0
+  # register color picker interactors on scene buttons
+  interaction.response_to(:scene1, :down, :exclusive => true, &display_color(:red => 3))
+  interaction.response_to(:scene2, :down, :exclusive => true, &display_color(:red => 2))
+  interaction.response_to(:scene3, :down, :exclusive => true, &display_color(:red => 1))
+  interaction.response_to(:scene4, :down, :exclusive => true, &display_color(:red => 0))
+  interaction.response_to(:scene5, :down, :exclusive => true, &display_color(:green => 3))
+  interaction.response_to(:scene6, :down, :exclusive => true, &display_color(:green => 2))
+  interaction.response_to(:scene7, :down, :exclusive => true, &display_color(:green => 1))
+  interaction.response_to(:scene8, :down, :exclusive => true, &display_color(:green => 0))
+  # display color
+  interaction.respond_to(:scene8, :down)
+end
+
+# mixer button terminates interaction on button up
+interaction.response_to(:mixer) do |interaction, action|
+  interaction.device.change(:mixer, :red => action[:state] == :down ? :hi : :off)
+  interaction.stop if action[:state] == :up
+end
+
+# setup mute display interactors on all unused buttons
+@mute = display_color_view([0] * 72 + [16, 16, 16, 16])
+interaction.response_to(%w(session user1 user2 grid), :down, &@mute)
+
+# display mute view
+interaction.respond_to(:session, :down)
+
+# start interacting
+interaction.start
+
+# sleep so that the messages can be sent before the program terminates
+sleep 0.1

data/examples/colors.rb

@@ -0,0 +1,27 @@
+require 'launchpad_mk2'
+
+device = Launchpad::Device.new(:input => false, :output => true)
+
+color = 0
+# first page of colors
+(0..7).each do |row|
+  (0..7).each do |column|
+    device.change :grid, :x => column, :y => row, :color => color
+    color = color + 1
+  end
+end
+
+sleep 2
+
+# second page of colors
+(0..7).each do |row|
+  (0..7).each do |column|
+    device.change :grid, :x => column, :y => row, :color => color
+    color = color + 1
+  end
+end
+
+# sleep so that the messages can be sent before the program terminates
+sleep 2
+
+device.reset_all()

data/examples/corners.rb

@@ -0,0 +1,11 @@
+require 'launchpad_mk2'
+
+device = Launchpad::Device.new(:input => false, :output => true)
+
+device.change :grid, :x => 0, :y => 0, :color => 56 # fuschia
+device.change :grid, :x => 7, :y => 7, :color => 63 # olive
+device.change :grid, :x => 0, :y => 7, :color => 72 # red
+device.change :grid, :x => 7, :y => 0, :color => 8  # orange
+
+# sleep so that the messages can be sent before the program terminates
+sleep 0.1

data/examples/doodle.rb

@@ -0,0 +1,65 @@
+require 'launchpad_mk2'
+
+interaction = Launchpad::Interaction.new
+
+current_color = {
+  :red    => :hi,
+  :green  => :hi,
+  :mode   => :normal
+}
+
+def update_scene_buttons(d, color)
+  on = {:red => :hi, :green => :hi}
+  d.change(:scene1, color[:red] == :hi ? on : {:red => :hi})
+  d.change(:scene2, color[:red] == :med ? on : {:red => :med})
+  d.change(:scene3, color[:red] == :lo ? on : {:red => :lo})
+  d.change(:scene4, color[:red] == :off ? on : {:red => :off})
+  d.change(:scene5, color[:green] == :hi ? on : {:green => :hi})
+  d.change(:scene6, color[:green] == :med ? on : {:green => :med})
+  d.change(:scene7, color[:green] == :lo ? on : {:green => :lo})
+  d.change(:scene8, color[:green] == :off ? on : {:green => :off})
+  d.change(:user1, :green => color[:mode] == :normal ? :lo : :hi, :mode => :flashing)
+  d.change(:user2, :green => color[:mode] == :normal ? :hi : :lo)
+end
+
+def choose_color(color, opts)
+  lambda do |interaction, action|
+    color.update(opts)
+    update_scene_buttons(interaction.device, color)
+  end
+end
+
+# register color picker interactors on scene buttons
+interaction.response_to(:scene1, :down, &choose_color(current_color, :red => :hi))
+interaction.response_to(:scene2, :down, &choose_color(current_color, :red => :med))
+interaction.response_to(:scene3, :down, &choose_color(current_color, :red => :lo))
+interaction.response_to(:scene4, :down, &choose_color(current_color, :red => :off))
+interaction.response_to(:scene5, :down, &choose_color(current_color, :green => :hi))
+interaction.response_to(:scene6, :down, &choose_color(current_color, :green => :med))
+interaction.response_to(:scene7, :down, &choose_color(current_color, :green => :lo))
+interaction.response_to(:scene8, :down, &choose_color(current_color, :green => :off))
+
+# register mode picker interactors on user buttons
+interaction.response_to(:user1, :down, &choose_color(current_color, :mode => :flashing))
+interaction.response_to(:user2, :down, &choose_color(current_color, :mode => :normal))
+
+# update scene buttons and start flashing
+update_scene_buttons(interaction.device, current_color)
+
+# feedback for grid buttons
+interaction.response_to(:grid, :down) do |interaction, action|
+  interaction.device.change(:grid, :x => action[:x], :y => action[:y], :color => current_color)
+end
+
+# mixer button terminates interaction on button up
+interaction.response_to(:mixer) do |interaction, action|
+  interaction.device.change(:mixer, :color => action[:state] == :down ? 5 : 61)
+  interaction.stop if action[:state] == :up
+  interaction.device.reset_all()
+end
+
+# start interacting
+interaction.start
+
+# sleep so that the messages can be sent before the program terminates
+sleep 0.1

data/examples/drawing_board.rb

@@ -0,0 +1,20 @@
+require 'launchpad_mk2'
+
+interaction = Launchpad::Interaction.new
+
+# yellow feedback for grid buttons
+interaction.response_to(:grid, :down) do |interaction, action|
+  interaction.device.change(:grid, :x => action[:x], :y => action[:y], :color => 13)
+end
+
+# mixer button terminates interaction on button up
+interaction.response_to(:mixer) do |interaction, action|
+  interaction.device.change(:mixer, :color => action[:state] == :down ? 5 : 61)
+  interaction.stop if action[:state] == :up
+end
+
+# start interacting
+interaction.start
+
+# sleep so that the messages can be sent before the program terminates
+sleep 0.1

data/examples/feedback.rb

@@ -0,0 +1,30 @@
+require 'launchpad_mk2'
+
+interaction = Launchpad::Interaction.new
+
+# yellow feedback for grid buttons
+interaction.response_to(:grid) do |interaction, action|
+  	interaction.device.change(:grid, :x => action[:x], :y => action[:y], :color => 72)
+end
+
+# red feedback for top control buttons
+interaction.response_to([:up, :down, :left, :right, :session, :user1, :user2, :mixer]) do |interaction, action|
+  interaction.device.change(action[:type], :color => 13)
+end
+
+# green feedback for scene buttons
+interaction.response_to([:scene1, :scene2, :scene3, :scene4, :scene5, :scene6, :scene7, :scene8]) do |interaction, action|
+  interaction.device.change(action[:type], :color => 16)
+end
+
+# mixer button terminates interaction on button up
+interaction.response_to(:mixer, :up) do |interaction, action|
+	interaction.device.reset_all()
+  interaction.stop
+end
+
+# start interacting
+interaction.start
+
+# sleep so that the messages can be sent before the program terminates
+sleep 0.1

data/examples/pong.rb

@@ -0,0 +1,193 @@
+require 'launchpad_mk2'
+
+interaction = Launchpad::Interaction.new
+
+UP = -1
+DOWN = 1
+
+@left_bottom_edge = @right_bottom_edge = 3
+@left_score = @right_score = 0
+
+def move_flipper(flipper, d, delta, column)
+	flipper = flipper + delta
+	if (flipper < 0 || flipper > 5)
+		return flipper - delta
+	end
+	show_flipper(d, column, flipper)
+
+	return flipper
+end
+
+def move_left_flipper(d, delta)
+	@left_bottom_edge = move_flipper(@left_bottom_edge, d, delta, 0)
+end
+
+def move_right_flipper(d, delta)
+	@right_bottom_edge = move_flipper(@right_bottom_edge, d, delta, 7)
+end
+
+def show_flipper(d, x, bottom_edge)
+	d.light1_column(x, 0)
+	d.change(:grid, :x => x, :y => bottom_edge, :color => 16)
+	d.change(:grid, :x => x, :y => bottom_edge + 1, :color => 16)
+	d.change(:grid, :x => x, :y => bottom_edge + 2, :color => 16)
+end
+
+# yellow feedback for grid buttons
+interaction.response_to(:grid, :down) do |interaction, action|
+	x = action[:x]
+	y = action[:y]
+	if (x == 0 && y == 0)
+		move_left_flipper(interaction.device, UP)
+	elsif (x == 0 && y == 7)
+		move_left_flipper(interaction.device, DOWN)
+	elsif (x == 7 && y == 0)
+		move_right_flipper(interaction.device, UP)
+	elsif (x == 7 && y == 7)
+		move_right_flipper(interaction.device, DOWN)
+	end
+end
+
+# red feedback for top control buttons
+interaction.response_to([:up, :down, :left, :right, :session, :user1, :user2, :mixer]) do |interaction, action|
+  interaction.device.change(action[:type], :color => 13)
+end
+
+# green feedback for scene buttons
+interaction.response_to([:scene1, :scene2, :scene3, :scene4, :scene5, :scene6, :scene7, :scene8]) do |interaction, action|
+  interaction.device.change(action[:type], :color => 16)
+end
+
+# mixer button terminates interaction on button up
+interaction.response_to(:mixer, :up) do |interaction, action|
+	interaction.device.reset_all()
+  interaction.stop
+end
+
+def hits_left_flipper?(new_ball_y)
+	new_ball_y >= @left_bottom_edge && new_ball_y <= @left_bottom_edge + 2
+end
+
+def hits_right_flipper?(new_ball_y)
+	new_ball_y >= @right_bottom_edge && new_ball_y <= @right_bottom_edge + 2
+end
+
+def update_scores(d)
+	puts "Left score: " + @left_score.to_s
+	puts "Right score: " + @right_score.to_s
+	if (@left_score > 0)
+		scene_button = (":scene" + @left_score.to_s).to_sym
+		puts scene_button
+		d.change(scene_button, :color => 72)
+	end
+	if (@right_score > 0)
+		scene_button = (":scene" + (9 - @right_score).to_s).to_sym
+		puts scene_button
+		d.change(scene_button, :color => 72)
+	end
+	if (@left_score == 4 || @right_score == 4)
+		@player_wins = true
+	end
+end
+
+def approaching_left_gutter?(new_ball_x)
+	new_ball_x < 1
+end
+
+def approaching_right_gutter?(new_ball_x)
+	new_ball_x > 6
+end
+
+def record_score(d)
+	update_scores(d)
+	hide_ball(d, @ball_x, @ball_y)
+end
+
+def record_right_score(d)
+	puts "Right score with ball at " + @ball_x.to_s + ", " + @ball_y.to_s + ", and left flipper at " + @left_bottom_edge.to_s
+	@right_score = @right_score + 1
+	record_score(d)
+end
+
+def record_left_score(d)
+	puts "Left score with ball at " + @ball_x.to_s + ", " + @ball_y.to_s + ", and right flipper at " + @right_bottom_edge.to_s
+	@left_score = @left_score + 1
+	record_score(d)
+end
+
+def bounce?(new_ball_y)
+	new_ball_y < 0 || new_ball_y > 7
+end
+
+def run_ball_movement(d) 
+	Thread.new {
+		@player_wins = false
+		until @player_wins do
+			new_score = false
+			start_ball(d)
+			until new_score do
+				sleep 0.5
+				if (approaching_left_gutter?(@ball_x + @lat_delta))
+					if (hits_left_flipper?(@ball_y + @lon_delta))
+						@lat_delta = -@lat_delta
+						move_ball(d, @ball_x + @lat_delta, @ball_y + @lon_delta)
+				else
+						record_right_score(d)
+						new_score = true
+					end
+				elsif (approaching_right_gutter?(@ball_x + @lat_delta))
+					if (hits_right_flipper?(@ball_y + @lon_delta))
+						@lat_delta = -@lat_delta
+						move_ball(d, @ball_x + @lat_delta, @ball_y + @lon_delta)
+					else
+						record_left_score(d)
+						new_score = true
+					end
+				end
+				if (!new_score)
+					if (bounce?(@ball_y + @lon_delta))
+						@lon_delta = -@lon_delta
+					end
+					move_ball(d, @ball_x + @lat_delta, @ball_y + @lon_delta)
+				end
+			end
+		end
+	}
+end
+
+def move_ball(d, new_ball_x, new_ball_y)
+	hide_ball(d, @ball_x, @ball_y)
+	@ball_x = new_ball_x
+	@ball_y = new_ball_y
+	show_ball(d, @ball_x, @ball_y)
+end
+
+def show_ball(d, x, y)
+	d.change(:grid, :x => x, :y => y, :color => 72)	
+end
+
+def hilite_collision(d, x, y)
+	d.change(:grid, :x => x, :y => y, :color => 34)	
+end
+
+def hide_ball(d, x, y)
+	d.change(:grid, :x => x, :y => y, :color => 0)	
+end
+
+def start_ball(d)
+	@lat_delta = rand(2) == 0 ? -1 : 1
+	@lon_delta = rand(2) == 0 ? -1 : 1
+	@ball_x = @lat_delta == -1 ? 4 : 3
+	@ball_y = @lon_delta == -1 ? 4 : 3
+	puts "Ball moving using " + @lat_delta.to_s + ", " + @lon_delta.to_s + " from " + @ball_x.to_s + ", " + @ball_y.to_s
+	show_ball(d, @ball_x, @ball_y)
+end
+
+show_flipper(interaction.device, 0, @left_bottom_edge)
+show_flipper(interaction.device, 7, @right_bottom_edge)
+run_ball_movement(interaction.device)
+# start interacting
+interaction.start
+
+# sleep so that the messages can be sent before the program terminates
+sleep 0.1