tinkerforge 2.1.24 → 2.1.29

data/lib/tinkerforge/bricklet_io16_v2.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-11-25.      #
+# This file was automatically generated on 2021-05-06.      #
 #                                                           #
-# Ruby Bindings Version 2.1.24                              #
+# Ruby Bindings Version 2.1.29                              #
 #                                                           #
 # 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
   # 16-channel digital input/output
   class BrickletIO16V2 < Device
@@ -87,7 +89,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]
 
@@ -118,10 +120,11 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_INPUT_VALUE] = 'C ? ?'
-      @callback_formats[CALLBACK_ALL_INPUT_VALUE] = '?16 ?16'
-      @callback_formats[CALLBACK_MONOFLOP_DONE] = 'C ?'
+      @callback_formats[CALLBACK_INPUT_VALUE] = [11, 'C ? ?']
+      @callback_formats[CALLBACK_ALL_INPUT_VALUE] = [12, '?16 ?16']
+      @callback_formats[CALLBACK_MONOFLOP_DONE] = [10, 'C ?']
 
+      @ipcon.add_device self
     end
 
     # Sets the output value of all sixteen channels. A value of *true* or *false* outputs
@@ -138,14 +141,18 @@ module Tinkerforge
     #  This function does nothing for channels that are configured as input. Pull-up
     #  resistors can be switched on with BrickletIO16V2#set_configuration.
     def set_value(value)
-      send_request FUNCTION_SET_VALUE, [value], '?16', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_VALUE, [value], '?16', 8, ''
     end
 
     # Returns the logic levels that are currently measured on the channels.
     # This function works if the channel is configured as input as well as if it is
     # configured as output.
     def get_value
-      send_request FUNCTION_GET_VALUE, [], '', 16, '?16'
+      check_validity
+
+      send_request FUNCTION_GET_VALUE, [], '', 10, '?16'
     end
 
     # Sets the output value of a specific channel without affecting the other channels.
@@ -157,7 +164,9 @@ module Tinkerforge
     #  This function does nothing for channels that are configured as input. Pull-up
     #  resistors can be switched on with BrickletIO16V2#set_configuration.
     def set_selected_value(channel, value)
-      send_request FUNCTION_SET_SELECTED_VALUE, [channel, value], 'C ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_SELECTED_VALUE, [channel, value], 'C ?', 8, ''
     end
 
     # Configures the value and direction of a specific channel. Possible directions
@@ -179,12 +188,16 @@ module Tinkerforge
     # A running monoflop timer for the specific channel will be aborted if this
     # function is called.
     def set_configuration(channel, direction, value)
-      send_request FUNCTION_SET_CONFIGURATION, [channel, direction, value], 'C k ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CONFIGURATION, [channel, direction, value], 'C k ?', 8, ''
     end
 
     # Returns the channel configuration as set by BrickletIO16V2#set_configuration.
     def get_configuration(channel)
-      send_request FUNCTION_GET_CONFIGURATION, [channel], 'C', 2, 'k ?'
+      check_validity
+
+      send_request FUNCTION_GET_CONFIGURATION, [channel], 'C', 10, 'k ?'
     end
 
     # This callback can be configured per channel.
@@ -199,13 +212,17 @@ module Tinkerforge
     # If it is set to false, the callback is continuously triggered with the period,
     # independent of the value.
     def set_input_value_callback_configuration(channel, period, value_has_to_change)
-      send_request FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION, [channel, period, value_has_to_change], 'C L ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_INPUT_VALUE_CALLBACK_CONFIGURATION, [channel, period, value_has_to_change], 'C L ?', 8, ''
     end
 
     # Returns the callback configuration as set by
     # BrickletIO16V2#set_input_value_callback_configuration.
     def get_input_value_callback_configuration(channel)
-      send_request FUNCTION_GET_INPUT_VALUE_CALLBACK_CONFIGURATION, [channel], 'C', 5, 'L ?'
+      check_validity
+
+      send_request FUNCTION_GET_INPUT_VALUE_CALLBACK_CONFIGURATION, [channel], 'C', 13, 'L ?'
     end
 
     # The period is the period with which the CALLBACK_ALL_INPUT_VALUE
@@ -218,13 +235,17 @@ module Tinkerforge
     # If it is set to false, the callback is continuously triggered with the period,
     # independent of the value.
     def set_all_input_value_callback_configuration(period, value_has_to_change)
-      send_request FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, ''
     end
 
     # Returns the callback configuration as set by
     # BrickletIO16V2#set_all_input_value_callback_configuration.
     def get_all_input_value_callback_configuration
-      send_request FUNCTION_GET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION, [], '', 5, 'L ?'
+      check_validity
+
+      send_request FUNCTION_GET_ALL_INPUT_VALUE_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
     end
 
     # Configures a monoflop of the specified channel.
@@ -245,7 +266,9 @@ module Tinkerforge
     # time. If now the RS485 connection is lost, then channel 0 will be opened in at
     # most two seconds.
     def set_monoflop(channel, value, time)
-      send_request FUNCTION_SET_MONOFLOP, [channel, value, time], 'C ? L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MONOFLOP, [channel, value, time], 'C ? L', 8, ''
     end
 
     # Returns (for the given channel) the current value and the time as set by
@@ -254,7 +277,9 @@ module Tinkerforge
     # If the timer is not running currently, the remaining time will be returned
     # as 0.
     def get_monoflop(channel)
-      send_request FUNCTION_GET_MONOFLOP, [channel], 'C', 9, '? L L'
+      check_validity
+
+      send_request FUNCTION_GET_MONOFLOP, [channel], 'C', 17, '? L L'
     end
 
     # Returns the current value of the edge counter for the selected channel. You can
@@ -263,7 +288,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.
@@ -280,13 +307,17 @@ module Tinkerforge
     # If you don't know what any of this means, just leave it at default. The
     # default configuration is very likely OK for you.
     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
     # BrickletIO16V2#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
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -301,7 +332,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
@@ -314,12 +347,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 BrickletIO16V2#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 BrickletIO16V2#write_firmware. The pointer has
@@ -329,7 +366,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
@@ -341,7 +380,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
@@ -352,22 +393,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 BrickletIO16V2#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
@@ -377,7 +424,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
@@ -386,25 +435,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_io4.rb

@@ -1,14 +1,16 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-11-25.      #
+# This file was automatically generated on 2021-05-06.      #
 #                                                           #
-# Ruby Bindings Version 2.1.24                              #
+# Ruby Bindings Version 2.1.29                              #
 #                                                           #
 # 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-channel digital input/output
   class BrickletIO4 < Device
@@ -59,7 +61,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]
 
@@ -79,9 +81,10 @@ 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] = 'C C'
-      @callback_formats[CALLBACK_MONOFLOP_DONE] = 'C C'
+      @callback_formats[CALLBACK_INTERRUPT] = [10, 'C C']
+      @callback_formats[CALLBACK_MONOFLOP_DONE] = [10, 'C C']
 
+      @ipcon.add_device self
     end
 
     # Sets the output value (high or low) with a bitmask (4bit). A 1 in the bitmask
@@ -96,14 +99,18 @@ module Tinkerforge
     #  This function does nothing for pins that are configured as input.
     #  Pull-up resistors can be switched on with BrickletIO4#set_configuration.
     def set_value(value_mask)
-      send_request FUNCTION_SET_VALUE, [value_mask], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_VALUE, [value_mask], 'C', 8, ''
     end
 
     # Returns a bitmask of the values that are currently measured.
     # This function works if the pin is configured to input
     # as well as if it is configured to output.
     def get_value
-      send_request FUNCTION_GET_VALUE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_VALUE, [], '', 9, 'C'
     end
 
     # Configures the value and direction of the specified pins. Possible directions
@@ -125,7 +132,9 @@ module Tinkerforge
     # Running monoflop timers for the specified pins will be aborted if this
     # function is called.
     def set_configuration(selection_mask, direction, value)
-      send_request FUNCTION_SET_CONFIGURATION, [selection_mask, direction, value], 'C k ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CONFIGURATION, [selection_mask, direction, value], 'C k ?', 8, ''
     end
 
     # Returns a value bitmask and a direction bitmask. A 1 in the direction bitmask
@@ -139,7 +148,9 @@ module Tinkerforge
     # * pin 2 is configured as output high and
     # * pin 3 is are configured as output low.
     def get_configuration
-      send_request FUNCTION_GET_CONFIGURATION, [], '', 2, 'C C'
+      check_validity
+
+      send_request FUNCTION_GET_CONFIGURATION, [], '', 10, 'C C'
     end
 
     # Sets the debounce period of the CALLBACK_INTERRUPT callback.
@@ -148,12 +159,16 @@ module Tinkerforge
     # maximal every 100ms. This is necessary if something that bounces is
     # connected to the IO-4 Bricklet, such as a button.
     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 BrickletIO4#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.
@@ -165,12 +180,16 @@ module Tinkerforge
     # 
     # The interrupt is delivered with the CALLBACK_INTERRUPT callback.
     def set_interrupt(interrupt_mask)
-      send_request FUNCTION_SET_INTERRUPT, [interrupt_mask], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_INTERRUPT, [interrupt_mask], 'C', 8, ''
     end
 
     # Returns the interrupt bitmask as set by BrickletIO4#set_interrupt.
     def get_interrupt
-      send_request FUNCTION_GET_INTERRUPT, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_INTERRUPT, [], '', 9, 'C'
     end
 
     # Configures a monoflop of the pins specified by the first parameter as 4 bit
@@ -193,7 +212,9 @@ module Tinkerforge
     # of two seconds and pin 0 set to high. Pin 0 will be high all the time. If now
     # the RS485 connection is lost, then pin 0 will get low in at most two seconds.
     def set_monoflop(selection_mask, value_mask, time)
-      send_request FUNCTION_SET_MONOFLOP, [selection_mask, value_mask, time], 'C C L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MONOFLOP, [selection_mask, value_mask, time], 'C C L', 8, ''
     end
 
     # Returns (for the given pin) the current value and the time as set by
@@ -202,7 +223,9 @@ module Tinkerforge
     # If the timer is not running currently, the remaining time will be returned
     # as 0.
     def get_monoflop(pin)
-      send_request FUNCTION_GET_MONOFLOP, [pin], 'C', 9, 'C L L'
+      check_validity
+
+      send_request FUNCTION_GET_MONOFLOP, [pin], 'C', 17, 'C L L'
     end
 
     # Sets the output value (high or low) with a bitmask, according to
@@ -219,7 +242,9 @@ module Tinkerforge
     #  This function does nothing for pins that are configured as input.
     #  Pull-up resistors can be switched on with BrickletIO4#set_configuration.
     def set_selected_values(selection_mask, value_mask)
-      send_request FUNCTION_SET_SELECTED_VALUES, [selection_mask, value_mask], 'C C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_SELECTED_VALUES, [selection_mask, value_mask], 'C C', 8, ''
     end
 
     # Returns the current value of the edge counter for the selected pin. You can
@@ -230,7 +255,9 @@ module Tinkerforge
     # 
     # .. 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.
@@ -242,8 +269,6 @@ module Tinkerforge
     # * 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
@@ -251,7 +276,9 @@ module Tinkerforge
     # 
     # .. 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], 'C C C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_EDGE_COUNT_CONFIG, [selection_mask, edge_type, debounce], 'C C C', 8, ''
     end
 
     # Returns the edge type and debounce time for the selected pin as set by
@@ -259,19 +286,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>.