tinkerforge 2.1.23 → 2.1.24

data/lib/tinkerforge/bricklet_oled_128x64_v2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -83,9 +83,8 @@ module Tinkerforge
 
     # Writes pixels to the specified window.
     # 
-    # The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are written
-    # into the window line by line top to bottom and each line is written from left to
-    # right.
+    # The pixels are written into the window line by line top to bottom
+    # and each line is written from left to right.
     # 
     # If automatic draw is enabled (default) the pixels are directly written to
     # the screen. Only pixels that have actually changed are updated on the screen,
@@ -104,9 +103,8 @@ module Tinkerforge
 
     # Reads pixels from the specified window.
     # 
-    # The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are read
-    # from the window line by line top to bottom and each line is read from left to
-    # right.
+    # The pixels are read from the window line by line top to bottom
+    # and each line is read from left to right.
     # 
     # If automatic draw is enabled (default) the pixels that are read are always the
     # same that are shown on the display.
@@ -144,8 +142,6 @@ module Tinkerforge
     # call of BrickletOLED128x64V2#write_pixels or BrickletOLED128x64V2#write_line. If it is set to false, the
     # changes are written into an internal buffer and only shown on the display after
     # a call of BrickletOLED128x64V2#draw_buffered_frame.
-    # 
-    # The default values are contrast 143, inverting off and automatic draw on.
     def set_display_configuration(contrast, invert, automatic_draw)
       send_request FUNCTION_SET_DISPLAY_CONFIGURATION, [contrast, invert, automatic_draw], 'C ? ?', 0, ''
     end
@@ -155,8 +151,8 @@ module Tinkerforge
       send_request FUNCTION_GET_DISPLAY_CONFIGURATION, [], '', 3, 'C ? ?'
     end
 
-    # Writes text to a specific line (0 to 7) with a specific position
-    # (0 to 21). The text can have a maximum of 22 characters.
+    # Writes text to a specific line with a specific position.
+    # The text can have a maximum of 22 characters.
     # 
     # For example: (1, 10, "Hello") will write *Hello* in the middle of the
     # second line of the display.
@@ -312,9 +308,8 @@ module Tinkerforge
 
     # Writes pixels to the specified window.
     # 
-    # The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are written
-    # into the window line by line top to bottom and each line is written from left to
-    # right.
+    # The pixels are written into the window line by line top to bottom
+    # and each line is written from left to right.
     # 
     # If automatic draw is enabled (default) the pixels are directly written to
     # the screen. Only pixels that have actually changed are updated on the screen,
@@ -360,9 +355,8 @@ module Tinkerforge
 
     # Reads pixels from the specified window.
     # 
-    # The x-axis goes from 0 to 127 and the y-axis from 0 to 63. The pixels are read
-    # from the window line by line top to bottom and each line is read from left to
-    # right.
+    # The pixels are read from the window line by line top to bottom
+    # and each line is read from left to right.
     # 
     # If automatic draw is enabled (default) the pixels that are read are always the
     # same that are shown on the display.

data/lib/tinkerforge/bricklet_oled_64x48.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -67,8 +67,6 @@ module Tinkerforge
 
     # Sets the window in which you can write with BrickletOLED64x48#write. One row
     # has a height of 8 pixels.
-    # 
-    # The columns have a range of 0 to 63 and the rows have a range of 0 to 5.
     def new_window(column_from, column_to, row_from, row_to)
       send_request FUNCTION_NEW_WINDOW, [column_from, column_to, row_from, row_to], 'C C C C', 0, ''
     end
@@ -82,8 +80,6 @@ module Tinkerforge
     # 
     # You can set a contrast value from 0 to 255 and you can invert the color
     # (black/white) of the display.
-    # 
-    # The default values are contrast 143 and inverting off.
     def set_display_configuration(contrast, invert)
       send_request FUNCTION_SET_DISPLAY_CONFIGURATION, [contrast, invert], 'C ?', 0, ''
     end
@@ -93,8 +89,8 @@ module Tinkerforge
       send_request FUNCTION_GET_DISPLAY_CONFIGURATION, [], '', 2, 'C ?'
     end
 
-    # Writes text to a specific line (0 to 5) with a specific position
-    # (0 to 12). The text can have a maximum of 13 characters.
+    # Writes text to a specific line with a specific position.
+    # The text can have a maximum of 13 characters.
     # 
     # For example: (1, 4, "Hello") will write *Hello* in the middle of the
     # second line of the display.

data/lib/tinkerforge/bricklet_one_wire.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #

data/lib/tinkerforge/bricklet_outdoor_weather.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -27,7 +27,7 @@ module Tinkerforge
     # Reports the sensor data every time a new data packet is received.
     # See BrickletOutdoorWeather#get_sensor_data for information about the data.
     # 
-    # For each station the callback will be called about every 45 seconds.
+    # For each sensor the callback will be called about every 45 seconds.
     # 
     # Turn the callback on/off with BrickletOutdoorWeather#set_sensor_callback_configuration
     # (by default it is turned off).
@@ -149,14 +149,14 @@ module Tinkerforge
     # 
     # The return values are:
     # 
-    # * Temperature in °C/10,
-    # * Humidity in %RH,
-    # * Wind Speed in m/10s,
-    # * Gust Speed in m/10s,
-    # * Rain Fall in mm/10,
-    # * Wind Direction (N, NNE, NE, ENE, E, ESE, SE, SSE, S, SSW, SW, WSW, W, WNW, NW, NNW),
-    # * Battery Low (true or false) and
-    # * Last Change (time in seconds since the reception of this data).
+    # * Temperature,
+    # * Humidity,
+    # * Wind Speed,
+    # * Gust Speed,
+    # * Rain Fall,
+    # * Wind Direction,
+    # * Battery Low (true if battery is low) and
+    # * Last Change (seconds since the reception of this data).
     def get_station_data(identifier)
       send_request FUNCTION_GET_STATION_DATA, [identifier], 'C', 19, 's C L L L C ? S'
     end
@@ -166,14 +166,14 @@ module Tinkerforge
     # 
     # The return values are:
     # 
-    # * Temperature in °C/10,
-    # * Humidity in %RH and
-    # * Last Change (time in seconds since the last reception of data).
+    # * Temperature,
+    # * Humidity and
+    # * Last Change (seconds since the last reception of data).
     def get_sensor_data(identifier)
       send_request FUNCTION_GET_SENSOR_DATA, [identifier], 'C', 5, 's C S'
     end
 
-    # Turns callback for station data on or off. Default is off.
+    # Turns callback for station data on or off.
     def set_station_callback_configuration(enable_callback)
       send_request FUNCTION_SET_STATION_CALLBACK_CONFIGURATION, [enable_callback], '?', 0, ''
     end
@@ -183,7 +183,7 @@ module Tinkerforge
       send_request FUNCTION_GET_STATION_CALLBACK_CONFIGURATION, [], '', 1, '?'
     end
 
-    # Turns callback for sensor data on or off. Default is off.
+    # Turns callback for sensor data on or off.
     def set_sensor_callback_configuration(enable_callback)
       send_request FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION, [enable_callback], '?', 0, ''
     end

data/lib/tinkerforge/bricklet_particulate_matter.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -99,7 +99,7 @@ module Tinkerforge
 
     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,6 +107,10 @@ 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'
     end
@@ -123,6 +127,10 @@ 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'
     end
@@ -155,7 +163,7 @@ module Tinkerforge
       send_request FUNCTION_GET_SENSOR_INFO, [], '', 4, '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,8 +172,6 @@ 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, ''
     end
@@ -176,7 +182,7 @@ module Tinkerforge
       send_request FUNCTION_GET_PM_CONCENTRATION_CALLBACK_CONFIGURATION, [], '', 5, '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,8 +191,6 @@ 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, ''
     end

data/lib/tinkerforge/bricklet_piezo_buzzer.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -43,8 +43,7 @@ module Tinkerforge
 
     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, ''
     end
@@ -56,8 +55,6 @@ 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, ''
     end

data/lib/tinkerforge/bricklet_piezo_speaker.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -47,17 +47,12 @@ module Tinkerforge
 
     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)
@@ -67,13 +62,10 @@ module Tinkerforge
     # 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, ''
     end

data/lib/tinkerforge/bricklet_piezo_speaker_v2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -91,28 +91,18 @@ module Tinkerforge
 
     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, ''
     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'
@@ -164,11 +154,11 @@ module Tinkerforge
       send_request FUNCTION_SET_ALARM, [start_frequency, end_frequency, step_size, step_delay, volume, duration], 'S S S S C L', 0, ''
     end
 
-    # Returns the last alarm settings as set by BrickletPiezoSpeakerV2#set_alarm. If an alarm is currently 
+    # 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.
     # 
-    # If the volume is updated during a beep (with BrickletPiezoSpeakerV2#update_volume) 
+    # If the volume is updated during a beep (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'

data/lib/tinkerforge/bricklet_ptc.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2019-08-23.      #
+# This file was automatically generated on 2019-11-25.      #
 #                                                           #
-# Ruby Bindings Version 2.1.23                              #
+# Ruby Bindings Version 2.1.24                              #
 #                                                           #
 # 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  #
@@ -148,13 +148,11 @@ module Tinkerforge
       send_request FUNCTION_GET_RESISTANCE, [], '', 4, 'l'
     end
 
-    # Sets the period in ms with which the CALLBACK_TEMPERATURE callback is triggered
+    # Sets the period with which the CALLBACK_TEMPERATURE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_TEMPERATURE callback is only triggered if the temperature has
     # changed since the last triggering.
-    # 
-    # The default value is 0.
     def set_temperature_callback_period(period)
       send_request FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -164,13 +162,11 @@ module Tinkerforge
       send_request FUNCTION_GET_TEMPERATURE_CALLBACK_PERIOD, [], '', 4, 'L'
     end
 
-    # Sets the period in ms with which the CALLBACK_RESISTANCE callback is triggered
+    # Sets the period with which the CALLBACK_RESISTANCE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
     # The CALLBACK_RESISTANCE callback is only triggered if the resistance has changed
     # since the last triggering.
-    # 
-    # The default value is 0.
     def set_resistance_callback_period(period)
       send_request FUNCTION_SET_RESISTANCE_CALLBACK_PERIOD, [period], 'L', 0, ''
     end
@@ -224,7 +220,7 @@ module Tinkerforge
       send_request FUNCTION_GET_RESISTANCE_CALLBACK_THRESHOLD, [], '', 9, 'k l l'
     end
 
-    # Sets the period in ms with which the threshold callback
+    # Sets the period with which the threshold callback
     # 
     # * CALLBACK_TEMPERATURE_REACHED,
     # * CALLBACK_RESISTANCE_REACHED
@@ -235,8 +231,6 @@ module Tinkerforge
     # * BrickletPTC#set_resistance_callback_threshold
     # 
     # keeps being reached.
-    # 
-    # The default value is 100.
     def set_debounce_period(debounce)
       send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 0, ''
     end