tinkerforge 2.1.13 → 2.1.14

data/lib/tinkerforge/ip_connection.rb

@@ -52,156 +52,163 @@ module Tinkerforge
   class NotSupportedException < TinkerforgeException
   end
 
-  def pack(unpacked, format)
-    data = ''
-    format.split(' ').each do |f|
-      if f.length > 1
-        f0 = f[0, 1]
-        f1 = f[1..-1]
-        r = []
-
-        if f0 == '?'
-          n1 = (Integer(f1) / 8.0).ceil
-          r = Array.new(n1, 0)
-
-          unpacked[0].each_with_index do |b, i|
-            if b
-              r[i / 8] |= 1 << (i % 8)
+  class StreamOutOfSyncException < TinkerforgeException
+  end
+
+  class Packer
+    def self.pack(unpacked, format)
+      data = ''
+
+      format.split(' ').each do |f|
+        if f.length > 1
+          f0 = f[0, 1]
+          f1 = f[1..-1]
+          r = []
+
+          if f0 == '?'
+            n1 = (Integer(f1) / 8.0).ceil
+            r = Array.new(n1, 0)
+
+            unpacked[0].each_with_index do |b, i|
+              if b
+                r[i / 8] |= 1 << (i % 8)
+              end
             end
-          end
 
-          data += r.pack "C#{n1}"
-        elsif f0 == 'k'
-          unpacked[0].each { |c| r << c.ord }
-          data += r.pack "c#{f1}"
-        else
-          r = unpacked[0]
-          if ['s', 'S', 'l', 'L', 'q', 'Q'].count(f0) > 0
-            data += r.pack "#{f0}<#{f1}"
-          elsif f0 == 'Z'
-            data += [r].pack "#{f0}#{f1}"
+            data += r.pack "C#{n1}"
+          elsif f0 == 'k'
+            unpacked[0].each { |c| r << c.ord }
+            data += r.pack "c#{f1}"
           else
-            data += r.pack "#{f0}#{f1}"
+            r = unpacked[0]
+            if ['s', 'S', 'l', 'L', 'q', 'Q'].count(f0) > 0
+              data += r.pack "#{f0}<#{f1}"
+            elsif f0 == 'Z'
+              data += [r].pack "#{f0}#{f1}"
+            else
+              data += r.pack "#{f0}#{f1}"
+            end
           end
-        end
-      else
-        if f == '?'
-          r = [unpacked[0] ? 1 : 0]
-          data += r.pack 'C'
-        elsif f == 'k'
-          r = [unpacked[0].ord]
-          data += r.pack 'c'
         else
-          r = [unpacked[0]]
-          if ['s', 'S', 'l', 'L', 'q', 'Q'].count(f) > 0
-            data += r.pack "#{f}<"
+          if f == '?'
+            r = [unpacked[0] ? 1 : 0]
+            data += r.pack 'C'
+          elsif f == 'k'
+            r = [unpacked[0].ord]
+            data += r.pack 'c'
           else
-            data += r.pack f
+            r = [unpacked[0]]
+            if ['s', 'S', 'l', 'L', 'q', 'Q'].count(f) > 0
+              data += r.pack "#{f}<"
+            else
+              data += r.pack f
+            end
           end
         end
+
+        unpacked = unpacked.drop 1
       end
 
-      unpacked = unpacked.drop 1
+      data
     end
 
-    data
-  end
+    def self.unpack(data, format)
+      unpacked = []
 
-  def unpack(data, format)
-    unpacked = []
-    format.split(' ').each do |f|
-      if f.length > 1
-        f0 = f[0, 1]
-        f1 = f[1..-1]
-        u = []
-
-        if f0 == '?'
-          r = data.unpack "C#{f1}a*"
-          data = r[-1]
-          r.delete_at(-1)
-
-          for i in 0..Integer(f1) - 1
-            u << ((r[i / 8] & (1 << (i % 8))) != 0)
-          end
-        elsif f0 == 'k'
-          r = data.unpack "c#{f1}a*"
-          data = r[-1]
-          r.delete_at(-1)
-          r.each { |c| u << c.chr }
-        else
-          if ['s', 'S', 'l', 'L', 'q', 'Q'].count(f0) > 0
-            r = data.unpack "#{f}<a*"
+      format.split(' ').each do |f|
+        if f.length > 1
+          f0 = f[0, 1]
+          f1 = f[1..-1]
+          u = []
+
+          if f0 == '?'
+            r = data.unpack "C#{f1}a*"
+            data = r[-1]
+            r.delete_at(-1)
+
+            for i in 0..Integer(f1) - 1
+              u << ((r[i / 8] & (1 << (i % 8))) != 0)
+            end
+          elsif f0 == 'k'
+            r = data.unpack "c#{f1}a*"
+            data = r[-1]
+            r.delete_at(-1)
+            r.each { |c| u << c.chr }
           else
-            r = data.unpack "#{f}a*"
+            if ['s', 'S', 'l', 'L', 'q', 'Q'].count(f0) > 0
+              r = data.unpack "#{f}<a*"
+            else
+              r = data.unpack "#{f}a*"
+            end
+            data = r[-1]
+            r.delete_at(-1)
+            r.each { |k| u << k }
           end
-          data = r[-1]
-          r.delete_at(-1)
-          r.each { |k| u << k }
-        end
 
-        if u.length == 1
-          u = u[0]
-        end
+          if u.length == 1
+            u = u[0]
+          end
 
-        unpacked << u
-      else
-        r = []
-        u = nil
-
-        if f == '?'
-          r = data.unpack "Ca*"
-          u = r[0] != 0
-        elsif f == 'k'
-          r = data.unpack "ca*"
-          u = r[0].chr
+          unpacked << u
         else
-          if ['s', 'q', 'l', 'L', 'S', 'Q'].count(f) > 0
-            r = data.unpack "#{f}<a*"
+          r = []
+          u = nil
+
+          if f == '?'
+            r = data.unpack "Ca*"
+            u = r[0] != 0
+          elsif f == 'k'
+            r = data.unpack "ca*"
+            u = r[0].chr
           else
-            r = data.unpack "#{f}a*"
+            if ['s', 'q', 'l', 'L', 'S', 'Q'].count(f) > 0
+              r = data.unpack "#{f}<a*"
+            else
+              r = data.unpack "#{f}a*"
+            end
+            u = r[0]
           end
-          u = r[0]
-        end
 
-        data = r[1]
-        unpacked << u
+          data = r[1]
+          unpacked << u
+        end
       end
-    end
 
-    unpacked
-  end
+      unpacked
+    end
 
-  def get_uid_from_data(data)
-    data[0, 4].unpack('L<')[0]
-  end
+    def self.get_uid_from_data(data)
+      data[0, 4].unpack('L<')[0]
+    end
 
-  def get_length_from_data(data)
-    data[4, 1].unpack('C')[0]
-  end
+    def self.get_length_from_data(data)
+      data[4, 1].unpack('C')[0]
+    end
 
-  def get_function_id_from_data(data)
-    data[5, 1].unpack('C')[0]
-  end
+    def self.get_function_id_from_data(data)
+      data[5, 1].unpack('C')[0]
+    end
 
-  def get_sequence_number_from_data(data)
-    (data[6, 1].unpack('C')[0] >> 4) & 0x0F
-  end
+    def self.get_sequence_number_from_data(data)
+      (data[6, 1].unpack('C')[0] >> 4) & 0x0F
+    end
 
-  def get_error_code_from_data(data)
-    (data[7, 1].unpack('C')[0] >> 6) & 0x03
+    def self.get_error_code_from_data(data)
+      (data[7, 1].unpack('C')[0] >> 6) & 0x03
+    end
   end
 
   class Device
     RESPONSE_EXPECTED_INVALID_FUNCTION_ID = 0
     RESPONSE_EXPECTED_ALWAYS_TRUE = 1 # getter
-    RESPONSE_EXPECTED_ALWAYS_FALSE = 2 # callback
-    RESPONSE_EXPECTED_TRUE = 3 # setter
-    RESPONSE_EXPECTED_FALSE = 4 # setter, default
+    RESPONSE_EXPECTED_TRUE = 2 # setter
+    RESPONSE_EXPECTED_FALSE = 3 # setter, default
 
     attr_accessor :uid
     attr_accessor :expected_response_function_id
     attr_accessor :expected_response_sequence_number
     attr_accessor :callback_formats
+    attr_accessor :high_level_callbacks
     attr_accessor :registered_callbacks
 
     # Creates the device object with the unique device ID <tt>uid</tt> and adds
@@ -228,8 +235,6 @@ module Tinkerforge
       @request_mutex = Mutex.new
 
       @response_expected = Array.new(256, RESPONSE_EXPECTED_INVALID_FUNCTION_ID)
-      @response_expected[IPConnection::FUNCTION_ENUMERATE] = RESPONSE_EXPECTED_ALWAYS_FALSE
-      @response_expected[IPConnection::CALLBACK_ENUMERATE] = RESPONSE_EXPECTED_ALWAYS_FALSE
 
       @expected_response_function_id = 0
       @expected_response_sequence_number = 0
@@ -238,7 +243,10 @@ module Tinkerforge
       @response_condition = ConditionVariable.new
       @response_queue = Queue.new
 
+      @stream_mutex = Mutex.new
+
       @callback_formats = {}
+      @high_level_callbacks = {}
       @registered_callbacks = {}
 
       @ipcon.devices[@uid] = self # FIXME: use a weakref here
@@ -287,8 +295,7 @@ module Tinkerforge
     # Changes the response expected flag of the function specified by the
     # <tt>function_id</tt> parameter. This flag can only be changed for setter
     # (default value: <tt>false</tt>) and callback configuration functions
-    # (default value: <tt>true</tt>). For getter functions it is always enabled
-    # and callbacks it is always disabled.
+    # (default value: <tt>true</tt>). For getter functions it is always enabled.
     #
     # Enabling the response expected flag for a setter function allows to
     # detect timeouts and other error conditions calls of this setter as
@@ -306,8 +313,7 @@ module Tinkerforge
         raise ArgumentError, "Invalid function ID #{function_id}"
       end
 
-      if flag == RESPONSE_EXPECTED_ALWAYS_TRUE or \
-         flag == RESPONSE_EXPECTED_ALWAYS_FALSE
+      if flag == RESPONSE_EXPECTED_ALWAYS_TRUE
         raise ArgumentError, "Response Expected flag cannot be changed for function ID #{function_id}"
       end
 
@@ -341,7 +347,7 @@ module Tinkerforge
       response = nil
 
       if request_data.length > 0
-        payload = pack request_data, request_format
+        payload = Packer.pack request_data, request_format
       else
         payload = ''
       end
@@ -363,8 +369,8 @@ module Tinkerforge
             while true
               packet = dequeue_response "Did not receive response in time for function ID #{function_id}"
 
-              if function_id == get_function_id_from_data(packet) and \
-                 sequence_number == get_sequence_number_from_data(packet)
+              if function_id == Packer.get_function_id_from_data(packet) and \
+                 sequence_number == Packer.get_sequence_number_from_data(packet)
                 # ignore old responses that arrived after the timeout expired, but before setting
                 # expected_response_function_id and expected_response_sequence_number back to None
                 break
@@ -376,7 +382,7 @@ module Tinkerforge
           end
         }
 
-        error_code = get_error_code_from_data(packet)
+        error_code = Packer.get_error_code_from_data packet
 
         if error_code == 0
           # no error
@@ -389,7 +395,7 @@ module Tinkerforge
         end
 
         if response_length > 0
-          response = unpack packet[8..-1], response_format
+          response = Packer.unpack packet[8..-1], response_format
 
           if response.length == 1
             response = response[0]
@@ -460,11 +466,11 @@ module Tinkerforge
     end
 
     def get_authentication_nonce
-      send_request(FUNCTION_GET_AUTHENTICATION_NONCE, [], '', 4, 'C4')
+      send_request FUNCTION_GET_AUTHENTICATION_NONCE, [], '', 4, 'C4'
     end
 
     def authenticate(client_nonce, digest)
-      send_request(FUNCTION_AUTHENTICATE, [client_nonce, digest], 'C4 C20', 0, '')
+      send_request FUNCTION_AUTHENTICATE, [client_nonce, digest], 'C4 C20', 0, ''
     end
   end
 
@@ -611,11 +617,11 @@ module Tinkerforge
         end
 
         server_nonce = @brickd.get_authentication_nonce
-        client_nonce = unpack(pack([@next_authentication_nonce], 'L'), 'C4')[0]
+        client_nonce = Packer.unpack(Packer.pack([@next_authentication_nonce], 'L'), 'C4')[0]
         @next_authentication_nonce += 1
-        nonce_bytes = pack [server_nonce, client_nonce], 'C4 C4'
+        nonce_bytes = Packer.pack [server_nonce, client_nonce], 'C4 C4'
         digest_bytes = OpenSSL::HMAC.digest 'sha1', secret, nonce_bytes
-        digest = unpack(digest_bytes, 'C20')[0]
+        digest = Packer.unpack(digest_bytes, 'C20')[0]
 
         @brickd.authenticate client_nonce, digest
       }
@@ -731,7 +737,7 @@ module Tinkerforge
       end
 
       sequence_number_and_options = (sequence_number << 4) | (r_bit << 3)
-      header = pack [uid, length, function_id, sequence_number_and_options, 0], 'L C C C C'
+      header = Packer.pack [uid, length, function_id, sequence_number_and_options, 0], 'L C C C C'
 
       [header, response_expected, sequence_number]
     end
@@ -907,7 +913,7 @@ module Tinkerforge
             break
           end
 
-          length = get_length_from_data pending_data
+          length = Packer.get_length_from_data pending_data
 
           if pending_data.length < length
             # Wait for complete packet
@@ -989,18 +995,80 @@ module Tinkerforge
 
     # internal
     def dispatch_packet(packet)
-      uid = get_uid_from_data packet
-      function_id = get_function_id_from_data packet
+      uid = Packer.get_uid_from_data packet
+      function_id = Packer.get_function_id_from_data packet
 
       if function_id == CALLBACK_ENUMERATE and \
          @registered_callbacks.has_key? CALLBACK_ENUMERATE
-        payload = unpack packet[8..-1], 'Z8 Z8 k C3 C3 S C'
+        payload = Packer.unpack packet[8..-1], 'Z8 Z8 k C3 C3 S C'
         @registered_callbacks[CALLBACK_ENUMERATE].call(*payload)
       elsif @devices.has_key? uid
         device = @devices[uid]
 
+        if device.high_level_callbacks.has_key?(-function_id)
+          hlcb = device.high_level_callbacks[-function_id] # [roles, options, data]
+          payload = Packer.unpack packet[8..-1], device.callback_formats[function_id]
+          has_data = false
+          data = nil
+
+          if hlcb[1]['fixed_length'] != nil
+            length = hlcb[1]['fixed_length']
+          else
+            length = payload[hlcb[0].index 'stream_length']
+          end
+
+          if not hlcb[1]['single_chunk']
+            chunk_offset = payload[hlcb[0].index 'stream_chunk_offset']
+          else
+            chunk_offset = 0
+          end
+
+          chunk_data = payload[hlcb[0].index 'stream_chunk_data']
+
+          if hlcb[2] == nil # no stream in-progress
+            if chunk_offset == 0 # stream starts
+              hlcb[2] = chunk_data
+
+              if hlcb[2].length >= length # stream complete
+                has_data = true
+                data = hlcb[2][0, length]
+                hlcb[2] = nil
+              else # ignore tail of current stream, wait for next stream start
+              end
+            else # stream in-progress
+              if chunk_offset != hlcb[2].length # stream out-of-sync
+                has_data = true
+                data = nil
+                hlcb[2] = nil
+              else # stream in-sync
+                hlcb[2] += chunk_data
+
+                if hlcb[2].length >= length # stream complete
+                  has_data = true
+                  data = hlcb[2][0, length]
+                  hlcb[2] = nil
+                end
+              end
+            end
+
+            if has_data and device.registered_callbacks.has_key?(-function_id)
+              result = []
+
+              hlcb[0].zip(payload).each do |role, value|
+                if role == 'stream_chunk_data'
+                  result << data
+                elsif role == nil
+                  result << value
+                end
+              end
+
+              device.registered_callbacks[-function_id].call(*result)
+            end
+          end
+        end
+
         if device.registered_callbacks.has_key? function_id
-          payload = unpack packet[8..-1], device.callback_formats[function_id]
+          payload = Packer.unpack packet[8..-1], device.callback_formats[function_id]
           device.registered_callbacks[function_id].call(*payload)
         end
       end
@@ -1084,9 +1152,9 @@ module Tinkerforge
     def handle_response(packet)
       @disconnect_probe_flag = false
 
-      uid = get_uid_from_data packet
-      function_id = get_function_id_from_data packet
-      sequence_number = get_sequence_number_from_data packet
+      uid = Packer.get_uid_from_data packet
+      function_id = Packer.get_function_id_from_data packet
+      sequence_number = Packer.get_sequence_number_from_data packet
 
       if sequence_number == 0 and function_id == CALLBACK_ENUMERATE
         if @registered_callbacks.has_key? CALLBACK_ENUMERATE
@@ -1096,7 +1164,8 @@ module Tinkerforge
         device = @devices[uid]
 
         if sequence_number == 0
-          if device.registered_callbacks.has_key? function_id
+          if device.registered_callbacks.has_key? function_id or \
+             device.high_level_callbacks.has_key?(-function_id)
             @callback.queue.push [QUEUE_KIND_PACKET, packet]
           end
         elsif device.expected_response_function_id == function_id and \

data/lib/tinkerforge/version.rb

@@ -1,4 +1,4 @@
 
 module Tinkerforge
-  VERSION = '2.1.13'
+  VERSION = '2.1.14'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tinkerforge
 version: !ruby/object:Gem::Version
-  version: 2.1.13
+  version: 2.1.14
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-07-27 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: matthias@tinkerforge.com
@@ -78,6 +78,7 @@ files:
 - lib/tinkerforge/bricklet_temperature_ir.rb
 - lib/tinkerforge/bricklet_dual_button.rb
 - lib/tinkerforge/brick_silent_stepper.rb
+- lib/tinkerforge/bricklet_rs485.rb
 - lib/tinkerforge/bricklet_load_cell.rb
 - lib/tinkerforge/bricklet_segment_display_4x7.rb
 - lib/tinkerforge/bricklet_distance_us.rb