tinderfridge 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2805da1fbb45d1938cde253637d7a66119718191692caf44ceb22f5d684ed58a
-  data.tar.gz: 5e3dbb8a81b3a5f59975a0b4ef4f1c5cbaa76e97d1fc6d9034cd14edc0f0371b
+  metadata.gz: d3c51a0740fb7714bbb9012543195df2539e310653510dfd6f6b4972aaf4b7dd
+  data.tar.gz: d02f24ea04041305ac5cc7b40c73e651451bca9caff08be1476bc592ac9fe56b
 SHA512:
-  metadata.gz: e5d86b78c3c4351b63d9bcbad1032a661d6fdd9b00457a59deaed677d358577781fdc2809ebe7f8a7c762c77638685d601349bb2065930e9f5dad8232ae61a2f
-  data.tar.gz: bc3e28b83f1704169827b0a4650e1f5a360714d70e5f153e62e4428f33360821e2514e31a10ff089cdfa4955225656106b26e314b03d6b24cdf91fe7190014a9
+  metadata.gz: 8d8e2423d20924eb5bcb96083268c337d3dbbb571f395d1d6861ce39de4f2391784de84674b59875fea61a0dc9aca7085aa41c7a7274362394582a6453d5cf5a
+  data.tar.gz: 838806023856f1f566b4f49ce73b04ff6d1bae47b395e7b7d089ee288e1ed0ad85396fda76d7401866dea848b0288fd6be4a6cc1a8e306c0a11a192f09582445

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,15 +92,22 @@ 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.
     def properties
-      @properties ||= {
-        'device_identifier'   => device_identifier,
-        'device_display_name' => device_display_name,
-      }.merge load_properties
+
+      # BrickDaemon inherits from Device, but has no #get_identity.
+      return {} unless respond_to? 'get_identity'
+
+      identity = get_identity
+
+      @properties ||= [
+        [ 'device_identifier'  , device_identifier     ],
+        [ 'device_display_name', device_display_name   ],
+        [ 'hardware_version'   , identity[3].join('.') ],
+      ].compact.to_h.merge load_properties
     end
 
     alias props properties
@@ -127,6 +146,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

@@ -2,6 +2,8 @@ module Tinkerforge
 
   class DeviceCollection < Hash
 
+    alias devices values
+
     # Returns the temperatures as measured inside the microcontrollers of devices in the collection.
     #
     # Nil for devices that do not support the get_chip_temperature method.
@@ -82,6 +84,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 +127,13 @@ module Tinkerforge
       smap('ipcon').values.compact.uniq
     end
 
+    # Disconnects IP Connections used by devices in the collection, and removes all devices from the collection.
+    def disconnect
+      result = ipcons.map { |i| [i, (i.get_connection_state == 0 ? nil : i.disconnect) ] }.to_h
+      clear
+      result
+    end
+
     # Returns an array of devices in the collection matching the selector.
     #
     # Selector argument can be:

data/lib/tinderfridge/devices/brick_master/brick_master.rb

@@ -6,6 +6,55 @@ module Tinkerforge
     CHIP_TEMPERATURE_UNIT = 0.1
     # REVIEW: This should ideally be part of base Tinkerforge.
 
+    # Returns the device's state.
+    def state
+      super.merge [
+        safe_send_state('connection_type'   , 'get_connection_type'  ), # FW 2.4.0
+        safe_send_state('status_led_enabled', 'is_status_led_enabled'), # FW 2.3.2
+        safe_send_state('chibi_present'     , 'is_chibi_present'     ),
+        safe_send_state('rs485_present'     , 'is_rs485_present'     ),
+        safe_send_state('ethernet_present'  , 'is_ethernet_present'  ), # FW 2.1.0
+        safe_send_state('wifi_present'      , 'is_wifi_present'      ),
+        safe_send_state('wifi2_present'     , 'is_wifi2_present'     ), # FW 2.4.0
+      ].compact.to_h
+    end
+
+    # Returns the state of the WIFI Extension 2.0.
+    def wifi2_state
+      if is_wifi2_present
+        [
+          safe_send_state('mesh_configuration'  , 'get_wifi2_mesh_configuration'  ), # FW 2.4.2 / 2.1.0
+          safe_send_state('mesh_router_ssid'    , 'get_wifi2_mesh_router_ssid'    ), # FW 2.4.2 / 2.1.0
+          safe_send_state('mesh_common_status'  , 'get_wifi2_mesh_common_status'  ), # FW 2.4.2 / 2.1.0
+          safe_send_state('mesh_client_status'  , 'get_wifi2_mesh_client_status'  ), # FW 2.4.2 / 2.1.0
+          safe_send_state('mesh_ap_status'      , 'get_wifi2_mesh_ap_status'      ), # FW 2.4.2 / 2.1.0
+          safe_send_state('configuration'       , 'get_wifi2_configuration'       ), # FW 2.4.0
+          safe_send_state('status'              , 'get_wifi2_status'              ), # FW 2.4.0
+          safe_send_state('client_configuration', 'get_wifi2_client_configuration'), # FW 2.4.0
+          safe_send_state('client_hostname'     , 'get_wifi2_client_hostname'     ), # FW 2.4.0
+          safe_send_state('ap_configuration'    , 'get_wifi2_ap_configuration'    ), # FW 2.4.0
+
+          if r = safe_send_state('firmware_version', 'get_wifi2_firmware_version' )  # FW 2.4.0
+            [ r[0], r[1].join('.') ]
+          end
+        ].compact.to_h
+      end
+    rescue
+      nil
+    end
+
+    private
+
+    # Safely call a method for inclusion in state hash.
+    # When method blows up, state can ignore it.
+    # REVIEW: possible candidate for Device class
+    def safe_send_state(key, methot)
+      [key, send(methot)]
+    rescue => e
+      logger_warn "Device '#{uid_string}': '#{methot}' failed. #{e}"
+      nil
+    end
+
   end
 
 end

data/lib/tinderfridge/devices/bricklet_co2_v2/bricklet_co2_v2.rb

@@ -16,6 +16,14 @@ module Tinkerforge
 
     private
 
+   def _print_4
+      if (co2 = get_co2_concentration) > 9999
+        ' ol '
+      else
+        '%4d' % co2
+      end
+    end
+
     def _view_21x8
       "CO2V2        #{uid_string.rjust 8}\n\n\n" +
       ('%d PPM' % get_co2_concentration).center(21)

data/lib/tinderfridge/devices/bricklet_particulate_matter/bricklet_particulate_matter.rb

@@ -0,0 +1,38 @@
+module Tinkerforge
+
+  class BrickletParticulateMatter
+
+    # Enables the fan and the laser diode.
+    def enable
+      set_enable true
+    end
+
+    # Disables the fan and the laser diode.
+    def disable
+      set_enable false
+    end
+
+    # Returns the device's state.
+    def state
+      super.merge(
+        'enabled'          => get_enable,
+        'pm_concentration' => get_pm_concentration,
+        'pm_count'         => get_pm_count,
+        'sensor_info'      => get_sensor_info,
+      )
+    end
+
+    private
+
+    def _view_21x8
+      "PM           #{uid_string.rjust 8}\n\n" +
+      if get_enable
+        "     PM1   %4d\n     PM2.5 %4d\n     PM10  %4d" % get_pm_concentration
+      else
+        "\n      disabled"
+      end
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/bricklet_segment_display_4x7_v2/bricklet_segment_display_4x7_v2.rb

@@ -35,30 +35,39 @@ module Tinkerforge
       self.segments = segments.gsub(/[ _]/, '').ljust(35, '0').chars.map { |s| s == '1' }
     end
 
+    # Turns all 35 segments on.
+    def all_on
+      self.segments = [true]*35
+    end
+
     # Returns the device's state.
     def state
       super.merge( 'brightness' => get_brightness )
     end
 
     # Displays a string.
-    def print(text='')
-      out   = ''
-      colon = false
-
-      text.to_s.chars.each do |c|
-        if glyphs.key? c
-          out << glyphs[c] << '0'
-        elsif c == '.' and out[-1] == '0'
-          out[-1] = '1'
-        elsif c == ':' and out.size == 16
-          colon = true
-        else
-          raise "Can not display '#{text}'"
+    def print(text_or_object='')
+      if text_or_object.respond_to?( :_print_4, true)
+        print ( text_or_object.send(:_print_4) rescue '' )
+      else
+        out   = ''
+        colon = false
+
+        text_or_object.to_s.chars.each do |c|
+          if glyphs.key? c
+            out << glyphs[c] << '0'
+          elsif c == '.' and out[-1] == '0'
+            out[-1] = '1'
+          elsif c == ':' and out.size == 16
+            colon = true
+          else
+            raise "Can not display '#{text}'"
+          end
         end
-      end
 
-      self.segments_string = out[0,32].ljust(32,'0') + ( colon ? '110' : '000' )
-      nil
+        self.segments_string = out[0,32].ljust(32,'0') + ( colon ? '110' : '000' )
+        nil
+      end
     end
 
     # Returns the definition of glyphs for Unicode chracters.
@@ -78,6 +87,7 @@ module Tinkerforge
 
         'A' => '1110111',
         'b' => '0011111',
+        'B' => '1111111',
         'c' => '0001101',
         'C' => '1001110',
         'd' => '0111101',
@@ -91,6 +101,7 @@ module Tinkerforge
         'J' => '0111000',
         'L' => '0001110',
         'l' => '0001100',
+        'N' => '1110110',
         'n' => '0010101',
         'O' => '1111110',
         'o' => '0011101',
@@ -103,7 +114,8 @@ module Tinkerforge
         'u' => '0011100',
         'V' => '0111110',
         'v' => '0011100',
-        'y' => '0110011',
+        'Y' => '0111011',
+        'y' => '0111011',
 
         'ö' => '1011101',
         'ü' => '1011100',

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
 
@@ -13,9 +16,27 @@ module Tinkerforge
     # Returns the network socket used by the IP Connection.
     attr_reader :socket
 
+    alias original_connect connect
+
+    # Creates a TCP/IP connection to the given host and port. Logs events if event logging is enabled.
+    def connect(host, port)
+      logger_debug "Connecting to #{host}:#{port}"
+      original_connect(host, port)
+      logger_debug "Connected  to #{host}:#{port}"
+    end
+
+    alias original_disconnect disconnect
+
+    # Disconnects the TCP/IP connection. Logs events if event logging is enabled.
+    def disconnect
+      logger_debug "Disconnecting from #{host}:#{port}"
+      original_disconnect
+      logger_debug "Disconnected  from #{host}:#{port}"
+    end
+
     # 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 +107,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 +117,6 @@ module Tinkerforge
             end
           when 2
             list.delete args[0]
-          else
-            raise "Unknown Enumeration Type: #{args[6]}"
         end
       end
 
@@ -112,7 +132,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 +148,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.15.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.15.0
 platform: ruby
 authors:
 - lllist.eu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-21 00:00:00.000000000 Z
+date: 2024-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tinkerforge
@@ -120,6 +120,7 @@ files:
 - lib/tinderfridge/devices/bricklet_outdoor_weather/bricklet_outdoor_weather.json
 - lib/tinderfridge/devices/bricklet_outdoor_weather/bricklet_outdoor_weather.rb
 - lib/tinderfridge/devices/bricklet_particulate_matter/bricklet_particulate_matter.json
+- lib/tinderfridge/devices/bricklet_particulate_matter/bricklet_particulate_matter.rb
 - lib/tinderfridge/devices/bricklet_performance_dc/bricklet_performance_dc.json
 - lib/tinderfridge/devices/bricklet_piezo_speaker_v2/bricklet_piezo_speaker_v2.json
 - lib/tinderfridge/devices/bricklet_piezo_speaker_v2/bricklet_piezo_speaker_v2.rb
@@ -156,6 +157,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