tinkerforge 2.1.13 → 2.1.14

data/lib/tinkerforge/brick_dc.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  #
@@ -76,7 +76,12 @@ module Tinkerforge
     FUNCTION_GET_DRIVE_MODE = 18 # :nodoc:
     FUNCTION_SET_CURRENT_VELOCITY_PERIOD = 19 # :nodoc:
     FUNCTION_GET_CURRENT_VELOCITY_PERIOD = 20 # :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:
@@ -123,11 +128,12 @@ module Tinkerforge
       @response_expected[FUNCTION_GET_DRIVE_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
       @response_expected[FUNCTION_SET_CURRENT_VELOCITY_PERIOD] = RESPONSE_EXPECTED_TRUE
       @response_expected[FUNCTION_GET_CURRENT_VELOCITY_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
-      @response_expected[CALLBACK_UNDER_VOLTAGE] = RESPONSE_EXPECTED_ALWAYS_FALSE
-      @response_expected[CALLBACK_EMERGENCY_SHUTDOWN] = RESPONSE_EXPECTED_ALWAYS_FALSE
-      @response_expected[CALLBACK_VELOCITY_REACHED] = RESPONSE_EXPECTED_ALWAYS_FALSE
-      @response_expected[CALLBACK_CURRENT_VELOCITY] = RESPONSE_EXPECTED_ALWAYS_FALSE
+      @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
@@ -140,6 +146,7 @@ module Tinkerforge
       @callback_formats[CALLBACK_EMERGENCY_SHUTDOWN] = ''
       @callback_formats[CALLBACK_VELOCITY_REACHED] = 's'
       @callback_formats[CALLBACK_CURRENT_VELOCITY] = 's'
+
     end
 
     # Sets the velocity of the motor. Whereas -32767 is full speed backward,
@@ -154,19 +161,19 @@ module Tinkerforge
     # 
     # The default velocity is 0.
     def set_velocity(velocity)
-      send_request(FUNCTION_SET_VELOCITY, [velocity], 's', 0, '')
+      send_request FUNCTION_SET_VELOCITY, [velocity], 's', 0, ''
     end
 
     # Returns the velocity as set by BrickDC#set_velocity.
     def get_velocity
-      send_request(FUNCTION_GET_VELOCITY, [], '', 2, 's')
+      send_request FUNCTION_GET_VELOCITY, [], '', 2, 's'
     end
 
     # Returns the *current* velocity of the motor. This value is different
     # from BrickDC#get_velocity whenever the motor is currently accelerating
     # to a goal set by BrickDC#set_velocity.
     def get_current_velocity
-      send_request(FUNCTION_GET_CURRENT_VELOCITY, [], '', 2, 's')
+      send_request FUNCTION_GET_CURRENT_VELOCITY, [], '', 2, 's'
     end
 
     # Sets the acceleration of the motor. It is given in *velocity/s*. An
@@ -182,12 +189,12 @@ module Tinkerforge
     # 
     # The default acceleration is 10000.
     def set_acceleration(acceleration)
-      send_request(FUNCTION_SET_ACCELERATION, [acceleration], 'S', 0, '')
+      send_request FUNCTION_SET_ACCELERATION, [acceleration], 'S', 0, ''
     end
 
     # Returns the acceleration as set by BrickDC#set_acceleration.
     def get_acceleration
-      send_request(FUNCTION_GET_ACCELERATION, [], '', 2, 'S')
+      send_request FUNCTION_GET_ACCELERATION, [], '', 2, 'S'
     end
 
     # Sets the frequency (in Hz) of the PWM with which the motor is driven.
@@ -201,12 +208,12 @@ module Tinkerforge
     # 
     # The default frequency is 15 kHz.
     def set_pwm_frequency(frequency)
-      send_request(FUNCTION_SET_PWM_FREQUENCY, [frequency], 'S', 0, '')
+      send_request FUNCTION_SET_PWM_FREQUENCY, [frequency], 'S', 0, ''
     end
 
     # Returns the PWM frequency (in Hz) as set by BrickDC#set_pwm_frequency.
     def get_pwm_frequency
-      send_request(FUNCTION_GET_PWM_FREQUENCY, [], '', 2, 'S')
+      send_request FUNCTION_GET_PWM_FREQUENCY, [], '', 2, 'S'
     end
 
     # Executes an active full brake.
@@ -218,14 +225,14 @@ module Tinkerforge
     # 
     # Call BrickDC#set_velocity with 0 if you just want to stop the motor.
     def full_brake
-      send_request(FUNCTION_FULL_BRAKE, [], '', 0, '')
+      send_request FUNCTION_FULL_BRAKE, [], '', 0, ''
     end
 
     # Returns the stack input voltage in mV. The stack input voltage is the
     # voltage that is supplied via the stack, i.e. it is given by a
     # Step-Down or Step-Up Power Supply.
     def get_stack_input_voltage
-      send_request(FUNCTION_GET_STACK_INPUT_VOLTAGE, [], '', 2, 'S')
+      send_request FUNCTION_GET_STACK_INPUT_VOLTAGE, [], '', 2, 'S'
     end
 
     # Returns the external input voltage in mV. The external input voltage is
@@ -241,29 +248,29 @@ module Tinkerforge
     #  the external connection, it will immediately be driven by the high
     #  stack voltage.
     def get_external_input_voltage
-      send_request(FUNCTION_GET_EXTERNAL_INPUT_VOLTAGE, [], '', 2, 'S')
+      send_request FUNCTION_GET_EXTERNAL_INPUT_VOLTAGE, [], '', 2, 'S'
     end
 
     # Returns the current consumption of the motor in mA.
     def get_current_consumption
-      send_request(FUNCTION_GET_CURRENT_CONSUMPTION, [], '', 2, 'S')
+      send_request FUNCTION_GET_CURRENT_CONSUMPTION, [], '', 2, 'S'
     end
 
     # Enables the driver chip. The driver parameters can be configured (velocity,
     # acceleration, etc) before it is enabled.
     def enable
-      send_request(FUNCTION_ENABLE, [], '', 0, '')
+      send_request FUNCTION_ENABLE, [], '', 0, ''
     end
 
     # Disables the driver chip. The configurations are kept (velocity,
     # acceleration, etc) but the motor is not driven until it is enabled again.
     def disable
-      send_request(FUNCTION_DISABLE, [], '', 0, '')
+      send_request FUNCTION_DISABLE, [], '', 0, ''
     end
 
     # Returns *true* if the driver chip is enabled, *false* otherwise.
     def is_enabled
-      send_request(FUNCTION_IS_ENABLED, [], '', 1, '?')
+      send_request FUNCTION_IS_ENABLED, [], '', 1, '?'
     end
 
     # Sets the minimum voltage in mV, below which the CALLBACK_UNDER_VOLTAGE callback
@@ -274,12 +281,12 @@ module Tinkerforge
     # 
     # The default value is 6V.
     def set_minimum_voltage(voltage)
-      send_request(FUNCTION_SET_MINIMUM_VOLTAGE, [voltage], 'S', 0, '')
+      send_request FUNCTION_SET_MINIMUM_VOLTAGE, [voltage], 'S', 0, ''
     end
 
     # Returns the minimum voltage as set by BrickDC#set_minimum_voltage
     def get_minimum_voltage
-      send_request(FUNCTION_GET_MINIMUM_VOLTAGE, [], '', 2, 'S')
+      send_request FUNCTION_GET_MINIMUM_VOLTAGE, [], '', 2, 'S'
     end
 
     # Sets the drive mode. Possible modes are:
@@ -300,12 +307,12 @@ module Tinkerforge
     # 
     # The default value is 0 = Drive/Brake.
     def set_drive_mode(mode)
-      send_request(FUNCTION_SET_DRIVE_MODE, [mode], 'C', 0, '')
+      send_request FUNCTION_SET_DRIVE_MODE, [mode], 'C', 0, ''
     end
 
     # Returns the drive mode, as set by BrickDC#set_drive_mode.
     def get_drive_mode
-      send_request(FUNCTION_GET_DRIVE_MODE, [], '', 1, 'C')
+      send_request FUNCTION_GET_DRIVE_MODE, [], '', 1, 'C'
     end
 
     # Sets a period in ms with which the CALLBACK_CURRENT_VELOCITY callback is triggered.
@@ -313,12 +320,47 @@ module Tinkerforge
     # 
     # The default value is 0.
     def set_current_velocity_period(period)
-      send_request(FUNCTION_SET_CURRENT_VELOCITY_PERIOD, [period], 'S', 0, '')
+      send_request FUNCTION_SET_CURRENT_VELOCITY_PERIOD, [period], 'S', 0, ''
     end
 
     # Returns the period as set by BrickDC#set_current_velocity_period.
     def get_current_velocity_period
-      send_request(FUNCTION_GET_CURRENT_VELOCITY_PERIOD, [], '', 2, 'S')
+      send_request FUNCTION_GET_CURRENT_VELOCITY_PERIOD, [], '', 2, 'S'
+    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 
+    # BrickDC#set_spitfp_baudrate. If the dynamic baudrate is disabled, the baudrate
+    # as set by BrickDC#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 BrickDC#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.
@@ -330,7 +372,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 BrickDC#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 BrickDC#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 BrickDC#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.
@@ -342,7 +430,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.
@@ -354,14 +442,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
@@ -370,7 +458,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
@@ -380,7 +468,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
@@ -390,7 +478,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,
@@ -402,7 +490,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>.