tinderfridge 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2805da1fbb45d1938cde253637d7a66119718191692caf44ceb22f5d684ed58a
-  data.tar.gz: 5e3dbb8a81b3a5f59975a0b4ef4f1c5cbaa76e97d1fc6d9034cd14edc0f0371b
+  metadata.gz: a5370c2b6210bbb986208ce2afc7f6ce9573592b7707bf14a8bc371ffb47050c
+  data.tar.gz: 79338d5081d87b1aff9402eaf656be89ed5a50c52f59f597c68a84e9462ccdd4
 SHA512:
-  metadata.gz: e5d86b78c3c4351b63d9bcbad1032a661d6fdd9b00457a59deaed677d358577781fdc2809ebe7f8a7c762c77638685d601349bb2065930e9f5dad8232ae61a2f
-  data.tar.gz: bc3e28b83f1704169827b0a4650e1f5a360714d70e5f153e62e4428f33360821e2514e31a10ff089cdfa4955225656106b26e314b03d6b24cdf91fe7190014a9
+  metadata.gz: c0077e242170d67d5c8ffdc63efd702183865d2e475c4be0c0f93bc4bf33aff1c313838a96ade44255245c320057e5369133d860fd5755b585f0fa92f1ae823c
+  data.tar.gz: 3a98205cf201dd8df8ca95378ad1bb82fa41af517f2f8b87a910f4f43b7753344ea0538d90aab6015fd3b8d16d2627b3ef24167380457601cf20f7aae19addfe

data/lib/tinderfridge/device.rb

@@ -1,4 +1,5 @@
 require 'tinkerforge/ip_connection'
+require 'tinderfridge/shared/logger'
 
 module Tinkerforge
 
@@ -56,6 +57,8 @@ module Tinkerforge
     #                           Instance Methods                           #
     #----------------------------------------------------------------------#
 
+    include Tinkerforge::Shared::Logger
+
     # Returns the device's UID. Not to be confused with #uid, which returns the numeric UID.
     attr_reader :uid_string
 
@@ -68,6 +71,15 @@ module Tinkerforge
     # Returns the device's IPConnection object.
     attr_reader :ipcon
 
+    alias original_initialize initialize
+
+    def initialize(uid, ipcon, device_identifier, device_display_name)
+      original_initialize(uid, ipcon, device_identifier, device_display_name)
+      if respond_to? 'get_identity'
+        logger_debug "Created %s '%s'" % [self.class, uid_string]
+      end
+    end
+
     # Returns device information.
     #
     # Device information is an array:
@@ -80,7 +92,7 @@ module Tinkerforge
 
     # Returns a programmer-friendly representation of the device.
     def inspect
-      "%s (%s@%s:%s)" % [self.class, uid_string, ipcon.host, ipcon.port]
+      "#{self.class} (#{uid_string}" + ( ipcon.host ? "@#{ipcon.host}:#{ipcon.port})" : ')' )
     end
 
     # Returns the device's properties.
@@ -127,6 +139,12 @@ module Tinkerforge
       @config ||= {}
     end
 
+    # Sets configuration data (a Hash) for the device.
+    def config=(configuration)
+      raise(ArgumentError, 'Invalid configuration') unless configuration.class == Hash
+      @config = configuration
+    end
+
     # Opens the online documentation for the device (Mac OS only).
     #
     # When the URL for the documentation is not known, does nothing.

data/lib/tinderfridge/device_collection.rb

@@ -82,6 +82,16 @@ module Tinkerforge
       smap 'config'
     end
 
+    # Sets configuration data of devices in the collection.
+    def config=(configuration)
+      raise ArgumentError, 'invalid configuration' unless (configuration.class == Hash)
+      each do |k,v|
+        if configuration[k]
+          v.config = configuration[k]
+        end
+      end
+    end
+
     # Opens the online documentation for the devices in the collection (Mac OS only).
     #
     # When the URL for a device's documentation is not known, does nothing.
@@ -115,6 +125,11 @@ module Tinkerforge
       smap('ipcon').values.compact.uniq
     end
 
+    # Disconnects IP Connections used by devices in the collection.
+    def disconnect
+      ipcons.map { |i| [i, (i.get_connection_state == 0 ? nil : i.disconnect) ] }.to_h
+    end
+
     # Returns an array of devices in the collection matching the selector.
     #
     # Selector argument can be:

data/lib/tinderfridge/ip_connection.rb

@@ -1,9 +1,12 @@
 require 'tinkerforge/ip_connection'
+require 'tinderfridge/shared/logger'
 
 module Tinkerforge
 
   class IPConnection
 
+    include Tinkerforge::Shared::Logger
+
     # Returns the host for the IP Connection.
     attr_reader :host
 
@@ -15,7 +18,7 @@ module Tinkerforge
 
     # Returns a programmer-friendly representation of the object.
     def inspect
-      "%s (%s:%s)" % [self.class, host, port]
+      "#{self.class} (%s:%s)" % (host ? [host, port] : ['-', '-'] )
     end
 
     # Returns the state of the IP Connection.
@@ -86,6 +89,7 @@ module Tinkerforge
       list = Tinkerforge::DeviceCollection.new
 
       self.register_callback(CALLBACK_ENUMERATE) do |*args|
+        logger_log_enum(args)
         case args[6]
           when 0, 1
             unless list.key?(args[0])
@@ -95,8 +99,6 @@ module Tinkerforge
             end
           when 2
             list.delete args[0]
-          else
-            raise "Unknown Enumeration Type: #{args[6]}"
         end
       end
 
@@ -112,7 +114,7 @@ module Tinkerforge
     #
     # Requires Brick Viewer version 2.4.23 or later.
     def open_brick_viewer
-      if RUBY_PLATFORM =~ /darwin/
+      if host and (RUBY_PLATFORM =~ /darwin/)
         `open -n -a Brickv --args #{host} --port #{port}`
         "#{host}:#{port}"
       end
@@ -128,11 +130,19 @@ module Tinkerforge
         require "tinkerforge/#{dev_info[2][1]}"
         Tinkerforge.const_get(dev_info[2][0]).new enum_data[0], self
       else
-        warn "Unknown Device Identifier: #{enum_data[5]} (UID: #{enum_data[0]})"
+        logger_warn "Unknown Device Identifier: #{enum_data[5]} (UID: #{enum_data[0]})"
         nil
       end
     end
 
+    def logger_log_enum(enum_data)
+      logger_debug(
+        "Device '#{enum_data[0]}' " +
+        ['available', 'connected', 'disconnected'][enum_data[6]] +
+        ( enum_data[6] == 2 ? '' : " (Device Identifier: #{enum_data[5]})" )
+      )
+    end
+
   end
 
 

data/lib/tinderfridge/shared/logger.rb

@@ -0,0 +1,51 @@
+module Tinkerforge
+
+  module Shared
+
+    # Mixin for event logging to a Logger instance.
+    #
+    # Logger is part of the Ruby Standard Library:
+    # - https://docs.ruby-lang.org/en/master/Logger.html
+    module Logger
+
+      private
+
+      def logger
+        Tinkerforge.logger
+      end
+
+      def logger_debug(msg)
+        if logger
+          logger.debug(msg)
+        end
+      end
+
+      def logger_info(msg)
+        if logger
+          logger.info(msg)
+        end
+      end
+
+      def logger_warn(msg)
+        if logger
+          logger.warn(msg)
+        end
+      end
+
+      def logger_error(msg)
+        if logger
+          logger.error(msg)
+        end
+      end
+
+      def logger_fatal(msg)
+        if logger
+          logger.fatal(msg)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/tinderfridge/tinkerforge.rb

@@ -7,6 +7,8 @@ module Tinkerforge
 
   class << self
 
+    @@logger = nil
+
     # Returns the directory where Tinkerforge bindings appear to be installed.
     def lib_dir
       File.dirname File.dirname Device.instance_method('uid').source_location.first
@@ -30,6 +32,25 @@ module Tinkerforge
       connect('localhost', port).discover(0.25)
     end
 
+    # Assign a Logger object to enable logging of Tinkerforge events.
+    def logger=(logger)
+      if logger
+        if logger.respond_to? :debug
+          @@logger = logger
+          logger.debug(about)
+        else
+          raise ArgumentError, 'Invalid Logger'
+        end
+      else
+        @@logger = nil
+      end
+    end
+
+    # Returns the Logger, or nil
+    def logger
+      @@logger
+    end
+
     private
 
     def _view_21x8

data/lib/tinderfridge/version.rb

@@ -3,7 +3,7 @@ require 'tinkerforge/version'
 module Tinkerforge
 
   # Tinderfridge version.
-  TINDERFRIDGE_VERSION = '0.13.0'
+  TINDERFRIDGE_VERSION = '0.14.0'
 
   # About Tinkerforge & Tinderfridge.
   def self.about

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tinderfridge
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - lllist.eu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-21 00:00:00.000000000 Z
+date: 2023-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tinkerforge
@@ -156,6 +156,7 @@ files:
 - lib/tinderfridge/devices/bricklet_xmc1400_breakout/bricklet_xmc1400_breakout.json
 - lib/tinderfridge/ip_connection.rb
 - lib/tinderfridge/shared/display_ibm437_encoding.rb
+- lib/tinderfridge/shared/logger.rb
 - lib/tinderfridge/tinkerforge.rb
 - lib/tinderfridge/version.rb
 homepage: https://github.com/lllisteu/tinderfridge