tinkerforge 2.1.9 → 2.1.10

data/lib/tinkerforge/bricklet_joystick.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2016-06-30.      #
+# This file was automatically generated on 2016-09-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.9                               #
+# Ruby Bindings Version 2.1.10                              #
 #                                                           #
 # 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_laser_range_finder.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2016-06-30.      #
+# This file was automatically generated on 2016-09-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.9                               #
+# Ruby Bindings Version 2.1.10                              #
 #                                                           #
 # 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_lcd_16x2.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2016-06-30.      #
+# This file was automatically generated on 2016-09-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.9                               #
+# Ruby Bindings Version 2.1.10                              #
 #                                                           #
 # 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_lcd_20x4.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2016-06-30.      #
+# This file was automatically generated on 2016-09-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.9                               #
+# Ruby Bindings Version 2.1.10                              #
 #                                                           #
 # 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_led_strip.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2016-06-30.      #
+# This file was automatically generated on 2016-09-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.9                               #
+# Ruby Bindings Version 2.1.10                              #
 #                                                           #
 # 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  #
@@ -33,18 +33,57 @@ module Tinkerforge
     FUNCTION_GET_CLOCK_FREQUENCY = 8 # :nodoc:
     FUNCTION_SET_CHIP_TYPE = 9 # :nodoc:
     FUNCTION_GET_CHIP_TYPE = 10 # :nodoc:
+    FUNCTION_SET_RGBW_VALUES = 11 # :nodoc:
+    FUNCTION_GET_RGBW_VALUES = 12 # :nodoc:
+    FUNCTION_SET_CHANNEL_MAPPING = 13 # :nodoc:
+    FUNCTION_GET_CHANNEL_MAPPING = 14 # :nodoc:
+    FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK = 15 # :nodoc:
+    FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK = 16 # :nodoc:
+    FUNCTION_IS_FRAME_RENDERED_CALLBACK_ENABLED = 17 # :nodoc:
     FUNCTION_GET_IDENTITY = 255 # :nodoc:
 
     CHIP_TYPE_WS2801 = 2801 # :nodoc:
     CHIP_TYPE_WS2811 = 2811 # :nodoc:
     CHIP_TYPE_WS2812 = 2812 # :nodoc:
+    CHIP_TYPE_LPD8806 = 8806 # :nodoc:
+    CHIP_TYPE_APA102 = 102 # :nodoc:
+    CHANNEL_MAPPING_RGB = 6 # :nodoc:
+    CHANNEL_MAPPING_RBG = 9 # :nodoc:
+    CHANNEL_MAPPING_BRG = 33 # :nodoc:
+    CHANNEL_MAPPING_BGR = 36 # :nodoc:
+    CHANNEL_MAPPING_GRB = 18 # :nodoc:
+    CHANNEL_MAPPING_GBR = 24 # :nodoc:
+    CHANNEL_MAPPING_RGBW = 27 # :nodoc:
+    CHANNEL_MAPPING_RGWB = 30 # :nodoc:
+    CHANNEL_MAPPING_RBGW = 39 # :nodoc:
+    CHANNEL_MAPPING_RBWG = 45 # :nodoc:
+    CHANNEL_MAPPING_RWGB = 54 # :nodoc:
+    CHANNEL_MAPPING_RWBG = 57 # :nodoc:
+    CHANNEL_MAPPING_GRWB = 78 # :nodoc:
+    CHANNEL_MAPPING_GRBW = 75 # :nodoc:
+    CHANNEL_MAPPING_GBWR = 108 # :nodoc:
+    CHANNEL_MAPPING_GBRW = 99 # :nodoc:
+    CHANNEL_MAPPING_GWBR = 120 # :nodoc:
+    CHANNEL_MAPPING_GWRB = 114 # :nodoc:
+    CHANNEL_MAPPING_BRGW = 135 # :nodoc:
+    CHANNEL_MAPPING_BRWG = 141 # :nodoc:
+    CHANNEL_MAPPING_BGRW = 147 # :nodoc:
+    CHANNEL_MAPPING_BGWR = 156 # :nodoc:
+    CHANNEL_MAPPING_BWRG = 177 # :nodoc:
+    CHANNEL_MAPPING_BWGR = 180 # :nodoc:
+    CHANNEL_MAPPING_WRBG = 201 # :nodoc:
+    CHANNEL_MAPPING_WRGB = 198 # :nodoc:
+    CHANNEL_MAPPING_WGBR = 216 # :nodoc:
+    CHANNEL_MAPPING_WGRB = 210 # :nodoc:
+    CHANNEL_MAPPING_WBGR = 228 # :nodoc:
+    CHANNEL_MAPPING_WBRG = 225 # :nodoc:
 
     # 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
 
-      @api_version = [2, 0, 2]
+      @api_version = [2, 0, 3]
 
       @response_expected[FUNCTION_SET_RGB_VALUES] = RESPONSE_EXPECTED_FALSE
       @response_expected[FUNCTION_GET_RGB_VALUES] = RESPONSE_EXPECTED_ALWAYS_TRUE
@@ -56,14 +95,25 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_CLOCK_FREQUENCY] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_SET_CHIP_TYPE] = RESPONSE_EXPECTED_FALSE
       @response_expected[FUNCTION_GET_CHIP_TYPE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_RGBW_VALUES] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_RGBW_VALUES] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_CHANNEL_MAPPING] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_CHANNEL_MAPPING] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK] = RESPONSE_EXPECTED_TRUE
+      @response_expected[FUNCTION_IS_FRAME_RENDERED_CALLBACK_ENABLED] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
 
       @callback_formats[CALLBACK_FRAME_RENDERED] = 'S'
     end
 
-    # Sets the *rgb* values for the LEDs with the given *length* starting 
+    # Sets the RGB values for the LEDs with the given *length* starting
     # from *index*.
     # 
+    # To make the colors show correctly you need to configure the chip type
+    # (BrickletLEDStrip#set_chip_type) and a 3-channel channel mapping (BrickletLEDStrip#set_channel_mapping)
+    # according to the connected LEDs.
+    # 
     # The maximum length is 16, the index goes from 0 to 319 and the rgb values
     # have 8 bits each.
     # 
@@ -82,10 +132,10 @@ module Tinkerforge
     # The colors will be transfered to actual LEDs when the next
     # frame duration ends, see BrickletLEDStrip#set_frame_duration.
     # 
-    # Generic approach: 
+    # Generic approach:
     # 
     # * Set the frame duration to a value that represents
-    #   the number of frames per second you want to achieve. 
+    #   the number of frames per second you want to achieve.
     # * Set all of the LED colors for one frame.
     # * Wait for the CALLBACK_FRAME_RENDERED callback.
     # * Set all of the LED colors for next frame.
@@ -103,7 +153,7 @@ module Tinkerforge
       send_request(FUNCTION_SET_RGB_VALUES, [index, length, r, g, b], 'S C C16 C16 C16', 0, '')
     end
 
-    # Returns *rgb* values with the given *length* starting from the
+    # Returns RGB value with the given *length* starting from the
     # given *index*.
     # 
     # The values are the last values that were set by BrickletLEDStrip#set_rgb_values.
@@ -114,7 +164,7 @@ module Tinkerforge
     # Sets the frame duration in ms.
     # 
     # Example: If you want to achieve 20 frames per second, you should
-    # set the frame duration to 50ms (50ms * 20 = 1 second). 
+    # set the frame duration to 50ms (50ms * 20 = 1 second).
     # 
     # For an explanation of the general approach see BrickletLEDStrip#set_rgb_values.
     # 
@@ -164,17 +214,16 @@ module Tinkerforge
       send_request(FUNCTION_GET_CLOCK_FREQUENCY, [], '', 4, 'L')
     end
 
-    # Sets the type of the led driver chip. We currently support
-    # the chips
-    # 
-    # * WS2801 (``chip`` = 2801),
-    # * WS2811 (``chip`` = 2811) and
-    # * WS2812 (``chip`` = 2812).
+    # Sets the type of the LED driver chip. We currently support the chips
     # 
-    # The WS2812 is sometimes also called "NeoPixel", a name coined by
-    # Adafruit.
+    # * WS2801,
+    # * WS2811,
+    # * WS2812 / SK6812 / NeoPixel RGB,
+    # * SK6812RGBW / NeoPixel RGBW (Chip Type = WS2812),
+    # * LPD8806 and
+    # * APA102 / DotStar.
     # 
-    # The default value is WS2801 (``chip`` = 2801).
+    # The default value is WS2801 (2801).
     # 
     # .. versionadded:: 2.0.2$nbsp;(Plugin)
     def set_chip_type(chip)
@@ -188,6 +237,134 @@ module Tinkerforge
       send_request(FUNCTION_GET_CHIP_TYPE, [], '', 2, 'S')
     end
 
+    # Sets the RGBW values for the LEDs with the given *length* starting
+    # from *index*.
+    # 
+    # To make the colors show correctly you need to configure the chip type
+    # (BrickletLEDStrip#set_chip_type) and a 4-channel channel mapping (BrickletLEDStrip#set_channel_mapping)
+    # according to the connected LEDs.
+    # 
+    # The maximum length is 12, the index goes from 0 to 239 and the rgbw values
+    # have 8 bits each.
+    # 
+    # Example: If you set
+    # 
+    # * index to 5,
+    # * length to 4,
+    # * r to [255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
+    # * g to [0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
+    # * b to [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0] and
+    # * w to [0, 0, 255, 0, 0, 0, 0, 0, 0, 0, 0, 0]
+    # 
+    # the LED with index 5 will be red, 6 will be green, 7 will be blue and 8 will be white.
+    # 
+    # .. note:: Depending on the LED circuitry colors can be permuted.
+    # 
+    # The colors will be transfered to actual LEDs when the next
+    # frame duration ends, see BrickletLEDStrip#set_frame_duration.
+    # 
+    # Generic approach:
+    # 
+    # * Set the frame duration to a value that represents
+    #   the number of frames per second you want to achieve.
+    # * Set all of the LED colors for one frame.
+    # * Wait for the CALLBACK_FRAME_RENDERED callback.
+    # * Set all of the LED colors for next frame.
+    # * Wait for the CALLBACK_FRAME_RENDERED callback.
+    # * and so on.
+    # 
+    # This approach ensures that you can change the LED colors with
+    # a fixed frame rate.
+    # 
+    # The actual number of controllable LEDs depends on the number of free
+    # Bricklet ports. See :ref:`here <led_strip_bricklet_ram_constraints>` for more
+    # information. A call of BrickletLEDStrip#set_rgbw_values with index + length above the
+    # bounds is ignored completely.
+    # 
+    # The LPD8806 LED driver chips have 7-bit channels for RGB. Internally the LED
+    # Strip Bricklets divides the 8-bit values set using this function by 2 to make
+    # them 7-bit. Therefore, you can just use the normal value range (0-255) for
+    # LPD8806 LEDs.
+    # 
+    # The brightness channel of the APA102 LED driver chips has 5-bit. Internally the
+    # LED Strip Bricklets divides the 8-bit values set using this function by 8 to make
+    # them 5-bit. Therefore, you can just use the normal value range (0-255) for
+    # the brightness channel of APA102 LEDs.
+    # 
+    # .. versionadded:: 2.0.6$nbsp;(Plugin)
+    def set_rgbw_values(index, length, r, g, b, w)
+      send_request(FUNCTION_SET_RGBW_VALUES, [index, length, r, g, b, w], 'S C C12 C12 C12 C12', 0, '')
+    end
+
+    # Returns RGBW values with the given *length* starting from the
+    # given *index*.
+    # 
+    # The values are the last values that were set by BrickletLEDStrip#set_rgbw_values.
+    # 
+    # .. versionadded:: 2.0.6$nbsp;(Plugin)
+    def get_rgbw_values(index, length)
+      send_request(FUNCTION_GET_RGBW_VALUES, [index, length], 'S C', 48, 'C12 C12 C12 C12')
+    end
+
+    # Sets the channel mapping for the connected LEDs.
+    # 
+    # BrickletLEDStrip#set_rgb_values and BrickletLEDStrip#set_rgbw_values take the data in RGB(W) order.
+    # But the connected LED driver chips might have their 3 or 4 channels in a
+    # different order. For example, the WS2801 chips typically use BGR order, the
+    # WS2812 chips typically use GRB order and the APA102 chips typically use WBGR
+    # order.
+    # 
+    # The APA102 chips are special. They have three 8-bit channels for RGB
+    # and an additional 5-bit channel for the overall brightness of the RGB LED
+    # making them 4-channel chips. Internally the brightness channel is the first
+    # channel, therefore one of the Wxyz channel mappings should be used. Then
+    # the W channel controls the brightness.
+    # 
+    # If a 3-channel mapping is selected then BrickletLEDStrip#set_rgb_values has to be used.
+    # Calling BrickletLEDStrip#set_rgbw_values with a 3-channel mapping will produce incorrect
+    # results. Vice-versa if a 4-channel mapping is selected then
+    # BrickletLEDStrip#set_rgbw_values has to be used. Calling BrickletLEDStrip#set_rgb_values with a
+    # 4-channel mapping will produce incorrect results.
+    # 
+    # The default value is BGR (36).
+    # 
+    # .. versionadded:: 2.0.6$nbsp;(Plugin)
+    def set_channel_mapping(mapping)
+      send_request(FUNCTION_SET_CHANNEL_MAPPING, [mapping], 'C', 0, '')
+    end
+
+    # Returns the currently used channel mapping as set by BrickletLEDStrip#set_channel_mapping.
+    # 
+    # .. versionadded:: 2.0.6$nbsp;(Plugin)
+    def get_channel_mapping
+      send_request(FUNCTION_GET_CHANNEL_MAPPING, [], '', 1, 'C')
+    end
+
+    # Enables the CALLBACK_FRAME_RENDERED callback.
+    # 
+    # By default the callback is enabled.
+    # 
+    # .. versionadded:: 2.0.6$nbsp;(Plugin)
+    def enable_frame_rendered_callback
+      send_request(FUNCTION_ENABLE_FRAME_RENDERED_CALLBACK, [], '', 0, '')
+    end
+
+    # Disables the CALLBACK_FRAME_RENDERED callback.
+    # 
+    # By default the callback is enabled.
+    # 
+    # .. versionadded:: 2.0.6$nbsp;(Plugin)
+    def disable_frame_rendered_callback
+      send_request(FUNCTION_DISABLE_FRAME_RENDERED_CALLBACK, [], '', 0, '')
+    end
+
+    # Returns *true* if the CALLBACK_FRAME_RENDERED callback is enabled, *false* otherwise.
+    # 
+    # .. versionadded:: 2.0.6$nbsp;(Plugin)
+    def is_frame_rendered_callback_enabled
+      send_request(FUNCTION_IS_FRAME_RENDERED_CALLBACK_ENABLED, [], '', 1, '?')
+    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.

data/lib/tinkerforge/bricklet_line.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2016-06-30.      #
+# This file was automatically generated on 2016-09-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.9                               #
+# Ruby Bindings Version 2.1.10                              #
 #                                                           #
 # 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_linear_poti.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2016-06-30.      #
+# This file was automatically generated on 2016-09-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.9                               #
+# Ruby Bindings Version 2.1.10                              #
 #                                                           #
 # 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_load_cell.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2016-06-30.      #
+# This file was automatically generated on 2016-09-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.9                               #
+# Ruby Bindings Version 2.1.10                              #
 #                                                           #
 # 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_moisture.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2016-06-30.      #
+# This file was automatically generated on 2016-09-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.9                               #
+# Ruby Bindings Version 2.1.10                              #
 #                                                           #
 # 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_motion_detector.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2016-06-30.      #
+# This file was automatically generated on 2016-09-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.9                               #
+# Ruby Bindings Version 2.1.10                              #
 #                                                           #
 # 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_multi_touch.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2016-06-30.      #
+# This file was automatically generated on 2016-09-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.9                               #
+# Ruby Bindings Version 2.1.10                              #
 #                                                           #
 # 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_nfc_rfid.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2016-06-30.      #
+# This file was automatically generated on 2016-09-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.9                               #
+# Ruby Bindings Version 2.1.10                              #
 #                                                           #
 # 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_oled_128x64.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2016-06-30.      #
+# This file was automatically generated on 2016-09-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.9                               #
+# Ruby Bindings Version 2.1.10                              #
 #                                                           #
 # 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_oled_64x48.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2016-06-30.      #
+# This file was automatically generated on 2016-09-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.9                               #
+# Ruby Bindings Version 2.1.10                              #
 #                                                           #
 # 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_piezo_buzzer.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2016-06-30.      #
+# This file was automatically generated on 2016-09-08.      #
 #                                                           #
-# Ruby Bindings Version 2.1.9                               #
+# Ruby Bindings Version 2.1.10                              #
 #                                                           #
 # 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  #