tinkerforge 2.0.13 → 2.1.0

data/lib/tinkerforge/bricklet_tilt.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-12-19.      #
+# This file was automatically generated on 2014-04-08.      #
 #                                                           #
-# Bindings Version 2.0.13                                    #
+# Bindings Version 2.1.0                                    #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
@@ -83,9 +83,8 @@ module Tinkerforge
     # 
     # The position can be 'a', 'b', 'c' or 'd'.
     # 
-    # The device identifiers can be found :ref:`here <device_identifier>`.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
+    # The device identifier numbers can be found :ref:`here <device_identifier>`.
+    # |device_identifier_constant|
     def get_identity
       send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
     end

data/lib/tinkerforge/bricklet_voltage.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-12-19.      #
+# This file was automatically generated on 2014-04-08.      #
 #                                                           #
-# Bindings Version 2.0.13                                    #
+# Bindings Version 2.1.0                                    #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
@@ -227,9 +227,8 @@ module Tinkerforge
     # 
     # The position can be 'a', 'b', 'c' or 'd'.
     # 
-    # The device identifiers can be found :ref:`here <device_identifier>`.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
+    # The device identifier numbers can be found :ref:`here <device_identifier>`.
+    # |device_identifier_constant|
     def get_identity
       send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
     end

data/lib/tinkerforge/bricklet_voltage_current.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-12-19.      #
+# This file was automatically generated on 2014-04-08.      #
 #                                                           #
-# Bindings Version 2.0.13                                    #
+# Bindings Version 2.1.0                                    #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
@@ -374,9 +374,8 @@ module Tinkerforge
     # 
     # The position can be 'a', 'b', 'c' or 'd'.
     # 
-    # The device identifiers can be found :ref:`here <device_identifier>`.
-    # 
-    # .. versionadded:: 2.0.0~(Plugin)
+    # The device identifier numbers can be found :ref:`here <device_identifier>`.
+    # |device_identifier_constant|
     def get_identity
       send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
     end

data/lib/tinkerforge/ip_connection.rb

@@ -1,12 +1,15 @@
 # -*- ruby encoding: utf-8 -*-
-# Copyright (C) 2012-2013 Matthias Bolte <matthias@tinkerforge.com>
+# Copyright (C) 2012-2014 Matthias Bolte <matthias@tinkerforge.com>
 #
 # Redistribution and use in source and binary forms of this file,
-# with or without modification, are permitted.
+# with or without modification, are permitted. See the Creative
+# Commons Zero (CC0 1.0) License for more details.
 
 require 'socket'
 require 'thread'
 require 'timeout'
+require 'securerandom'
+require 'openssl'
 
 module Tinkerforge
   class Base58
@@ -429,6 +432,31 @@ module Tinkerforge
     end
   end
 
+  # internal
+  class BrickDaemon < Device
+    FUNCTION_GET_AUTHENTICATION_NONCE = 1 # :nodoc:
+    FUNCTION_AUTHENTICATE = 2 # :nodoc:
+
+    # Creates an object with the unique device ID <tt>uid</tt> and adds it to
+    # the IP Connection <tt>ipcon</tt>.
+    def initialize(uid, ipcon)
+      super uid, ipcon
+
+      @api_version = [2, 0, 0]
+
+      @response_expected[FUNCTION_GET_AUTHENTICATION_NONCE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_AUTHENTICATE] = RESPONSE_EXPECTED_TRUE
+    end
+
+    def get_authentication_nonce
+      send_request(FUNCTION_GET_AUTHENTICATION_NONCE, [], '', 4, 'C4')
+    end
+
+    def authenticate(client_nonce, digest)
+      send_request(FUNCTION_AUTHENTICATE, [client_nonce, digest], 'C4 C20', 0, '')
+    end
+  end
+
   class IPConnection
     attr_accessor :devices
     attr_accessor :timeout
@@ -469,9 +497,12 @@ module Tinkerforge
       @auto_reconnect_allowed = false
       @auto_reconnect_pending = false
 
-      @next_sequence_number = 0
+      @next_sequence_number = 0 # protected by sequence_number_mutex
       @sequence_number_mutex = Mutex.new
 
+      @next_authentication_nonce = 0 # protected by authentication_mutex
+      @authentication_mutex = Mutex.new # protects authentication handshake
+
       @devices = {}
 
       @registered_callbacks = {}
@@ -491,6 +522,8 @@ module Tinkerforge
       @disconnect_probe_thread = nil # protected by socket_mutex
 
       @waiter_queue = Queue.new
+
+      @brickd = BrickDaemon.new '2', self
     end
 
     # Creates a TCP/IP connection to the given <tt>host</tt> and <tt>port</tt>.
@@ -551,6 +584,32 @@ module Tinkerforge
       end
     end
 
+    # Performs an authentication handshake with the connected Brick Daemon or
+    # WIFI/Ethernet Extension. If the handshake succeeds the connection switches
+    # from non-authenticated to authenticated state and communication can
+    # continue as normal. If the handshake fails then the connection gets closed.
+    # Authentication can fail if the wrong secret was used or if authentication
+    # is not enabled at all on the Brick Daemon or the WIFI/Ethernet Extension.
+    #
+    # For more information about authentication see
+    # http://www.tinkerforge.com/en/doc/Tutorials/Tutorial_Authentication/Tutorial.html
+    def authenticate(secret)
+      @authentication_mutex.synchronize {
+        if @next_authentication_nonce == 0
+          @next_authentication_nonce = SecureRandom.random_number(1 << 32)
+        end
+
+        server_nonce = @brickd.get_authentication_nonce
+        client_nonce = unpack(pack([@next_authentication_nonce], 'L'), 'C4')[0]
+        @next_authentication_nonce += 1
+        nonce_bytes = pack [server_nonce, client_nonce], 'C4 C4'
+        digest_bytes = OpenSSL::HMAC.digest 'sha1', secret, nonce_bytes
+        digest = unpack(digest_bytes, 'C20')[0]
+
+        @brickd.authenticate client_nonce, digest
+      }
+    end
+
     # Can return the following states:
     #
     # - CONNECTION_STATE_DISCONNECTED: No connection is established.
@@ -572,7 +631,7 @@ module Tinkerforge
     # the IP Connection will try to reconnect to the previously given
     # host and port, if the connection is lost.
     #
-    # Default value is *true*.
+    # Default value is <tt>true</tt>.
     def set_auto_reconnect(auto_reconnect)
       @auto_reconnect = auto_reconnect
 
@@ -666,6 +725,7 @@ module Tinkerforge
       [header, response_expected, sequence_number]
     end
 
+    # internal
     def send_request(request)
       @socket_mutex.synchronize {
         if @socket == nil
@@ -744,8 +804,8 @@ module Tinkerforge
         connect_reason = CONNECT_REASON_REQUEST
       end
 
-      @auto_reconnect_allowed = false;
-      @auto_reconnect_pending = false;
+      @auto_reconnect_allowed = false
+      @auto_reconnect_pending = false
 
       @callback.queue.push [QUEUE_KIND_META, [CALLBACK_CONNECTED,
                                               connect_reason, nil]]
@@ -812,6 +872,13 @@ module Tinkerforge
         rescue Errno::ECONNRESET
           handle_disconnect_by_peer DISCONNECT_REASON_SHUTDOWN, socket_id, false
           break
+        rescue Errno::ESHUTDOWN
+          # shutdown was called from disconnect_unlocked
+          break
+        end
+
+        if not @receive_flag
+          break
         end
 
         if data.length == 0

data/lib/tinkerforge/version.rb

@@ -1,4 +1,4 @@
 
 module Tinkerforge
-  VERSION = '2.0.13'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tinkerforge
 version: !ruby/object:Gem::Version
-  version: 2.0.13
+  version: 2.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-19 00:00:00.000000000 Z
+date: 2014-04-08 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: matthias@tinkerforge.com