tinderfridge 0.11.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1c28bf9d30fc0a07640bc0455e0c79625d9c83891eff91d8e6e4227780c57d3
-  data.tar.gz: cb7039e16d274378b77af9c065e74ff0ad2ebd07450df034893d04144c5b5302
+  metadata.gz: 2805da1fbb45d1938cde253637d7a66119718191692caf44ceb22f5d684ed58a
+  data.tar.gz: 5e3dbb8a81b3a5f59975a0b4ef4f1c5cbaa76e97d1fc6d9034cd14edc0f0371b
 SHA512:
-  metadata.gz: 3311ac8e16a9233ae652ae8caf50aca8ebe6fa48ba8f0079764da55a8234542d57044ab52c2d7a6358fe22fb57e771c4cef8777e772dff3ad78da1e0e86ba989
-  data.tar.gz: 466bc1054d70689af056866a5d784050d6731d71fc711937a59e8a053bc7f17335eee594034f241282f918d773237d401486f62cef209d173e37eb95b559e105
+  metadata.gz: e5d86b78c3c4351b63d9bcbad1032a661d6fdd9b00457a59deaed677d358577781fdc2809ebe7f8a7c762c77638685d601349bb2065930e9f5dad8232ae61a2f
+  data.tar.gz: bc3e28b83f1704169827b0a4650e1f5a360714d70e5f153e62e4428f33360821e2514e31a10ff089cdfa4955225656106b26e314b03d6b24cdf91fe7190014a9

data/lib/tinderfridge/device.rb

@@ -15,6 +15,7 @@ module Tinkerforge
       # With help from:
       # - https://stackoverflow.com/questions/2393697
       def descendants
+        # NOTE: Ruby 3.1 has Class#subclasses
         ObjectSpace.each_object(Class).select { |klass| klass < self }
       end
 
@@ -121,6 +122,11 @@ module Tinkerforge
       ].compact.to_h
     end
 
+    # Returns configuration data for the device (a mutable Hash).
+    def config
+      @config ||= {}
+    end
+
     # Opens the online documentation for the device (Mac OS only).
     #
     # When the URL for the documentation is not known, does nothing.

data/lib/tinderfridge/device_collection.rb

@@ -61,7 +61,7 @@ module Tinkerforge
     # 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]]
+        puts "%-8s %.40s" % [k, self[k].device_display_name]
       end.size
     end
 
@@ -77,6 +77,11 @@ module Tinkerforge
       smap 'state'
     end
 
+    # Returns configuration data of devices in the collection.
+    def config
+      smap 'config'
+    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.
@@ -86,6 +91,18 @@ module Tinkerforge
 
     alias doc open_documentation
 
+    # On Mac OS, opens a new Brick Viewer for each unique
+    # IP Connection used by devices in the collection.
+    #
+    # Not supported on other platforms.
+    #
+    # Requires Brick Viewer version 2.4.23 or later.
+    def open_brick_viewer
+      ipcons.map { |i| i.open_brick_viewer }
+    end
+
+    alias brickv open_brick_viewer
+
     # Turns off light sources such as screens and RGB LEDs for devices in the collection.
     #
     # Ignores devices that do not support the blackout method.

data/lib/tinderfridge/devices/brick_esp32_ethernet/brick_esp32_ethernet.rb

@@ -5,7 +5,7 @@ module Tinkerforge
     private
 
     def _view_21x8
-      "ESP32 Eth    #{uid_string.rjust 8}"
+      "ESP32Eth     #{uid_string.rjust 8}"
     end
 
   end

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

@@ -14,6 +14,15 @@ module Tinkerforge
       )
     end
 
+    private
+
+    def _view_21x8
+      s = state
+      "AmbiLightV3  #{uid_string.rjust 8}\n\n\n" +
+      ("%.2f Lux" % [0.01 * s['illuminance_raw']]).center(21) + "\n\n\n\n" +
+      ("max %d / %d ms" % [ s['illuminance_range'], s['integration_time'] ]).center(21)
+    end
+
   end
 
 end

data/lib/tinderfridge/devices/bricklet_barometer_v2/bricklet_barometer_v2.rb

@@ -18,11 +18,8 @@ module Tinkerforge
     private
 
     def _view_21x8
-      <<~ET
-      Baro         #{uid_string.rjust 8}
-
-          #{'%7.2f hPa' % [get_air_pressure*0.001]}
-      ET
+      "BaroV2       #{uid_string.rjust 8}\n\n\n" +
+      ('%.2f hPa' % [get_air_pressure*0.001]).center(21)
     end
 
   end

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

@@ -17,11 +17,8 @@ module Tinkerforge
     private
 
     def _view_21x8
-      <<~ET
-      CO2          #{uid_string.rjust 8}
-
-            #{'%5d PPM' % get_co2_concentration}
-      ET
+      "CO2V2        #{uid_string.rjust 8}\n\n\n" +
+      ('%d PPM' % get_co2_concentration).center(21)
     end
 
   end

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

@@ -4,7 +4,7 @@
     35,
     12
   ],
-  "weight": 20,
+  "weight": 16,
   "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/bricklet_gps_v2.rb

@@ -49,7 +49,7 @@ module Tinkerforge
     private
 
     def _view_21x8
-      "GPS          #{uid_string.rjust 8}\n\n" +
+      "GPSV2        #{uid_string.rjust 8}\n\n" +
       ((c = coordinates) ? ("   Lat %10.5f\n   Lon %10.5f" % c) : '       no fix')
     end
 

data/lib/tinderfridge/devices/bricklet_gps_v3/bricklet_gps_v3.json

@@ -1,4 +1,11 @@
 {
+  "dimensions": [
+    40,
+    40,
+    12
+  ],
+  "weight": 12,
   "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/GPS_V3.html",
+  "versions_identifier": "bricklets:gps_v3",
   "released": "2022-05-09"
 }

data/lib/tinderfridge/devices/bricklet_gps_v3/bricklet_gps_v3.rb

@@ -0,0 +1,58 @@
+module Tinkerforge
+
+  class BrickletGPSV3
+
+    # 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 fix?
+        c = get_coordinates
+        [
+          c[0] / (c[1] == 'N' ? 1000000.0 : -1000000.0),
+          c[2] / (c[3] == 'E' ? 1000000.0 : -1000000.0)
+        ]
+      else
+        nil
+      end
+    end
+
+    # Returns a Time object representing the time as reported by the GPS Bricklet.
+    def time
+      # FIXME: This will not work after 31-Dec-2099.
+      dt = get_date_time.map &:to_s
+      dt = dt[0].rjust(6,'0').unpack('a2a2a2').reverse + dt[1].rjust(9,'0').concat('000').unpack('a2a2a2a6')
+      dt[0].prepend '20'
+      Time.gm *dt.map(&:to_i)
+    end
+
+    # Returns a URL for viewing the current coordinates on OpenStreetMap.
+    def openstreetmap_marker_url(zoom=12)
+      if c = coordinates
+        "https://www.openstreetmap.org/?mlat=%f&mlon=%f&zoom=%d" % [c, zoom].flatten
+      end
+    end
+
+    private
+
+    def _view_21x8
+      "GPSV3        #{uid_string.rjust 8}\n\n" +
+      ((c = coordinates) ? ("   Lat %10.5f\n   Lon %10.5f" % c) : '       no fix')
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/bricklet_lcd_128x64/bricklet_lcd_128x64.rb

@@ -106,7 +106,7 @@ module Tinkerforge
     private
 
     def _view_21x8
-      "LCD          #{uid_string.rjust 8}"
+      "LCD128x64    #{uid_string.rjust 8}"
     end
 
   end

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

@@ -86,7 +86,7 @@ module Tinkerforge
     private
 
     def _view_21x8
-      "OLED         #{uid_string.rjust 8}"
+      "OLED128x64V2 #{uid_string.rjust 8}"
     end
 
   end

data/lib/tinderfridge/devices/bricklet_outdoor_weather/bricklet_outdoor_weather.rb

@@ -2,15 +2,27 @@ module Tinkerforge
 
   class BrickletOutdoorWeather
 
+    # Returns the device's state.
+    def state
+      super.merge(
+        'sensor_data' => sensors,
+      )
+    end
+
     # Returns the last measured data for all sensors.
     #
-    # The result is a Hash, with sensor identifiers as the keys. Values per sensor are:
+    # The result is a Hash, with sensor identifiers (or their mapped values) as the keys. Values per sensor are:
     # - 0: Temperature (°C)
     # - 1: Relative humidity (%RH)
     # - 2: Last change (seconds)
+    #
+    # Sensor identifiers can be mapped to descriptive strings or other values:
+    # @example
+    #  my_weather_bricklet.config['sensormap'] = { 202 => 'outdoors' }
     def sensors
+      sensormap = (config['sensormap'].class == Hash) ? config['sensormap'] : {}
       get_sensor_identifiers.map do |id|
-        [ id, get_sensor_data(id).each_with_index.map { |v,i| i == 0 ? v/10.0 : v } ]
+        [ (sensormap[id] || id), get_sensor_data(id).each_with_index.map { |v,i| i == 0 ? v/10.0 : v } ]
       end.to_h
     end
 
@@ -19,7 +31,7 @@ module Tinkerforge
     def _view_21x8
       "Weather      #{uid_string.rjust 8}\n\n" +
       sensors.first(6).map do |k,v|
-        %Q(#{v[2] > 100 ? '?' : ' '} %3d  %4.1f °C  %2d %%\n) % [k,v].flatten
+        %Q(#{v[2] > 100 ? '!' : ' '}%-8.8s %5.1f°C%3d%%\n) % [k,v].flatten
       end.join
     end
 

data/lib/tinderfridge/devices/bricklet_piezo_speaker_v2/bricklet_piezo_speaker_v2.rb

@@ -0,0 +1,14 @@
+module Tinkerforge
+
+  class BrickletPiezoSpeakerV2
+
+    # Beeps briefly.
+    #
+    # Volume (0..10) defaults to 0.
+    def blip(volume=0)
+      set_beep(600, volume, 80)
+    end
+
+  end
+
+end

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

@@ -112,7 +112,9 @@ module Tinkerforge
 
         '_' => '0001000',
         '-' => '0000001',
+        '¯' => '1000000',
         '=' => '0001001',
+        '≡' => '1001001',
 
         '(' => '1001110',
         ')' => '1111000',
@@ -147,6 +149,35 @@ module Tinkerforge
       [value1, value2]
     end
 
+    # Returns the current thread automatically updating the display.
+    def thread
+      @thread
+    end
+
+    # Stops automatic updating of the display.
+    def stop
+      if thread
+        thread.exit
+        @thread = nil
+      end
+    end
+
+    # Continuously displays the current time, in 24-hour format.
+    #
+    # Starts a new thread automatically updating the display. Use the stop method to end.
+    #
+    # By default uses local time, or optionally UTC.
+    def clock(utc=false)
+      stop
+      @thread = Thread.new do
+        while true
+          t = utc ? Time.now.getutc : Time.now
+          print t.strftime("%H#{t.sec.even? ? ':' : ''}%M")
+          sleep 0.5
+        end
+      end
+    end
+
   end
 
 end

data/lib/tinderfridge/devices/bricklet_solid_state_relay_v2/bricklet_solid_state_relay_v2.rb

@@ -0,0 +1,22 @@
+module Tinkerforge
+
+  class BrickletSolidStateRelayV2
+
+    # Returns the device's state.
+    def state
+      super.merge(
+        'value'    => get_state,
+        'monoflop' => get_monoflop,
+      )
+    end
+
+    private
+
+    def _view_21x8
+      "SSRelayV2    #{uid_string.rjust 8}\n\n\n" +
+      (get_state ? 'ON' : 'Off').center(21)
+    end
+
+  end
+
+end

data/lib/tinderfridge/devices/bricklet_temperature_v2/bricklet_temperature_v2.rb

@@ -13,13 +13,9 @@ module Tinkerforge
     private
 
     def _view_21x8
-      <<~ET
-      Temp         #{uid_string.rjust 8}
-
-            #{'%6.2f °C' % [get_temperature*0.01]}
-
-              #{get_heater_configuration == 1 ? 'HEATER' : ''}
-      ET
+      "TempV2       #{uid_string.rjust 8}\n\n\n" +
+      ('%.2f °C' % [get_temperature*0.01]).center(21) +
+      (get_heater_configuration == 1 ? "\n\n\n       HEATER" : '')
     end
 
   end

data/lib/tinderfridge/ip_connection.rb

@@ -105,6 +105,21 @@ module Tinkerforge
       list
     end
 
+    # On Mac OS, opens a new Brick Viewer,
+    # connected to the IP Connection's host and port.
+    #
+    # Not supported on other platforms.
+    #
+    # Requires Brick Viewer version 2.4.23 or later.
+    def open_brick_viewer
+      if RUBY_PLATFORM =~ /darwin/
+        `open -n -a Brickv --args #{host} --port #{port}`
+        "#{host}:#{port}"
+      end
+    end
+
+    alias brickv open_brick_viewer
+
     private
 
     # Takes the args supplied by an enumeration callback, and returns a device instance.

data/lib/tinderfridge/tinkerforge.rb

@@ -30,6 +30,19 @@ module Tinkerforge
       connect('localhost', port).discover(0.25)
     end
 
+    private
+
+    def _view_21x8
+      "\n" +
+      'Tinkerforge'.center(21) +
+      "\n" +
+      VERSION.center(21) +
+      "\n\n\n\n" +
+      "Tinderfridge #{TINDERFRIDGE_VERSION}".center(21) +
+      "\n" +
+      "Ruby #{RUBY_VERSION}".center(21)
+    end
+
   end
 
 end

data/lib/tinderfridge/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tinderfridge
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.0
 platform: ruby
 authors:
 - lllist.eu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-24 00:00:00.000000000 Z
+date: 2022-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tinkerforge
@@ -77,6 +77,7 @@ files:
 - lib/tinderfridge/devices/bricklet_gps_v2/bricklet_gps_v2.json
 - lib/tinderfridge/devices/bricklet_gps_v2/bricklet_gps_v2.rb
 - lib/tinderfridge/devices/bricklet_gps_v3/bricklet_gps_v3.json
+- lib/tinderfridge/devices/bricklet_gps_v3/bricklet_gps_v3.rb
 - lib/tinderfridge/devices/bricklet_hall_effect_v2/bricklet_hall_effect_v2.json
 - lib/tinderfridge/devices/bricklet_hall_effect_v2/bricklet_hall_effect_v2.rb
 - lib/tinderfridge/devices/bricklet_humidity_v2/bricklet_humidity_v2.json
@@ -121,6 +122,7 @@ files:
 - lib/tinderfridge/devices/bricklet_particulate_matter/bricklet_particulate_matter.json
 - lib/tinderfridge/devices/bricklet_performance_dc/bricklet_performance_dc.json
 - lib/tinderfridge/devices/bricklet_piezo_speaker_v2/bricklet_piezo_speaker_v2.json
+- lib/tinderfridge/devices/bricklet_piezo_speaker_v2/bricklet_piezo_speaker_v2.rb
 - lib/tinderfridge/devices/bricklet_ptc_v2/bricklet_ptc_v2.json
 - lib/tinderfridge/devices/bricklet_real_time_clock_v2/bricklet_real_time_clock_v2.json
 - lib/tinderfridge/devices/bricklet_remote_switch_v2/bricklet_remote_switch_v2.json
@@ -139,6 +141,7 @@ files:
 - lib/tinderfridge/devices/bricklet_servo_v2/bricklet_servo_v2.json
 - lib/tinderfridge/devices/bricklet_silent_stepper_v2/bricklet_silent_stepper_v2.json
 - lib/tinderfridge/devices/bricklet_solid_state_relay_v2/bricklet_solid_state_relay_v2.json
+- lib/tinderfridge/devices/bricklet_solid_state_relay_v2/bricklet_solid_state_relay_v2.rb
 - lib/tinderfridge/devices/bricklet_sound_pressure_level/bricklet_sound_pressure_level.json
 - lib/tinderfridge/devices/bricklet_sound_pressure_level/bricklet_sound_pressure_level.rb
 - lib/tinderfridge/devices/bricklet_temperature_ir_v2/bricklet_temperature_ir_v2.json