tinkerforge 2.1.23 → 2.1.28

data/lib/tinkerforge/bricklet_piezo_buzzer.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
   # 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-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
   # 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>.

data/lib/tinkerforge/bricklet_piezo_speaker_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
   # Creates beep and alarm with configurable volume and frequency
   class BrickletPiezoSpeakerV2 < Device
@@ -63,7 +65,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,47 +88,42 @@ module Tinkerforge
       @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
-      @callback_formats[CALLBACK_BEEP_FINISHED] = ''
-      @callback_formats[CALLBACK_ALARM_FINISHED] = ''
+      @callback_formats[CALLBACK_BEEP_FINISHED] = [8, '']
+      @callback_formats[CALLBACK_ALARM_FINISHED] = [8, '']
 
+      @ipcon.add_device self
     end
 
-    # Beeps with the given frequency and volume for the duration in ms. 
-    # 
-    # For example: If you set a duration of 1000, with a volume of 10 and a frequency
-    # value of 2000 the piezo buzzer will beep with maximum loudness for one 
-    # second with a frequency of 2 kHz.
+    # Beeps with the given frequency and volume for the duration.
     # 
     # A duration of 0 stops the current beep if any is ongoing.
     # A duration of 4294967295 results in an infinite beep.
-    # 
-    # The ranges are:
-    # 
-    # * Frequency: 50Hz - 15000Hz
-    # * Volume: 0 - 10
-    # * Duration: 0ms - 4294967295ms
     def set_beep(frequency, volume, duration)
-      send_request FUNCTION_SET_BEEP, [frequency, volume, duration], 'S C L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_BEEP, [frequency, volume, duration], 'S C L', 8, ''
     end
 
-    # Returns the last beep settings as set by BrickletPiezoSpeakerV2#set_beep. If a beep is currently 
-    # running it also returns the remaining duration of the beep in ms.
+    # Returns the last beep settings as set by BrickletPiezoSpeakerV2#set_beep. If a beep is currently
+    # running it also returns the remaining duration of the beep.
     # 
-    # If the frequency or volume is updated during a beep (with BrickletPiezoSpeakerV2#update_frequency 
+    # If the frequency or volume is updated during a beep (with BrickletPiezoSpeakerV2#update_frequency
     # or BrickletPiezoSpeakerV2#update_volume) this function returns the updated value.
     def get_beep
-      send_request FUNCTION_GET_BEEP, [], '', 11, 'S C L L'
+      check_validity
+
+      send_request FUNCTION_GET_BEEP, [], '', 19, 'S C L L'
     end
 
     # Creates an alarm (a tone that goes back and force between two specified frequencies).
     # 
     # The following parameters can be set:
     # 
-    # * Start Frequency: Start frequency of the alarm in Hz.
-    # * End Frequency: End frequency of the alarm in Hz.
-    # * Step Size: Size of one step of the sweep between the start/end frequencies in Hz.
-    # * Step Delay: Delay between two steps (duration of time that one tone is used in a sweep) in ms.
-    # * Duration: Duration of the alarm in ms.
+    # * Start Frequency: Start frequency of the alarm.
+    # * End Frequency: End frequency of the alarm.
+    # * Step Size: Size of one step of the sweep between the start/end frequencies.
+    # * Step Delay: Delay between two steps (duration of time that one tone is used in a sweep).
+    # * Duration: Duration of the alarm.
     # 
     # A duration of 0 stops the current alarm if any is ongoing.
     # A duration of 4294967295 results in an infinite alarm.
@@ -152,36 +149,42 @@ module Tinkerforge
     # * Volume = 0
     # * Duration = 10000
     # 
-    # The ranges are:
+    # The following conditions must be met:
     # 
-    # * Start Frequency: 50Hz - 14999Hz (has to be smaller than end frequency)
-    # * End Frequency: 51Hz - 15000Hz (has to be bigger than start frequency)
-    # * Step Size: 1Hz - 65535Hz (has to be small enough to fit into the frequency range)
-    # * Step Delay: 1ms - 65535ms (has to be small enough to fit into the duration)
-    # * Volume: 0 - 10
-    # * Duration: 0ms - 4294967295ms
+    # * Start Frequency: has to be smaller than end frequency
+    # * End Frequency: has to be bigger than start frequency
+    # * Step Size: has to be small enough to fit into the frequency range
+    # * Step Delay: has to be small enough to fit into the duration
     def set_alarm(start_frequency, end_frequency, step_size, step_delay, volume, duration)
-      send_request FUNCTION_SET_ALARM, [start_frequency, end_frequency, step_size, step_delay, volume, duration], 'S S S S C L', 0, ''
+      check_validity
+
+      send_request FUNCTION_SET_ALARM, [start_frequency, end_frequency, step_size, step_delay, volume, duration], 'S S S S C L', 8, ''
     end
 
-    # Returns the last alarm settings as set by BrickletPiezoSpeakerV2#set_alarm. If an alarm is currently 
-    # running it also returns the remaining duration of the alarm in ms as well as the
-    # current frequency of the alarm in Hz.
+    # Returns the last alarm settings as set by BrickletPiezoSpeakerV2#set_alarm. If an alarm is currently
+    # running it also returns the remaining duration of the alarm as well as the
+    # current frequency of the alarm.
     # 
-    # If the volume is updated during a beep (with BrickletPiezoSpeakerV2#update_volume) 
+    # If the volume is updated during an alarm (with BrickletPiezoSpeakerV2#update_volume)
     # this function returns the updated value.
     def get_alarm
-      send_request FUNCTION_GET_ALARM, [], '', 19, 'S S S S C L L S'
+      check_validity
+
+      send_request FUNCTION_GET_ALARM, [], '', 27, 'S S S S C L L S'
     end
 
-    # Updates the volume of an ongoing beep or alarm. The range of the volume is 0 to 10.
+    # Updates the volume of an ongoing beep or alarm.
     def update_volume(volume)
-      send_request FUNCTION_UPDATE_VOLUME, [volume], 'C', 0, ''
+      check_validity
+
+      send_request FUNCTION_UPDATE_VOLUME, [volume], 'C', 8, ''
     end
 
-    # Updates the frequency of an ongoing beep. The range of the frequency is 50Hz to 15000Hz.
+    # Updates the frequency of an ongoing beep.
     def update_frequency(frequency)
-      send_request FUNCTION_UPDATE_FREQUENCY, [frequency], 'S', 0, ''
+      check_validity
+
+      send_request FUNCTION_UPDATE_FREQUENCY, [frequency], 'S', 8, ''
     end
 
     # Returns the error count for the communication between Brick and Bricklet.
@@ -196,7 +199,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
@@ -209,12 +214,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 BrickletPiezoSpeakerV2#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 BrickletPiezoSpeakerV2#write_firmware. The pointer has
@@ -224,7 +233,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
@@ -236,7 +247,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
@@ -247,22 +260,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 BrickletPiezoSpeakerV2#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
@@ -272,7 +291,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
@@ -281,25 +302,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>.