tinderfridge 0.5.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7b851b2ea04d7ab8385d6ca4f11cece38721b4cb09dd7afbd449e84d9e4e2a7
-  data.tar.gz: 19e264699bc41886fe56fa954339d04b118994d39990cb0e834d7a8b5fb1f0e2
+  metadata.gz: 26a171ddfc01502cca8300d445d498c960b8cfb1304e1b60fddc5d33ad0a68ba
+  data.tar.gz: ebf5e97bd0fe072375c6a548615baff3e42ef77432b96373035571a41897ba8a
 SHA512:
-  metadata.gz: 7694f3b62443011a1658034d015a50485f491cee038ce87f820b58e35bf017ce857a21a25a8aae33b92602164100e04a50fc5094679da1164a0592a845852b5b
-  data.tar.gz: fd7b21aac321ae3b25be1857da5e6c91cbc26d7f3bc839fd5934774de35dd9730a5bdfa13ed103f8d4d3bfb4f533d87a325f01f20ec6db30991a24511a0f6e7d
+  metadata.gz: e5a6e8d3f54c3955afbbce8d48c1ded48ea46535dd078cc6118d207bf988634c7e04fbcab178a5b440ea5ff55798287df53f94465a06e0971a5d0282876f532f
+  data.tar.gz: 31d5cbea577e5b98279279193301e2a95062db29d7150149c3035ecb639f4301ce739854927f018fa922a9630bea7217c76dfb0329ccc5e88359b73f7c4fc7fe

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
@@ -81,32 +82,85 @@ module Tinkerforge
       "%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] } ],
         [ '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,
+
+        if respond_to?('get_spitfp_error_count') and (method(:get_spitfp_error_count).arity == 0)
+          [ 'spitfp_error_count', get_spitfp_error_count ]
+        else
+          nil
+        end,
+
         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.
+    # Supports recent devices. When invoked on some older devices, does nothing.
     def identify(seconds=10)
-      if (respond_to? 'get_status_led_config') and (respond_to? 'set_status_led_config')
+      case status_led_api_variety
+      when 1
+        seconds = seconds.to_i
+        state   = is_status_led_enabled
+
+        (seconds*2).times do |n|
+          if n.even?
+            disable_status_led
+          else
+            enable_status_led
+          end
+          sleep 0.5
+        end
+
+        if state
+          enable_status_led
+        else
+          disable_status_led
+        end
+
+        seconds
+      when 2
         seconds = seconds.to_i
         state = get_status_led_config
 
@@ -122,5 +176,46 @@ 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
+
+    def status_led_api_variety
+      @status_led_api_variety ||=
+        if ( respond_to?('get_status_led_config') &&
+             respond_to?('set_status_led_config') )
+          2
+        elsif ( respond_to?('is_status_led_enabled') &&
+                respond_to?('enable_status_led')     &&
+                respond_to?('disable_status_led') )
+          1
+        else
+          nil
+        end
+    end
+
   end
+
 end

data/lib/tinderfridge/device_collection.rb

@@ -5,6 +5,8 @@ module Tinkerforge
     # Returns the temperatures as measured inside the microcontrollers of devices in the collection.
     #
     # Nil for devices that do not support the get_chip_temperature method.
+    #
+    # Note: most devices return temperature in °C, but a few return temperature in 1/10 °C.
     def get_chip_temperature
       smap 'get_chip_temperature'
     end
@@ -63,11 +65,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.
@@ -119,7 +137,7 @@ module Tinkerforge
     private
 
     def smap(m)
-      map { |k,d| [ k, d.respond_to?(m) ? d.send(m) : nil ] }.to_h
+      map { |k,d| [ k, ( d.respond_to?(m) and (d.method(m).arity == 0) ) ? d.send(m) : nil ] }.to_h
     end
 
   end

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/brick_master/brick_master.json

@@ -0,0 +1,11 @@
+{
+  "dimensions": [
+    40,
+    40,
+    16
+  ],
+  "weight": 12,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricks/Master_Brick.html",
+  "versions_identifier": "bricks:master",
+  "released": ""
+}

data/lib/tinderfridge/devices/brick_master/brick_master.rb

@@ -0,0 +1,11 @@
+module Tinkerforge
+
+  class BrickMaster
+
+    # Unit returned by #get_chip_temperature. Master Bricks return temperature as 1/10 °C.
+    CHIP_TEMPERATURE_UNIT = 0.1
+    # REVIEW: This should ideally be part of base Tinkerforge.
+
+  end
+
+end

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_ambient_light_v3/bricklet_ambient_light_v3.json

@@ -0,0 +1,11 @@
+{
+  "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",
+  "released": "2019-01-29"
+}

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

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

@@ -0,0 +1,19 @@
+module Tinkerforge
+
+  class BrickletCO2V2
+
+    # Returns the device's state.
+    def state
+      av = get_all_values
+      super.merge(
+        'co2_concentration'  => av[0],
+        'temperature'        => av[1],
+        'temperature_offset' => get_temperature_offset,
+        'humidity'           => av[2],
+        'air_pressure'       => get_air_pressure,
+      )
+    end
+
+  end
+
+end

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

@@ -0,0 +1,11 @@
+{
+  "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",
+  "released": "2019-08-22"
+}

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,11 @@
+{
+  "dimensions": [
+    25,
+    20,
+    5
+  ],
+  "weight": 2,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Compass.html",
+  "versions_identifier": "bricklets:compass",
+  "released": "2019-08-22"
+}

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"
+}

data/lib/tinderfridge/devices/bricklet_distance_ir_v2/bricklet_distance_ir_v2.json

@@ -0,0 +1,11 @@
+{
+  "dimensions": [
+    45,
+    13,
+    5
+  ],
+  "weight": 8,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Distance_IR_V2.html",
+  "versions_identifier": "bricklets:distance_ir_v2",
+  "released": "2018-09-27"
+}

data/lib/tinderfridge/devices/bricklet_distance_us_v2/bricklet_distance_us_v2.json

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

data/lib/tinderfridge/devices/bricklet_dmx/bricklet_dmx.json

@@ -0,0 +1,10 @@
+{
+  "dimensions": [
+    60,
+    50,
+    30
+  ],
+  "weight": 30,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/DMX.html",
+  "versions_identifier": "bricklets:dmx"
+}

data/lib/tinderfridge/devices/bricklet_dual_button_v2/bricklet_dual_button_v2.json

@@ -0,0 +1,11 @@
+{
+  "dimensions": [
+    45,
+    20,
+    10
+  ],
+  "weight": 5.5,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Dual_Button_V2.html",
+  "versions_identifier": "bricklets:dual_button_v2",
+  "released": "2018-09-27"
+}

data/lib/tinderfridge/devices/bricklet_e_paper_296x128/bricklet_e_paper_296x128.json

@@ -0,0 +1,10 @@
+{
+  "dimensions": [
+    100,
+    40,
+    6
+  ],
+  "weight": 20,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/EPaper_296x128.html",
+  "versions_identifier": "bricklets:e_paper_296x128"
+}

data/lib/tinderfridge/devices/bricklet_energy_monitor/bricklet_energy_monitor.json

@@ -0,0 +1,10 @@
+{
+  "dimensions": [
+    40,
+    40,
+    5
+  ],
+  "weight": 7,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Energy_Monitor.html",
+  "versions_identifier": "bricklets:energy_monitor"
+}

data/lib/tinderfridge/devices/bricklet_gps_v2/bricklet_gps_v2.json

@@ -0,0 +1,11 @@
+{
+  "dimensions": [
+    40,
+    35,
+    12
+  ],
+  "weight": 20,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/GPS_V2.html",
+  "versions_identifier": "bricklets:gps_v2",
+  "released": "2017-05-11"
+}

data/lib/tinderfridge/devices/{bricklet_gps_v2.rb → bricklet_gps_v2/bricklet_gps_v2.rb}

@@ -2,11 +2,24 @@ module Tinkerforge
 
   class BrickletGPSV2
 
+    # Returns the device's state.
+    def state
+      super.merge(
+        'fix_led_config' => get_fix_led_config,
+        'fix'            => fix?,
+      )
+    end
+
+    # Returns true if a fix is available.
+    def fix?
+      get_status[0]
+    end
+
     # 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]
+      if fix?
         c = get_coordinates
         [
           c[0] / (c[1] == 'N' ? 1000000.0 : -1000000.0),

data/lib/tinderfridge/devices/bricklet_hall_effect_v2/bricklet_hall_effect_v2.json

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

data/lib/tinderfridge/devices/bricklet_humidity_v2/bricklet_humidity_v2.json

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

data/lib/tinderfridge/devices/bricklet_imu_v3/bricklet_imu_v3.json

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

data/lib/tinderfridge/devices/bricklet_industrial_analog_out_v2/bricklet_industrial_analog_out_v2.json

@@ -0,0 +1,11 @@
+{
+  "dimensions": [
+    40,
+    40,
+    11
+  ],
+  "weight": 9,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Industrial_Analog_Out_V2.html",
+  "versions_identifier": "bricklets:industrial_analog_out_v2",
+  "released": "2018-09-27"
+}

data/lib/tinderfridge/devices/bricklet_industrial_counter/bricklet_industrial_counter.json

@@ -0,0 +1,11 @@
+{
+  "dimensions": [
+    40,
+    40,
+    11
+  ],
+  "weight": 8.4,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Industrial_Counter.html",
+  "versions_identifier": "bricklets:industrial_counter",
+  "released": "2018-06-07"
+}

data/lib/tinderfridge/devices/bricklet_industrial_digital_in_4_v2/bricklet_industrial_digital_in_4_v2.json

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