tinkerforge 2.1.23 → 2.1.28

data/lib/tinkerforge/bricklet_load_cell_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
   # Measures weight with a load cell
   class BrickletLoadCellV2 < Device
@@ -77,7 +79,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]
 
@@ -105,21 +107,24 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_WEIGHT] = 'l'
+      @callback_formats[CALLBACK_WEIGHT] = [12, 'l']
 
+      @ipcon.add_device self
     end
 
-    # Returns the currently measured weight in grams.
+    # Returns the currently measured weight.
     # 
     # 
     # If you want to get the value periodically, it is recommended to use the
     # CALLBACK_WEIGHT callback. You can set the callback configuration
     # with BrickletLoadCellV2#set_weight_callback_configuration.
     def get_weight
-      send_request FUNCTION_GET_WEIGHT, [], '', 4, 'l'
+      check_validity
+
+      send_request FUNCTION_GET_WEIGHT, [], '', 12, 'l'
     end
 
-    # The period in ms is the period with which the CALLBACK_WEIGHT callback is triggered
+    # The period is the period with which the CALLBACK_WEIGHT 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
@@ -144,15 +149,17 @@ module Tinkerforge
     #  "'>'",    "Threshold is triggered when the value is greater than the min value (max is ignored)"
     # 
     # If the option is set to 'x' (threshold turned off) the callback is triggered with the fixed period.
-    # 
-    # The default value is (0, false, 'x', 0, 0).
     def set_weight_callback_configuration(period, value_has_to_change, option, min, max)
-      send_request FUNCTION_SET_WEIGHT_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_WEIGHT_CALLBACK_CONFIGURATION, [period, value_has_to_change, option, min, max], 'L ? k l l', 8, ''
     end
 
     # Returns the callback configuration as set by BrickletLoadCellV2#set_weight_callback_configuration.
     def get_weight_callback_configuration
-      send_request FUNCTION_GET_WEIGHT_CALLBACK_CONFIGURATION, [], '', 14, 'L ? k l l'
+      check_validity
+
+      send_request FUNCTION_GET_WEIGHT_CALLBACK_CONFIGURATION, [], '', 22, 'L ? k l l'
     end
 
     # Sets the length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__
@@ -160,35 +167,38 @@ module Tinkerforge
     # 
     # Setting the length to 1 will turn the averaging off. With less
     # averaging, there is more noise on the data.
-    # 
-    # The range for the averaging is 1-100.
-    # 
-    # The default value is 4.
     def set_moving_average(average)
-      send_request FUNCTION_SET_MOVING_AVERAGE, [average], 'S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MOVING_AVERAGE, [average], 'S', 8, ''
     end
 
     # Returns the length moving average as set by BrickletLoadCellV2#set_moving_average.
     def get_moving_average
-      send_request FUNCTION_GET_MOVING_AVERAGE, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_MOVING_AVERAGE, [], '', 10, 'S'
     end
 
     # Configures the info LED to be either turned off, turned on, or blink in
     # heartbeat mode.
     def set_info_led_config(config)
-      send_request FUNCTION_SET_INFO_LED_CONFIG, [config], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_INFO_LED_CONFIG, [config], 'C', 8, ''
     end
 
     # Returns the LED configuration as set by BrickletLoadCellV2#set_info_led_config
     def get_info_led_config
-      send_request FUNCTION_GET_INFO_LED_CONFIG, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_INFO_LED_CONFIG, [], '', 9, 'C'
     end
 
     # To calibrate your Load Cell Bricklet 2.0 you have to
     # 
     # * empty the scale and call this function with 0 and
-    # * add a known weight to the scale and call this function with the weight in
-    #   grams.
+    # * add a known weight to the scale and call this function with the weight.
     # 
     # The calibration is saved in the flash of the Bricklet and only
     # needs to be done once.
@@ -196,12 +206,16 @@ module Tinkerforge
     # We recommend to use the Brick Viewer for calibration, you don't need
     # to call this function in your source code.
     def calibrate(weight)
-      send_request FUNCTION_CALIBRATE, [weight], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_CALIBRATE, [weight], 'L', 8, ''
     end
 
     # Sets the currently measured weight as tare weight.
     def tare
-      send_request FUNCTION_TARE, [], '', 0, ''
+      check_validity
+
+      send_request FUNCTION_TARE, [], '', 8, ''
     end
 
     # The measurement rate and gain are configurable.
@@ -216,15 +230,17 @@ module Tinkerforge
     # means the voltage range is ±15mV for most load cells (i.e. gain of 128x
     # is best). If you don't know what all of this means you should keep it at
     # 128x, it will most likely be correct.
-    # 
-    # The default rate is 10Hz and the default gain is 128x.
     def set_configuration(rate, gain)
-      send_request FUNCTION_SET_CONFIGURATION, [rate, gain], 'C C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_CONFIGURATION, [rate, gain], 'C C', 8, ''
     end
 
     # Returns the configuration as set by BrickletLoadCellV2#set_configuration.
     def get_configuration
-      send_request FUNCTION_GET_CONFIGURATION, [], '', 2, 'C C'
+      check_validity
+
+      send_request FUNCTION_GET_CONFIGURATION, [], '', 10, 'C C'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -239,7 +255,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
@@ -252,12 +270,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 BrickletLoadCellV2#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 BrickletLoadCellV2#write_firmware. The pointer has
@@ -267,7 +289,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
@@ -279,7 +303,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
@@ -290,22 +316,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 BrickletLoadCellV2#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
@@ -315,7 +347,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
@@ -324,25 +358,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_moisture.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
   # Measures soil moisture
   class BrickletMoisture < Device
@@ -51,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, 0]
 
@@ -66,36 +68,41 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_MOVING_AVERAGE] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_MOISTURE] = 'S'
-      @callback_formats[CALLBACK_MOISTURE_REACHED] = 'S'
+      @callback_formats[CALLBACK_MOISTURE] = [10, 'S']
+      @callback_formats[CALLBACK_MOISTURE_REACHED] = [10, 'S']
 
+      @ipcon.add_device self
     end
 
-    # Returns the current moisture value. The value has a range of
-    # 0 to 4095. A small value corresponds to little moisture, a big
+    # Returns the current moisture value.
+    # A small value corresponds to little moisture, a big
     # value corresponds to much moisture.
     # 
     # If you want to get the moisture value periodically, it is recommended
     # to use the CALLBACK_MOISTURE callback and set the period with
     # BrickletMoisture#set_moisture_callback_period.
     def get_moisture_value
-      send_request FUNCTION_GET_MOISTURE_VALUE, [], '', 2, 'S'
+      check_validity
+
+      send_request FUNCTION_GET_MOISTURE_VALUE, [], '', 10, 'S'
     end
 
-    # Sets the period in ms with which the CALLBACK_MOISTURE callback is triggered
+    # Sets the period with which the CALLBACK_MOISTURE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_MOISTURE callback is only triggered if the moisture value has changed
     # since the last triggering.
-    # 
-    # The default value is 0.
     def set_moisture_callback_period(period)
-      send_request FUNCTION_SET_MOISTURE_CALLBACK_PERIOD, [period], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MOISTURE_CALLBACK_PERIOD, [period], 'L', 8, ''
     end
 
     # Returns the period as set by BrickletMoisture#set_moisture_callback_period.
     def get_moisture_callback_period
-      send_request FUNCTION_GET_MOISTURE_CALLBACK_PERIOD, [], '', 4, 'L'
+      check_validity
+
+      send_request FUNCTION_GET_MOISTURE_CALLBACK_PERIOD, [], '', 12, 'L'
     end
 
     # Sets the thresholds for the CALLBACK_MOISTURE_REACHED callback.
@@ -109,18 +116,20 @@ module Tinkerforge
     #  "'i'",    "Callback is triggered when the moisture value is *inside* the min and max values"
     #  "'<'",    "Callback is triggered when the moisture value is smaller than the min value (max is ignored)"
     #  "'>'",    "Callback is triggered when the moisture value is greater than the min value (max is ignored)"
-    # 
-    # The default value is ('x', 0, 0).
     def set_moisture_callback_threshold(option, min, max)
-      send_request FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 8, ''
     end
 
     # Returns the threshold as set by BrickletMoisture#set_moisture_callback_threshold.
     def get_moisture_callback_threshold
-      send_request FUNCTION_GET_MOISTURE_CALLBACK_THRESHOLD, [], '', 5, 'k S S'
+      check_validity
+
+      send_request FUNCTION_GET_MOISTURE_CALLBACK_THRESHOLD, [], '', 13, 'k S S'
     end
 
-    # Sets the period in ms with which the threshold callback
+    # Sets the period with which the threshold callback
     # 
     # * CALLBACK_MOISTURE_REACHED
     # 
@@ -129,15 +138,17 @@ module Tinkerforge
     # * BrickletMoisture#set_moisture_callback_threshold
     # 
     # keeps being reached.
-    # 
-    # 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 BrickletMoisture#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 length of a `moving averaging <https://en.wikipedia.org/wiki/Moving_average>`__
@@ -145,29 +156,31 @@ module Tinkerforge
     # 
     # Setting the length to 0 will turn the averaging completely off. With less
     # averaging, there is more noise on the data.
-    # 
-    # The range for the averaging is 0-100.
-    # 
-    # The default value is 100.
     def set_moving_average(average)
-      send_request FUNCTION_SET_MOVING_AVERAGE, [average], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_MOVING_AVERAGE, [average], 'C', 8, ''
     end
 
     # Returns the length moving average as set by BrickletMoisture#set_moving_average.
     def get_moving_average
-      send_request FUNCTION_GET_MOVING_AVERAGE, [], '', 1, 'C'
+      check_validity
+
+      send_request FUNCTION_GET_MOVING_AVERAGE, [], '', 9, '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>.