tinkerforge 2.1.13 → 2.1.14

data/lib/tinkerforge/brick_imu.rb

@@ -1,8 +1,8 @@
 # -*- ruby encoding: utf-8 -*-
 #############################################################
-# This file was automatically generated on 2017-05-11.      #
+# This file was automatically generated on 2017-07-27.      #
 #                                                           #
-# Ruby Bindings Version 2.1.13                              #
+# Ruby Bindings Version 2.1.14                              #
 #                                                           #
 # 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  #
@@ -81,7 +81,12 @@ module Tinkerforge
     FUNCTION_ORIENTATION_CALCULATION_ON = 37 # :nodoc:
     FUNCTION_ORIENTATION_CALCULATION_OFF = 38 # :nodoc:
     FUNCTION_IS_ORIENTATION_CALCULATION_ON = 39 # :nodoc:
+    FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231 # :nodoc:
+    FUNCTION_GET_SPITFP_BAUDRATE_CONFIG = 232 # :nodoc:
     FUNCTION_GET_SEND_TIMEOUT_COUNT = 233 # :nodoc:
+    FUNCTION_SET_SPITFP_BAUDRATE = 234 # :nodoc:
+    FUNCTION_GET_SPITFP_BAUDRATE = 235 # :nodoc:
+    FUNCTION_GET_SPITFP_ERROR_COUNT = 237 # :nodoc:
     FUNCTION_ENABLE_STATUS_LED = 238 # :nodoc:
     FUNCTION_DISABLE_STATUS_LED = 239 # :nodoc:
     FUNCTION_IS_STATUS_LED_ENABLED = 240 # :nodoc:
@@ -142,16 +147,15 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_ORIENTATION_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_SET_QUATERNION_PERIOD] = RESPONSE_EXPECTED_TRUE
       @response_expected[FUNCTION_GET_QUATERNION_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
-      @response_expected[CALLBACK_ACCELERATION] = RESPONSE_EXPECTED_ALWAYS_FALSE
-      @response_expected[CALLBACK_MAGNETIC_FIELD] = RESPONSE_EXPECTED_ALWAYS_FALSE
-      @response_expected[CALLBACK_ANGULAR_VELOCITY] = RESPONSE_EXPECTED_ALWAYS_FALSE
-      @response_expected[CALLBACK_ALL_DATA] = RESPONSE_EXPECTED_ALWAYS_FALSE
-      @response_expected[CALLBACK_ORIENTATION] = RESPONSE_EXPECTED_ALWAYS_FALSE
-      @response_expected[CALLBACK_QUATERNION] = RESPONSE_EXPECTED_ALWAYS_FALSE
       @response_expected[FUNCTION_ORIENTATION_CALCULATION_ON] = RESPONSE_EXPECTED_FALSE
       @response_expected[FUNCTION_ORIENTATION_CALCULATION_OFF] = RESPONSE_EXPECTED_FALSE
       @response_expected[FUNCTION_IS_ORIENTATION_CALCULATION_ON] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_SPITFP_BAUDRATE_CONFIG] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_SPITFP_BAUDRATE_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_GET_SEND_TIMEOUT_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_SET_SPITFP_BAUDRATE] = RESPONSE_EXPECTED_FALSE
+      @response_expected[FUNCTION_GET_SPITFP_BAUDRATE] = RESPONSE_EXPECTED_ALWAYS_TRUE
+      @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_ENABLE_STATUS_LED] = RESPONSE_EXPECTED_FALSE
       @response_expected[FUNCTION_DISABLE_STATUS_LED] = RESPONSE_EXPECTED_FALSE
       @response_expected[FUNCTION_IS_STATUS_LED_ENABLED] = RESPONSE_EXPECTED_ALWAYS_TRUE
@@ -166,6 +170,7 @@ module Tinkerforge
       @callback_formats[CALLBACK_ALL_DATA] = 's s s s s s s s s s'
       @callback_formats[CALLBACK_ORIENTATION] = 's s s'
       @callback_formats[CALLBACK_QUATERNION] = 'e e e e'
+
     end
 
     # Returns the calibrated acceleration from the accelerometer for the
@@ -175,7 +180,7 @@ module Tinkerforge
     # to use the CALLBACK_ACCELERATION callback and set the period with
     # BrickIMU#set_acceleration_period.
     def get_acceleration
-      send_request(FUNCTION_GET_ACCELERATION, [], '', 6, 's s s')
+      send_request FUNCTION_GET_ACCELERATION, [], '', 6, 's s s'
     end
 
     # Returns the calibrated magnetic field from the magnetometer for the
@@ -185,7 +190,7 @@ module Tinkerforge
     # to use the CALLBACK_MAGNETIC_FIELD callback and set the period with
     # BrickIMU#set_magnetic_field_period.
     def get_magnetic_field
-      send_request(FUNCTION_GET_MAGNETIC_FIELD, [], '', 6, 's s s')
+      send_request FUNCTION_GET_MAGNETIC_FIELD, [], '', 6, 's s s'
     end
 
     # Returns the calibrated angular velocity from the gyroscope for the
@@ -196,7 +201,7 @@ module Tinkerforge
     # to use the CALLBACK_ANGULAR_VELOCITY callback and set the period with
     # BrickIMU#set_angular_velocity_period.
     def get_angular_velocity
-      send_request(FUNCTION_GET_ANGULAR_VELOCITY, [], '', 6, 's s s')
+      send_request FUNCTION_GET_ANGULAR_VELOCITY, [], '', 6, 's s s'
     end
 
     # Returns the data from BrickIMU#get_acceleration, BrickIMU#get_magnetic_field
@@ -208,7 +213,7 @@ module Tinkerforge
     # to use the CALLBACK_ALL_DATA callback and set the period with
     # BrickIMU#set_all_data_period.
     def get_all_data
-      send_request(FUNCTION_GET_ALL_DATA, [], '', 20, 's s s s s s s s s s')
+      send_request FUNCTION_GET_ALL_DATA, [], '', 20, 's s s s s s s s s s'
     end
 
     # Returns the current orientation (roll, pitch, yaw) of the IMU Brick as Euler
@@ -224,7 +229,7 @@ module Tinkerforge
     # to use the CALLBACK_ORIENTATION callback and set the period with
     # BrickIMU#set_orientation_period.
     def get_orientation
-      send_request(FUNCTION_GET_ORIENTATION, [], '', 6, 's s s')
+      send_request FUNCTION_GET_ORIENTATION, [], '', 6, 's s s'
     end
 
     # Returns the current orientation (x, y, z, w) of the IMU as
@@ -259,49 +264,49 @@ module Tinkerforge
     # to use the CALLBACK_QUATERNION callback and set the period with
     # BrickIMU#set_quaternion_period.
     def get_quaternion
-      send_request(FUNCTION_GET_QUATERNION, [], '', 16, 'e e e e')
+      send_request FUNCTION_GET_QUATERNION, [], '', 16, 'e e e e'
     end
 
     # Returns the temperature of the IMU Brick. The temperature is given in
     # °C/100.
     def get_imu_temperature
-      send_request(FUNCTION_GET_IMU_TEMPERATURE, [], '', 2, 's')
+      send_request FUNCTION_GET_IMU_TEMPERATURE, [], '', 2, 's'
     end
 
     # Turns the orientation and direction LEDs of the IMU Brick on.
     def leds_on
-      send_request(FUNCTION_LEDS_ON, [], '', 0, '')
+      send_request FUNCTION_LEDS_ON, [], '', 0, ''
     end
 
     # Turns the orientation and direction LEDs of the IMU Brick off.
     def leds_off
-      send_request(FUNCTION_LEDS_OFF, [], '', 0, '')
+      send_request FUNCTION_LEDS_OFF, [], '', 0, ''
     end
 
     # Returns *true* if the orientation and direction LEDs of the IMU Brick
     # are on, *false* otherwise.
     def are_leds_on
-      send_request(FUNCTION_ARE_LEDS_ON, [], '', 1, '?')
+      send_request FUNCTION_ARE_LEDS_ON, [], '', 1, '?'
     end
 
     # Not implemented yet.
     def set_acceleration_range(range)
-      send_request(FUNCTION_SET_ACCELERATION_RANGE, [range], 'C', 0, '')
+      send_request FUNCTION_SET_ACCELERATION_RANGE, [range], 'C', 0, ''
     end
 
     # Not implemented yet.
     def get_acceleration_range
-      send_request(FUNCTION_GET_ACCELERATION_RANGE, [], '', 1, 'C')
+      send_request FUNCTION_GET_ACCELERATION_RANGE, [], '', 1, 'C'
     end
 
     # Not implemented yet.
     def set_magnetometer_range(range)
-      send_request(FUNCTION_SET_MAGNETOMETER_RANGE, [range], 'C', 0, '')
+      send_request FUNCTION_SET_MAGNETOMETER_RANGE, [range], 'C', 0, ''
     end
 
     # Not implemented yet.
     def get_magnetometer_range
-      send_request(FUNCTION_GET_MAGNETOMETER_RANGE, [], '', 1, 'C')
+      send_request FUNCTION_GET_MAGNETOMETER_RANGE, [], '', 1, 'C'
     end
 
     # Sets the convergence speed of the IMU Brick in °/s. The convergence speed
@@ -332,12 +337,12 @@ module Tinkerforge
     # 
     # The default value is 30.
     def set_convergence_speed(speed)
-      send_request(FUNCTION_SET_CONVERGENCE_SPEED, [speed], 'S', 0, '')
+      send_request FUNCTION_SET_CONVERGENCE_SPEED, [speed], 'S', 0, ''
     end
 
     # Returns the convergence speed as set by BrickIMU#set_convergence_speed.
     def get_convergence_speed
-      send_request(FUNCTION_GET_CONVERGENCE_SPEED, [], '', 2, 'S')
+      send_request FUNCTION_GET_CONVERGENCE_SPEED, [], '', 2, 'S'
     end
 
     # There are several different types that can be calibrated:
@@ -373,12 +378,12 @@ module Tinkerforge
     #  We highly recommend that you use the Brick Viewer to calibrate your
     #  IMU Brick.
     def set_calibration(typ, data)
-      send_request(FUNCTION_SET_CALIBRATION, [typ, data], 'C s10', 0, '')
+      send_request FUNCTION_SET_CALIBRATION, [typ, data], 'C s10', 0, ''
     end
 
     # Returns the calibration for a given type as set by BrickIMU#set_calibration.
     def get_calibration(typ)
-      send_request(FUNCTION_GET_CALIBRATION, [typ], 'C', 20, 's10')
+      send_request FUNCTION_GET_CALIBRATION, [typ], 'C', 20, 's10'
     end
 
     # Sets the period in ms with which the CALLBACK_ACCELERATION callback is triggered
@@ -386,67 +391,67 @@ module Tinkerforge
     # 
     # The default value is 0.
     def set_acceleration_period(period)
-      send_request(FUNCTION_SET_ACCELERATION_PERIOD, [period], 'L', 0, '')
+      send_request FUNCTION_SET_ACCELERATION_PERIOD, [period], 'L', 0, ''
     end
 
     # Returns the period as set by BrickIMU#set_acceleration_period.
     def get_acceleration_period
-      send_request(FUNCTION_GET_ACCELERATION_PERIOD, [], '', 4, 'L')
+      send_request FUNCTION_GET_ACCELERATION_PERIOD, [], '', 4, 'L'
     end
 
     # Sets the period in ms with which the CALLBACK_MAGNETIC_FIELD callback is
     # triggered periodically. A value of 0 turns the callback off.
     def set_magnetic_field_period(period)
-      send_request(FUNCTION_SET_MAGNETIC_FIELD_PERIOD, [period], 'L', 0, '')
+      send_request FUNCTION_SET_MAGNETIC_FIELD_PERIOD, [period], 'L', 0, ''
     end
 
     # Returns the period as set by BrickIMU#set_magnetic_field_period.
     def get_magnetic_field_period
-      send_request(FUNCTION_GET_MAGNETIC_FIELD_PERIOD, [], '', 4, 'L')
+      send_request FUNCTION_GET_MAGNETIC_FIELD_PERIOD, [], '', 4, 'L'
     end
 
     # Sets the period in ms with which the CALLBACK_ANGULAR_VELOCITY callback is
     # triggered periodically. A value of 0 turns the callback off.
     def set_angular_velocity_period(period)
-      send_request(FUNCTION_SET_ANGULAR_VELOCITY_PERIOD, [period], 'L', 0, '')
+      send_request FUNCTION_SET_ANGULAR_VELOCITY_PERIOD, [period], 'L', 0, ''
     end
 
     # Returns the period as set by BrickIMU#set_angular_velocity_period.
     def get_angular_velocity_period
-      send_request(FUNCTION_GET_ANGULAR_VELOCITY_PERIOD, [], '', 4, 'L')
+      send_request FUNCTION_GET_ANGULAR_VELOCITY_PERIOD, [], '', 4, 'L'
     end
 
     # Sets the period in ms with which the CALLBACK_ALL_DATA callback is triggered
     # periodically. A value of 0 turns the callback off.
     def set_all_data_period(period)
-      send_request(FUNCTION_SET_ALL_DATA_PERIOD, [period], 'L', 0, '')
+      send_request FUNCTION_SET_ALL_DATA_PERIOD, [period], 'L', 0, ''
     end
 
     # Returns the period as set by BrickIMU#set_all_data_period.
     def get_all_data_period
-      send_request(FUNCTION_GET_ALL_DATA_PERIOD, [], '', 4, 'L')
+      send_request FUNCTION_GET_ALL_DATA_PERIOD, [], '', 4, 'L'
     end
 
     # Sets the period in ms with which the CALLBACK_ORIENTATION callback is triggered
     # periodically. A value of 0 turns the callback off.
     def set_orientation_period(period)
-      send_request(FUNCTION_SET_ORIENTATION_PERIOD, [period], 'L', 0, '')
+      send_request FUNCTION_SET_ORIENTATION_PERIOD, [period], 'L', 0, ''
     end
 
     # Returns the period as set by BrickIMU#set_orientation_period.
     def get_orientation_period
-      send_request(FUNCTION_GET_ORIENTATION_PERIOD, [], '', 4, 'L')
+      send_request FUNCTION_GET_ORIENTATION_PERIOD, [], '', 4, 'L'
     end
 
     # Sets the period in ms with which the CALLBACK_QUATERNION callback is triggered
     # periodically. A value of 0 turns the callback off.
     def set_quaternion_period(period)
-      send_request(FUNCTION_SET_QUATERNION_PERIOD, [period], 'L', 0, '')
+      send_request FUNCTION_SET_QUATERNION_PERIOD, [period], 'L', 0, ''
     end
 
     # Returns the period as set by BrickIMU#set_quaternion_period.
     def get_quaternion_period
-      send_request(FUNCTION_GET_QUATERNION_PERIOD, [], '', 4, 'L')
+      send_request FUNCTION_GET_QUATERNION_PERIOD, [], '', 4, 'L'
     end
 
     # Turns the orientation calculation of the IMU Brick on.
@@ -455,7 +460,7 @@ module Tinkerforge
     # 
     # .. versionadded:: 2.0.2$nbsp;(Firmware)
     def orientation_calculation_on
-      send_request(FUNCTION_ORIENTATION_CALCULATION_ON, [], '', 0, '')
+      send_request FUNCTION_ORIENTATION_CALCULATION_ON, [], '', 0, ''
     end
 
     # Turns the orientation calculation of the IMU Brick off.
@@ -472,7 +477,7 @@ module Tinkerforge
     # 
     # .. versionadded:: 2.0.2$nbsp;(Firmware)
     def orientation_calculation_off
-      send_request(FUNCTION_ORIENTATION_CALCULATION_OFF, [], '', 0, '')
+      send_request FUNCTION_ORIENTATION_CALCULATION_OFF, [], '', 0, ''
     end
 
     # Returns *true* if the orientation calculation of the IMU Brick
@@ -480,7 +485,42 @@ module Tinkerforge
     # 
     # .. versionadded:: 2.0.2$nbsp;(Firmware)
     def is_orientation_calculation_on
-      send_request(FUNCTION_IS_ORIENTATION_CALCULATION_ON, [], '', 1, '?')
+      send_request FUNCTION_IS_ORIENTATION_CALCULATION_ON, [], '', 1, '?'
+    end
+
+    # The SPITF protocol can be used with a dynamic baudrate. If the dynamic baudrate is
+    # enabled, the Brick will try to adapt the baudrate for the communication
+    # between Bricks and Bricklets according to the amount of data that is transferred.
+    # 
+    # The baudrate will be increased exponetially if lots of data is send/receieved and
+    # decreased linearly if little data is send/received.
+    # 
+    # This lowers the baudrate in applications where little data is transferred (e.g.
+    # a weather station) and increases the robustness. If there is lots of data to transfer
+    # (e.g. Thermal Imaging Bricklet) it automatically increases the baudrate as needed.
+    # 
+    # In cases where some data has to transferred as fast as possible every few seconds
+    # (e.g. RS485 Bricklet with a high baudrate but small payload) you may want to turn
+    # the dynamic baudrate off to get the highest possible performance.
+    # 
+    # The maximum value of the baudrate can be set per port with the function 
+    # BrickIMU#set_spitfp_baudrate. If the dynamic baudrate is disabled, the baudrate
+    # as set by BrickIMU#set_spitfp_baudrate will be used statically.
+    # 
+    # The minimum dynamic baudrate has a value range of 400000 to 2000000 baud.
+    # 
+    # By default dynamic baudrate is enabled and the minimum dynamic baudrate is 400000.
+    # 
+    # .. versionadded:: 2.3.5$nbsp;(Firmware)
+    def set_spitfp_baudrate_config(enable_dynamic_baudrate, minimum_dynamic_baudrate)
+      send_request FUNCTION_SET_SPITFP_BAUDRATE_CONFIG, [enable_dynamic_baudrate, minimum_dynamic_baudrate], '? L', 0, ''
+    end
+
+    # Returns the baudrate config, see BrickIMU#set_spitfp_baudrate_config.
+    # 
+    # .. versionadded:: 2.3.5$nbsp;(Firmware)
+    def get_spitfp_baudrate_config
+      send_request FUNCTION_GET_SPITFP_BAUDRATE_CONFIG, [], '', 5, '? L'
     end
 
     # Returns the timeout count for the different communication methods.
@@ -492,7 +532,53 @@ module Tinkerforge
     # 
     # .. versionadded:: 2.3.3$nbsp;(Firmware)
     def get_send_timeout_count(communication_method)
-      send_request(FUNCTION_GET_SEND_TIMEOUT_COUNT, [communication_method], 'C', 4, 'L')
+      send_request FUNCTION_GET_SEND_TIMEOUT_COUNT, [communication_method], 'C', 4, 'L'
+    end
+
+    # Sets the baudrate for a specific Bricklet port ('a' - 'd'). The
+    # baudrate can be in the range 400000 to 2000000.
+    # 
+    # If you want to increase the throughput of Bricklets you can increase
+    # the baudrate. If you get a high error count because of high
+    # interference (see BrickIMU#get_spitfp_error_count) you can decrease the
+    # baudrate.
+    # 
+    # If the dynamic baudrate feature is enabled, the baudrate set by this
+    # function corresponds to the maximum baudrate (see BrickIMU#set_spitfp_baudrate_config).
+    # 
+    # Regulatory testing is done with the default baudrate. If CE compatability
+    # or similar is necessary in you applications we recommend to not change
+    # the baudrate.
+    # 
+    # The default baudrate for all ports is 1400000.
+    # 
+    # .. versionadded:: 2.3.3$nbsp;(Firmware)
+    def set_spitfp_baudrate(bricklet_port, baudrate)
+      send_request FUNCTION_SET_SPITFP_BAUDRATE, [bricklet_port, baudrate], 'k L', 0, ''
+    end
+
+    # Returns the baudrate for a given Bricklet port, see BrickIMU#set_spitfp_baudrate.
+    # 
+    # .. versionadded:: 2.3.3$nbsp;(Firmware)
+    def get_spitfp_baudrate(bricklet_port)
+      send_request FUNCTION_GET_SPITFP_BAUDRATE, [bricklet_port], 'k', 4, 'L'
+    end
+
+    # Returns the error count for the communication between Brick and Bricklet.
+    # 
+    # The errors are divided into
+    # 
+    # * ACK checksum errors,
+    # * message checksum errors,
+    # * frameing errors and
+    # * overflow errors.
+    # 
+    # The errors counts are for errors that occur on the Brick side. All
+    # Bricklets have a similar function that returns the errors on the Bricklet side.
+    # 
+    # .. versionadded:: 2.3.3$nbsp;(Firmware)
+    def get_spitfp_error_count(bricklet_port)
+      send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [bricklet_port], 'k', 16, 'L L L L'
     end
 
     # Enables the status LED.
@@ -504,7 +590,7 @@ module Tinkerforge
     # 
     # .. versionadded:: 2.3.1$nbsp;(Firmware)
     def enable_status_led
-      send_request(FUNCTION_ENABLE_STATUS_LED, [], '', 0, '')
+      send_request FUNCTION_ENABLE_STATUS_LED, [], '', 0, ''
     end
 
     # Disables the status LED.
@@ -516,14 +602,14 @@ module Tinkerforge
     # 
     # .. versionadded:: 2.3.1$nbsp;(Firmware)
     def disable_status_led
-      send_request(FUNCTION_DISABLE_STATUS_LED, [], '', 0, '')
+      send_request FUNCTION_DISABLE_STATUS_LED, [], '', 0, ''
     end
 
     # Returns *true* if the status LED is enabled, *false* otherwise.
     # 
     # .. versionadded:: 2.3.1$nbsp;(Firmware)
     def is_status_led_enabled
-      send_request(FUNCTION_IS_STATUS_LED_ENABLED, [], '', 1, '?')
+      send_request FUNCTION_IS_STATUS_LED_ENABLED, [], '', 1, '?'
     end
 
     # Returns the firmware and protocol version and the name of the Bricklet for a
@@ -532,7 +618,7 @@ module Tinkerforge
     # This functions sole purpose is to allow automatic flashing of v1.x.y Bricklet
     # plugins.
     def get_protocol1_bricklet_name(port)
-      send_request(FUNCTION_GET_PROTOCOL1_BRICKLET_NAME, [port], 'k', 44, 'C C3 Z40')
+      send_request FUNCTION_GET_PROTOCOL1_BRICKLET_NAME, [port], 'k', 44, 'C C3 Z40'
     end
 
     # Returns the temperature in °C/10 as measured inside the microcontroller. The
@@ -542,7 +628,7 @@ module Tinkerforge
     # accuracy of +-15%. Practically it is only useful as an indicator for
     # temperature changes.
     def get_chip_temperature
-      send_request(FUNCTION_GET_CHIP_TEMPERATURE, [], '', 2, 's')
+      send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 2, 's'
     end
 
     # Calling this function will reset the Brick. Calling this function
@@ -552,7 +638,7 @@ module Tinkerforge
     # calling functions on the existing ones will result in
     # undefined behavior!
     def reset
-      send_request(FUNCTION_RESET, [], '', 0, '')
+      send_request FUNCTION_RESET, [], '', 0, ''
     end
 
     # Returns the UID, the UID where the Brick is connected to,
@@ -564,7 +650,7 @@ module Tinkerforge
     # The device identifier numbers can be found :ref:`here <device_identifier>`.
     # |device_identifier_constant|
     def get_identity
-      send_request(FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S')
+      send_request FUNCTION_GET_IDENTITY, [], '', 25, 'Z8 Z8 k C3 C3 S'
     end
 
     # Registers a callback with ID <tt>id</tt> to the block <tt>block</tt>.