surface_master 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3c8e66c72e0225a04e8fbe61bbffc2d477de6c6
-  data.tar.gz: c3ac84410c8799b5b345c9692f99ccd91ec562a6
+  metadata.gz: 94debb23931c0d4acfc807e8c537442ebc4f34bf
+  data.tar.gz: bf26b6479e46056fd7ca580464cca8c2b9b98e80
 SHA512:
-  metadata.gz: 03da9f7ecd866d2133fc46b57fa4ad295c46edbe93588c221ce73a8ca11d1d9a3e2de748872769fab960888219d2df3bac9c0e45ff245d864da1d2ced9e51a41
-  data.tar.gz: fcf81c4609204ffdcc882c68c4187f0992ba7f3d9f2a65f2c134798b34557cc74d63550f6f818364e33c6d8bc4070e84dece0480e41bf0c2ece55dfa74210917
+  metadata.gz: af1db6281a6c2802bcdf177452788c047bbb59358db6d5695ce8b5020522d22859c7622d76444351bd394d9f565e76f58fa98cd1a3126f2448949b2794cd9621
+  data.tar.gz: d4ccfa6aed322a129725ba6600c643c398b121d34f1ab7e5e4937e2b67cf2f70193b0632eded87f0b017ef95a3e3f2b36d96db131d40ea7c18af79f8219bb50f

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changes
 
+## v0.5.0
+
+* Make all addressing for Numark Orbit be zero-based.
+* Switch to grid addressing for Numark Orbit (backwards incompatible change!).
+
+
 ## v0.4.1
 
 * Add a simple driver for the TouchOSC Bridge.

data/examples/orbit_interaction.rb

@@ -7,17 +7,17 @@ require "surface_master"
 
 SurfaceMaster.init!
 interaction = SurfaceMaster::Orbit::Interaction.new
-interaction.response_to(:pad, :down) do |_inter, action|
+interaction.response_to(:grid, :down) do |_inter, action|
   puts "PAD DOWN: #{action.inspect}"
 end
-interaction.response_to(:pad, :up) do |_inter, action|
+interaction.response_to(:grid, :up) do |_inter, action|
   puts "PAD UP: #{action.inspect}"
 end
-interaction.response_to(:pad, :up, button: 1..4) do |_inter, action|
+interaction.response_to(:grid, :up, x: 0) do |_inter, action|
   puts "LEFT COLUMN PAD UP: #{action.inspect}"
 end
-interaction.response_to(:pad, :up, button: 5..8, bank: 4, exclusive: true) do |_inter, action|
-  puts "SECOND-FROM-LEFT COLUMN PAD UP: #{action.inspect}"
+interaction.response_to(:grid, :up, x: 1, y: 0..3, bank: 3, exclusive: true) do |_inter, action|
+  puts "SECOND-FROM-LEFT COLUMN, LAST BANK, PAD UP: #{action.inspect}"
 end
 
 interaction.response_to(:vknob, :update) do |_inter, action|
@@ -29,8 +29,8 @@ end
 interaction.response_to(:vknob, :update, bank: 2, exclusive: true) do |_inter, action|
   puts "ANY KNOB, BANK 2 TURNED: #{action.inspect}"
 end
-interaction.response_to(:vknob, :update, bank: 4, vknob: 1) do |_inter, action|
-  puts "KNOB 1, BANK 4 TURNED: #{action.inspect}"
+interaction.response_to(:vknob, :update, bank: 1, vknob: 1) do |_inter, action|
+  puts "KNOB 1, BANK 1 TURNED: #{action.inspect}"
 end
 
 interaction.response_to(:accelerometer, :tilt) do |_inter, action|

data/examples/orbit_playground.rb

@@ -26,8 +26,8 @@ device = SurfaceMaster::Orbit::Device.new
 # TODO: Can we safely get input simultaneously?
 MODE      = :wired
 
-CONFIGS   = { wireless: { delay: 0.75,  offset: 0x03, use_read: true,   read_delay: 0.1 },
-              wired:    { delay: 0.1,  offset: 0x01, use_read: false,  read_delay: 0 } }
+CONFIGS   = { wireless: { delay: 0.75, offset: 0x03, use_read: true,  read_delay: 0.1 },
+              wired:    { delay: 0.1,  offset: 0x01, use_read: false, read_delay: 0 } }
 MAPPINGS  =  [0x03, 0x01, 0x70,
 
               0x00, 0x00, 0x00,

data/lib/surface_master/interaction.rb

@@ -76,7 +76,7 @@ module SurfaceMaster
   protected
 
     def expand(list)
-      list.map { |ll| ll.respond_to?(:to_a) ? ll.to_a : ll }.flatten
+      Array(list).map { |ll| ll.respond_to?(:to_a) ? ll.to_a : ll }.flatten
     end
 
     def guard_input_and_reset_at_end!(&block)

data/lib/surface_master/orbit/device.rb

@@ -11,52 +11,55 @@ module SurfaceMaster
       end
 
       def reset!
+        # Hack to get around apparent portmidi message truncation.
+        return
+
         # Skip Sysex begin, vendor header, command code, aaaaand sysex end --
         # this will let us compare command vs. response payloads to determine
         # if the state of the device is what we want.  Of course, sometimes it
         # lies, but we can't do much about that.
-        expected_state = MAPPINGS[6..-2]
-        sysex!(MAPPINGS)
-        sleep 0.1
-        sysex!(READ_STATE)
-        current_state = nil
-        started_at    = Time.now.to_f
-        attempts      = 1
-        loop do
-          # TODO: It appears that accessing `buffer` is HIGHLY unsafe!  We may
-          # TODO: be OK if everyone's waiting on us to come back from this
-          # TODO: method before they begin clamoring for input, but that's just
-          # TODO: a guess right now.
-          if @input.buffer.length == 0
-            elapsed = Time.now.to_f - started_at
-            if elapsed > 4.0
-              logger.warn { "Timeout fetching state of Numark Orbit!" }
-              break
-            elsif elapsed > (1.0 * attempts)
-              logger.warn { "Asking for current state of Numark Orbit again!" }
-              attempts += 1
-              @output.puts(READ_STATE)
-              next
-            end
-            sleep 0.01
-            next
-          end
-          raw             = @input.gets
-          current_state   = raw.find { |ii| ii[:data][0] == 0xF0 }
-          break unless current_state.nil?
-        end
-
-        return unless current_state
-
-        current_state = current_state[:data][6..-2].dup
-        logger.debug { "Got state info from Numark Orbit!" }
-        if expected_state != current_state
-          logger.error { "UH OH!  Numark Orbit state didn't match what we sent!" }
-          logger.error { "Expected: #{expected_state.inspect}" }
-          logger.error { "Got:      #{current_state.inspect}" }
-        else
-          logger.debug { "Your Numark Orbit should be in the right state now." }
-        end
+        # expected_state = MAPPINGS[6..-2]
+        # sysex!(MAPPINGS)
+        # sleep 0.1
+        # sysex!(READ_STATE)
+        # current_state = nil
+        # started_at    = Time.now.to_f
+        # attempts      = 1
+        # loop do
+        #   # TODO: It appears that accessing `buffer` is HIGHLY unsafe!  We may
+        #   # TODO: be OK if everyone's waiting on us to come back from this
+        #   # TODO: method before they begin clamoring for input, but that's just
+        #   # TODO: a guess right now.
+        #   if @input.buffer.length == 0
+        #     elapsed = Time.now.to_f - started_at
+        #     if elapsed > 4.0
+        #       logger.warn { "Timeout fetching state of Numark Orbit!" }
+        #       break
+        #     elsif elapsed > (1.0 * attempts)
+        #       logger.warn { "Asking for current state of Numark Orbit again!" }
+        #       attempts += 1
+        #       @output.puts(READ_STATE)
+        #       next
+        #     end
+        #     sleep 0.01
+        #     next
+        #   end
+        #   raw             = @input.gets
+        #   current_state   = raw.find { |ii| ii[:data][0] == 0xF0 }
+        #   break unless current_state.nil?
+        # end
+
+        # return unless current_state
+
+        # current_state = current_state[:data][6..-2].dup
+        # logger.debug { "Got state info from Numark Orbit!" }
+        # if expected_state != current_state
+        #   logger.error { "UH OH!  Numark Orbit state didn't match what we sent!" }
+        #   logger.error { "Expected: #{expected_state.inspect}" }
+        #   logger.error { "Got:      #{current_state.inspect}" }
+        # else
+        #   logger.debug { "Your Numark Orbit should be in the right state now." }
+        # end
       end
 
       def read
@@ -159,13 +162,13 @@ module SurfaceMaster
         decoded
       end
 
-      def decode_pad(decoded, note, _velocity)
-        decoded[:control] = decoded[:control].merge(button: note + 1)
+      def decode_grid(decoded, note, _velocity)
+        decoded[:control] = decoded[:control].merge(x: note / 4, y: note % 4)
         decoded
       end
 
       def decode_knob(decoded, note, velocity)
-        decoded[:control] = decoded[:control].merge(bank: note + 1)
+        decoded[:control] = decoded[:control].merge(bank: note)
         decoded[:value]   = velocity
         decoded
       end
@@ -184,7 +187,7 @@ module SurfaceMaster
       def enrich_decoded_message(decoded, note, velocity, timestamp)
         case decoded[:type]
         when :shoulder      then decoded = decode_shoulder(decoded, note, velocity)
-        when :pad           then decoded = decode_pad(decoded, note, velocity)
+        when :grid          then decoded = decode_grid(decoded, note, velocity)
         when :vknob         then decoded = decode_knob(decoded, note, velocity)
         when :accelerometer then decoded = decode_accelerometer(decoded, note, velocity)
         else decoded = decode_control(decoded, note, velocity)

data/lib/surface_master/orbit/interaction.rb

@@ -9,6 +9,13 @@ module SurfaceMaster
 
     protected
 
+      def grid_range(range)
+        return [0..3] if range.nil?
+        Array(range).flatten.map do |pos|
+          pos.respond_to?(:to_a) ? pos.to_a : pos
+        end.flatten.uniq
+      end
+
       def combined_types(type, opts = nil)
         tmp = case type
               when :shoulder
@@ -16,19 +23,20 @@ module SurfaceMaster
               when :accelerometer
                 [:"#{type}-#{opts[:axis]}"]
               when :vknob
-                knobs = opts[:vknob].nil? ? [1..4] : [opts[:vknob]]
-                banks = opts[:bank].nil? ? [1..4] : [opts[:bank]]
+                knobs = opts[:vknob].nil? ? [0..3] : [opts[:vknob]]
+                banks = opts[:bank].nil? ? [0..3] : [opts[:bank]]
 
                 expand(knobs).product(expand(banks)).map { |k, b| :"#{type}-#{k}-#{b}" }
               when :vknobs, :banks
-                buttons = opts[:button].nil? ? [1..4] : [opts[:button]]
+                buttons = opts[:button].nil? ? [0..3] : [opts[:button]]
 
                 expand(buttons).map { |b| [:"#{type}-#{b}"] }
-              when :pad
-                banks   = opts[:bank].nil? ? [1..4] : [opts[:bank]]
-                buttons = opts[:button].nil? ? [1..16] : [opts[:button]]
-
-                expand(buttons).product(expand(banks)).map { |p, b| :"#{type}-#{p}-#{b}" }
+              when :grid
+                banks = expand(opts[:bank] || [0..3])
+                x     = expand(grid_range(opts[:x]))
+                y     = expand(grid_range(opts[:y]))
+                # return [:grid] if x.nil? && y.nil?  # whole grid
+                x.product(y).product(banks).map { |xx, (yy, b)| :"#{type}-#{xx}-#{yy}-#{b}" }
               else
                 [type]
               end
@@ -63,11 +71,28 @@ module SurfaceMaster
         combined_types  = combined_types(action[:type].to_sym, action[:control])
         state           = action[:state].to_sym
         actions         = []
+        if action[:type] == :grid
+          actions += mappings_for_grid_action(state, action[:control])
+        end
         actions        += combined_types.map { |ct| responses[ct][state] }
         actions        += responses[:all][state]
         actions.flatten.compact
       end
 
+      def mappings_for_grid_action(state, control)
+        x         = control[:x]
+        y         = control[:y]
+        bank      = control[:bank]
+        actions   = []
+        actions  += responses[:"grid-#{x}-#{y}-#{bank}"][state]
+        actions  += responses[:"grid-#{x}--#{bank}"][state]
+        actions  += responses[:"grid--#{y}-#{bank}"][state]
+        actions  += responses[:"grid-#{x}-#{y}-"][state]
+        actions  += responses[:"grid-#{x}--"][state]
+        actions  += responses[:"grid--#{y}-"][state]
+        actions
+      end
+
       def expand_states(state)
         case state
         when :both  then %i(down up)

data/lib/surface_master/orbit/midi_codes.rb

@@ -6,20 +6,20 @@ module SurfaceMaster
     module MIDICodes
       # TODO: Use a lib to do a deep-freeze.
       # rubocop:disable Metrics/LineLength
-      CONTROLS    = { 0x90 => { 0x00 => { type: :pad,           state: :down,    control: { bank: 1 } },
-                                0x01 => { type: :pad,           state: :down,    control: { bank: 2 } },
-                                0x02 => { type: :pad,           state: :down,    control: { bank: 3 } },
-                                0x03 => { type: :pad,           state: :down,    control: { bank: 4 } },
+      CONTROLS    = { 0x90 => { 0x00 => { type: :grid,          state: :down,    control: { bank: 0 } },
+                                0x01 => { type: :grid,          state: :down,    control: { bank: 1 } },
+                                0x02 => { type: :grid,          state: :down,    control: { bank: 2 } },
+                                0x03 => { type: :grid,          state: :down,    control: { bank: 3 } },
                                 0x0F => { type: :shoulder,      state: :down,    control: {} } },
-                      0x80 => { 0x00 => { type: :pad,           state: :up,      control: { bank: 1 } },
-                                0x01 => { type: :pad,           state: :up,      control: { bank: 2 } },
-                                0x02 => { type: :pad,           state: :up,      control: { bank: 3 } },
-                                0x03 => { type: :pad,           state: :up,      control: { bank: 4 } },
+                      0x80 => { 0x00 => { type: :grid,          state: :up,      control: { bank: 0 } },
+                                0x01 => { type: :grid,          state: :up,      control: { bank: 1 } },
+                                0x02 => { type: :grid,          state: :up,      control: { bank: 2 } },
+                                0x03 => { type: :grid,          state: :up,      control: { bank: 3 } },
                                 0x0F => { type: :shoulder,      state: :up,      control: {} } },
-                      0xB0 => { 0x00 => { type: :vknob,         state: :update,  control: { vknob: 1 } },
-                                0x01 => { type: :vknob,         state: :update,  control: { vknob: 2 } },
-                                0x02 => { type: :vknob,         state: :update,  control: { vknob: 3 } },
-                                0x03 => { type: :vknob,         state: :update,  control: { vknob: 4 } },
+                      0xB0 => { 0x00 => { type: :vknob,         state: :update,  control: { vknob: 0 } },
+                                0x01 => { type: :vknob,         state: :update,  control: { vknob: 1 } },
+                                0x02 => { type: :vknob,         state: :update,  control: { vknob: 2 } },
+                                0x03 => { type: :vknob,         state: :update,  control: { vknob: 3 } },
                                 0x0C => { type: :accelerometer, state: :tilt,    control: { axis: :x } },
                                 0x0D => { type: :accelerometer, state: :tilt,    control: { axis: :y } },
                                 0x0F => {                       state: :down } } }.freeze

data/lib/surface_master/touch_osc/device.rb

@@ -8,8 +8,7 @@ module SurfaceMaster
         @mapper = mapper || proc { |input| input }
       end
 
-      def reset!
-      end
+      def reset!; end
 
       def read
         super
@@ -20,10 +19,6 @@ module SurfaceMaster
       def write(messages)
         @output.write(Array(messages))
       end
-
-    protected
-
-      # def sysex_prefix; @sysex_prefix ||= super + []; end
     end
   end
 end

data/lib/surface_master/version.rb

@@ -1,4 +1,4 @@
 #
 module SurfaceMaster
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: surface_master
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Jon Frisby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-13 00:00:00.000000000 Z
+date: 2015-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: portmidi