tinderfridge 0.1.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92034339759c82954498219a57e8070f6859b907e135a8d9a8df936abd58a01f
-  data.tar.gz: a222affea211a17b0e6b9fd0087ddb53830f5e2a0de7a63258ebc566d5e6bd7d
+  metadata.gz: f93f157ac5afd9dd2b5a6108889f8b00b58df36c16a78faea7fa788ac64ef37d
+  data.tar.gz: b28896b7b8938c3d58a043e0c3ff804f253dbcb8fc5b8605ee6fb2efc4a7b92f
 SHA512:
-  metadata.gz: a450530444bcaeeed475e6476d12d7cfeedda25f02cb2619b4ccdd62951f9f16f9a1f03f874c6807fef6efddbe7fe3b06825c5ca120ca6828ef1e332844cceb3
-  data.tar.gz: a7c84f3fd084e655a81f79d58a3bbf1173f31ca0b0fafd5a66041c3aefd689f5a04d18045599a645073ccae693b13a07c6af0f51d668eb0ab8bd0954dbf6f1e9
+  metadata.gz: 2b436ea8162a3d32352a3b5d37a6cd3b5efdebb76cb21f51f9cf6fc393ba4a03eaed7bb0385c9471e80eb5c91ba20d56e89e4d425c02f4f7f3475947bf74fc57
+  data.tar.gz: 24671e0d6c6ff57bfb4bdb4094919c70803cdb7f63cf814c25c879e3c2d9555cbb803dba3c9dff6cc14cac2a4ad339af754993fcb4594ec8309e70ded461d7b1

data/lib/tinderfridge/device.rb

@@ -1,6 +1,7 @@
 require 'tinkerforge/ip_connection'
 
 module Tinkerforge
+
   class Device
 
     #----------------------------------------------------------------------#
@@ -33,20 +34,97 @@ 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]}/#{info[2][1]}")
+          rescue LoadError
+            # No extension found for this device
+          end
+        end
+      end
+
     end
 
     #----------------------------------------------------------------------#
     #                           Instance Methods                           #
     #----------------------------------------------------------------------#
 
+    # Returns the device's UID. Not to be confused with #uid, which returns the numeric UID.
+    attr_reader :uid_string
+
+    # Returns the device's numeric Device Identifier.
+    attr_reader :device_identifier
+
+    # Returns the device's Display Name.
+    attr_reader :device_display_name
+
     # Returns the device's IPConnection object.
     attr_reader :ipcon
 
+    # Returns device information.
+    #
+    # Device information is an array:
+    # - 0 : Device Identifier
+    # - 1 : Device Display Name
+    # - 2 : Associated class name and source file
+    def device_info
+      Tinkerforge.device_info device_identifier
+    end
+
     # Returns a programmer-friendly representation of the device.
     def inspect
       "%s (%s@%s:%s)" % [self.class, @uid_string, 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
+    end
+
+    alias props properties
+
+    # Returns the device's state.
+    def state
+      identity = get_identity
+
+      [
+        [ 'uid'                , uid_string            ],
+        [ 'update_time'        , Time.now.gmtime       ],
+        [ 'firmware_version'   , identity[4].join('.') ],
+
+        [ 'connected', { 'uid'  => identity[1], 'position' => identity[2] } ],
+        [ 'ipcon'    , { 'host' => ipcon.host , 'port'     => ipcon.port  } ],
+
+        respond_to?('get_chip_temperature'  ) ? [ 'chip_temperature'  , get_chip_temperature   ] : nil,
+        respond_to?('get_spitfp_error_count') ? [ 'spitfp_error_count', get_spitfp_error_count ] : nil,
+        respond_to?('get_status_led_config' ) ? [ 'status_led_config' , get_status_led_config  ] : nil,
+
+      ].compact.to_h
+    end
+
+    # Opens the online documentation for the device (Mac OS only).
+    #
+    # When the URL for the documentation is not known, does nothing.
+    def open_documentation
+      if properties['documentation_en_url'] and ( RUBY_PLATFORM =~ /darwin/ )
+        `open #{properties['documentation_en_url']}`
+        properties['documentation_en_url']
+      else
+        nil
+      end
+    end
+
+    alias doc open_documentation
+
     # Identifies a Tinkerforge device by blinking its status led.
     #
     # Supports recent devices. When invoked on older devices, does nothing.
@@ -67,5 +145,32 @@ module Tinkerforge
       end
     end
 
+    private
+
+    def load_properties
+      if device_info
+        properties_file = File.join(
+          File.dirname(__FILE__),
+          'devices',
+          device_info[2][1],
+          device_info[2][1],
+        ) + '.json'
+
+        if File.readable? properties_file
+          begin
+            require 'json'
+            JSON.load File.read properties_file
+          rescue
+            {}
+          end
+        else
+          {}
+        end
+      else
+        {}
+      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,88 @@ 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
+
+    # Returns the properties of devices in the collection.
+    def properties
+      smap 'properties'
+    end
+
+    alias props properties
+
+    # Returns the state of devices in the collection.
+    def state
+      smap 'state'
+    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.
+    def open_documentation
+      smap 'open_documentation'
+    end
+
+    alias doc open_documentation
+
+    # Turns off light sources such as screens and RGB LEDs for devices in the collection.
+    #
+    # Ignores devices that do not support the blackout method.
+    def blackout
+      smap 'blackout'
+    end
+
+    # Returns a list of unique IP Connections used by devices in the collection.
+    def ipcons
+      smap('ipcon').values.compact.uniq
+    end
+
+    # Returns an array of devices in the collection matching the selector.
+    #
+    # Selector argument can be:
+    # - Device Identifier
+    # - Class name or Device Display Name (Regexp)
+    # Selection by regular expression is case-insensitive by default.
+    #
+    # @example Select by class name and Device Display Name
+    #  # All 'analog' devices
+    #  tf = Tinkerforge.connect.discover(1)
+    #  tf.find_all /analog/
+    def find_all(selector)
+      case selector
+        when Integer
+          values.select { |v| v.device_identifier == selector}
+        when Regexp
+          r = Regexp.new selector.source, Regexp::IGNORECASE
+          values.select { |v| v.class.to_s.split('::').last =~ r || v.device_display_name =~ r }
+      end
+    end
+
+    # Returns the first device in the collection matching the selector.
+    #
+    # Selector argument can be:
+    # - Device Identifier
+    # - Class name or Device Display Name (Regexp)
+    # Selection by regular expression is case-insensitive by default.
+    #
+    # @example Select by Device Identifier
+    #  # Remote Switch Bricklet 2.0
+    #  tf = Tinkerforge.connect('myhost.local').discover(1)
+    #  tf.find 289
+    def find(selector)
+      find_all(selector).first
+    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/device_info.txt

@@ -135,5 +135,7 @@
 2147	CO2 Bricklet 2.0	Tinkerforge::BrickletCO2V2	bricklet_co2_v2
 2152	Energy Monitor Bricklet	Tinkerforge::BrickletEnergyMonitor	bricklet_energy_monitor
 2153	Compass Bricklet	Tinkerforge::BrickletCompass	bricklet_compass
+2156	Performance DC Bricklet	Tinkerforge::BrickletPerformanceDC	bricklet_performance_dc
+2157	Servo Bricklet 2.0	Tinkerforge::BrickletServoV2	bricklet_servo_v2
 2161	IMU Bricklet 3.0	Tinkerforge::BrickletIMUV3	bricklet_imu_v3
 2162	Industrial Dual AC Relay Bricklet	Tinkerforge::BrickletIndustrialDualACRelay	bricklet_industrial_dual_ac_relay

data/lib/tinderfridge/devices/brick_hat/brick_hat.json

@@ -0,0 +1,10 @@
+{
+  "dimensions": [
+    65,
+    56,
+    25
+  ],
+  "weight": 30,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricks/HAT_Brick.html",
+  "versions_identifier": "bricklets:hat"
+}

data/lib/tinderfridge/devices/brick_hat/brick_hat.rb

@@ -0,0 +1,18 @@
+module Tinkerforge
+
+  class BrickHAT
+
+    # Returns the device's state.
+    def state
+      volts = get_voltages
+      super.merge(
+        'bricklet_power' => get_bricklet_power,
+        'usb_voltage'    => volts[0],
+        'dc_voltage'     => volts[1],
+        'sleep_mode'     => get_sleep_mode,
+      )
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/brick_hat_zero/brick_hat_zero.json

@@ -0,0 +1,10 @@
+{
+  "dimensions": [
+    65,
+    30,
+    5
+  ],
+  "weight": 12,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricks/HAT_Zero_Brick.html",
+  "versions_identifier": "bricklets:hat_zero"
+}

data/lib/tinderfridge/devices/brick_hat_zero/brick_hat_zero.rb

@@ -0,0 +1,14 @@
+module Tinkerforge
+
+  class BrickHATZero
+
+    # Returns the device's state.
+    def state
+      super.merge(
+        'usb_voltage' => get_usb_voltage,
+      )
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/bricklet_air_quality/bricklet_air_quality.json

@@ -0,0 +1,3 @@
+{
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Air_Quality.html"
+}

data/lib/tinderfridge/devices/bricklet_air_quality/bricklet_air_quality.rb

@@ -0,0 +1,20 @@
+module Tinkerforge
+
+  class BrickletAirQuality
+
+    # Returns the device's state.
+    def state
+      av = get_all_values
+      super.merge(
+        'iaq_index'          => av[0],
+        'iaq_index_accuracy' => av[1],
+        'temperature'        => av[2],
+        'temperature_offset' => get_temperature_offset,
+        'humidity'           => av[3],
+        'air_pressure'       => av[4],
+      )
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/bricklet_ambient_light_v3/bricklet_ambient_light_v3.json

@@ -0,0 +1,3 @@
+{
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Ambient_Light_V3.html"
+}

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

@@ -0,0 +1,19 @@
+module Tinkerforge
+
+  class BrickletAmbientLightV3
+
+    ILLUMINANCE_RANGES = [ 64000, 32000, 16000, 8000, 1300, 600, 100000 ]
+
+    # Returns the device's state.
+    def state
+      super.merge(
+        'configuration'     => conf = get_configuration,
+        'illuminance_range' => ILLUMINANCE_RANGES[ conf[0] ],
+        'integration_time'  => 50 + conf[1] * 50,
+        'illuminance_raw'   => get_illuminance,
+      )
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/bricklet_color_v2/bricklet_color_v2.json

@@ -0,0 +1,3 @@
+{
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Color_V2.html"
+}

data/lib/tinderfridge/devices/bricklet_color_v2/bricklet_color_v2.rb

@@ -0,0 +1,31 @@
+module Tinkerforge
+
+  class BrickletColorV2
+
+    GAINS = [1, 4, 16, 60]
+    INTEGRATION_TIMES = [2.4, 24, 101, 154, 700]
+
+    # Switches off the Bricklet's white LED.
+    def blackout
+      set_light false
+      true
+    end
+
+    # Returns the device's state.
+    def state
+      super.merge(
+        'configuration'     => config = get_configuration,
+        'gain'              => GAINS[ config[0] ],
+        'integration_time'  => INTEGRATION_TIMES[ config[1] ],
+        'color_rgbc'        => color = get_color,
+        'illuminance_raw'   => illum = get_illuminance,
+        'illuminance'       => illum * 700.0 / GAINS[ config[0] ] / INTEGRATION_TIMES[ config[1] ],
+        'color_temperature' => get_color_temperature,
+        'saturated'         => color[0,3].include?(65535),
+        'light'             => get_light,
+      )
+    end
+
+  end
+
+end