tinkerforge 2.1.23 → 2.1.28

data/lib/tinkerforge/bricklet_industrial_digital_in_4.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2021-01-15.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.28                              #
 #                                                           #
 # 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
   # 4 galvanically isolated digital inputs
   class BrickletIndustrialDigitalIn4 < Device
@@ -27,6 +29,8 @@ module Tinkerforge
     #   currently pin 0 is high and pins 1-3 are low.
     # * (9, 14) or (0b1001, 0b1110) means that interrupts on pins 0 and 3
     #   occurred and currently pin 0 is low and pins 1-3 are high.
+    # 
+    # The interrupts use the grouping as set by BrickletIndustrialDigitalIn4#set_group.
     CALLBACK_INTERRUPT = 9
 
     FUNCTION_GET_VALUE = 1 # :nodoc:
@@ -49,7 +53,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, 1]
 
@@ -66,8 +70,9 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_EDGE_COUNT_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_INTERRUPT] = 'S S'
+      @callback_formats[CALLBACK_INTERRUPT] = [12, 'S S']
 
+      @ipcon.add_device self
     end
 
     # Returns the input value with a bitmask. The bitmask is 16bit long, *true*
@@ -83,7 +88,9 @@ module Tinkerforge
     # Element 1 in the group will get pins 0-3, element 2 pins 4-7, element 3
     # pins 8-11 and element 4 pins 12-15.
     def get_value
-      send_request FUNCTION_GET_VALUE, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_VALUE, [], '', 10, 'S'
     end
 
     # Sets a group of Digital In 4 Bricklets that should work together. You can
@@ -105,35 +112,43 @@ module Tinkerforge
     # Changing the group configuration resets all edge counter configurations
     # and values.
     def set_group(group)
-      send_request FUNCTION_SET_GROUP, [group], 'k4', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_GROUP, [group], 'k4', 8, ''
     end
 
     # Returns the group as set by BrickletIndustrialDigitalIn4#set_group
     def get_group
-      send_request FUNCTION_GET_GROUP, [], '', 4, 'k4'
+      check_validity
+
+      send_request FUNCTION_GET_GROUP, [], '', 12, 'k4'
     end
 
     # Returns a bitmask of ports that are available for grouping. For example the
     # value 5 or 0b0101 means: Port A and port C are connected to Bricklets that
     # can be grouped together.
     def get_available_for_group
-      send_request FUNCTION_GET_AVAILABLE_FOR_GROUP, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_AVAILABLE_FOR_GROUP, [], '', 9, 'C'
     end
 
-    # Sets the debounce period of the CALLBACK_INTERRUPT callback in ms.
+    # Sets the debounce period of the CALLBACK_INTERRUPT callback.
     # 
     # For example: If you set this value to 100, you will get the interrupt
     # maximal every 100ms. This is necessary if something that bounces is
     # connected to the Digital In 4 Bricklet, such as a button.
-    # 
-    # The default value is 100.
     def set_debounce_period(debounce)
-      send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 8, ''
     end
 
     # Returns the debounce period as set by BrickletIndustrialDigitalIn4#set_debounce_period.
     def get_debounce_period
-      send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 12, 'L'
     end
 
     # Sets the pins on which an interrupt is activated with a bitmask.
@@ -147,12 +162,16 @@ module Tinkerforge
     # 
     # The interrupt is delivered with the CALLBACK_INTERRUPT callback.
     def set_interrupt(interrupt_mask)
-      send_request FUNCTION_SET_INTERRUPT, [interrupt_mask], 'S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_INTERRUPT, [interrupt_mask], 'S', 8, ''
     end
 
     # Returns the interrupt bitmask as set by BrickletIndustrialDigitalIn4#set_interrupt.
     def get_interrupt
-      send_request FUNCTION_GET_INTERRUPT, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_INTERRUPT, [], '', 10, 'S'
     end
 
     # Returns the current value of the edge counter for the selected pin. You can
@@ -161,9 +180,13 @@ module Tinkerforge
     # If you set the reset counter to *true*, the count is set back to 0
     # directly after it is read.
     # 
+    # The edge counters use the grouping as set by BrickletIndustrialDigitalIn4#set_group.
+    # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
     def get_edge_count(pin, reset_counter)
-      send_request FUNCTION_GET_EDGE_COUNT, [pin, reset_counter], 'C ?', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_EDGE_COUNT, [pin, reset_counter], 'C ?', 12, 'L'
     end
 
     # Configures the edge counter for the selected pins. A bitmask of 9 or 0b1001 will
@@ -172,22 +195,22 @@ module Tinkerforge
     # The edge type parameter configures if rising edges, falling edges or
     # both are counted if the pin is configured for input. Possible edge types are:
     # 
-    # * 0 = rising (default)
+    # * 0 = rising
     # * 1 = falling
     # * 2 = both
     # 
-    # The debounce time is given in ms.
-    # 
     # Configuring an edge counter resets its value to 0.
     # 
     # If you don't know what any of this means, just leave it at default. The
     # default configuration is very likely OK for you.
     # 
-    # Default values: 0 (edge type) and 100ms (debounce time)
+    # The edge counters use the grouping as set by BrickletIndustrialDigitalIn4#set_group.
     # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
     def set_edge_count_config(selection_mask, edge_type, debounce)
-      send_request FUNCTION_SET_EDGE_COUNT_CONFIG, [selection_mask, edge_type, debounce], 'S C C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_EDGE_COUNT_CONFIG, [selection_mask, edge_type, debounce], 'S C C', 8, ''
     end
 
     # Returns the edge type and debounce time for the selected pin as set by
@@ -195,19 +218,23 @@ module Tinkerforge
     # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
     def get_edge_count_config(pin)
-      send_request FUNCTION_GET_EDGE_COUNT_CONFIG, [pin], 'C', 2, 'C C'
+      check_validity
+
+      send_request FUNCTION_GET_EDGE_COUNT_CONFIG, [pin], 'C', 10, 'C C'
     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_industrial_digital_in_4_v2.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2021-01-15.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.28                              #
 #                                                           #
 # 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
   # 4 galvanically isolated digital inputs
   class BrickletIndustrialDigitalIn4V2 < Device
@@ -84,7 +86,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]
 
@@ -111,19 +113,22 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_VALUE] = 'C ? ?'
-      @callback_formats[CALLBACK_ALL_VALUE] = '?4 ?4'
+      @callback_formats[CALLBACK_VALUE] = [11, 'C ? ?']
+      @callback_formats[CALLBACK_ALL_VALUE] = [10, '?4 ?4']
 
+      @ipcon.add_device self
     end
 
     # Returns the input value as bools, *true* refers to high and *false* refers to low.
     def get_value
-      send_request FUNCTION_GET_VALUE, [], '', 4, '?4'
+      check_validity
+
+      send_request FUNCTION_GET_VALUE, [], '', 9, '?4'
     end
 
     # This callback can be configured per channel.
     # 
-    # The period in ms is the period with which the CALLBACK_VALUE
+    # The period is the period with which the CALLBACK_VALUE
     # callback is triggered periodically. A value of 0 turns the callback off.
     # 
     # If the `value has to change`-parameter is set to true, the callback is only
@@ -132,19 +137,21 @@ module Tinkerforge
     # 
     # If it is set to false, the callback is continuously triggered with the period,
     # independent of the value.
-    # 
-    # The default value is (0, false).
     def set_value_callback_configuration(channel, period, value_has_to_change)
-      send_request FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION, [channel, period, value_has_to_change], 'C L ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION, [channel, period, value_has_to_change], 'C L ?', 8, ''
     end
 
     # Returns the callback configuration for the given channel as set by
     # BrickletIndustrialDigitalIn4V2#set_value_callback_configuration.
     def get_value_callback_configuration(channel)
-      send_request FUNCTION_GET_VALUE_CALLBACK_CONFIGURATION, [channel], 'C', 5, 'L ?'
+      check_validity
+
+      send_request FUNCTION_GET_VALUE_CALLBACK_CONFIGURATION, [channel], 'C', 13, 'L ?'
     end
 
-    # The period in ms is the period with which the CALLBACK_ALL_VALUE
+    # The period is the period with which the CALLBACK_ALL_VALUE
     # callback is triggered periodically. A value of 0 turns the callback off.
     # 
     # If the `value has to change`-parameter is set to true, the callback is only
@@ -153,16 +160,18 @@ module Tinkerforge
     # 
     # If it is set to false, the callback is continuously triggered with the period,
     # independent of the value.
-    # 
-    # The default value is (0, false).
     def set_all_value_callback_configuration(period, value_has_to_change)
-      send_request FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, ''
     end
 
     # Returns the callback configuration as set by
     # BrickletIndustrialDigitalIn4V2#set_all_value_callback_configuration.
     def get_all_value_callback_configuration
-      send_request FUNCTION_GET_ALL_VALUE_CALLBACK_CONFIGURATION, [], '', 5, 'L ?'
+      check_validity
+
+      send_request FUNCTION_GET_ALL_VALUE_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
     end
 
     # Returns the current value of the edge counter for the selected channel. You can
@@ -171,7 +180,9 @@ module Tinkerforge
     # If you set the reset counter to *true*, the count is set back to 0
     # directly after it is read.
     def get_edge_count(channel, reset_counter)
-      send_request FUNCTION_GET_EDGE_COUNT, [channel, reset_counter], 'C ?', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_EDGE_COUNT, [channel, reset_counter], 'C ?', 12, 'L'
     end
 
     # Configures the edge counter for a specific channel.
@@ -179,26 +190,26 @@ module Tinkerforge
     # The edge type parameter configures if rising edges, falling edges or both are
     # counted. Possible edge types are:
     # 
-    # * 0 = rising (default)
+    # * 0 = rising
     # * 1 = falling
     # * 2 = both
     # 
-    # The debounce time is given in ms.
-    # 
     # Configuring an edge counter resets its value to 0.
     # 
     # If you don't know what any of this means, just leave it at default. The
     # default configuration is very likely OK for you.
-    # 
-    # Default values: 0 (edge type) and 100ms (debounce time)
     def set_edge_count_configuration(channel, edge_type, debounce)
-      send_request FUNCTION_SET_EDGE_COUNT_CONFIGURATION, [channel, edge_type, debounce], 'C C C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_EDGE_COUNT_CONFIGURATION, [channel, edge_type, debounce], 'C C C', 8, ''
     end
 
     # Returns the edge type and debounce time for the selected channel as set by
     # BrickletIndustrialDigitalIn4V2#set_edge_count_configuration.
     def get_edge_count_configuration(channel)
-      send_request FUNCTION_GET_EDGE_COUNT_CONFIGURATION, [channel], 'C', 2, 'C C'
+      check_validity
+
+      send_request FUNCTION_GET_EDGE_COUNT_CONFIGURATION, [channel], 'C', 10, 'C C'
     end
 
     # Each channel has a corresponding LED. You can turn the LED off, on or show a
@@ -207,12 +218,16 @@ module Tinkerforge
     # 
     # By default all channel LEDs are configured as "Channel Status".
     def set_channel_led_config(channel, config)
-      send_request FUNCTION_SET_CHANNEL_LED_CONFIG, [channel, config], 'C C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CHANNEL_LED_CONFIG, [channel, config], 'C C', 8, ''
     end
 
     # Returns the channel LED configuration as set by BrickletIndustrialDigitalIn4V2#set_channel_led_config
     def get_channel_led_config(channel)
-      send_request FUNCTION_GET_CHANNEL_LED_CONFIG, [channel], 'C', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_CHANNEL_LED_CONFIG, [channel], 'C', 9, 'C'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -227,7 +242,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
@@ -240,12 +257,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 BrickletIndustrialDigitalIn4V2#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 BrickletIndustrialDigitalIn4V2#write_firmware. The pointer has
@@ -255,7 +276,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
@@ -267,7 +290,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
@@ -278,22 +303,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 BrickletIndustrialDigitalIn4V2#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
@@ -303,7 +334,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
@@ -312,25 +345,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>.