tinderfridge 0.2.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a1a23e33e307a89386dbf4d61f3a9852e000e3382ec3c61de5b1c45c0335f11
-  data.tar.gz: 4261d085ad57d3205da9b27fcd38d74bd3bb47e482f0fbcfb391918e4abac268
+  metadata.gz: 61c196b035feb056ef219545b4fb18b0d31143ec45dce191fd24abba736c6c06
+  data.tar.gz: b8f7e262293e0c1f42648f57360818bc160bef744d3bf4e1424c31f81658fe84
 SHA512:
-  metadata.gz: 12677e84815ddad014bf40df64798fbb05c46be764106143e16d2964a73d71a402bfb9d66bbc6f1422ec83766628ec0f6e2ddf9817fb64e38988523f9b4c3479
-  data.tar.gz: '0749d1e2bf1b022313bbe807c08836df740d223d1b5d81efd5bb388693c84c707d436e5dc35f9fe827518dcf6ce97db70e9f8c948a5d3b0e64f75b4780f722f5'
+  metadata.gz: 68b64abcf925c879f4962b505c4ae06b9cdf3d4fad9964c34e1d33cbe1dc72fffee805a7a1651fe9b4d0cdc3c2c93a53a593dafdc0ad28f8fea93e20a3fc2c0b
+  data.tar.gz: b3a2980b1f8d21b9044b59b8e40b62bf148fc5a18505b3391f1c7047796df5139e2782e50872cac01acf1a29bb8b52cfe14fea0fca8b706c9a6fb3d120ebbfc5

data/lib/tinderfridge/device.rb

@@ -1,6 +1,7 @@
 require 'tinkerforge/ip_connection'
 
 module Tinkerforge
+
   class Device
 
     #----------------------------------------------------------------------#
@@ -41,7 +42,7 @@ module Tinkerforge
       def inherited(klass)
         if info = Tinkerforge.device_info(klass)
           begin
-            require("tinderfridge/devices/#{info[2][1]}")
+            require("tinderfridge/devices/#{info[2][1]}/#{info[2][1]}")
           rescue LoadError
             # No extension found for this device
           end
@@ -54,14 +55,80 @@ module Tinkerforge
     #                           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
+
+      # BrickDaemon inherits from Device, but has no #get_identity.
+      return {} unless respond_to? 'get_identity'
+
+      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.
@@ -82,5 +149,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

@@ -63,6 +63,75 @@ module Tinkerforge
       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)

data/lib/tinderfridge/device_info.txt

@@ -135,5 +135,10 @@
 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
+2164	Industrial PTC Bricklet	Tinkerforge::BrickletIndustrialPTC	bricklet_industrial_ptc
+2165	DC Bricklet 2.0	Tinkerforge::BrickletDCV2	bricklet_dc_v2
+2166	Silent Stepper Bricklet 2.0	Tinkerforge::BrickletSilentStepperV2	bricklet_silent_stepper_v2

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

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

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,11 @@
+{
+  "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",
+  "released": "2019-05-21"
+}

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,10 @@
+{
+  "dimensions": [
+    25,
+    20,
+    5
+  ],
+  "weight": 2.1,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Air_Quality.html",
+  "versions_identifier": "bricklets:air_quality"
+}

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,10 @@
+{
+  "dimensions": [
+    25,
+    15,
+    5
+  ],
+  "weight": 2,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Ambient_Light_V3.html",
+  "versions_identifier": "bricklets:ambient_light_v3"
+}

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_analog_in_v3/bricklet_analog_in_v3.json

@@ -0,0 +1,10 @@
+{
+  "dimensions": [
+    35,
+    30,
+    14
+  ],
+  "weight": 8,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Analog_In_V3.html",
+  "versions_identifier": "bricklets:analog_in_v3"
+}

data/lib/tinderfridge/devices/bricklet_analog_out_v3/bricklet_analog_out_v3.json

@@ -0,0 +1,10 @@
+{
+  "dimensions": [
+    35,
+    30,
+    14
+  ],
+  "weight": 8,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Analog_Out_V3.html",
+  "versions_identifier": "bricklets:analog_out_v3"
+}

data/lib/tinderfridge/devices/bricklet_barometer_v2/bricklet_barometer_v2.json

@@ -0,0 +1,10 @@
+{
+  "dimensions": [
+    25,
+    15,
+    5
+  ],
+  "weight": 1.6,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Barometer_V2.html",
+  "versions_identifier": "bricklets:barometer_v2"
+}

data/lib/tinderfridge/devices/bricklet_can_v2/bricklet_can_v2.json

@@ -0,0 +1,11 @@
+{
+  "dimensions": [
+    45,
+    35,
+    14
+  ],
+  "weight": 8.6,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/CAN_V2.html",
+  "versions_identifier": "bricklets:can_v2",
+  "released": "2018-06-07"
+}

data/lib/tinderfridge/devices/bricklet_co2_v2/bricklet_co2_v2.json

@@ -0,0 +1,10 @@
+{
+  "dimensions": [
+    35,
+    40,
+    18
+  ],
+  "weight": 9,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/CO2_V2.html",
+  "versions_identifier": "bricklets:co2_v2"
+}

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

@@ -0,0 +1,10 @@
+{
+  "dimensions": [
+    25,
+    20,
+    5
+  ],
+  "weight": 2,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Color_V2.html",
+  "versions_identifier": "bricklets:color_v2"
+}

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