tinderfridge 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92034339759c82954498219a57e8070f6859b907e135a8d9a8df936abd58a01f
-  data.tar.gz: a222affea211a17b0e6b9fd0087ddb53830f5e2a0de7a63258ebc566d5e6bd7d
+  metadata.gz: 2a1a23e33e307a89386dbf4d61f3a9852e000e3382ec3c61de5b1c45c0335f11
+  data.tar.gz: 4261d085ad57d3205da9b27fcd38d74bd3bb47e482f0fbcfb391918e4abac268
 SHA512:
-  metadata.gz: a450530444bcaeeed475e6476d12d7cfeedda25f02cb2619b4ccdd62951f9f16f9a1f03f874c6807fef6efddbe7fe3b06825c5ca120ca6828ef1e332844cceb3
-  data.tar.gz: a7c84f3fd084e655a81f79d58a3bbf1173f31ca0b0fafd5a66041c3aefd689f5a04d18045599a645073ccae693b13a07c6af0f51d668eb0ab8bd0954dbf6f1e9
+  metadata.gz: 12677e84815ddad014bf40df64798fbb05c46be764106143e16d2964a73d71a402bfb9d66bbc6f1422ec83766628ec0f6e2ddf9817fb64e38988523f9b4c3479
+  data.tar.gz: '0749d1e2bf1b022313bbe807c08836df740d223d1b5d81efd5bb388693c84c707d436e5dc35f9fe827518dcf6ce97db70e9f8c948a5d3b0e64f75b4780f722f5'

data/lib/tinderfridge/device.rb

@@ -33,6 +33,21 @@ module Tinkerforge
         end.compact.sort_by { |i| i[0] }
       end
 
+      private
+
+      # Primitive superhook:
+      # Every time a class inherits from the Device class,
+      # attempts to load an extension for that new class.
+      def inherited(klass)
+        if info = Tinkerforge.device_info(klass)
+          begin
+            require("tinderfridge/devices/#{info[2][1]}")
+          rescue LoadError
+            # No extension found for this device
+          end
+        end
+      end
+
     end
 
     #----------------------------------------------------------------------#

data/lib/tinderfridge/device_collection.rb

@@ -6,28 +6,43 @@ module Tinkerforge
     #
     # Nil for devices that do not support the get_chip_temperature method.
     def get_chip_temperature
-      map { |k,d| [ k, d.respond_to?('get_chip_temperature' ) ? d.get_chip_temperature  : nil ] }.to_h
+      smap 'get_chip_temperature'
+    end
+
+    # Returns identity information for devices in the collection.
+    #
+    # Identity information is returned as an array:
+    # - 0 : UID
+    # - 1 : Connected UID
+    # - 2 : Connected port (position)
+    # - 3 : Hardware version
+    # - 4 : Firmware version
+    # - 5 : Device Identifier
+    #
+    # Nil for devices that do not support the get_identity method.
+    def get_identity
+      smap 'get_identity'
     end
 
     # Returns the error counts for devices in the collection.
     #
     # Nil for devices that do not support the get_spitfp_error_count method.
     def get_spitfp_error_count
-      map { |k,d| [ k, d.respond_to?('get_spitfp_error_count' ) ? d.get_spitfp_error_count  : nil ] }.to_h
+      smap 'get_spitfp_error_count'
     end
 
     # Returns the status LED configuration for devices in the collection.
     #
     # Nil for devices that do not support the get_status_led_config method.
     def get_status_led_config
-      map { |k,d| [ k, d.respond_to?('get_status_led_config') ? d.get_status_led_config : nil ] }.to_h
+      smap 'get_status_led_config'
     end
 
     # Sets the status LED configuration for devices in the collection.
     #
     # Ignores devices that do not support the set_status_led_config method.
     #
-    # Argument can be an Integer (e.g. 0=off, 1=on), or a Hash (as returned by #get_status_led_config).
+    # Argument can be an integer (e.g. 0=off, 1=on), or a hash (as returned by #get_status_led_config).
     def set_status_led_config(state)
       case state
         when Integer
@@ -41,6 +56,19 @@ module Tinkerforge
       end
     end
 
+    # 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]]
+      end.size
+    end
+
+    private
+
+    def smap(m)
+      map { |k,d| [ k, d.respond_to?(m) ? d.send(m) : nil ] }.to_h
+    end
+
   end
 
 end

data/lib/tinderfridge/devices/bricklet_gps_v2.rb

@@ -0,0 +1,31 @@
+module Tinkerforge
+
+  class BrickletGPSV2
+
+    # Returns latitude and longitude as reported by the GPS Bricklet.
+    #
+    # Nil when there is no fix (position not determined).
+    def coordinates
+      if get_status[0]
+        c = get_coordinates
+        [
+          c[0] / (c[1] == 'N' ? 1000000.0 : -1000000.0),
+          c[2] / (c[3] == 'E' ? 1000000.0 : -1000000.0)
+        ]
+      else
+        nil
+      end
+    end
+
+    # Returns a Time object representing the time as reported by the GPS Bricklet.
+    def time
+      # FIXME: This will not work after 31-Dec-2099.
+      dt = get_date_time.map &:to_s
+      dt = dt[0].rjust(6,'0').unpack('a2a2a2').reverse + dt[1].rjust(9,'0').concat('000').unpack('a2a2a2a6')
+      dt[0].prepend '20'
+      Time.gm *dt.map(&:to_i)
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/bricklet_lcd_128x64.rb

@@ -0,0 +1,31 @@
+module Tinkerforge
+
+  class BrickletLCD128x64
+
+    # Returns the current setting for the backlight (0..100).
+    def backlight
+      get_display_configuration[1]
+    end
+
+    # Sets the brightness of the backlight (0..100).
+    def backlight=(brightness)
+      state = get_display_configuration
+      state[1] = brightness.to_i
+      set_display_configuration *state
+    end
+
+    # Switches off the backlight.
+    def blackout
+      self.backlight = 0
+      true
+    end
+
+    # Clears the display, including the GUI.
+    def clear
+      clear_display
+      remove_all_gui
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/bricklet_led_strip_v2.rb

@@ -0,0 +1,43 @@
+module Tinkerforge
+
+  class BrickletLEDStripV2
+
+    # Switches off all connected LEDs. Use in case of misconfiguration or other trouble.
+    #
+    # Sends the connected LEDs 6144 zeros (2048 RGB values or 1536 RGBW values).
+    def blackout
+      a = Array.new(1024,0)
+      6.times { |n| set_led_values( n*1024, a ) }
+      true
+    end
+
+    # Returns the channels as defined by the channel mapping.
+    def channels
+      if ch = lookup_channel_mapping(get_channel_mapping)
+        ch[1].chars
+      else
+        ch
+      end
+    end
+
+    private
+
+    def lookup_channel_mapping(selector=nil)
+      @@channel_mapping_table ||= self.class.constants.map do |c|
+        (c.to_s =~ /^CHANNEL_MAPPING_(\w{3,4})$/ ) ? [self.class.const_get(c), $1] : nil
+      end.compact.sort_by { |l| l[0] }
+      case selector
+        when NilClass
+          @@channel_mapping_table
+        when Integer
+          @@channel_mapping_table.select { |n,s| n == selector }.first
+        when String
+          @@channel_mapping_table.select { |n,s| s == selector }.first
+        else
+          raise ArgumentError, 'Unknown selector'
+      end
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/bricklet_outdoor_weather.rb

@@ -0,0 +1,19 @@
+module Tinkerforge
+
+  class BrickletOutdoorWeather
+
+    # Returns the last measured data for all sensors.
+    #
+    # The result is a Hash, with sensor identifiers as the keys. Values per sensor are:
+    # - 0: Temperature (°C)
+    # - 1: Relative humidity (%RH)
+    # - 2: Last change (seconds)
+    def sensors
+      get_sensor_identifiers.map do |id|
+        [ id, get_sensor_data(id).each_with_index.map { |v,i| i == 0 ? v/10.0 : v } ]
+      end.to_h
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/bricklet_rgb_led_button.rb

@@ -0,0 +1,25 @@
+module Tinkerforge
+
+  class BrickletRGBLEDButton
+
+    # Returns the button's current color as three values for red, green, and blue (integers in the range 0..255).
+    def rgb
+      get_color
+    end
+
+    # Sets the button's color using three values for red, green, and blue (integers in the range 0..255).
+    #
+    # Values can be supplied as an array or as three separate values.
+    def rgb=(*rgb)
+      set_color *rgb.flatten
+    end
+
+    # Switches off the button's LED.
+    def blackout
+      self.rgb = 0, 0, 0
+      true
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/bricklet_rgb_led_v2.rb

@@ -0,0 +1,25 @@
+module Tinkerforge
+
+  class BrickletRGBLEDV2
+
+    # Returns the LED's current color as three values for red, green, and blue (integers in the range 0..255).
+    def rgb
+      get_rgb_value
+    end
+
+    # Sets the LED's color using three values for red, green, and blue (integers in the range 0..255).
+    #
+    # Values can be supplied as an array or as three separate values.
+    def rgb=(*rgb)
+      set_rgb_value *rgb.flatten
+    end
+
+    # Switches off the LED.
+    def blackout
+      self.rgb = 0, 0, 0
+      true
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/bricklet_segment_display_4x7_v2.rb

@@ -0,0 +1,20 @@
+module Tinkerforge
+
+  class BrickletSegmentDisplay4x7V2
+
+    # Clears the display.
+    def clear
+      set_segments [false]*8, [false]*8, [false]*8, [false]*8, [false]*2, false
+      true
+    end
+
+    alias blackout clear
+
+    # Returns the state of all 35 segments.
+    def segments
+      send_request FUNCTION_GET_SEGMENTS, [], '', 14, '?35'
+    end
+
+  end
+
+end

data/lib/tinderfridge/ip_connection.rb

@@ -33,28 +33,32 @@ module Tinkerforge
       list = Tinkerforge::DeviceCollection.new
       self.register_callback(CALLBACK_ENUMERATE) do |*args|
         case args[6]
-
-          when 0, 1  # Available or Connected
-            info = Tinkerforge.device_info args[5]
-            if info
-              require File.join('tinkerforge', info[2][1] )
-              list[args.first] = Tinkerforge.const_get( info[2][0] ).new args.first, self
-            else     # Device not in device_info
-              list[args.first] = nil
+          when 0, 1
+            unless list.key?(args[0])
+              list[args[0]] = device_instance_from_enum_data(args)
             end
-
-          when 2     # Disconnected
-            list[args.first] = nil
-
+          when 2
+            list.delete args[0]
           else
             raise "Unknown Enumeration Type: #{args[6]}"
-
         end
       end
       self.enumerate
       list
     end
 
+    private
+
+    # Takes the args supplied by an enumeration callback, and returns a device instance.
+    def device_instance_from_enum_data(enum_data)
+      if dev_info = Tinkerforge.device_info(enum_data[5])
+        require "tinkerforge/#{dev_info[2][1]}"
+        Tinkerforge.const_get(dev_info[2][0]).new enum_data[0], self
+      else
+        raise "Unknown device type #{enum_data[5]} (#{enum_data[0]})"
+      end
+    end
+
   end
 
   # Creates an IP Connection object connected to the given host and port.

data/lib/tinderfridge/version.rb

@@ -3,7 +3,7 @@ require 'tinkerforge/version'
 module Tinkerforge
 
   # Tinderfridge version.
-  TINDERFRIDGE_VERSION = '0.1.0'
+  TINDERFRIDGE_VERSION = '0.2.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.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - lllist.eu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-09 00:00:00.000000000 Z
+date: 2020-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tinkerforge
@@ -35,6 +35,13 @@ files:
 - lib/tinderfridge/device_collection.rb
 - lib/tinderfridge/device_info.rb
 - lib/tinderfridge/device_info.txt
+- lib/tinderfridge/devices/bricklet_gps_v2.rb
+- lib/tinderfridge/devices/bricklet_lcd_128x64.rb
+- lib/tinderfridge/devices/bricklet_led_strip_v2.rb
+- lib/tinderfridge/devices/bricklet_outdoor_weather.rb
+- lib/tinderfridge/devices/bricklet_rgb_led_button.rb
+- lib/tinderfridge/devices/bricklet_rgb_led_v2.rb
+- lib/tinderfridge/devices/bricklet_segment_display_4x7_v2.rb
 - lib/tinderfridge/ip_connection.rb
 - lib/tinderfridge/tinkerforge.rb
 - lib/tinderfridge/version.rb