tinkerforge 2.1.22 → 2.1.27

data/lib/tinkerforge/bricklet_segment_display_4x7.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-05-21.      #
+# This file was automatically generated on 2020-11-02.      #
 #                                                           #
-# Ruby Bindings Version 2.1.22                              #
+# Ruby Bindings Version 2.1.27                              #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################
 
+require_relative './ip_connection'
+
 module Tinkerforge
   # Four 7-segment displays with switchable colon
   class BrickletSegmentDisplay4x7 < Device
@@ -29,7 +31,7 @@ module Tinkerforge
     # Creates an object with the unique device ID <tt>uid</tt> and adds it to
     # the IP Connection <tt>ipcon</tt>.
     def initialize(uid, ipcon)
-      super uid, ipcon
+      super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME
 
       @api_version = [2, 0, 0]
 
@@ -39,8 +41,9 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_COUNTER_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_COUNTER_FINISHED] = ''
+      @callback_formats[CALLBACK_COUNTER_FINISHED] = [8, '']
 
+      @ipcon.add_device self
     end
 
     # The 7-segment display can be set with bitmaps. Every bit controls one
@@ -57,50 +60,57 @@ module Tinkerforge
     # The brightness can be set between 0 (dark) and 7 (bright). The colon
     # parameter turns the colon of the display on or off.
     def set_segments(segments, brightness, colon)
-      send_request FUNCTION_SET_SEGMENTS, [segments, brightness, colon], 'C4 C ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_SEGMENTS, [segments, brightness, colon], 'C4 C ?', 8, ''
     end
 
     # Returns the segment, brightness and color data as set by
     # BrickletSegmentDisplay4x7#set_segments.
     def get_segments
-      send_request FUNCTION_GET_SEGMENTS, [], '', 6, 'C4 C ?'
+      check_validity
+
+      send_request FUNCTION_GET_SEGMENTS, [], '', 14, 'C4 C ?'
     end
 
     # Starts a counter with the *from* value that counts to the *to*
     # value with the each step incremented by *increment*.
-    # The *length* of the increment is given in ms.
+    # *length* is the pause between each increment.
     # 
     # Example: If you set *from* to 0, *to* to 100, *increment* to 1 and
     # *length* to 1000, a counter that goes from 0 to 100 with one second
     # pause between each increment will be started.
     # 
-    # The maximum values for *from*, *to* and *increment* is 9999,
-    # the minimum value is -999.
-    # 
     # Using a negative increment allows to count backwards.
     # 
     # You can stop the counter at every time by calling BrickletSegmentDisplay4x7#set_segments.
     def start_counter(value_from, value_to, increment, length)
-      send_request FUNCTION_START_COUNTER, [value_from, value_to, increment, length], 's s s L', 0, ''
+      check_validity
+
+      send_request FUNCTION_START_COUNTER, [value_from, value_to, increment, length], 's s s L', 8, ''
     end
 
     # Returns the counter value that is currently shown on the display.
     # 
     # If there is no counter running a 0 will be returned.
     def get_counter_value
-      send_request FUNCTION_GET_COUNTER_VALUE, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_COUNTER_VALUE, [], '', 10, 'S'
     end
 
     # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 
-    # The position can be 'a', 'b', 'c' or 'd'.
+    # The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port).
+    # A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at
+    # position 'z'.
     # 
     # The device identifier numbers can be found :ref:`here <device_identifier>`.
     # |device_identifier_constant|
     def get_identity
-      send_request FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S'
+      send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
     end
 
     # Registers a callback with ID <tt>id</tt> to the block <tt>block</tt>.

data/lib/tinkerforge/bricklet_segment_display_4x7_v2.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-05-21.      #
+# This file was automatically generated on 2020-11-02.      #
 #                                                           #
-# Ruby Bindings Version 2.1.22                              #
+# Ruby Bindings Version 2.1.27                              #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################
 
+require_relative './ip_connection'
+
 module Tinkerforge
   # Four 7-segment displays with switchable dots
   class BrickletSegmentDisplay4x7V2 < Device
@@ -60,7 +62,7 @@ module Tinkerforge
     # Creates an object with the unique device ID <tt>uid</tt> and adds it to
     # the IP Connection <tt>ipcon</tt>.
     def initialize(uid, ipcon)
-      super uid, ipcon
+      super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME
 
       @api_version = [2, 0, 0]
 
@@ -86,8 +88,9 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_COUNTER_FINISHED] = ''
+      @callback_formats[CALLBACK_COUNTER_FINISHED] = [8, '']
 
+      @ipcon.add_device self
     end
 
     # Sets the segments of the Segment Display 4x7 Bricklet 2.0 segment-by-segment.
@@ -101,28 +104,33 @@ module Tinkerforge
     #    :alt: Indices of segments
     #    :align: center
     def set_segments(digit0, digit1, digit2, digit3, colon, tick)
-      send_request FUNCTION_SET_SEGMENTS, [digit0, digit1, digit2, digit3, colon, tick], '?8 ?8 ?8 ?8 ?2 ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_SEGMENTS, [digit0, digit1, digit2, digit3, colon, tick], '?8 ?8 ?8 ?8 ?2 ?', 8, ''
     end
 
     # Returns the segment data as set by BrickletSegmentDisplay4x7V2#set_segments.
     def get_segments
-      send_request FUNCTION_GET_SEGMENTS, [], '', 35, '?8 ?8 ?8 ?8 ?2 ?'
+      check_validity
+
+      send_request FUNCTION_GET_SEGMENTS, [], '', 14, '?8 ?8 ?8 ?8 ?2 ?'
     end
 
-    # The brightness can be set between 0 (dark) and 7 (bright). 
-    # 
-    # The default value is 7.
+    # The brightness can be set between 0 (dark) and 7 (bright).
     def set_brightness(brightness)
-      send_request FUNCTION_SET_BRIGHTNESS, [brightness], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_BRIGHTNESS, [brightness], 'C', 8, ''
     end
 
     # Returns the brightness as set by BrickletSegmentDisplay4x7V2#set_brightness.
     def get_brightness
-      send_request FUNCTION_GET_BRIGHTNESS, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_BRIGHTNESS, [], '', 9, 'C'
     end
 
-    # Sets a numeric value for each of the digits. The values can be between
-    # -2 and 15. They represent:
+    # Sets a numeric value for each of the digits. They represent:
     # 
     # * -2: minus sign
     # * -1: blank
@@ -136,7 +144,9 @@ module Tinkerforge
     # 
     # Example: A call with [-2, -1, 4, 2] will result in a display of "- 42".
     def set_numeric_value(value)
-      send_request FUNCTION_SET_NUMERIC_VALUE, [value], 'c4', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_NUMERIC_VALUE, [value], 'c4', 8, ''
     end
 
     # Turns one specified segment on or off.
@@ -148,38 +158,43 @@ module Tinkerforge
     #    :alt: Indices of selected segments
     #    :align: center
     def set_selected_segment(segment, value)
-      send_request FUNCTION_SET_SELECTED_SEGMENT, [segment, value], 'C ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_SELECTED_SEGMENT, [segment, value], 'C ?', 8, ''
     end
 
     # Returns the value of a single segment.
     def get_selected_segment(segment)
-      send_request FUNCTION_GET_SELECTED_SEGMENT, [segment], 'C', 1, '?'
+      check_validity
+
+      send_request FUNCTION_GET_SELECTED_SEGMENT, [segment], 'C', 9, '?'
     end
 
     # Starts a counter with the *from* value that counts to the *to*
     # value with the each step incremented by *increment*.
-    # The *length* of the increment is given in ms.
+    # *length* is the pause between each increment.
     # 
     # Example: If you set *from* to 0, *to* to 100, *increment* to 1 and
     # *length* to 1000, a counter that goes from 0 to 100 with one second
     # pause between each increment will be started.
     # 
-    # The maximum values for *from*, *to* and *increment* is 9999,
-    # the minimum value is -999.
-    # 
     # Using a negative *increment* allows to count backwards.
     # 
     # You can stop the counter at every time by calling BrickletSegmentDisplay4x7V2#set_segments
     # or BrickletSegmentDisplay4x7V2#set_numeric_value.
     def start_counter(value_from, value_to, increment, length)
-      send_request FUNCTION_START_COUNTER, [value_from, value_to, increment, length], 's s s L', 0, ''
+      check_validity
+
+      send_request FUNCTION_START_COUNTER, [value_from, value_to, increment, length], 's s s L', 8, ''
     end
 
     # Returns the counter value that is currently shown on the display.
     # 
     # If there is no counter running a 0 will be returned.
     def get_counter_value
-      send_request FUNCTION_GET_COUNTER_VALUE, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_COUNTER_VALUE, [], '', 10, 'S'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -194,7 +209,9 @@ module Tinkerforge
     # The errors counts are for errors that occur on the Bricklet side. All
     # Bricks have a similar function that returns the errors on the Brick side.
     def get_spitfp_error_count
-      send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 16, 'L L L L'
+      check_validity
+
+      send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
     end
 
     # Sets the bootloader mode and returns the status after the requested
@@ -207,12 +224,16 @@ module Tinkerforge
     # This function is used by Brick Viewer during flashing. It should not be
     # necessary to call it in a normal user program.
     def set_bootloader_mode(mode)
-      send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
     end
 
     # Returns the current bootloader mode, see BrickletSegmentDisplay4x7V2#set_bootloader_mode.
     def get_bootloader_mode
-      send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
     end
 
     # Sets the firmware pointer for BrickletSegmentDisplay4x7V2#write_firmware. The pointer has
@@ -222,7 +243,9 @@ module Tinkerforge
     # This function is used by Brick Viewer during flashing. It should not be
     # necessary to call it in a normal user program.
     def set_write_firmware_pointer(pointer)
-      send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
     end
 
     # Writes 64 Bytes of firmware at the position as written by
@@ -234,7 +257,9 @@ module Tinkerforge
     # This function is used by Brick Viewer during flashing. It should not be
     # necessary to call it in a normal user program.
     def write_firmware(data)
-      send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
     end
 
     # Sets the status LED configuration. By default the LED shows
@@ -245,22 +270,28 @@ module Tinkerforge
     # 
     # If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.
     def set_status_led_config(config)
-      send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
     end
 
     # Returns the configuration as set by BrickletSegmentDisplay4x7V2#set_status_led_config
     def get_status_led_config
-      send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
     end
 
-    # Returns the temperature in °C as measured inside the microcontroller. The
+    # Returns the temperature as measured inside the microcontroller. The
     # value returned is not the ambient temperature!
     # 
     # The temperature is only proportional to the real temperature and it has bad
     # accuracy. Practically it is only useful as an indicator for
     # temperature changes.
     def get_chip_temperature
-      send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 2, 's'
+      check_validity
+
+      send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
     end
 
     # Calling this function will reset the Bricklet. All configurations
@@ -270,7 +301,9 @@ module Tinkerforge
     # calling functions on the existing ones will result in
     # undefined behavior!
     def reset
-      send_request FUNCTION_RESET, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_RESET, [], '', 8, ''
     end
 
     # Writes a new UID into flash. If you want to set a new UID
@@ -279,25 +312,31 @@ module Tinkerforge
     # 
     # We recommend that you use Brick Viewer to change the UID.
     def write_uid(uid)
-      send_request FUNCTION_WRITE_UID, [uid], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
     end
 
     # Returns the current UID as an integer. Encode as
     # Base58 to get the usual string version.
     def read_uid
-      send_request FUNCTION_READ_UID, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_READ_UID, [], '', 12, 'L'
     end
 
     # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 
-    # The position can be 'a', 'b', 'c' or 'd'.
+    # The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port).
+    # A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at
+    # position 'z'.
     # 
     # The device identifier numbers can be found :ref:`here <device_identifier>`.
     # |device_identifier_constant|
     def get_identity
-      send_request FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S'
+      send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
     end
 
     # Registers a callback with ID <tt>id</tt> to the block <tt>block</tt>.

data/lib/tinkerforge/bricklet_solid_state_relay.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-05-21.      #
+# This file was automatically generated on 2020-11-02.      #
 #                                                           #
-# Ruby Bindings Version 2.1.22                              #
+# Ruby Bindings Version 2.1.27                              #
 #                                                           #
 # If you have a bugfix for this file and want to commit it, #
 # please fix the bug in the generator. You can find a link  #
 # to the generators git repository on tinkerforge.com       #
 #############################################################
 
+require_relative './ip_connection'
+
 module Tinkerforge
   # Controls AC and DC Solid State Relays
   class BrickletSolidStateRelay < Device
@@ -30,7 +32,7 @@ module Tinkerforge
     # Creates an object with the unique device ID <tt>uid</tt> and adds it to
     # the IP Connection <tt>ipcon</tt>.
     def initialize(uid, ipcon)
-      super uid, ipcon
+      super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME
 
       @api_version = [2, 0, 0]
 
@@ -40,26 +42,29 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_MONOFLOP] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_MONOFLOP_DONE] = '?'
+      @callback_formats[CALLBACK_MONOFLOP_DONE] = [9, '?']
 
+      @ipcon.add_device self
     end
 
     # Sets the state of the relays *true* means on and *false* means off.
     # 
     # A running monoflop timer will be aborted if this function is called.
-    # 
-    # The default value is *false*.
     def set_state(state)
-      send_request FUNCTION_SET_STATE, [state], '?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_STATE, [state], '?', 8, ''
     end
 
     # Returns the state of the relay, *true* means on and *false* means off.
     def get_state
-      send_request FUNCTION_GET_STATE, [], '', 1, '?'
+      check_validity
+
+      send_request FUNCTION_GET_STATE, [], '', 9, '?'
     end
 
     # The first parameter  is the desired state of the relay (*true* means on
-    # and *false* means off). The second parameter indicates the time (in ms) that
+    # and *false* means off). The second parameter indicates the time that
     # the relay should hold the state.
     # 
     # If this function is called with the parameters (true, 1500):
@@ -71,7 +76,9 @@ module Tinkerforge
     # of two seconds. The relay will be on all the time. If now the RS485
     # connection is lost, the relay will turn off in at most two seconds.
     def set_monoflop(state, time)
-      send_request FUNCTION_SET_MONOFLOP, [state, time], '? L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MONOFLOP, [state, time], '? L', 8, ''
     end
 
     # Returns the current state and the time as set by
@@ -80,19 +87,23 @@ module Tinkerforge
     # If the timer is not running currently, the remaining time will be returned
     # as 0.
     def get_monoflop
-      send_request FUNCTION_GET_MONOFLOP, [], '', 9, '? L L'
+      check_validity
+
+      send_request FUNCTION_GET_MONOFLOP, [], '', 17, '? L L'
     end
 
     # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 
-    # The position can be 'a', 'b', 'c' or 'd'.
+    # The position can be 'a', 'b', 'c', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port).
+    # A Bricklet connected to an :ref:`Isolator Bricklet <isolator_bricklet>` is always at
+    # position 'z'.
     # 
     # The device identifier numbers can be found :ref:`here <device_identifier>`.
     # |device_identifier_constant|
     def get_identity
-      send_request FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S'
+      send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
     end
 
     # Registers a callback with ID <tt>id</tt> to the block <tt>block</tt>.