tinkerforge 2.1.11 → 2.1.12

data/lib/tinkerforge/bricklet_multi_touch.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.12                              #
 #                                                           #
 # 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  #
@@ -122,7 +122,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_ELECTRODE_SENSITIVITY, [], '', 1, 'C')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 

data/lib/tinkerforge/bricklet_nfc_rfid.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.12                              #
 #                                                           #
 # 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  #
@@ -69,9 +69,9 @@ module Tinkerforge
       @callback_formats[CALLBACK_STATE_CHANGED] = 'C ?'
     end
 
-    # To read or write a tag that is in proximity of the NFC/RFID Bricklet you 
+    # To read or write a tag that is in proximity of the NFC/RFID Bricklet you
     # first have to call this function with the expected tag type as parameter.
-    # It is no problem if you don't know the tag type. You can cycle through 
+    # It is no problem if you don't know the tag type. You can cycle through
     # the available tag types until the tag gives an answer to the request.
     # 
     # Current the following tag types are supported:
@@ -80,14 +80,14 @@ module Tinkerforge
     # * NFC Forum Type 1
     # * NFC Forum Type 2
     # 
-    # After you call BrickletNFCRFID#request_tag_id the NFC/RFID Bricklet will try to read 
+    # After you call BrickletNFCRFID#request_tag_id the NFC/RFID Bricklet will try to read
     # the tag ID from the tag. After this process is done the state will change.
     # You can either register the CALLBACK_STATE_CHANGED callback or you can poll
     # BrickletNFCRFID#get_state to find out about the state change.
     # 
-    # If the state changes to *RequestTagIDError* it means that either there was 
-    # no tag present or that the tag is of an incompatible type. If the state 
-    # changes to *RequestTagIDReady* it means that a compatible tag was found 
+    # If the state changes to *RequestTagIDError* it means that either there was
+    # no tag present or that the tag is of an incompatible type. If the state
+    # changes to *RequestTagIDReady* it means that a compatible tag was found
     # and that the tag ID could be read out. You can now get the tag ID by
     # calling BrickletNFCRFID#get_tag_id.
     # 
@@ -101,7 +101,7 @@ module Tinkerforge
       send_request(FUNCTION_REQUEST_TAG_ID, [tag_type], 'C', 0, '')
     end
 
-    # Returns the tag type, tag ID and the length of the tag ID 
+    # Returns the tag type, tag ID and the length of the tag ID
     # (4 or 7 bytes are possible length). This function can only be called if the
     # NFC/RFID is currently in one of the *Ready* states. The returned ID
     # is the ID that was saved through the last call of BrickletNFCRFID#request_tag_id.
@@ -110,7 +110,7 @@ module Tinkerforge
     # 
     # 1. Call BrickletNFCRFID#request_tag_id
     # 2. Wait for state to change to *RequestTagIDReady* (see BrickletNFCRFID#get_state or
-    #    CALLBACK_STATE_CHANGED)
+    #    CALLBACK_STATE_CHANGED callback)
     # 3. Call BrickletNFCRFID#get_tag_id
     def get_tag_id
       send_request(FUNCTION_GET_TAG_ID, [], '', 9, 'C C C7')
@@ -124,7 +124,7 @@ module Tinkerforge
     # The functions of this Bricklet can be called in the *Idle* state and all of
     # the *Ready* and *Error* states.
     # 
-    # Example: If you call BrickletNFCRFID#request_page, the state will change to 
+    # Example: If you call BrickletNFCRFID#request_page, the state will change to
     # *RequestPage* until the reading of the page is finished. Then it will change
     # to either *RequestPageReady* if it worked or to *RequestPageError* if it
     # didn't. If the request worked you can get the page by calling BrickletNFCRFID#get_page.
@@ -145,12 +145,12 @@ module Tinkerforge
     # 
     # 1. Call BrickletNFCRFID#request_tag_id
     # 2. Wait for state to change to *RequestTagIDReady* (see BrickletNFCRFID#get_state
-    #    or CALLBACK_STATE_CHANGED)
+    #    or CALLBACK_STATE_CHANGED callback)
     # 3. If looking for a specific tag then call BrickletNFCRFID#get_tag_id and check if the
     #    expected tag was found, if it was not found got back to step 1
     # 4. Call BrickletNFCRFID#authenticate_mifare_classic_page with page and key for the page
     # 5. Wait for state to change to *AuthenticatingMifareClassicPageReady* (see
-    #    BrickletNFCRFID#get_state or CALLBACK_STATE_CHANGED)
+    #    BrickletNFCRFID#get_state or CALLBACK_STATE_CHANGEDcallback)
     # 6. Call BrickletNFCRFID#request_page or BrickletNFCRFID#write_page to read/write page
     def authenticate_mifare_classic_page(page, key_number, key)
       send_request(FUNCTION_AUTHENTICATE_MIFARE_CLASSIC_PAGE, [page, key_number, key], 'S C C6', 0, '')
@@ -167,12 +167,12 @@ module Tinkerforge
     # 
     # 1. Call BrickletNFCRFID#request_tag_id
     # 2. Wait for state to change to *RequestTagIDReady* (see BrickletNFCRFID#get_state or
-    #    CALLBACK_STATE_CHANGED)
+    #    CALLBACK_STATE_CHANGED callback)
     # 3. If looking for a specific tag then call BrickletNFCRFID#get_tag_id and check if the
     #    expected tag was found, if it was not found got back to step 1
     # 4. Call BrickletNFCRFID#write_page with page number and data
     # 5. Wait for state to change to *WritePageReady* (see BrickletNFCRFID#get_state or
-    #    CALLBACK_STATE_CHANGED)
+    #    CALLBACK_STATE_CHANGEDcallback)
     # 
     # If you use a Mifare Classic tag you have to authenticate a page before you
     # can write to it. See BrickletNFCRFID#authenticate_mifare_classic_page.
@@ -180,9 +180,9 @@ module Tinkerforge
       send_request(FUNCTION_WRITE_PAGE, [page, data], 'S C16', 0, '')
     end
 
-    # Reads 16 bytes starting from the given page and stores them into a buffer. 
+    # Reads 16 bytes starting from the given page and stores them into a buffer.
     # The buffer can then be read out with BrickletNFCRFID#get_page.
-    # How many pages are read depends on the tag type. The page sizes are 
+    # How many pages are read depends on the tag type. The page sizes are
     # as follows:
     # 
     # * Mifare Classic page size: 16 byte (one page is read)
@@ -193,12 +193,12 @@ module Tinkerforge
     # 
     # 1. Call BrickletNFCRFID#request_tag_id
     # 2. Wait for state to change to *RequestTagIDReady* (see BrickletNFCRFID#get_state
-    #    or CALLBACK_STATE_CHANGED)
+    #    or CALLBACK_STATE_CHANGED callback)
     # 3. If looking for a specific tag then call BrickletNFCRFID#get_tag_id and check if the
     #    expected tag was found, if it was not found got back to step 1
     # 4. Call BrickletNFCRFID#request_page with page number
     # 5. Wait for state to change to *RequestPageReady* (see BrickletNFCRFID#get_state
-    #    or CALLBACK_STATE_CHANGED)
+    #    or CALLBACK_STATE_CHANGED callback)
     # 6. Call BrickletNFCRFID#get_page to retrieve the page from the buffer
     # 
     # If you use a Mifare Classic tag you have to authenticate a page before you
@@ -213,7 +213,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_PAGE, [], '', 16, 'C16')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 

data/lib/tinkerforge/bricklet_oled_128x64.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.12                              #
 #                                                           #
 # 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  #
@@ -55,11 +55,11 @@ module Tinkerforge
     #    :align: center
     #    :target: ../../_images/Bricklets/bricklet_oled_128x64_display.png
     # 
-    # The LSB (D0) of each data byte is at the top and the MSB (D7) is at the 
+    # The LSB (D0) of each data byte is at the top and the MSB (D7) is at the
     # bottom of the row.
     # 
     # The next call of BrickletOLED128x64#write will write the second half of the row
-    # and the next two the second row and so on. To fill the whole display 
+    # and the next two the second row and so on. To fill the whole display
     # you need to call BrickletOLED128x64#write 16 times.
     def write(data)
       send_request(FUNCTION_WRITE, [data], 'C64', 0, '')
@@ -93,7 +93,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_DISPLAY_CONFIGURATION, [], '', 2, 'C ?')
     end
 
-    # Writes text to a specific line (0 to 7) with a specific position 
+    # Writes text to a specific line (0 to 7) with a specific position
     # (0 to 25). The text can have a maximum of 26 characters.
     # 
     # For example: (1, 10, "Hello") will write *Hello* in the middle of the
@@ -102,13 +102,13 @@ module Tinkerforge
     # You can draw to the display with BrickletOLED128x64#write and then add text to it
     # afterwards.
     # 
-    # The display uses a special 5x7 pixel charset. You can view the characters 
+    # The display uses a special 5x7 pixel charset. You can view the characters
     # of the charset in Brick Viewer.
     def write_line(line, position, text)
       send_request(FUNCTION_WRITE_LINE, [line, position, text], 'C C Z26', 0, '')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 

data/lib/tinkerforge/bricklet_oled_64x48.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.12                              #
 #                                                           #
 # 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  #
@@ -55,7 +55,7 @@ module Tinkerforge
     #    :align: center
     #    :target: ../../_images/Bricklets/bricklet_oled_64x48_display.png
     # 
-    # The LSB (D0) of each data byte is at the top and the MSB (D7) is at the 
+    # The LSB (D0) of each data byte is at the top and the MSB (D7) is at the
     # bottom of the row.
     # 
     # The next call of BrickletOLED64x48#write will write the second row and so on. To
@@ -92,7 +92,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_DISPLAY_CONFIGURATION, [], '', 2, 'C ?')
     end
 
-    # Writes text to a specific line (0 to 5) with a specific position 
+    # 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.
     # 
     # For example: (1, 4, "Hello") will write *Hello* in the middle of the
@@ -101,13 +101,13 @@ module Tinkerforge
     # You can draw to the display with BrickletOLED64x48#write and then add text to it
     # afterwards.
     # 
-    # The display uses a special 5x7 pixel charset. You can view the characters 
+    # The display uses a special 5x7 pixel charset. You can view the characters
     # of the charset in Brick Viewer.
     def write_line(line, position, text)
       send_request(FUNCTION_WRITE_LINE, [line, position, text], 'C C Z13', 0, '')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 

data/lib/tinkerforge/bricklet_piezo_buzzer.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.12                              #
 #                                                           #
 # 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  #
@@ -55,7 +55,7 @@ module Tinkerforge
     # for *dits*, *dahs* and *pauses*. Every other character is ignored.
     # 
     # For example: If you set the string "...---...", the piezo buzzer will beep
-    # nine times with the durations "short short short long long long short 
+    # nine times with the durations "short short short long long long short
     # short short".
     # 
     # The maximum string size is 60.
@@ -63,7 +63,7 @@ module Tinkerforge
       send_request(FUNCTION_MORSE_CODE, [morse], 'Z60', 0, '')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 

data/lib/tinkerforge/bricklet_piezo_speaker.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.12                              #
 #                                                           #
 # 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  #
@@ -48,7 +48,7 @@ module Tinkerforge
       @callback_formats[CALLBACK_MORSE_CODE_FINISHED] = ''
     end
 
-    # Beeps with the given frequency for the duration in ms. For example: 
+    # 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.
@@ -71,7 +71,7 @@ module Tinkerforge
     # 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 
+    # nine times with the durations "short short short long long long short
     # short short".
     # 
     # The maximum string size is 60.
@@ -92,7 +92,7 @@ module Tinkerforge
       send_request(FUNCTION_CALIBRATE, [], '', 1, '?')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 

data/lib/tinkerforge/bricklet_ptc.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.12                              #
 #                                                           #
 # 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  #
@@ -16,11 +16,11 @@ module Tinkerforge
     DEVICE_DISPLAY_NAME = 'PTC Bricklet' # :nodoc:
 
     # This callback is triggered periodically with the period that is set by
-    # BrickletPTC#set_temperature_callback_period. The parameter is the temperature
-    # of the connected sensor.
+    # BrickletPTC#set_temperature_callback_period. The parameter is the
+    # temperature of the connected sensor.
     # 
-    # CALLBACK_TEMPERATURE is only triggered if the temperature has changed since the
-    # last triggering.
+    # The CALLBACK_TEMPERATURE callback is only triggered if the temperature has changed
+    # since the last triggering.
     CALLBACK_TEMPERATURE = 13
 
     # This callback is triggered when the threshold as set by
@@ -35,8 +35,8 @@ module Tinkerforge
     # BrickletPTC#set_resistance_callback_period. The parameter is the resistance
     # of the connected sensor.
     # 
-    # CALLBACK_RESISTANCE is only triggered if the resistance has changed since the
-    # last triggering.
+    # The CALLBACK_RESISTANCE callback is only triggered if the resistance has changed
+    # since the last triggering.
     CALLBACK_RESISTANCE = 15
 
     # This callback is triggered when the threshold as set by
@@ -117,8 +117,8 @@ module Tinkerforge
     # has a range of -246 to 849 °C and is given in °C/100,
     # e.g. a value of 4223 means that a temperature of 42.23 °C is measured.
     # 
-    # If you want to get the temperature periodically, it is recommended 
-    # to use the callback CALLBACK_TEMPERATURE and set the period with 
+    # If you want to get the temperature periodically, it is recommended
+    # to use the CALLBACK_TEMPERATURE callback and set the period with
     # BrickletPTC#set_temperature_callback_period.
     def get_temperature
       send_request(FUNCTION_GET_TEMPERATURE, [], '', 4, 'l')
@@ -131,8 +131,8 @@ module Tinkerforge
     # * Pt100:  resistance = (value * 390) / 32768
     # * Pt1000: resistance = (value * 3900) / 32768
     # 
-    # If you want to get the resistance periodically, it is recommended 
-    # to use the callback CALLBACK_RESISTANCE and set the period with 
+    # If you want to get the resistance periodically, it is recommended
+    # to use the CALLBACK_RESISTANCE callback and set the period with
     # BrickletPTC#set_resistance_callback_period.
     def get_resistance
       send_request(FUNCTION_GET_RESISTANCE, [], '', 2, 'S')
@@ -141,8 +141,8 @@ module Tinkerforge
     # Sets the period in ms with which the CALLBACK_TEMPERATURE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
-    # CALLBACK_TEMPERATURE is only triggered if the temperature has changed since the
-    # last triggering.
+    # 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)
@@ -157,8 +157,8 @@ module Tinkerforge
     # Sets the period in ms with which the CALLBACK_RESISTANCE callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
-    # CALLBACK_RESISTANCE is only triggered if the resistance has changed since the
-    # last triggering.
+    # 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)
@@ -170,7 +170,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_RESISTANCE_CALLBACK_PERIOD, [], '', 4, 'L')
     end
 
-    # Sets the thresholds for the CALLBACK_TEMPERATURE_REACHED callback. 
+    # Sets the thresholds for the CALLBACK_TEMPERATURE_REACHED callback.
     # 
     # The following options are possible:
     # 
@@ -192,7 +192,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_TEMPERATURE_CALLBACK_THRESHOLD, [], '', 9, 'k l l')
     end
 
-    # Sets the thresholds for the CALLBACK_RESISTANCE_REACHED callback. 
+    # Sets the thresholds for the CALLBACK_RESISTANCE_REACHED callback.
     # 
     # The following options are possible:
     # 
@@ -246,13 +246,13 @@ module Tinkerforge
       send_request(FUNCTION_SET_NOISE_REJECTION_FILTER, [filter], 'C', 0, '')
     end
 
-    # Returns the noise rejection filter option as set by 
+    # Returns the noise rejection filter option as set by
     # BrickletPTC#set_noise_rejection_filter
     def get_noise_rejection_filter
       send_request(FUNCTION_GET_NOISE_REJECTION_FILTER, [], '', 1, 'C')
     end
 
-    # Returns *true* if the sensor is connected correctly. 
+    # Returns *true* if the sensor is connected correctly.
     # 
     # If this function
     # returns *false*, there is either no Pt100 or Pt1000 sensor connected,
@@ -275,7 +275,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_WIRE_MODE, [], '', 1, 'C')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     # 

data/lib/tinkerforge/bricklet_real_time_clock.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-01-25.      #
+# This file was automatically generated on 2017-04-21.      #
 #                                                           #
-# Ruby Bindings Version 2.1.11                              #
+# Ruby Bindings Version 2.1.12                              #
 #                                                           #
 # 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  #
@@ -19,8 +19,8 @@ module Tinkerforge
     # BrickletRealTimeClock#set_date_time_callback_period. The parameters are the same
     # as for BrickletRealTimeClock#get_date_time and BrickletRealTimeClock#get_timestamp combined.
     # 
-    # CALLBACK_DATE_TIME is only triggered if the date or time changed since the
-    # last triggering.
+    # The CALLBACK_DATE_TIME callback is only triggered if the date or time changed
+    # since the last triggering.
     # 
     # .. versionadded:: 2.0.1$nbsp;(Plugin)
     CALLBACK_DATE_TIME = 10
@@ -151,8 +151,8 @@ module Tinkerforge
     # Sets the period in ms with which the CALLBACK_DATE_TIME callback is triggered
     # periodically. A value of 0 turns the callback off.
     # 
-    # CALLBACK_DATE_TIME is only triggered if the date or time changed since the
-    # last triggering.
+    # The CALLBACK_DATE_TIME Callback is only triggered if the date or time changed
+    # since the last triggering.
     # 
     # The default value is 0.
     # 
@@ -205,7 +205,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_ALARM, [], '', 10, 'c c c c c c l')
     end
 
-    # Returns the UID, the UID where the Bricklet is connected to, 
+    # Returns the UID, the UID where the Bricklet is connected to,
     # the position, the hardware and firmware version as well as the
     # device identifier.
     #