tinderfridge 0.4.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f7d7c9860d6aa8495eef63beeca7be8d7122205b562c49d560d513bdd780c7f
-  data.tar.gz: efc7ec85867758066b96df1ceccf63ff5b32eee7f0a29b7060560a2236cfe365
+  metadata.gz: c1f848437f1877596a58521fdbe213042f6561b42a91c91b60eca2fd3ab1a690
+  data.tar.gz: '09c7adcf40fabf6eae5ca89316428aeb6cabfa5f4abccbaaf27bd3901535afca'
 SHA512:
-  metadata.gz: 8de0db5c9d6dc68b3f2fd18b434191e7b23c7bdff389b71918308846637e23fdc80b4880c3ee15b0f83b97e358a6751364c73795a1071bfe2e3ed0a99aeecf74
-  data.tar.gz: 640bee0f79ea37182229abed010480cedbd079de16a3920623c5a6ee4cfca393482bb82d64924485a9b7b651afc194394c40bf76a787fbea8bf21e119b491f3d
+  metadata.gz: a84bc2687015ef1c65dd61cac031a7b6e6ff57e22a811784e6160dd5b002badf5f55f11c3883ffa754a6f42d0b5a6e5a085a4c930700c899956d06ec8f533d98
+  data.tar.gz: c12dcf3ef70b1111f665a3098ab213a75819c2953b3c7cb2ebc020bd00b016588ec70ca0bebbdf72666a84edcc4be345f7aaa67c8ee4f8841262c1fc4afb80a7

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
@@ -66,20 +67,42 @@ module Tinkerforge
     # 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       ],
-        [ 'device_identifier'  , device_identifier     ],
-        [ 'device_display_name', device_display_name   ],
         [ 'firmware_version'   , identity[4].join('.') ],
 
         [ 'connected', { 'uid'  => identity[1], 'position' => identity[2] } ],
@@ -92,6 +115,20 @@ module Tinkerforge
       ].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.
@@ -112,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,11 +63,27 @@ 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.
@@ -80,6 +96,42 @@ module Tinkerforge
       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

@@ -139,3 +139,6 @@
 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_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/bricklet_accelerometer_v2/bricklet_accelerometer_v2.json

@@ -0,0 +1,11 @@
+{
+  "dimensions": [
+    25,
+    20,
+    5
+  ],
+  "weight": 2,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Accelerometer_V2.html",
+  "versions_identifier": "bricklets:accelerometer_v2",
+  "released": "2019-01-29"
+}

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

@@ -0,0 +1,11 @@
+{
+  "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",
+  "released": "2018-09-27"
+}

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,11 @@
+{
+  "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",
+  "released": "2018-09-27"
+}

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

@@ -0,0 +1,11 @@
+{
+  "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",
+  "released": "2018-09-27"
+}

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

data/lib/tinderfridge/devices/bricklet_compass/bricklet_compass.json

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

data/lib/tinderfridge/devices/bricklet_dc_v2/bricklet_dc_v2.json

@@ -0,0 +1,11 @@
+{
+  "dimensions": [
+    40,
+    40,
+    15
+  ],
+  "weight": 12,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/DC_V2.html",
+  "versions_identifier": "bricklets:dc_v2",
+  "released": "2021-05-04"
+}