tinkerforge 2.0.8 → 2.0.9

data/lib/tinkerforge/brick_dc.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-07-04.      #
+# This file was automatically generated on 2013-08-23.      #
 #                                                           #
-# Bindings Version 2.0.8                                    #
+# Bindings Version 2.0.9                                    #
 #                                                           #
 # 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  #
@@ -304,9 +304,11 @@ module Tinkerforge
       send_request(FUNCTION_GET_CURRENT_VELOCITY_PERIOD, [], '', 2, 'S')
     end
 
-    # Returns the firmware and protocol version and the name of the Bricklet for a given port.
+    # Returns the firmware and protocol version and the name of the Bricklet for a
+    # given port.
     # 
-    # This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet plugins.
+    # This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet
+    # plugins.
     # 
     # .. versionadded:: 2.0.0~(Firmware)
     def get_protocol1_bricklet_name(port)

data/lib/tinkerforge/brick_imu.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-07-04.      #
+# This file was automatically generated on 2013-08-23.      #
 #                                                           #
-# Bindings Version 2.0.8                                    #
+# Bindings Version 2.0.9                                    #
 #                                                           #
 # 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  #
@@ -317,14 +317,14 @@ module Tinkerforge
 
     # There are several different types that can be calibrated:
     # 
-    #  "Type", "Description",        "Values"
+    #  "Type", "Description", "Values"
     # 
-    #  "0",    "Accelerometer Gain", "[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]"
-    #  "1",    "Accelerometer Bias", "[bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0]"
-    #  "2",    "Magnetometer Gain",  "[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]"
-    #  "3",    "Magnetometer Bias",  "[bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0]"
-    #  "4",    "Gyroskop Gain",     "[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]"
-    #  "5",    "Gyroskop Bias",     "[bias xl, bias yl, bias zl, temp l, bias xh, bias yh, bias zh, temp h, 0, 0]"
+    #  "0",    "Accelerometer Gain", "``[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]``"
+    #  "1",    "Accelerometer Bias", "``[bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0]``"
+    #  "2",    "Magnetometer Gain",  "``[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]``"
+    #  "3",    "Magnetometer Bias",  "``[bias x, bias y, bias z, 0, 0, 0, 0, 0, 0, 0]``"
+    #  "4",    "Gyroscope Gain",     "``[mul x, mul y, mul z, div x, div y, div z, 0, 0, 0, 0]``"
+    #  "5",    "Gyroscope Bias",     "``[bias xl, bias yl, bias zl, temp l, bias xh, bias yh, bias zh, temp h, 0, 0]``"
     # 
     # The calibration via gain and bias is done with the following formula::
     # 
@@ -336,12 +336,13 @@ module Tinkerforge
     # to obtain a usable result in the end.
     # 
     # The gyroscope bias is highly dependent on the temperature, so you have to
-    # calibrate the bias two times with different temperatures. The values xl, yl, zl 
-    # and temp l are the bias for x, y, z and the corresponding temperature for a 
-    # low temperature. The values xh, yh, zh and temp h are the same for a high 
-    # temperatures. The temperature difference should be at least 5°C. If you have 
-    # a temperature where the IMU Brick is mostly used, you should use this 
-    # temperature for one of the sampling points.
+    # calibrate the bias two times with different temperatures. The values ``xl``,
+    # ``yl``, ``zl `` and ``temp l`` are the bias for ``x``, ``y``, ``z`` and the
+    # corresponding temperature for a low temperature. The values ``xh``, ``yh``,
+    # ``zh`` and ``temp h`` are the same for a high temperatures. The temperature
+    # difference should be at least 5°C. If you have a temperature where the
+    # IMU Brick is mostly used, you should use this temperature for one of the
+    # sampling points.
     # 
     # .. note::
     #  We highly recommend that you use the Brick Viewer to calibrate your
@@ -457,9 +458,11 @@ module Tinkerforge
       send_request(FUNCTION_IS_ORIENTATION_CALCULATION_ON, [], '', 1, '?')
     end
 
-    # Returns the firmware and protocol version and the name of the Bricklet for a given port.
+    # Returns the firmware and protocol version and the name of the Bricklet for a
+    # given port.
     # 
-    # This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet plugins.
+    # This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet
+    # plugins.
     # 
     # .. versionadded:: 2.0.0~(Firmware)
     def get_protocol1_bricklet_name(port)

data/lib/tinkerforge/brick_master.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-07-04.      #
+# This file was automatically generated on 2013-08-23.      #
 #                                                           #
-# Bindings Version 2.0.8                                    #
+# Bindings Version 2.0.9                                    #
 #                                                           #
 # 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  #
@@ -310,20 +310,16 @@ module Tinkerforge
     # 
     # The extension type is already set when bought and it can be set with the 
     # Brick Viewer, it is unlikely that you need this function.
-    # 
-    # The value will be saved in the EEPROM of the Chibi Extension, it does not
-    # have to be set on every startup.
     def set_extension_type(extension, exttype)
       send_request(FUNCTION_SET_EXTENSION_TYPE, [extension, exttype], 'C L', 0, '')
     end
 
-    # Returns the extension type for a given extension as set by 
-    # BrickMaster#set_extension_type.
+    # Returns the type for a given extension as set by BrickMaster#set_extension_type.
     def get_extension_type(extension)
       send_request(FUNCTION_GET_EXTENSION_TYPE, [extension], 'C', 4, 'L')
     end
 
-    # Returns *true* if a Chibi Extension is available to be used by the Master.
+    # Returns *true* if a Chibi Extension is available to be used by the Master Brick.
     # 
     # .. versionadded:: 1.1.0~(Firmware)
     def is_chibi_present
@@ -369,13 +365,13 @@ module Tinkerforge
 
     # Sets up to 254 slave addresses. Valid addresses are in range 1-255. 0 has a
     # special meaning, it is used as list terminator and not allowed as normal slave
-    # address. The address numeration (via num parameter) has to be used
+    # address. The address numeration (via ``num`` parameter) has to be used
     # ascending from 0. For example: If you use the Chibi Extension in Master mode
     # (i.e. the stack has an USB connection) and you want to talk to three other
     # Chibi stacks with the slave addresses 17, 23, and 42, you should call with
-    # "(0, 17), (1, 23), (2, 42) and (3, 0)". The last call with "(3, 0)" is a list
-    # terminator and indicates that the Chibi slave address list contains 3 addresses
-    # in this case.
+    # ``(0, 17)``, ``(1, 23)``, ``(2, 42)`` and ``(3, 0)``. The last call with
+    # ``(3, 0)`` is a list terminator and indicates that the Chibi slave address
+    # list contains 3 addresses in this case.
     # 
     # It is possible to set the addresses with the Brick Viewer, that will take care
     # of correct address numeration and list termination.
@@ -388,7 +384,7 @@ module Tinkerforge
       send_request(FUNCTION_SET_CHIBI_SLAVE_ADDRESS, [num, address], 'C C', 0, '')
     end
 
-    # Returns the slave address for a given num as set by 
+    # Returns the slave address for a given ``num`` as set by
     # BrickMaster#set_chibi_slave_address.
     # 
     # .. versionadded:: 1.1.0~(Firmware)
@@ -465,7 +461,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_CHIBI_CHANNEL, [], '', 1, 'C')
     end
 
-    # Returns *true* if a RS485 Extension is available to be used by the Master.
+    # Returns *true* if a RS485 Extension is available to be used by the Master Brick.
     # 
     # .. versionadded:: 1.2.0~(Firmware)
     def is_rs485_present
@@ -495,13 +491,13 @@ module Tinkerforge
 
     # Sets up to 255 slave addresses. Valid addresses are in range 1-255. 0 has a
     # special meaning, it is used as list terminator and not allowed as normal slave
-    # address. The address numeration (via num parameter) has to be used
+    # address. The address numeration (via ``num`` parameter) has to be used
     # ascending from 0. For example: If you use the RS485 Extension in Master mode
     # (i.e. the stack has an USB connection) and you want to talk to three other
-    # RS485 stacks with the addresses 17, 23, and 42, you should call with "(0, 17),
-    # (1, 23), (2, 42) and (3, 0)". The last call with "(3, 0)" is a list terminator
-    # and indicates that the RS485 slave address list contains 3 addresses in this
-    # case.
+    # RS485 stacks with the addresses 17, 23, and 42, you should call with
+    # ``(0, 17)``, ``(1, 23)``, ``(2, 42)`` and ``(3, 0)``. The last call with
+    # ``(3, 0)`` is a list terminator and indicates that the RS485 slave address list
+    # contains 3 addresses in this case.
     # 
     # It is possible to set the addresses with the Brick Viewer, that will take care
     # of correct address numeration and list termination.
@@ -514,7 +510,7 @@ module Tinkerforge
       send_request(FUNCTION_SET_RS485_SLAVE_ADDRESS, [num, address], 'C C', 0, '')
     end
 
-    # Returns the slave address for a given num as set by 
+    # Returns the slave address for a given ``num`` as set by
     # BrickMaster#set_rs485_slave_address.
     # 
     # .. versionadded:: 1.2.0~(Firmware)
@@ -557,15 +553,15 @@ module Tinkerforge
       send_request(FUNCTION_GET_RS485_CONFIGURATION, [], '', 6, 'L k C')
     end
 
-    # Returns *true* if a WIFI Extension is available to be used by the Master.
+    # Returns *true* if a WIFI Extension is available to be used by the Master Brick.
     # 
     # .. versionadded:: 1.2.0~(Firmware)
     def is_wifi_present
       send_request(FUNCTION_IS_WIFI_PRESENT, [], '', 1, '?')
     end
 
-    # Sets the configuration of the WIFI Extension. The *ssid* can have a max length
-    # of 32 characters. Possible values for *connection* are:
+    # Sets the configuration of the WIFI Extension. The ``ssid`` can have a max length
+    # of 32 characters. Possible values for ``connection`` are:
     # 
     #  "Value", "Description"
     # 
@@ -576,11 +572,11 @@ module Tinkerforge
     #  "4", "Ad Hoc: DHCP"
     #  "5", "Ad Hoc: Static IP"
     # 
-    # If you set *connection* to one of the static IP options then you have to supply
-    # *ip*, *subnet_mask* and *gateway* as an array of size 4 (first element of the
-    # array is the least significant byte of the address). If *connection* is set to
-    # one of the DHCP options then *ip*, *subnet_mask* and *gateway* are ignored, you
-    # can set them to 0.
+    # If you set ``connection`` to one of the static IP options then you have to
+    # supply ``ip``, ``subnet_mask`` and ``gateway`` as an array of size 4 (first
+    # element of the array is the least significant byte of the address). If
+    # ``connection`` is set to one of the DHCP options then ``ip``, ``subnet_mask``
+    # and ``gateway`` are ignored, you can set them to 0.
     # 
     # The last parameter is the port that your program will connect to. The
     # default port, that is used by brickd, is 4223.
@@ -612,30 +608,30 @@ module Tinkerforge
     #  "2", "WEP"
     #  "3", "No Encryption"
     # 
-    # The key has a max length of 50 characters and is used if encryption
+    # The ``key`` has a max length of 50 characters and is used if ``encryption``
     # is set to 0 or 2 (WPA/WPA2 or WEP). Otherwise the value is ignored.
     # 
     # For WPA/WPA2 the key has to be at least 8 characters long. If you want to set
     # a key with more than 50 characters, see BrickMaster#set_long_wifi_key.
     # 
     # For WEP the key has to be either 10 or 26 hexadecimal digits long. It is
-    # possible to set the WEP key index (1-4). If you don't know your key index,
-    # it is likely 1.
+    # possible to set the WEP ``key_index`` (1-4). If you don't know your
+    # ``key_index``, it is likely 1.
     # 
-    # If you choose WPA Enterprise as encryption, you have to set eap options and
+    # If you choose WPA Enterprise as encryption, you have to set ``eap_options`` and
     # the length of the certificates (for other encryption types these parameters
     # are ignored). The certificate length are given in byte and the certificates
-    # themselves can be set with BrickMaster#set_wifi_certificate. Eap options consist of
-    # the outer authentication (bits 1-2), inner authentication (bit 3) and 
+    # themselves can be set with BrickMaster#set_wifi_certificate. ``eap_options`` consist
+    # of the outer authentication (bits 1-2), inner authentication (bit 3) and
     # certificate type (bits 4-5):
     # 
     #  "Option", "Bits", "Description"
     # 
-    #  "outer auth", "1-2", "0=EAP-FAST, 1=EAP-TLS, 2=EAP-TTLS, 3=EAP-PEAP"
-    #  "inner auth", "3", "0=EAP-MSCHAP, 1=EAP-GTC"
-    #  "cert type", "4-5", "0=CA Certificate, 1=Client Certificate, 2=Private Key"
+    #  "outer authentication", "1-2", "0=EAP-FAST, 1=EAP-TLS, 2=EAP-TTLS, 3=EAP-PEAP"
+    #  "inner authentication", "3", "0=EAP-MSCHAP, 1=EAP-GTC"
+    #  "certificate type", "4-5", "0=CA Certificate, 1=Client Certificate, 2=Private Key"
     # 
-    # Example for EAP-TTLS + EAP-GTC + Private Key: option = 2 | (1 << 2) | (2 << 3).
+    # Example for EAP-TTLS + EAP-GTC + Private Key: ``option = 2 | (1 << 2) | (2 << 3)``.
     # 
     # The values are stored in the EEPROM and only applied on startup. That means
     # you have to restart the Master Brick after configuration.
@@ -654,7 +650,7 @@ module Tinkerforge
       send_request(FUNCTION_GET_WIFI_ENCRYPTION, [], '', 59, 'C Z50 C C S S S')
     end
 
-    # Returns the status of the WIFI Extension. The state is updated automatically,
+    # Returns the status of the WIFI Extension. The ``state`` is updated automatically,
     # all of the other parameters are updated on startup and every time
     # BrickMaster#refresh_wifi_status is called.
     # 
@@ -677,7 +673,7 @@ module Tinkerforge
     # of the WIFI module, the Master Brick has to change from data mode to
     # command mode and back. This transaction and the readout itself is
     # unfortunately time consuming. This means, that it might take some ms
-    # until the stack with attached WIFI Extensions reacts again after this
+    # until the stack with attached WIFI Extension reacts again after this
     # function is called.
     # 
     # .. versionadded:: 1.3.0~(Firmware)
@@ -691,7 +687,7 @@ module Tinkerforge
     # password is 32.
     # 
     # The certificate is written in chunks of size 32 and the index is used as
-    # the index of the chunk. The data length should nearly always be 32. Only
+    # the index of the chunk. ``data_length`` should nearly always be 32. Only
     # the last chunk can have a length that is not equal to 32.
     # 
     # The starting index of the CA Certificate is 0, of the Client Certificate
@@ -965,11 +961,15 @@ module Tinkerforge
 
     # Sets the period in ms with which the threshold callbacks
     # 
-    #  CALLBACK_STACK_CURRENT_REACHED, CALLBACK_STACK_VOLTAGE_REACHED, CALLBACK_USB_VOLTAGE_REACHED
+    # * CALLBACK_STACK_CURRENT_REACHED,
+    # * CALLBACK_STACK_VOLTAGE_REACHED,
+    # * CALLBACK_USB_VOLTAGE_REACHED
     # 
     # are triggered, if the thresholds
     # 
-    #  BrickMaster#set_stack_current_callback_threshold, BrickMaster#set_stack_voltage_callback_threshold, BrickMaster#set_usb_voltage_callback_threshold
+    # * BrickMaster#set_stack_current_callback_threshold,
+    # * BrickMaster#set_stack_voltage_callback_threshold,
+    # * BrickMaster#set_usb_voltage_callback_threshold
     # 
     # keep being reached.
     # 
@@ -987,25 +987,27 @@ module Tinkerforge
       send_request(FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 4, 'L')
     end
 
-    # Returns *true* if a Ethernet Extension is available to be used by the Master.
+    # Returns *true* if a Ethernet Extension is available to be used by the Master
+    # Brick.
     # 
     # .. versionadded:: 2.1.0~(Firmware)
     def is_ethernet_present
       send_request(FUNCTION_IS_ETHERNET_PRESENT, [], '', 1, '?')
     end
 
-    # Sets the configuration of the WIFI Extension. Possible values for *connection* are:
+    # Sets the configuration of the Ethernet Extension. Possible values for
+    # ``connection`` are:
     # 
     #  "Value", "Description"
     # 
     #  "0", "DHCP"
     #  "1", "Static IP"
     # 
-    # If you set *connection* to static IP options then you have to supply
-    # *ip*, *subnet_mask* and *gateway* as an array of size 4 (first element of the
-    # array is the least significant byte of the address). If *connection* is set to
-    # the DHCP options then *ip*, *subnet_mask* and *gateway* are ignored, you
-    # can set them to 0.
+    # If you set ``connection`` to static IP options then you have to supply ``ip``,
+    # ``subnet_mask`` and ``gateway`` as an array of size 4 (first element of the
+    # array is the least significant byte of the address). If ``connection`` is set
+    # to the DHCP options then ``ip``, ``subnet_mask`` and ``gateway`` are ignored,
+    # you can set them to 0.
     # 
     # The last parameter is the port that your program will connect to. The
     # default port, that is used by brickd, is 4223.
@@ -1027,15 +1029,15 @@ module Tinkerforge
       send_request(FUNCTION_GET_ETHERNET_CONFIGURATION, [], '', 15, 'C C4 C4 C4 S')
     end
 
-    # Returns the status of the Ethernet Extension. 
+    # Returns the status of the Ethernet Extension.
     # 
-    # *mac_address*, *ip*, *subnet_mask* and *gateway* are given as an array
-    # (first element of the array is the least significant byte of the address). 
+    # ``mac_address``, ``ip``, ``subnet_mask`` and ``gateway`` are given as an array.
+    # The first element of the array is the least significant byte of the address.
     # 
-    # *rx_count* and *tx_count* are the number of bytes that have been received/send
-    # since last restart
+    # ``rx_count`` and ``tx_count`` are the number of bytes that have been
+    # received/send since last restart.
     # 
-    # *hostname* is the currently used hostname.
+    # ``hostname`` is the currently used hostname.
     # 
     # .. versionadded:: 2.1.0~(Firmware)
     def get_ethernet_status
@@ -1065,9 +1067,11 @@ module Tinkerforge
       send_request(FUNCTION_SET_ETHERNET_MAC_ADDRESS, [mac_address], 'C6', 0, '')
     end
 
-    # Returns the firmware and protocol version and the name of the Bricklet for a given port.
+    # Returns the firmware and protocol version and the name of the Bricklet for a
+    # given port.
     # 
-    # This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet plugins.
+    # This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet
+    # plugins.
     # 
     # .. versionadded:: 2.0.0~(Firmware)
     def get_protocol1_bricklet_name(port)

data/lib/tinkerforge/brick_servo.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-07-04.      #
+# This file was automatically generated on 2013-08-23.      #
 #                                                           #
-# Bindings Version 2.0.8                                    #
+# Bindings Version 2.0.9                                    #
 #                                                           #
 # 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  #
@@ -420,9 +420,11 @@ module Tinkerforge
       send_request(FUNCTION_IS_VELOCITY_REACHED_CALLBACK_ENABLED, [], '', 1, 'C')
     end
 
-    # Returns the firmware and protocol version and the name of the Bricklet for a given port.
+    # Returns the firmware and protocol version and the name of the Bricklet for a
+    # given port.
     # 
-    # This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet plugins.
+    # This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet
+    # plugins.
     # 
     # .. versionadded:: 2.0.0~(Firmware)
     def get_protocol1_bricklet_name(port)

data/lib/tinkerforge/brick_stepper.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-07-04.      #
+# This file was automatically generated on 2013-08-23.      #
 #                                                           #
-# Bindings Version 2.0.8                                    #
+# Bindings Version 2.0.9                                    #
 #                                                           #
 # 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  #
@@ -501,9 +501,11 @@ module Tinkerforge
       send_request(FUNCTION_GET_ALL_DATA_PERIOD, [], '', 4, 'L')
     end
 
-    # Returns the firmware and protocol version and the name of the Bricklet for a given port.
+    # Returns the firmware and protocol version and the name of the Bricklet for a
+    # given port.
     # 
-    # This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet plugins.
+    # This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet
+    # plugins.
     # 
     # .. versionadded:: 2.0.0~(Firmware)
     def get_protocol1_bricklet_name(port)

data/lib/tinkerforge/bricklet_ambient_light.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2013-07-04.      #
+# This file was automatically generated on 2013-08-23.      #
 #                                                           #
-# Bindings Version 2.0.8                                    #
+# Bindings Version 2.0.9                                    #
 #                                                           #
 # 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  #
@@ -206,11 +206,13 @@ module Tinkerforge
 
     # Sets the period in ms with which the threshold callbacks
     # 
-    #  CALLBACK_ILLUMINANCE_REACHED, CALLBACK_ANALOG_VALUE_REACHED
+    # * CALLBACK_ILLUMINANCE_REACHED,
+    # * CALLBACK_ANALOG_VALUE_REACHED
     # 
     # are triggered, if the thresholds
     # 
-    #  BrickletAmbientLight#set_illuminance_callback_threshold, BrickletAmbientLight#set_analog_value_callback_threshold
+    # * BrickletAmbientLight#set_illuminance_callback_threshold,
+    # * BrickletAmbientLight#set_analog_value_callback_threshold
     # 
     # keep being reached.
     #