tinderfridge 0.7.0 → 0.10.0

data/lib/tinderfridge/devices/bricklet_multi_touch_v2/bricklet_multi_touch_v2.json

@@ -6,5 +6,6 @@
   ],
   "weight": 4,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Multi_Touch_V2.html",
-  "versions_identifier": "bricklets:multi_touch_v2"
+  "versions_identifier": "bricklets:multi_touch_v2",
+  "released": "2019-08-22"
 }

data/lib/tinderfridge/devices/bricklet_nfc/bricklet_nfc.json

@@ -6,5 +6,6 @@
   ],
   "weight": 18,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/NFC.html",
-  "versions_identifier": "bricklets:nfc"
+  "versions_identifier": "bricklets:nfc",
+  "released": "2018-02-26"
 }

data/lib/tinderfridge/devices/bricklet_oled_128x64_v2/bricklet_oled_128x64_v2.rb

@@ -0,0 +1,79 @@
+require 'tinderfridge/shared/display_ibm437_encoding'
+
+module Tinkerforge
+
+  class BrickletOLED128x64V2
+
+    include Tinkerforge::Shared::IBM437_encoding
+
+    # Encodes a string in the IBM437 character set used by some displays.
+    #
+    # Characters that can not be encoded are replaced with '?'.
+    #
+    # See:
+    # - https://en.wikipedia.org/wiki/Code_page_437
+    def encode(string)
+      ibm437_encode(string)
+    end
+
+    # Turns the display all black.
+    def blackout
+      c = get_display_configuration
+
+      if c[1] # inverted
+        set_display_configuration c[0], false, c[2]
+      end
+
+      clear_display
+
+      if ! c[2] # buffered
+        draw_buffered_frame(true)
+      end
+
+      true
+    end
+
+    # Returns true if automatic draw is set to false.
+    def buffered?
+      ! get_display_configuration[2]
+    end
+
+    # Draws the currently buffered frame.
+    def redraw(force_complete_redraw=false)
+      draw_buffered_frame force_complete_redraw
+    end
+
+    alias flush redraw
+
+    # Returns the device's state.
+    def state
+      super.merge(
+        'display_configuration' => get_display_configuration,
+      )
+    end
+
+    # Clears the display and prints upto 8 lines of text.
+    #
+    # Text may contain newline characters to separate lines.
+    # Lines longer than 21 characters will be wrapped.
+    #
+    # Text is automatically encoded in the IBM437 character set.
+    # @example
+    #  my_oled.put_screen "Hello, World!\n\nRuby #{RUBY_VERSION}"
+    def put_screen(text='', test: false)
+      lines = text.split("\n")
+      lines = lines.map { |s| s.empty? ? '' : s.scan(/.{1,21}/) }.flatten
+      lines = lines[0,8].map { |l| encode l }
+
+      return lines if test
+
+      clear_display
+      lines.each_with_index do |s,l|
+        write_line l, 0, s
+      end
+      nil
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/bricklet_one_wire/bricklet_one_wire.json

@@ -0,0 +1,11 @@
+{
+  "dimensions": [
+    30,
+    30,
+    14
+  ],
+  "weight": 6.5,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/One_Wire.html",
+  "versions_identifier": "bricklets:one_wire",
+  "released": "2018-09-27"
+}

data/lib/tinderfridge/devices/bricklet_outdoor_weather/bricklet_outdoor_weather.json

@@ -6,5 +6,6 @@
   ],
   "weight": 10,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Outdoor_Weather.html",
-  "versions_identifier": "bricklets:outdoor_weather"
+  "versions_identifier": "bricklets:outdoor_weather",
+  "released": "2018-02-26"
 }

data/lib/tinderfridge/devices/bricklet_particulate_matter/bricklet_particulate_matter.json

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

data/lib/tinderfridge/devices/bricklet_piezo_speaker_v2/bricklet_piezo_speaker_v2.json

@@ -6,5 +6,6 @@
   ],
   "weight": 20,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Piezo_Speaker_V2.html",
-  "versions_identifier": "bricklets:piezo_speaker_v2"
+  "versions_identifier": "bricklets:piezo_speaker_v2",
+  "released": "2019-05-20"
 }

data/lib/tinderfridge/devices/bricklet_ptc_v2/bricklet_ptc_v2.json

@@ -0,0 +1,11 @@
+{
+  "dimensions": [
+    35,
+    30,
+    15
+  ],
+  "weight": 9,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/PTC_V2.html",
+  "versions_identifier": "bricklets:ptc_v2",
+  "released": "2018-06-07"
+}

data/lib/tinderfridge/devices/bricklet_real_time_clock_v2/bricklet_real_time_clock_v2.json

@@ -6,5 +6,6 @@
   ],
   "weight": 3,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/RealTime_Clock_V2.html",
-  "versions_identifier": "bricklets:real_time_clock_v2"
+  "versions_identifier": "bricklets:real_time_clock_v2",
+  "released": "2018-06-07"
 }

data/lib/tinderfridge/devices/bricklet_remote_switch_v2/bricklet_remote_switch_v2.json

@@ -6,5 +6,6 @@
   ],
   "weight": 8,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Remote_Switch_V2.html",
-  "versions_identifier": "bricklets:remote_switch_v2"
+  "versions_identifier": "bricklets:remote_switch_v2",
+  "released": "2018-02-26"
 }

data/lib/tinderfridge/devices/bricklet_rgb_led_button/bricklet_rgb_led_button.json

@@ -6,5 +6,6 @@
   ],
   "weight": 7,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/RGB_LED_Button.html",
-  "versions_identifier": "bricklets:rgb_led_button"
+  "versions_identifier": "bricklets:rgb_led_button",
+  "released": "2017-11-17"
 }

data/lib/tinderfridge/devices/bricklet_rgb_led_v2/bricklet_rgb_led_v2.json

@@ -6,5 +6,6 @@
   ],
   "weight": 3,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/RGB_LED_V2.html",
-  "versions_identifier": "bricklets:rgb_led_v2"
+  "versions_identifier": "bricklets:rgb_led_v2",
+  "released": "2019-05-20"
 }

data/lib/tinderfridge/devices/bricklet_rotary_encoder_v2/bricklet_rotary_encoder_v2.json

@@ -6,5 +6,6 @@
   ],
   "weight": 6,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Rotary_Encoder_V2.html",
-  "versions_identifier": "bricklets:rotary_encoder_v2"
+  "versions_identifier": "bricklets:rotary_encoder_v2",
+  "released": "2018-02-26"
 }

data/lib/tinderfridge/devices/bricklet_rotary_poti_v2/bricklet_rotary_poti_v2.json

@@ -6,5 +6,6 @@
   ],
   "weight": 7,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Rotary_Poti_V2.html",
-  "versions_identifier": "bricklets:rotary_poti_v2"
+  "versions_identifier": "bricklets:rotary_poti_v2",
+  "released": "2019-08-22"
 }

data/lib/tinderfridge/devices/bricklet_segment_display_4x7_v2/bricklet_segment_display_4x7_v2.json

@@ -6,5 +6,6 @@
   ],
   "weight": 11,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Segment_Display_4x7_V2.html",
-  "versions_identifier": "bricklets:segment_display_4x7_v2"
+  "versions_identifier": "bricklets:segment_display_4x7_v2",
+  "released": "2019-05-20"
 }

data/lib/tinderfridge/devices/bricklet_segment_display_4x7_v2/bricklet_segment_display_4x7_v2.rb

@@ -12,7 +12,7 @@ module Tinkerforge
 
     # Returns the state of all 35 segments.
     def segments
-      send_request FUNCTION_GET_SEGMENTS, [], '', 14, '?35'
+      get_segments.flatten
     end
 
     # Sets the state of all 35 segments.
@@ -120,9 +120,33 @@ module Tinkerforge
         '[' => '1001110',
         ']' => '1111000',
 
+        '°' => '1100011',
+
       }
     end
 
+    # Displays an 8-segment bar graph for 1 or 2 values in the range 0..1.
+    #
+    # @example
+    #  my_bricklet.bar_graph 0.5
+    #  my_bricklet.bar_graph 0.5, 0.8
+    def bar_graph(value1, value2=value1)
+      value1, value2 = [value1, value2].map { |v| (v.to_f.clamp(0,1) * 8).round }
+
+      frame = [false] * 35
+
+      [ 5, 1, 13,  9, 21, 17, 29, 25 ].first(value1).each do |n|
+        frame[n] = true
+      end
+
+      [ 4, 2, 12, 10, 20, 18, 28, 26 ].first(value2).each do |n|
+        frame[n] = true
+      end
+
+      self.segments = frame
+      [value1, value2]
+    end
+
   end
 
 end

data/lib/tinderfridge/devices/bricklet_solid_state_relay_v2/bricklet_solid_state_relay_v2.json

@@ -0,0 +1,11 @@
+{
+  "dimensions": [
+    19,
+    33.4,
+    5
+  ],
+  "weight": 2,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Solid_State_Relay_V2.html",
+  "versions_identifier": "bricklets:solid_state_relay_v2",
+  "released": "2018-02-26"
+}

data/lib/tinderfridge/devices/bricklet_sound_pressure_level/bricklet_sound_pressure_level.json

@@ -6,5 +6,6 @@
   ],
   "weight": 2.6,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Sound_Pressure_Level.html",
-  "versions_identifier": "bricklets:sound_pressure_level"
+  "versions_identifier": "bricklets:sound_pressure_level",
+  "released": "2018-06-07"
 }

data/lib/tinderfridge/devices/bricklet_sound_pressure_level/bricklet_sound_pressure_level.rb

@@ -0,0 +1,20 @@
+module Tinkerforge
+
+  class BrickletSoundPressureLevel
+
+    WEIGHTINGS = [ 'dB(A)', 'dB(B)','dB(C)', 'dB(D)', 'dB(Z)', 'ITU-R 468']
+
+    # Returns the device's state.
+    def state
+      super.merge(
+        'configuration'  => conf = get_configuration,
+        'weighting'      => WEIGHTINGS[ conf[1] ],
+        'sampling_rate'  => 2 ** (3 - conf[0]) * 10,
+        'bin_size'       => 2 ** (3 - conf[0]) * 40,
+        'sound_pressure' => get_decibel,
+      )
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/bricklet_temperature_ir_v2/bricklet_temperature_ir_v2.json

@@ -6,5 +6,6 @@
   ],
   "weight": 3,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Temperature_IR_V2.html",
-  "versions_identifier": "bricklets:temperature_ir_v2"
+  "versions_identifier": "bricklets:temperature_ir_v2",
+  "released": "2018-02-26"
 }

data/lib/tinderfridge/devices/bricklet_temperature_ir_v2/bricklet_temperature_ir_v2.rb

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

data/lib/tinderfridge/devices/bricklet_temperature_v2/bricklet_temperature_v2.json

@@ -6,5 +6,6 @@
   ],
   "weight": 2,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Temperature_V2.html",
-  "versions_identifier": "bricklets:temperature_v2"
+  "versions_identifier": "bricklets:temperature_v2",
+  "released": "2018-09-27"
 }

data/lib/tinderfridge/devices/bricklet_thermal_imaging/bricklet_thermal_imaging.json

@@ -6,5 +6,6 @@
   ],
   "weight": 8,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Thermal_Imaging.html",
-  "versions_identifier": "bricklets:thermal_imaging"
+  "versions_identifier": "bricklets:thermal_imaging",
+  "released": "2017-11-17"
 }

data/lib/tinderfridge/devices/bricklet_thermocouple_v2/bricklet_thermocouple_v2.json

@@ -6,5 +6,6 @@
   ],
   "weight": 9,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Thermocouple_V2.html",
-  "versions_identifier": "bricklets:thermocouple_v2"
+  "versions_identifier": "bricklets:thermocouple_v2",
+  "released": "2018-06-07"
 }

data/lib/tinderfridge/devices/bricklet_uv_light_v2/bricklet_uv_light_v2.json

@@ -6,5 +6,6 @@
   ],
   "weight": 2.1,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/UV_Light_V2.html",
-  "versions_identifier": "bricklets:uv_light_v2"
+  "versions_identifier": "bricklets:uv_light_v2",
+  "released": "2018-09-27"
 }

data/lib/tinderfridge/devices/bricklet_voltage_current_v2/bricklet_voltage_current_v2.json

@@ -6,5 +6,6 @@
   ],
   "weight": 10,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Voltage_Current_V2.html",
-  "versions_identifier": "bricklets:voltage_current_v2"
+  "versions_identifier": "bricklets:voltage_current_v2",
+  "released": "2018-06-07"
 }

data/lib/tinderfridge/devices/bricklet_xmc1400_breakout/bricklet_xmc1400_breakout.json

@@ -6,5 +6,6 @@
   ],
   "weight": 12,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/XMC1400_Breakout.html",
-  "versions_identifier": "bricklets:xmc1400_breakout"
+  "versions_identifier": "bricklets:xmc1400_breakout",
+  "released": "2019-08-22"
 }

data/lib/tinderfridge/ip_connection.rb

@@ -10,6 +10,9 @@ module Tinkerforge
     # Returns the port for the IP Connection.
     attr_reader :port
 
+    # Returns the network socket used by the IP Connection.
+    attr_reader :socket
+
     # Returns a programmer-friendly representation of the object.
     def inspect
       "%s (%s:%s)" % [self.class, host, port]
@@ -117,17 +120,22 @@ module Tinkerforge
 
   end
 
-  # Creates an IP Connection object connected to the given host and port.
-  #
-  # If no host and port are specified, uses the TINKERFORGE_HOST and TINKERFORGE_PORT environment variables, when defined.
-  # Otherwise defaults to 'localhost' and port 4223.
-  def self.connect(host=nil, port=nil)
-    ipcon = IPConnection.new
-    ipcon.connect(
-      ( host || ENV['TINKERFORGE_HOST'] || 'localhost' ),
-      ( port || ENV['TINKERFORGE_PORT'] ||  4223       )
-    )
-    ipcon
+
+  class << self
+
+    # Creates an IP Connection object connected to the given host and port.
+    #
+    # If no host and port are specified, uses the TINKERFORGE_HOST and TINKERFORGE_PORT environment variables, when defined.
+    # Otherwise defaults to 'localhost' and port 4223.
+    def connect(host=nil, port=nil)
+      ipcon = IPConnection.new
+      ipcon.connect(
+        ( host || ENV['TINKERFORGE_HOST'] || 'localhost' ),
+        ( port || ENV['TINKERFORGE_PORT'] ||  4223       )
+      )
+      ipcon
+    end
+
   end
 
 end

data/lib/tinderfridge/shared/display_ibm437_encoding.rb

@@ -0,0 +1,41 @@
+module Tinkerforge
+
+  module Shared
+
+    module IBM437_encoding
+
+      private
+
+      # Encodes a string in the IBM437 character set used by some displays.
+      #
+      # Characters that can not be encoded are replaced with '?'.
+      #
+      # See:
+      # - https://en.wikipedia.org/wiki/Code_page_437
+      def ibm437_encode(string)
+        string.encode('IBM437', fallback: ibm437_encoding_fallback_table)
+      end
+
+      # Ruby's IBM437 encoding does not include codepoints 0..31 and 127.
+      # This fallback table defines those, minus 0,
+      # and defines '?' as default for undefined characters.
+      def ibm437_encoding_fallback_table
+        @@ibm437_encoding_fallback_table ||= Hash.new('?').merge(
+          {
+            '☺'=> "\x01", '☻'=> "\x02", '♥'=> "\x03", '♦'=> "\x04",
+            '♣'=> "\x05", '♠'=> "\x06", '•'=> "\x07", '◘'=> "\x08",
+            '○'=> "\x09", '◙'=> "\x0a", '♂'=> "\x0b", '♀'=> "\x0c",
+            '♪'=> "\x0d", '♫'=> "\x0e", '☼'=> "\x0f", '►'=> "\x10",
+            '◄'=> "\x11", '↕'=> "\x12", '‼'=> "\x13", '¶'=> "\x14",
+            '§'=> "\x15", '▬'=> "\x16", '↨'=> "\x17", '↑'=> "\x18",
+            '↓'=> "\x19", '→'=> "\x1a", '←'=> "\x1b", '∟'=> "\x1c",
+            '↔'=> "\x1d", '▲'=> "\x1e", '▼'=> "\x1f", '⌂'=> "\x7f"
+          }
+        )
+      end
+
+    end
+
+  end
+
+end

data/lib/tinderfridge/tinkerforge.rb

@@ -5,16 +5,31 @@ module Tinkerforge
   ALL_VERSIONS_URL    = 'https://download.tinkerforge.com/all_versions.txt'
   LATEST_VERSIONS_URL = 'https://download.tinkerforge.com/latest_versions.txt'
 
-  # Returns the directory where Tinkerforge bindings appear to be installed.
-  def self.lib_dir
-    File.dirname File.dirname Device.instance_method('uid').source_location.first
-  end
+  class << self
+
+    # Returns the directory where Tinkerforge bindings appear to be installed.
+    def lib_dir
+      File.dirname File.dirname Device.instance_method('uid').source_location.first
+    end
+
+    # Attempts to load all files that are part of Tinkerforge. Returns a list of files loaded.
+    def require_everything
+      Dir.glob(File.join lib_dir, 'tinkerforge', '*.rb').map do |file|
+        require(file) ? file : nil
+      end.compact
+    end
+
+    # Discovers local devices.
+    #
+    # Connects to 'localhost', and returns devices discovered there. If no port is specified, defaults to port 4223.
+    # @example
+    #  Tinkerforge.local.ls
+    # @example Mac only
+    #  Tinkerforge.local.doc
+    def local(port=4223)
+      connect('localhost', port).discover(0.25)
+    end
 
-  # Attempts to load all files that are part of Tinkerforge. Returns a list of files loaded.
-  def self.require_everything
-    Dir.glob(File.join lib_dir, 'tinkerforge', '*.rb').map do |file|
-      require(file) ? file : nil
-    end.compact
   end
 
 end

data/lib/tinderfridge/version.rb

@@ -3,7 +3,7 @@ require 'tinkerforge/version'
 module Tinkerforge
 
   # Tinderfridge version.
-  TINDERFRIDGE_VERSION = '0.7.0'
+  TINDERFRIDGE_VERSION = '0.10.0'
 
   # About Tinkerforge & Tinderfridge.
   def self.about