tinderfridge 0.14.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5370c2b6210bbb986208ce2afc7f6ce9573592b7707bf14a8bc371ffb47050c
-  data.tar.gz: 79338d5081d87b1aff9402eaf656be89ed5a50c52f59f597c68a84e9462ccdd4
+  metadata.gz: 8269237b83fcfd5a052cdcc9cb9f702bbca2f8e093a918dca330418679cf0496
+  data.tar.gz: ff1e59646d0b04205e1f5151d6710c2f0834e2822dab3e842fd627c5a1878140
 SHA512:
-  metadata.gz: c0077e242170d67d5c8ffdc63efd702183865d2e475c4be0c0f93bc4bf33aff1c313838a96ade44255245c320057e5369133d860fd5755b585f0fa92f1ae823c
-  data.tar.gz: 3a98205cf201dd8df8ca95378ad1bb82fa41af517f2f8b87a910f4f43b7753344ea0538d90aab6015fd3b8d16d2627b3ef24167380457601cf20f7aae19addfe
+  metadata.gz: fb2db92d210948ce317538ef9826ec34e2171061f91f01ea4aa6964edd5379f8274e624cdfa5078618d7ebff4029f8c776c404324587c3344fb08ce9d58d9449
+  data.tar.gz: 2944c853d896630f99b2d305a8b76782fb67158199bfa108ca3ff7432e2c5381710bfdecca993d398bd60b26a0bf1eaefb81d8ef7afc1ba49c8574d255d37915

data/lib/tinderfridge/device/configuration.rb

@@ -0,0 +1,16 @@
+module Tinkerforge
+  class Device
+
+    # Returns configuration data for the device (a mutable Hash).
+    def config
+      @config ||= {}
+    end
+
+    # Sets configuration data (a Hash) for the device.
+    def config=(configuration)
+      raise(ArgumentError, 'Invalid configuration') unless configuration.class == Hash
+      @config = configuration
+    end
+
+  end
+end

data/lib/tinderfridge/device.rb

@@ -1,5 +1,6 @@
 require 'tinkerforge/ip_connection'
 require 'tinderfridge/shared/logger'
+require 'tinderfridge/device/configuration'
 
 module Tinkerforge
 
@@ -76,7 +77,7 @@ module Tinkerforge
     def initialize(uid, ipcon, device_identifier, device_display_name)
       original_initialize(uid, ipcon, device_identifier, device_display_name)
       if respond_to? 'get_identity'
-        logger_debug "Created %s '%s'" % [self.class, uid_string]
+        logger_debug "Created #{self.class}"
       end
     end
 
@@ -97,10 +98,17 @@ module Tinkerforge
 
     # Returns the device's properties.
     def properties
-      @properties ||= {
-        'device_identifier'   => device_identifier,
-        'device_display_name' => device_display_name,
-      }.merge load_properties
+
+      # BrickDaemon inherits from Device, but has no #get_identity.
+      return {} unless respond_to? 'get_identity'
+
+      identity = get_identity
+
+      @properties ||= [
+        [ 'device_identifier'  , device_identifier     ],
+        [ 'device_display_name', device_display_name   ],
+        [ 'hardware_version'   , identity[3].join('.') ],
+      ].compact.to_h.merge load_properties
     end
 
     alias props properties
@@ -134,17 +142,6 @@ module Tinkerforge
       ].compact.to_h
     end
 
-    # Returns configuration data for the device (a mutable Hash).
-    def config
-      @config ||= {}
-    end
-
-    # Sets configuration data (a Hash) for the device.
-    def config=(configuration)
-      raise(ArgumentError, 'Invalid configuration') unless configuration.class == Hash
-      @config = configuration
-    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

@@ -2,6 +2,8 @@ module Tinkerforge
 
   class DeviceCollection < Hash
 
+    alias devices values
+
     # 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.
@@ -125,9 +127,11 @@ module Tinkerforge
       smap('ipcon').values.compact.uniq
     end
 
-    # Disconnects IP Connections used by devices in the collection.
+    # Disconnects IP Connections used by devices in the collection, and removes all devices from the collection.
     def disconnect
-      ipcons.map { |i| [i, (i.get_connection_state == 0 ? nil : i.disconnect) ] }.to_h
+      result = ipcons.map { |i| [i, (i.get_connection_state == 0 ? nil : i.disconnect) ] }.to_h
+      clear
+      result
     end
 
     # Returns an array of devices in the collection matching the selector.

data/lib/tinderfridge/device_info.txt

@@ -145,3 +145,4 @@
 2165	DC Bricklet 2.0	Tinkerforge::BrickletDCV2	bricklet_dc_v2
 2166	Silent Stepper Bricklet 2.0	Tinkerforge::BrickletSilentStepperV2	bricklet_silent_stepper_v2
 2171	GPS Bricklet 3.0	Tinkerforge::BrickletGPSV3	bricklet_gps_v3
+2174	Industrial Dual AC In Bricklet	Tinkerforge::BrickletIndustrialDualACIn	bricklet_industrial_dual_ac_in

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

@@ -6,6 +6,55 @@ module Tinkerforge
     CHIP_TEMPERATURE_UNIT = 0.1
     # REVIEW: This should ideally be part of base Tinkerforge.
 
+    # Returns the device's state.
+    def state
+      super.merge [
+        safe_send_state('connection_type'   , 'get_connection_type'  ), # FW 2.4.0
+        safe_send_state('status_led_enabled', 'is_status_led_enabled'), # FW 2.3.2
+        safe_send_state('chibi_present'     , 'is_chibi_present'     ),
+        safe_send_state('rs485_present'     , 'is_rs485_present'     ),
+        safe_send_state('ethernet_present'  , 'is_ethernet_present'  ), # FW 2.1.0
+        safe_send_state('wifi_present'      , 'is_wifi_present'      ),
+        safe_send_state('wifi2_present'     , 'is_wifi2_present'     ), # FW 2.4.0
+      ].compact.to_h
+    end
+
+    # Returns the state of the WIFI Extension 2.0.
+    def wifi2_state
+      if is_wifi2_present
+        [
+          safe_send_state('mesh_configuration'  , 'get_wifi2_mesh_configuration'  ), # FW 2.4.2 / 2.1.0
+          safe_send_state('mesh_router_ssid'    , 'get_wifi2_mesh_router_ssid'    ), # FW 2.4.2 / 2.1.0
+          safe_send_state('mesh_common_status'  , 'get_wifi2_mesh_common_status'  ), # FW 2.4.2 / 2.1.0
+          safe_send_state('mesh_client_status'  , 'get_wifi2_mesh_client_status'  ), # FW 2.4.2 / 2.1.0
+          safe_send_state('mesh_ap_status'      , 'get_wifi2_mesh_ap_status'      ), # FW 2.4.2 / 2.1.0
+          safe_send_state('configuration'       , 'get_wifi2_configuration'       ), # FW 2.4.0
+          safe_send_state('status'              , 'get_wifi2_status'              ), # FW 2.4.0
+          safe_send_state('client_configuration', 'get_wifi2_client_configuration'), # FW 2.4.0
+          safe_send_state('client_hostname'     , 'get_wifi2_client_hostname'     ), # FW 2.4.0
+          safe_send_state('ap_configuration'    , 'get_wifi2_ap_configuration'    ), # FW 2.4.0
+
+          if r = safe_send_state('firmware_version', 'get_wifi2_firmware_version' )  # FW 2.4.0
+            [ r[0], r[1].join('.') ]
+          end
+        ].compact.to_h
+      end
+    rescue
+      nil
+    end
+
+    private
+
+    # Safely call a method for inclusion in state hash.
+    # When method blows up, state can ignore it.
+    # REVIEW: possible candidate for Device class
+    def safe_send_state(key, methot)
+      [key, send(methot)]
+    rescue => e
+      logger_warn "Device '#{uid_string}': '#{methot}' failed. #{e}"
+      nil
+    end
+
   end
 
 end

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

@@ -16,6 +16,14 @@ module Tinkerforge
 
     private
 
+   def _print_4
+      if (co2 = get_co2_concentration) > 9999
+        ' ol '
+      else
+        '%4d' % co2
+      end
+    end
+
     def _view_21x8
       "CO2V2        #{uid_string.rjust 8}\n\n\n" +
       ('%d PPM' % get_co2_concentration).center(21)

data/lib/tinderfridge/devices/bricklet_industrial_dual_ac_in/bricklet_industrial_dual_ac_in.json

@@ -0,0 +1,11 @@
+{
+  "dimensions": [
+    40,
+    40,
+    16
+  ],
+  "weight": 29,
+  "documentation_en_url": "https://www.tinkerforge.com/en/doc/Hardware/Bricklets/Industrial_Dual_AC_In.html",
+  "versions_identifier": "bricklets:industrial_dual_ac_in",
+  "released": "2023-05-12"
+}

data/lib/tinderfridge/devices/bricklet_particulate_matter/bricklet_particulate_matter.rb

@@ -0,0 +1,38 @@
+module Tinkerforge
+
+  class BrickletParticulateMatter
+
+    # Enables the fan and the laser diode.
+    def enable
+      set_enable true
+    end
+
+    # Disables the fan and the laser diode.
+    def disable
+      set_enable false
+    end
+
+    # Returns the device's state.
+    def state
+      super.merge(
+        'enabled'          => get_enable,
+        'pm_concentration' => get_pm_concentration,
+        'pm_count'         => get_pm_count,
+        'sensor_info'      => get_sensor_info,
+      )
+    end
+
+    private
+
+    def _view_21x8
+      "PM           #{uid_string.rjust 8}\n\n" +
+      if get_enable
+        "     PM1   %4d\n     PM2.5 %4d\n     PM10  %4d" % get_pm_concentration
+      else
+        "\n      disabled"
+      end
+    end
+
+  end
+
+end

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

@@ -35,30 +35,39 @@ module Tinkerforge
       self.segments = segments.gsub(/[ _]/, '').ljust(35, '0').chars.map { |s| s == '1' }
     end
 
+    # Turns all 35 segments on.
+    def all_on
+      self.segments = [true]*35
+    end
+
     # Returns the device's state.
     def state
       super.merge( 'brightness' => get_brightness )
     end
 
     # Displays a string.
-    def print(text='')
-      out   = ''
-      colon = false
-
-      text.to_s.chars.each do |c|
-        if glyphs.key? c
-          out << glyphs[c] << '0'
-        elsif c == '.' and out[-1] == '0'
-          out[-1] = '1'
-        elsif c == ':' and out.size == 16
-          colon = true
-        else
-          raise "Can not display '#{text}'"
+    def print(text_or_object='')
+      if text_or_object.respond_to?( :_print_4, true)
+        print ( text_or_object.send(:_print_4) rescue '' )
+      else
+        out   = ''
+        colon = false
+
+        text_or_object.to_s.chars.each do |c|
+          if glyphs.key? c
+            out << glyphs[c] << '0'
+          elsif c == '.' and out[-1] == '0'
+            out[-1] = '1'
+          elsif c == ':' and out.size == 16
+            colon = true
+          else
+            raise "Can not display character '#{c}'"
+          end
         end
-      end
 
-      self.segments_string = out[0,32].ljust(32,'0') + ( colon ? '110' : '000' )
-      nil
+        self.segments_string = out[0,32].ljust(32,'0') + ( colon ? '110' : '000' )
+        nil
+      end
     end
 
     # Returns the definition of glyphs for Unicode chracters.
@@ -78,6 +87,7 @@ module Tinkerforge
 
         'A' => '1110111',
         'b' => '0011111',
+        'B' => '1111111',
         'c' => '0001101',
         'C' => '1001110',
         'd' => '0111101',
@@ -91,6 +101,7 @@ module Tinkerforge
         'J' => '0111000',
         'L' => '0001110',
         'l' => '0001100',
+        'N' => '1110110',
         'n' => '0010101',
         'O' => '1111110',
         'o' => '0011101',
@@ -103,7 +114,8 @@ module Tinkerforge
         'u' => '0011100',
         'V' => '0111110',
         'v' => '0011100',
-        'y' => '0110011',
+        'Y' => '0111011',
+        'y' => '0111011',
 
         'ö' => '1011101',
         'ü' => '1011100',

data/lib/tinderfridge/ip_connection.rb

@@ -16,6 +16,25 @@ module Tinkerforge
     # Returns the network socket used by the IP Connection.
     attr_reader :socket
 
+    alias original_connect connect
+
+    # Creates a TCP/IP connection to the given host and port. Logs events if event logging is enabled.
+    def connect(host, port)
+      logger_debug "Connecting to %s:%s"          % [host, port]
+      ts = Time.now.to_f
+      original_connect(host, port)
+      logger_debug "Connected  to %s:%s (%5.3fs)" % [host, port, Time.now.to_f - ts]
+    end
+
+    alias original_disconnect disconnect
+
+    # Disconnects the TCP/IP connection. Logs events if event logging is enabled.
+    def disconnect
+      logger_debug "Disconnecting from #{host}:#{port}"
+      original_disconnect
+      logger_debug "Disconnected  from #{host}:#{port}"
+    end
+
     # Returns a programmer-friendly representation of the object.
     def inspect
       "#{self.class} (%s:%s)" % (host ? [host, port] : ['-', '-'] )
@@ -130,14 +149,14 @@ module Tinkerforge
         require "tinkerforge/#{dev_info[2][1]}"
         Tinkerforge.const_get(dev_info[2][0]).new enum_data[0], self
       else
-        logger_warn "Unknown Device Identifier: #{enum_data[5]} (UID: #{enum_data[0]})"
+        logger_warn "[ #{enum_data[0]} ] Unknown Device Identifier: #{enum_data[5]}"
         nil
       end
     end
 
     def logger_log_enum(enum_data)
       logger_debug(
-        "Device '#{enum_data[0]}' " +
+        "[ #{enum_data[0]} ] Device " +
         ['available', 'connected', 'disconnected'][enum_data[6]] +
         ( enum_data[6] == 2 ? '' : " (Device Identifier: #{enum_data[5]})" )
       )

data/lib/tinderfridge/shared/logger.rb

@@ -14,33 +14,48 @@ module Tinkerforge
         Tinkerforge.logger
       end
 
-      def logger_debug(msg)
-        if logger
-          logger.debug(msg)
-        end
+      def logger_debug(message='', &block)
+        logger_log(0, message, &block)
       end
 
-      def logger_info(msg)
-        if logger
-          logger.info(msg)
-        end
+      def logger_info(message='', &block)
+        logger_log(1, message, &block)
       end
 
-      def logger_warn(msg)
-        if logger
-          logger.warn(msg)
-        end
+      def logger_warn(message='', &block)
+        logger_log(2, message, &block)
       end
 
-      def logger_error(msg)
-        if logger
-          logger.error(msg)
-        end
+      def logger_error(message='', &block)
+        logger_log(3, message, &block)
+      end
+
+      def logger_fatal(message='', &block)
+        logger_log(4, message, &block)
       end
 
-      def logger_fatal(msg)
-        if logger
-          logger.fatal(msg)
+      def logger_log(level, message='', &block)
+        return unless logger
+
+        if message.empty? and block_given?
+          message = yield
+        end
+
+        if respond_to? 'uid_string'
+          message = "[ #{uid_string} ] #{message}"
+        end
+
+        case level
+          when 0
+            logger.debug(message)
+          when 1
+            logger.info(message)
+          when 2
+            logger.warn(message)
+          when 3
+            logger.error(message)
+          when 4
+            logger.fatal(message)
         end
       end
 

data/lib/tinderfridge/version.rb

@@ -3,7 +3,7 @@ require 'tinkerforge/version'
 module Tinkerforge
 
   # Tinderfridge version.
-  TINDERFRIDGE_VERSION = '0.14.0'
+  TINDERFRIDGE_VERSION = '0.16.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.14.0
+  version: 0.16.0
 platform: ruby
 authors:
 - lllist.eu
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-31 00:00:00.000000000 Z
+date: 2024-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tinkerforge
@@ -38,6 +38,7 @@ extra_rdoc_files: []
 files:
 - lib/tinderfridge.rb
 - lib/tinderfridge/device.rb
+- lib/tinderfridge/device/configuration.rb
 - lib/tinderfridge/device_collection.rb
 - lib/tinderfridge/device_info.rb
 - lib/tinderfridge/device_info.txt
@@ -87,6 +88,7 @@ files:
 - lib/tinderfridge/devices/bricklet_industrial_digital_in_4_v2/bricklet_industrial_digital_in_4_v2.json
 - lib/tinderfridge/devices/bricklet_industrial_digital_out_4_v2/bricklet_industrial_digital_out_4_v2.json
 - lib/tinderfridge/devices/bricklet_industrial_dual_0_20ma_v2/bricklet_industrial_dual_0_20ma_v2.json
+- lib/tinderfridge/devices/bricklet_industrial_dual_ac_in/bricklet_industrial_dual_ac_in.json
 - lib/tinderfridge/devices/bricklet_industrial_dual_ac_relay/bricklet_industrial_dual_ac_relay.json
 - lib/tinderfridge/devices/bricklet_industrial_dual_analog_in_v2/bricklet_industrial_dual_analog_in_v2.json
 - lib/tinderfridge/devices/bricklet_industrial_dual_relay/bricklet_industrial_dual_relay.json
@@ -120,6 +122,7 @@ files:
 - lib/tinderfridge/devices/bricklet_outdoor_weather/bricklet_outdoor_weather.json
 - lib/tinderfridge/devices/bricklet_outdoor_weather/bricklet_outdoor_weather.rb
 - lib/tinderfridge/devices/bricklet_particulate_matter/bricklet_particulate_matter.json
+- lib/tinderfridge/devices/bricklet_particulate_matter/bricklet_particulate_matter.rb
 - 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