Ishraq Ibne Ashraf
and 1 contributors

NAME

Tinkerforge::BrickServo - Drives up to 7 RC Servos with up to 3A

CONSTANTS

DEVICE_IDENTIFIER

This constant is used to identify a Servo Brick.

The get_identity() subroutine and the CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

DEVICE_DISPLAY_NAME

This constant represents the display name of a Servo Brick.

CALLBACK_UNDER_VOLTAGE

This constant is used with the register_callback() subroutine to specify the CALLBACK_UNDER_VOLTAGE callback.

CALLBACK_POSITION_REACHED

This constant is used with the register_callback() subroutine to specify the CALLBACK_POSITION_REACHED callback.

CALLBACK_VELOCITY_REACHED

This constant is used with the register_callback() subroutine to specify the CALLBACK_VELOCITY_REACHED callback.

FUNCTION_ENABLE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_DISABLE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_IS_ENABLED

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_POSITION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_POSITION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_CURRENT_POSITION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_VELOCITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_VELOCITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_CURRENT_VELOCITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_ACCELERATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_ACCELERATION

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_OUTPUT_VOLTAGE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_OUTPUT_VOLTAGE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_PULSE_WIDTH

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_PULSE_WIDTH

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_DEGREE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_DEGREE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_PERIOD

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_SERVO_CURRENT

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_OVERALL_CURRENT

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_STACK_INPUT_VOLTAGE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_EXTERNAL_INPUT_VOLTAGE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_SET_MINIMUM_VOLTAGE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_MINIMUM_VOLTAGE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_ENABLE_POSITION_REACHED_CALLBACK

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_DISABLE_POSITION_REACHED_CALLBACK

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_IS_POSITION_REACHED_CALLBACK_ENABLED

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_ENABLE_VELOCITY_REACHED_CALLBACK

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_DISABLE_VELOCITY_REACHED_CALLBACK

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_IS_VELOCITY_REACHED_CALLBACK_ENABLED

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_SEND_TIMEOUT_COUNT

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_ENABLE_STATUS_LED

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_DISABLE_STATUS_LED

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_IS_STATUS_LED_ENABLED

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_PROTOCOL1_BRICKLET_NAME

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_CHIP_TEMPERATURE

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_RESET

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTION_GET_IDENTITY

This constant is used with the get_response_expected(), set_response_expected() and set_response_expected_all() subroutines.

FUNCTIONS

new()

Creates an object with the unique device ID *uid* and adds it to the IP Connection *ipcon*.

enable()

Enables a servo (0 to 6). If a servo is enabled, the configured position, velocity, acceleration, etc. are applied immediately.

disable()

Disables a servo (0 to 6). Disabled servos are not driven at all, i.e. a disabled servo will not hold its position if a load is applied.

is_enabled()

Returns *true* if the specified servo is enabled, *false* otherwise.

set_position()

Sets the position in °/100 for the specified servo.

The default range of the position is -9000 to 9000, but it can be specified according to your servo with :func:`Set Degree`.

If you want to control a linear servo or RC brushless motor controller or similar with the Servo Brick, you can also define lengths or speeds with :func:`Set Degree`.

get_position()

Returns the position of the specified servo as set by :func:`Set Position`.

get_current_position()

Returns the *current* position of the specified servo. This may not be the value of :func:`Set Position` if the servo is currently approaching a position goal.

set_velocity()

Sets the maximum velocity of the specified servo in °/100s. The velocity is accelerated according to the value set by :func:`Set Acceleration`.

The minimum velocity is 0 (no movement) and the maximum velocity is 65535. With a value of 65535 the position will be set immediately (no velocity).

The default value is 65535.

get_velocity()

Returns the velocity of the specified servo as set by :func:`Set Velocity`.

get_current_velocity()

Returns the *current* velocity of the specified servo. This may not be the value of :func:`Set Velocity` if the servo is currently approaching a velocity goal.

set_acceleration()

Sets the acceleration of the specified servo in °/100s².

The minimum acceleration is 1 and the maximum acceleration is 65535. With a value of 65535 the velocity will be set immediately (no acceleration).

The default value is 65535.

get_acceleration()

Returns the acceleration for the specified servo as set by :func:`Set Acceleration`.

set_output_voltage()

Sets the output voltages with which the servos are driven in mV. The minimum output voltage is 2000mV and the maximum output voltage is 9000mV.

.. note:: We recommend that you set this value to the maximum voltage that is specified for your servo, most servos achieve their maximum force only with high voltages.

The default value is 5000.

get_output_voltage()

Returns the output voltage as specified by :func:`Set Output Voltage`.

set_pulse_width()

Sets the minimum and maximum pulse width of the specified servo in µs.

Usually, servos are controlled with a `PWM <https://en.wikipedia.org/wiki/Pulse-width_modulation>`__, whereby the length of the pulse controls the position of the servo. Every servo has different minimum and maximum pulse widths, these can be specified with this function.

If you have a datasheet for your servo that specifies the minimum and maximum pulse width, you should set the values accordingly. If your servo comes without any datasheet you have to find the values via trial and error.

Both values have a range from 1 to 65535 (unsigned 16-bit integer). The minimum must be smaller than the maximum.

The default values are 1000µs (1ms) and 2000µs (2ms) for minimum and maximum pulse width.

get_pulse_width()

Returns the minimum and maximum pulse width for the specified servo as set by :func:`Set Pulse Width`.

set_degree()

Sets the minimum and maximum degree for the specified servo (by default given as °/100).

This only specifies the abstract values between which the minimum and maximum pulse width is scaled. For example: If you specify a pulse width of 1000µs to 2000µs and a degree range of -90° to 90°, a call of :func:`Set Position` with 0 will result in a pulse width of 1500µs (-90° = 1000µs, 90° = 2000µs, etc.).

Possible usage:

* The datasheet of your servo specifies a range of 200° with the middle position at 110°. In this case you can set the minimum to -9000 and the maximum to 11000. * You measure a range of 220° on your servo and you don't have or need a middle position. In this case you can set the minimum to 0 and the maximum to 22000. * You have a linear servo with a drive length of 20cm, In this case you could set the minimum to 0 and the maximum to 20000. Now you can set the Position with :func:`Set Position` with a resolution of cm/100. Also the velocity will have a resolution of cm/100s and the acceleration will have a resolution of cm/100s². * You don't care about units and just want the highest possible resolution. In this case you should set the minimum to -32767 and the maximum to 32767. * You have a brushless motor with a maximum speed of 10000 rpm and want to control it with a RC brushless motor controller. In this case you can set the minimum to 0 and the maximum to 10000. :func:`Set Position` now controls the rpm.

Both values have a possible range from -32767 to 32767 (signed 16-bit integer). The minimum must be smaller than the maximum.

The default values are -9000 and 9000 for the minimum and maximum degree.

get_degree()

Returns the minimum and maximum degree for the specified servo as set by :func:`Set Degree`.

set_period()

Sets the period of the specified servo in µs.

Usually, servos are controlled with a `PWM <https://en.wikipedia.org/wiki/Pulse-width_modulation>`__. Different servos expect PWMs with different periods. Most servos run well with a period of about 20ms.

If your servo comes with a datasheet that specifies a period, you should set it accordingly. If you don't have a datasheet and you have no idea what the correct period is, the default value (19.5ms) will most likely work fine.

The minimum possible period is 1µs and the maximum is 65535µs.

The default value is 19.5ms (19500µs).

get_period()

Returns the period for the specified servo as set by :func:`Set Period`.

get_servo_current()

Returns the current consumption of the specified servo in mA.

get_overall_current()

Returns the current consumption of all servos together in mA.

get_stack_input_voltage()

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.

get_external_input_voltage()

Returns the external input voltage in mV. The external input voltage is given via the black power input connector on the Servo Brick.

If there is an external input voltage and a stack input voltage, the motors will be driven by the external input voltage. If there is only a stack voltage present, the motors will be driven by this voltage.

.. warning:: This means, if you have a high stack voltage and a low external voltage, the motors will be driven with the low external voltage. If you then remove the external connection, it will immediately be driven by the high stack voltage

set_minimum_voltage()

Sets the minimum voltage in mV, below which the :cb:`Under Voltage` callback is triggered. The minimum possible value that works with the Servo Brick is 5V. You can use this function to detect the discharge of a battery that is used to drive the stepper motor. If you have a fixed power supply, you likely do not need this functionality.

The default value is 5V (5000mV).

get_minimum_voltage()

Returns the minimum voltage as set by :func:`Set Minimum Voltage`

enable_position_reached_callback()

Enables the :cb:`Position Reached` callback.

Default is disabled.

.. versionadded:: 2.0.1$nbsp;(Firmware)

disable_position_reached_callback()

Disables the :cb:`Position Reached` callback.

Default is disabled.

.. versionadded:: 2.0.1$nbsp;(Firmware)

is_position_reached_callback_enabled()

Returns *true* if :cb:`Position Reached` callback is enabled, *false* otherwise.

.. versionadded:: 2.0.1$nbsp;(Firmware)

enable_velocity_reached_callback()

Enables the :cb:`Velocity Reached` callback.

Default is disabled.

.. versionadded:: 2.0.1$nbsp;(Firmware)

disable_velocity_reached_callback()

Disables the :cb:`Velocity Reached` callback.

Default is disabled.

.. versionadded:: 2.0.1$nbsp;(Firmware)

is_velocity_reached_callback_enabled()

Returns *true* if :cb:`Velocity Reached` callback is enabled, *false* otherwise.

.. versionadded:: 2.0.1$nbsp;(Firmware)

get_send_timeout_count()

Returns the timeout count for the different communication methods.

The methods 0-2 are available for all Bricks, 3-7 only for Master Bricks.

This function is mostly used for debugging during development, in normal operation the counters should nearly always stay at 0.

.. versionadded:: 2.3.2$nbsp;(Firmware)

enable_status_led()

Enables the status LED.

The status LED is the blue LED next to the USB connector. If enabled is is on and it flickers if data is transfered. If disabled it is always off.

The default state is enabled.

.. versionadded:: 2.3.1$nbsp;(Firmware)

disable_status_led()

Disables the status LED.

The status LED is the blue LED next to the USB connector. If enabled is is on and it flickers if data is transfered. If disabled it is always off.

The default state is enabled.

.. versionadded:: 2.3.1$nbsp;(Firmware)

is_status_led_enabled()

Returns *true* if the status LED is enabled, *false* otherwise.

.. versionadded:: 2.3.1$nbsp;(Firmware)

get_protocol1_bricklet_name()

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.

get_chip_temperature()

Returns the temperature in °C/10 as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has an accuracy of +-15%. Practically it is only useful as an indicator for temperature changes.

reset()

Calling this function will reset the Brick. Calling this function on a Brick inside of a stack will reset the whole stack.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

get_identity()

Returns the UID, the UID where the Brick is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be '0'-'8' (stack position).

The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|