tinderfridge 0.12.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11aec071db2201e67dee0935c5a37ba2f801d2337cf0dc938ea465a9c0435bd3
-  data.tar.gz: ad2faa18ff3320c9320ded930b47f54c38e9471eba0bb52e2aa23cb48da3d108
+  metadata.gz: a5370c2b6210bbb986208ce2afc7f6ce9573592b7707bf14a8bc371ffb47050c
+  data.tar.gz: 79338d5081d87b1aff9402eaf656be89ed5a50c52f59f597c68a84e9462ccdd4
 SHA512:
-  metadata.gz: 440adf1b54a1787963688f4392fe686e07b898eae1361d3f245526a244f6e677b5a29a7cd84f2f3aa0221ef4300372dcbae18b55200cef2b96d6fa7206a0c7d0
-  data.tar.gz: 8204e15a1106392bbde997f2e65704b2cfd176c4e18066685f26e8a50a6cd62e3002b10e8fd6224f16540d946c94c66f66e96f6941b90c7255beec4e4c545a60
+  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.
@@ -122,6 +134,17 @@ module Tinkerforge
       ].compact.to_h
     end
 
+    # Returns configuration data for the device (a mutable Hash).
+    def config
+      @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

@@ -61,7 +61,7 @@ module Tinkerforge
     # Prints a list of devices in the collection.
     def ls
       keys.sort_by(&:downcase).each do |k|
-        puts "%-8s %.40s" % [k, Tinkerforge.device_info(self[k])[1]]
+        puts "%-8s %.40s" % [k, self[k].device_display_name]
       end.size
     end
 
@@ -77,6 +77,21 @@ module Tinkerforge
       smap 'state'
     end
 
+    # Returns configuration data of devices in the collection.
+    def config
+      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.
@@ -86,6 +101,18 @@ module Tinkerforge
 
     alias doc open_documentation
 
+    # On Mac OS, opens a new Brick Viewer for each unique
+    # IP Connection used by devices in the collection.
+    #
+    # Not supported on other platforms.
+    #
+    # Requires Brick Viewer version 2.4.23 or later.
+    def open_brick_viewer
+      ipcons.map { |i| i.open_brick_viewer }
+    end
+
+    alias brickv open_brick_viewer
+
     # Turns off light sources such as screens and RGB LEDs for devices in the collection.
     #
     # Ignores devices that do not support the blackout method.
@@ -98,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/devices/brick_esp32_ethernet/brick_esp32_ethernet.rb

@@ -5,7 +5,7 @@ module Tinkerforge
     private
 
     def _view_21x8
-      "ESP32 Eth    #{uid_string.rjust 8}"
+      "ESP32Eth     #{uid_string.rjust 8}"
     end
 
   end

data/lib/tinderfridge/devices/bricklet_ambient_light_v3/bricklet_ambient_light_v3.rb

@@ -14,6 +14,15 @@ module Tinkerforge
       )
     end
 
+    private
+
+    def _view_21x8
+      s = state
+      "AmbiLightV3  #{uid_string.rjust 8}\n\n\n" +
+      ("%.2f Lux" % [0.01 * s['illuminance_raw']]).center(21) + "\n\n\n\n" +
+      ("max %d / %d ms" % [ s['illuminance_range'], s['integration_time'] ]).center(21)
+    end
+
   end
 
 end

data/lib/tinderfridge/devices/bricklet_barometer_v2/bricklet_barometer_v2.rb

@@ -18,11 +18,8 @@ module Tinkerforge
     private
 
     def _view_21x8
-      <<~ET
-      Baro         #{uid_string.rjust 8}
-
-          #{'%7.2f hPa' % [get_air_pressure*0.001]}
-      ET
+      "BaroV2       #{uid_string.rjust 8}\n\n\n" +
+      ('%.2f hPa' % [get_air_pressure*0.001]).center(21)
     end
 
   end

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

@@ -17,11 +17,8 @@ module Tinkerforge
     private
 
     def _view_21x8
-      <<~ET
-      CO2          #{uid_string.rjust 8}
-
-            #{'%5d PPM' % get_co2_concentration}
-      ET
+      "CO2V2        #{uid_string.rjust 8}\n\n\n" +
+      ('%d PPM' % get_co2_concentration).center(21)
     end
 
   end

data/lib/tinderfridge/devices/bricklet_gps_v2/bricklet_gps_v2.rb

@@ -49,7 +49,7 @@ module Tinkerforge
     private
 
     def _view_21x8
-      "GPSv2        #{uid_string.rjust 8}\n\n" +
+      "GPSV2        #{uid_string.rjust 8}\n\n" +
       ((c = coordinates) ? ("   Lat %10.5f\n   Lon %10.5f" % c) : '       no fix')
     end
 

data/lib/tinderfridge/devices/bricklet_gps_v3/bricklet_gps_v3.rb

@@ -49,7 +49,7 @@ module Tinkerforge
     private
 
     def _view_21x8
-      "GPSv3        #{uid_string.rjust 8}\n\n" +
+      "GPSV3        #{uid_string.rjust 8}\n\n" +
       ((c = coordinates) ? ("   Lat %10.5f\n   Lon %10.5f" % c) : '       no fix')
     end
 

data/lib/tinderfridge/devices/bricklet_lcd_128x64/bricklet_lcd_128x64.rb

@@ -106,7 +106,7 @@ module Tinkerforge
     private
 
     def _view_21x8
-      "LCD          #{uid_string.rjust 8}"
+      "LCD128x64    #{uid_string.rjust 8}"
     end
 
   end

data/lib/tinderfridge/devices/bricklet_oled_128x64_v2/bricklet_oled_128x64_v2.rb

@@ -86,7 +86,7 @@ module Tinkerforge
     private
 
     def _view_21x8
-      "OLED         #{uid_string.rjust 8}"
+      "OLED128x64V2 #{uid_string.rjust 8}"
     end
 
   end

data/lib/tinderfridge/devices/bricklet_outdoor_weather/bricklet_outdoor_weather.rb

@@ -11,13 +11,18 @@ module Tinkerforge
 
     # Returns the last measured data for all sensors.
     #
-    # The result is a Hash, with sensor identifiers as the keys. Values per sensor are:
+    # The result is a Hash, with sensor identifiers (or their mapped values) as the keys. Values per sensor are:
     # - 0: Temperature (°C)
     # - 1: Relative humidity (%RH)
     # - 2: Last change (seconds)
+    #
+    # Sensor identifiers can be mapped to descriptive strings or other values:
+    # @example
+    #  my_weather_bricklet.config['sensormap'] = { 202 => 'outdoors' }
     def sensors
+      sensormap = (config['sensormap'].class == Hash) ? config['sensormap'] : {}
       get_sensor_identifiers.map do |id|
-        [ id, get_sensor_data(id).each_with_index.map { |v,i| i == 0 ? v/10.0 : v } ]
+        [ (sensormap[id] || id), get_sensor_data(id).each_with_index.map { |v,i| i == 0 ? v/10.0 : v } ]
       end.to_h
     end
 
@@ -26,7 +31,7 @@ module Tinkerforge
     def _view_21x8
       "Weather      #{uid_string.rjust 8}\n\n" +
       sensors.first(6).map do |k,v|
-        %Q(#{v[2] > 100 ? '?' : ' '} %3d  %4.1f °C  %2d %%\n) % [k,v].flatten
+        %Q(#{v[2] > 100 ? '!' : ' '}%-8.8s %5.1f°C%3d%%\n) % [k,v].flatten
       end.join
     end
 

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

@@ -112,7 +112,9 @@ module Tinkerforge
 
         '_' => '0001000',
         '-' => '0000001',
+        '¯' => '1000000',
         '=' => '0001001',
+        '≡' => '1001001',
 
         '(' => '1001110',
         ')' => '1111000',
@@ -147,6 +149,35 @@ module Tinkerforge
       [value1, value2]
     end
 
+    # Returns the current thread automatically updating the display.
+    def thread
+      @thread
+    end
+
+    # Stops automatic updating of the display.
+    def stop
+      if thread
+        thread.exit
+        @thread = nil
+      end
+    end
+
+    # Continuously displays the current time, in 24-hour format.
+    #
+    # Starts a new thread automatically updating the display. Use the stop method to end.
+    #
+    # By default uses local time, or optionally UTC.
+    def clock(utc=false)
+      stop
+      @thread = Thread.new do
+        while true
+          t = utc ? Time.now.getutc : Time.now
+          print t.strftime("%H#{t.sec.even? ? ':' : ''}%M")
+          sleep 0.5
+        end
+      end
+    end
+
   end
 
 end

data/lib/tinderfridge/devices/bricklet_solid_state_relay_v2/bricklet_solid_state_relay_v2.rb

@@ -0,0 +1,22 @@
+module Tinkerforge
+
+  class BrickletSolidStateRelayV2
+
+    # Returns the device's state.
+    def state
+      super.merge(
+        'value'    => get_state,
+        'monoflop' => get_monoflop,
+      )
+    end
+
+    private
+
+    def _view_21x8
+      "SSRelayV2    #{uid_string.rjust 8}\n\n\n" +
+      (get_state ? 'ON' : 'Off').center(21)
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/bricklet_temperature_v2/bricklet_temperature_v2.rb

@@ -13,13 +13,9 @@ module Tinkerforge
     private
 
     def _view_21x8
-      <<~ET
-      Temp         #{uid_string.rjust 8}
-
-            #{'%6.2f °C' % [get_temperature*0.01]}
-
-              #{get_heater_configuration == 1 ? 'HEATER' : ''}
-      ET
+      "TempV2       #{uid_string.rjust 8}\n\n\n" +
+      ('%.2f °C' % [get_temperature*0.01]).center(21) +
+      (get_heater_configuration == 1 ? "\n\n\n       HEATER" : '')
     end
 
   end

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
 
@@ -105,6 +107,21 @@ module Tinkerforge
       list
     end
 
+    # On Mac OS, opens a new Brick Viewer,
+    # connected to the IP Connection's host and port.
+    #
+    # Not supported on other platforms.
+    #
+    # Requires Brick Viewer version 2.4.23 or later.
+    def open_brick_viewer
+      if host and (RUBY_PLATFORM =~ /darwin/)
+        `open -n -a Brickv --args #{host} --port #{port}`
+        "#{host}:#{port}"
+      end
+    end
+
+    alias brickv open_brick_viewer
+
     private
 
     # Takes the args supplied by an enumeration callback, and returns a device instance.
@@ -113,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,38 @@ 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
+      "\n" +
+      'Tinkerforge'.center(21) +
+      "\n" +
+      VERSION.center(21) +
+      "\n\n\n\n" +
+      "Tinderfridge #{TINDERFRIDGE_VERSION}".center(21) +
+      "\n" +
+      "Ruby #{RUBY_VERSION}".center(21)
+    end
+
   end
 
 end

data/lib/tinderfridge/version.rb

@@ -3,7 +3,7 @@ require 'tinkerforge/version'
 module Tinkerforge
 
   # Tinderfridge version.
-  TINDERFRIDGE_VERSION = '0.12.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.12.0
+  version: 0.14.0
 platform: ruby
 authors:
 - lllist.eu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-22 00:00:00.000000000 Z
+date: 2023-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tinkerforge
@@ -141,6 +141,7 @@ files:
 - lib/tinderfridge/devices/bricklet_servo_v2/bricklet_servo_v2.json
 - lib/tinderfridge/devices/bricklet_silent_stepper_v2/bricklet_silent_stepper_v2.json
 - lib/tinderfridge/devices/bricklet_solid_state_relay_v2/bricklet_solid_state_relay_v2.json
+- lib/tinderfridge/devices/bricklet_solid_state_relay_v2/bricklet_solid_state_relay_v2.rb
 - lib/tinderfridge/devices/bricklet_sound_pressure_level/bricklet_sound_pressure_level.json
 - lib/tinderfridge/devices/bricklet_sound_pressure_level/bricklet_sound_pressure_level.rb
 - lib/tinderfridge/devices/bricklet_temperature_ir_v2/bricklet_temperature_ir_v2.json
@@ -155,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