surface_master 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94debb23931c0d4acfc807e8c537442ebc4f34bf
-  data.tar.gz: bf26b6479e46056fd7ca580464cca8c2b9b98e80
+  metadata.gz: 186d651bbe04a8255ccc6d5d85b7faf13c7e1345
+  data.tar.gz: 1b4b9684879c2c01703301979ffba653e11811ea
 SHA512:
-  metadata.gz: af1db6281a6c2802bcdf177452788c047bbb59358db6d5695ce8b5020522d22859c7622d76444351bd394d9f565e76f58fa98cd1a3126f2448949b2794cd9621
-  data.tar.gz: d4ccfa6aed322a129725ba6600c643c398b121d34f1ab7e5e4937e2b67cf2f70193b0632eded87f0b017ef95a3e3f2b36d96db131d40ea7c18af79f8219bb50f
+  metadata.gz: ba465d6123b0d6c9547e31b13f548e03bf795c8b727c296e144651cce84d13d82f47d65cf94c58942245d23c688e06e4810569ed7c34c50d26ec4dd59835202f
+  data.tar.gz: 5d65cc3500a1e1cdf4b29c3114bd3561548b32ded2c2ac00726a1404b4a74f6c26693f83847fc25193efd5f3229df60045d81aaaa88060395c752bdf078511c9

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changes
 
+## v0.5.1
+
+* Log to stderr.
+* Fix for method privacy issue in `orbit_playground.rb`.
+* Improvements to logging of sysex requests in `Device` base class.
+
+
 ## v0.5.0
 
 * Make all addressing for Numark Orbit be zero-based.

data/examples/orbit_playground.rb

@@ -125,10 +125,10 @@ loop do
   indices.each do |i|
     MAPPINGS[i] = (MAPPINGS[i] + offset) % 0x3F
   end
-  device.sysex!(*MAPPINGS)
+  device.send(:sysex!, *MAPPINGS)
   if use_read
     sleep read_delay
-    device.sysex!(*READ_STATE)
+    device.send(:sysex!, *READ_STATE)
   end
   printf "."
   sleep delay

data/lib/surface_master/device.rb

@@ -50,14 +50,17 @@ module SurfaceMaster
     def sysex!(*payload)
       fail NoOutputAllowedError unless output_enabled?
       msg = sysex_msg(payload)
-      logger.debug { "#{msg.length}: 0x#{msg.map { |b| '%02X' % b }.join(' ')}" }
       result = @output.write_sysex(msg)
       if result != 0
-        puts "Sysex Error: #{Portmidi::PM_Map.Pm_GetErrorText(result)}"
+        logger.error { "Sysex Error: #{Portmidi::PM_Map.Pm_GetErrorText(result)}" }
       end
       result
     end
 
+    def format_msg(msg)
+      "0x#{msg.map { |b| '%02X' % b }.join(' ')} (len = #{msg.length})"
+    end
+
     def create_input_device(opts)
       return nil unless opts[:input]
       create_device(Portmidi.input_devices,

data/lib/surface_master/logging.rb

@@ -6,7 +6,7 @@ module SurfaceMaster
     #
     # Creates one if none was set.
     def logger
-      @logger ||= Logger.new(nil)
+      @logger ||= Logger.new(STDERR)
     end
 
     # Sets the logger to be used by the current instance.

data/lib/surface_master/orbit/device.rb

@@ -7,10 +7,12 @@ module SurfaceMaster
       def initialize(opts = nil)
         @name = "Numark ORBIT"
         super(opts)
-        reset!
+        init!
       end
 
-      def reset!
+      def reset!; end
+
+      def init!
         # Hack to get around apparent portmidi message truncation.
         return
 
@@ -18,48 +20,63 @@ module SurfaceMaster
         # 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]
+        # expected_state = MAPPINGS[1..-1]
         # sysex!(MAPPINGS)
         # sleep 0.1
         # sysex!(READ_STATE)
-        # current_state = nil
-        # started_at    = Time.now.to_f
-        # attempts      = 1
+        # current_state       = []
+        # started_at          = Time.now.to_f
+        # attempts            = 1
+        # state               = :looking_for_start
         # 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
+        #   raw = @input.read
+        #   unless raw
         #     elapsed = Time.now.to_f - started_at
         #     if elapsed > 4.0
-        #       logger.warn { "Timeout fetching state of Numark Orbit!" }
+        #       logger.error { "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)
+        #       logger.error { "Asking for current state of Numark Orbit again!" }
+        #       attempts     += 1
+        #       current_state = []
+        #       state         = :looking_for_start
+        #       sysex!(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." }
+        #   case state
+        #   when :looking_for_start
+        #     idx = raw.find_index { |ii| ii[:message][0] == 0xF0 }
+        #     if idx
+        #       state           = :looking_for_end
+        #       raw             = raw[idx..-1]
+        #       current_state  += raw.map { |ii| ii[:message] }.flatten
+        #     end
+        #   when :looking_for_end
+        #     idx = raw.find_index { |ii| ii[:message][0] == 0xF7 }
+        #     if idx
+        #       # TODO: Now what?
+        #       current_state = current_state[6..-1]
+        #       if expected_state != current_state
+        #         logger.error { "UH OH!  Numark Orbit state didn't match what we sent!" }
+        #         logger.error { "Expected: #{format_msg(expected_state)}" }
+        #         logger.error { "Got:      #{format_msg(current_state)}" }
+        #       else
+        #         logger.debug { "Your Numark Orbit should be in the right state now." }
+        #         return
+        #       end
+        #     else
+        #       idx = -1
+        #     end
+        #     raw             = raw[0..idx]
+        #     current_state  += raw.map { |ii| ii[:message] }.flatten
+        #   end
         # end
+
+        # logger.error { "Didn't get state from Numark Orbit!" }
       end
 
       def read
@@ -70,8 +87,13 @@ module SurfaceMaster
 
     protected
 
-      MAPPINGS =   [0x03, 0x01, 0x70,
+      MAPPINGS =   [0x03, # Command byte.
+
+                    # Some aspect of internal state I don't understand...
+                    0x01, 0x70,
 
+                    # Pad mappings.  (Channel, Note, Color) for banks 1-4.
+                    # These are addressed left-to-right, top-to-bottom.
                     0x00, 0x00, 0x00,
                     0x00, 0x04, 0x00,
                     0x00, 0x08, 0x00,
@@ -88,6 +110,7 @@ module SurfaceMaster
                     0x00, 0x07, 0x00,
                     0x00, 0x0B, 0x00,
                     0x00, 0x0F, 0x00,
+
                     0x01, 0x00, 0x00,
                     0x01, 0x04, 0x00,
                     0x01, 0x08, 0x00,
@@ -104,6 +127,7 @@ module SurfaceMaster
                     0x01, 0x07, 0x00,
                     0x01, 0x0B, 0x00,
                     0x01, 0x0F, 0x00,
+
                     0x02, 0x00, 0x00,
                     0x02, 0x04, 0x00,
                     0x02, 0x08, 0x00,
@@ -111,7 +135,7 @@ module SurfaceMaster
                     0x02, 0x01, 0x00,
                     0x02, 0x05, 0x00,
                     0x02, 0x09, 0x00,
-                    0x02, 0x0D, 0x00,
+                    0x02, 0x0D, 0x00, # After here is where shit goes sideways...
                     0x02, 0x02, 0x00,
                     0x02, 0x06, 0x00,
                     0x02, 0x0A, 0x00,
@@ -120,6 +144,7 @@ module SurfaceMaster
                     0x02, 0x07, 0x00,
                     0x02, 0x0B, 0x00,
                     0x02, 0x0F, 0x00,
+
                     0x03, 0x00, 0x00,
                     0x03, 0x04, 0x00,
                     0x03, 0x08, 0x00,
@@ -137,22 +162,42 @@ module SurfaceMaster
                     0x03, 0x0B, 0x00,
                     0x03, 0x0F, 0x00,
 
-                    0x00, 0x00, 0x01,
-                    0x00, 0x02, 0x00,
-                    0x03, 0x00, 0x00,
-                    0x01, 0x01, 0x01,
-                    0x02, 0x01, 0x03,
-                    0x01, 0x00, 0x02,
-                    0x01, 0x02, 0x02,
-                    0x02, 0x03, 0x02,
-                    0x00, 0x03, 0x01,
-                    0x03, 0x02, 0x03,
-                    0x03, 0x03, 0x0C,
-                    0x00, 0x0D, 0x00,
-                    0x0C, 0x00, 0x0D,
-                    0x00, 0x0C, 0x00,
-                    0x0D, 0x00, 0x0C,
-                    0x00, 0x0D, 0x00]
+                    # VKnob buttons, I think.  Ordered by bank, then vknob.
+                    # High nybble of first byte is 0x0 for abslute, 0x1 for
+                    # relative.  Low nybble is channel.  Second byte is CC.
+                    0x00, 0x00,
+                    0x01, 0x00,
+                    0x02, 0x00,
+                    0x03, 0x00,
+
+                    0x00, 0x01,
+                    0x01, 0x01,
+                    0x02, 0x01,
+                    0x03, 0x01,
+
+                    0x00, 0x02,
+                    0x01, 0x02,
+                    0x02, 0x02,
+                    0x03, 0x02,
+
+                    0x00, 0x03,
+                    0x01, 0x03,
+                    0x02, 0x03,
+                    0x03, 0x03,
+
+                    # Shoulder buttons.  Channel/CC pairs for left, then right
+                    # through each of the four banks.
+                    0x0C, 0x00,
+                    0x0D, 0x00,
+
+                    0x0C, 0x00,
+                    0x0D, 0x00,
+
+                    0x0C, 0x00,
+                    0x0D, 0x00,
+
+                    0x0C, 0x00,
+                    0x0D, 0x00]
       READ_STATE = [0x01, 0x00, 0x00]
 
       def sysex_prefix; @sysex_prefix ||= super + [0x00, 0x01, 0x3F, 0x2B]; end

data/lib/surface_master/version.rb

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

metadata

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