tinkerforge 2.1.22 → 2.1.27

data/lib/tinkerforge/bricklet_particulate_matter.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
   # Measures Particulate Matter concentration (PM1.0, PM2.5 and PM10)
   class BrickletParticulateMatter < Device
@@ -68,7 +70,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]
 
@@ -94,12 +96,13 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_PM_CONCENTRATION] = 'S S S'
-      @callback_formats[CALLBACK_PM_COUNT] = 'S S S S S S'
+      @callback_formats[CALLBACK_PM_CONCENTRATION] = [14, 'S S S']
+      @callback_formats[CALLBACK_PM_COUNT] = [20, 'S S S S S S']
 
+      @ipcon.add_device self
     end
 
-    # Returns the particulate matter concentration in µg/m³, broken down as:
+    # Returns the particulate matter concentration, broken down as:
     # 
     # * PM\ :sub:`1.0`\ ,
     # * PM\ :sub:`2.5`\  and
@@ -107,8 +110,14 @@ module Tinkerforge
     # 
     # If the sensor is disabled (see BrickletParticulateMatter#set_enable) then the last known good
     # values from the sensor are returned.
+    # 
+    # If you want to get the values periodically, it is recommended to use the
+    # CALLBACK_PM_CONCENTRATION callback. You can set the callback configuration
+    # with BrickletParticulateMatter#set_pm_concentration_callback_configuration.
     def get_pm_concentration
-      send_request FUNCTION_GET_PM_CONCENTRATION, [], '', 6, 'S S S'
+      check_validity
+
+      send_request FUNCTION_GET_PM_CONCENTRATION, [], '', 14, 'S S S'
     end
 
     # Returns the number of particulates in 100 ml of air, broken down by their
@@ -123,12 +132,17 @@ module Tinkerforge
     # 
     # If the sensor is disabled (see BrickletParticulateMatter#set_enable) then the last known good
     # value from the sensor is returned.
+    # 
+    # If you want to get the values periodically, it is recommended to use the
+    # CALLBACK_PM_COUNT callback. You can set the callback configuration
+    # with BrickletParticulateMatter#set_pm_count_callback_configuration.
     def get_pm_count
-      send_request FUNCTION_GET_PM_COUNT, [], '', 12, 'S S S S S S'
+      check_validity
+
+      send_request FUNCTION_GET_PM_COUNT, [], '', 20, 'S S S S S S'
     end
 
-    # Enables/Disables the fan and the laser diode of the sensors. The sensor is
-    # enabled by default.
+    # Enables/Disables the fan and the laser diode of the sensors.
     # 
     # The sensor takes about 30 seconds after it is enabled to settle and produce stable
     # values.
@@ -137,12 +151,16 @@ module Tinkerforge
     # an interval with a long idle time (e.g. hourly) you should turn the
     # laser diode off between the measurements.
     def set_enable(enable)
-      send_request FUNCTION_SET_ENABLE, [enable], '?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_ENABLE, [enable], '?', 8, ''
     end
 
     # Returns the state of the sensor as set by BrickletParticulateMatter#set_enable.
     def get_enable
-      send_request FUNCTION_GET_ENABLE, [], '', 1, '?'
+      check_validity
+
+      send_request FUNCTION_GET_ENABLE, [], '', 9, '?'
     end
 
     # Returns information about the sensor:
@@ -152,10 +170,12 @@ module Tinkerforge
     # * the number of framing and checksum errors that occurred in the communication
     #   with the sensor.
     def get_sensor_info
-      send_request FUNCTION_GET_SENSOR_INFO, [], '', 4, 'C C C C'
+      check_validity
+
+      send_request FUNCTION_GET_SENSOR_INFO, [], '', 12, 'C C C C'
     end
 
-    # The period in ms is the period with which the CALLBACK_PM_CONCENTRATION
+    # The period is the period with which the CALLBACK_PM_CONCENTRATION
     # 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
@@ -164,19 +184,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_pm_concentration_callback_configuration(period, value_has_to_change)
-      send_request FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, ''
     end
 
     # Returns the callback configuration as set by
     # BrickletParticulateMatter#set_pm_concentration_callback_configuration.
     def get_pm_concentration_callback_configuration
-      send_request FUNCTION_GET_PM_CONCENTRATION_CALLBACK_CONFIGURATION, [], '', 5, 'L ?'
+      check_validity
+
+      send_request FUNCTION_GET_PM_CONCENTRATION_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
     end
 
-    # The period in ms is the period with which the CALLBACK_PM_COUNT callback
+    # The period is the period with which the CALLBACK_PM_COUNT 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
@@ -185,16 +207,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_pm_count_callback_configuration(period, value_has_to_change)
-      send_request FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, ''
     end
 
     # Returns the callback configuration as set by
     # BrickletParticulateMatter#set_pm_count_callback_configuration.
     def get_pm_count_callback_configuration
-      send_request FUNCTION_GET_PM_COUNT_CALLBACK_CONFIGURATION, [], '', 5, 'L ?'
+      check_validity
+
+      send_request FUNCTION_GET_PM_COUNT_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -209,7 +233,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
@@ -222,12 +248,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 BrickletParticulateMatter#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 BrickletParticulateMatter#write_firmware. The pointer has
@@ -237,7 +267,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
@@ -249,7 +281,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
@@ -260,22 +294,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 BrickletParticulateMatter#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
@@ -285,7 +325,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
@@ -294,25 +336,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_piezo_buzzer.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
   # Creates 1kHz beep
   class BrickletPiezoBuzzer < 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]
 
@@ -38,15 +40,17 @@ module Tinkerforge
       @response_expected[FUNCTION_MORSE_CODE] = RESPONSE_EXPECTED_FALSE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_BEEP_FINISHED] = ''
-      @callback_formats[CALLBACK_MORSE_CODE_FINISHED] = ''
+      @callback_formats[CALLBACK_BEEP_FINISHED] = [8, '']
+      @callback_formats[CALLBACK_MORSE_CODE_FINISHED] = [8, '']
 
+      @ipcon.add_device self
     end
 
-    # Beeps with the duration in ms. For example: If you set a value of 1000,
-    # the piezo buzzer will beep for one second.
+    # Beeps for the given duration.
     def beep(duration)
-      send_request FUNCTION_BEEP, [duration], 'L', 0, ''
+      check_validity
+
+      send_request FUNCTION_BEEP, [duration], 'L', 8, ''
     end
 
     # Sets morse code that will be played by the piezo buzzer. The morse code
@@ -56,22 +60,24 @@ module Tinkerforge
     # For example: If you set the string "...---...", the piezo buzzer will beep
     # nine times with the durations "short short short long long long short
     # short short".
-    # 
-    # The maximum string size is 60.
     def morse_code(morse)
-      send_request FUNCTION_MORSE_CODE, [morse], 'Z60', 0, ''
+      check_validity
+
+      send_request FUNCTION_MORSE_CODE, [morse], 'Z60', 8, ''
     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_piezo_speaker.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
   # Creates beep with configurable frequency
   class BrickletPiezoSpeaker < Device
@@ -33,7 +35,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]
 
@@ -42,40 +44,37 @@ module Tinkerforge
       @response_expected[FUNCTION_CALIBRATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_BEEP_FINISHED] = ''
-      @callback_formats[CALLBACK_MORSE_CODE_FINISHED] = ''
+      @callback_formats[CALLBACK_BEEP_FINISHED] = [8, '']
+      @callback_formats[CALLBACK_MORSE_CODE_FINISHED] = [8, '']
 
+      @ipcon.add_device self
     end
 
-    # Beeps with the given frequency for the duration in ms. For example:
-    # If you set a duration of 1000, with a frequency value of 2000
-    # the piezo buzzer will beep for one second with a frequency of
-    # approximately 2 kHz.
+    # Beeps with the given frequency for the given duration.
     # 
     # .. versionchanged:: 2.0.2$nbsp;(Plugin)
     #    A duration of 0 stops the current beep if any, the frequency parameter is
     #    ignored. A duration of 4294967295 results in an infinite beep.
     # 
-    # The *frequency* parameter can be set between 585 and 7100.
-    # 
     # The Piezo Speaker Bricklet can only approximate the frequency, it will play
     # the best possible match by applying the calibration (see BrickletPiezoSpeaker#calibrate).
     def beep(duration, frequency)
-      send_request FUNCTION_BEEP, [duration, frequency], 'L S', 0, ''
+      check_validity
+
+      send_request FUNCTION_BEEP, [duration, frequency], 'L S', 8, ''
     end
 
     # Sets morse code that will be played by the piezo buzzer. The morse code
     # is given as a string consisting of "." (dot), "-" (minus) and " " (space)
     # for *dits*, *dahs* and *pauses*. Every other character is ignored.
-    # The second parameter is the frequency (see BrickletPiezoSpeaker#beep).
     # 
     # For example: If you set the string "...---...", the piezo buzzer will beep
     # nine times with the durations "short short short long long long short
     # short short".
-    # 
-    # The maximum string size is 60.
     def morse_code(morse, frequency)
-      send_request FUNCTION_MORSE_CODE, [morse, frequency], 'Z60 S', 0, ''
+      check_validity
+
+      send_request FUNCTION_MORSE_CODE, [morse, frequency], 'Z60 S', 8, ''
     end
 
     # The Piezo Speaker Bricklet can play 512 different tones. This function
@@ -88,19 +87,23 @@ module Tinkerforge
     # 
     # Returns *true* after the calibration finishes.
     def calibrate
-      send_request FUNCTION_CALIBRATE, [], '', 1, '?'
+      check_validity
+
+      send_request FUNCTION_CALIBRATE, [], '', 9, '?'
     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>.