This is the description of the TCP/IP protocol for the Servo Brick. General information and technical specifications for the Servo Brick are summarized in its hardware description.
A general description of the TCP/IP protocol structure can be found here.
Every function of the Servo Brick API that has a servo_num parameter can address a servo with the servo number (0 to 6). If it is a setter function then multiple servos can be addressed at once with a bitmask for the servos, if the highest bit is set. For example: 1 will address servo 1, (1 << 1) | (1 << 5) | (1 << 7) will address servos 1 and 5, 0xFF will address all seven servos, etc. This allows to set configurations to several servos with one function call. It is guaranteed that the changes will take effect in the same PWM period for all servos you specified in the bitmask.
Function ID: | 1 |
---|---|
Request: |
|
Response: | no response |
Enables a servo (0 to 6). If a servo is enabled, the configured position, velocity, acceleration, etc. are applied immediately.
Function ID: | 2 |
---|---|
Request: |
|
Response: | no response |
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.
Function ID: | 3 |
---|---|
Request: |
|
Response: |
|
Returns true if the specified servo is enabled, false otherwise.
Function ID: | 4 |
---|---|
Request: |
|
Response: | no response |
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 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 set_degree.
Function ID: | 5 |
---|---|
Request: |
|
Response: |
|
Returns the position of the specified servo as set by set_position.
Function ID: | 6 |
---|---|
Request: |
|
Response: |
|
Returns the current position of the specified servo. This may not be the value of set_position if the servo is currently approaching a position goal.
Function ID: | 7 |
---|---|
Request: |
|
Response: | no response |
Sets the maximum velocity of the specified servo in °/100s. The velocity is accelerated according to the value set by 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.
Function ID: | 8 |
---|---|
Request: |
|
Response: |
|
Returns the velocity of the specified servo as set by set_velocity.
Function ID: | 9 |
---|---|
Request: |
|
Response: |
|
Returns the current velocity of the specified servo. This may not be the value of set_velocity if the servo is currently approaching a velocity goal.
Function ID: | 10 |
---|---|
Request: |
|
Response: | no response |
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.
Function ID: | 11 |
---|---|
Request: |
|
Response: |
|
Returns the acceleration for the specified servo as set by set_acceleration.
Function ID: | 12 |
---|---|
Request: |
|
Response: | no response |
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.
Function ID: | 13 |
---|---|
Request: | empty payload |
Response: |
|
Returns the output voltage as specified by set_output_voltage.
Function ID: | 14 |
---|---|
Request: |
|
Response: | no response |
Sets the minimum and maximum pulse width of the specified servo in µs.
Usually, servos are controlled with a PWM, 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.
Function ID: | 15 |
---|---|
Request: |
|
Response: |
|
Returns the minimum and maximum pulse width for the specified servo as set by set_pulse_width.
Function ID: | 16 |
---|---|
Request: |
|
Response: | no response |
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 set_position with 0 will result in a pulse width of 1500µs (-90° = 1000µs, 90° = 2000µs, etc.).
Possible usage:
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.
Function ID: | 17 |
---|---|
Request: |
|
Response: |
|
Returns the minimum and maximum degree for the specified servo as set by set_degree.
Function ID: | 18 |
---|---|
Request: |
|
Response: | no response |
Sets the period of the specified servo in µs.
Usually, servos are controlled with a PWM. 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).
Function ID: | 19 |
---|---|
Request: |
|
Response: |
|
Returns the period for the specified servo as set by set_period.
Function ID: | 20 |
---|---|
Request: |
|
Response: |
|
Returns the current consumption of the specified servo in mA.
Function ID: | 21 |
---|---|
Request: | empty payload |
Response: |
|
Returns the current consumption of all servos together in mA.
Function ID: | 22 |
---|---|
Request: | empty payload |
Response: |
|
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.
Function ID: | 23 |
---|---|
Request: | empty payload |
Response: |
|
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
Function ID: | 238 |
---|---|
Request: | empty payload |
Response: | no response |
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.
New in version 2.3.1 (Firmware).
Function ID: | 239 |
---|---|
Request: | empty payload |
Response: | no response |
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.
New in version 2.3.1 (Firmware).
Function ID: | 240 |
---|---|
Request: | empty payload |
Response: |
|
Returns true if the status LED is enabled, false otherwise.
New in version 2.3.1 (Firmware).
Function ID: | 241 |
---|---|
Request: |
|
Response: |
|
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.
Function ID: | 242 |
---|---|
Request: | empty payload |
Response: |
|
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.
Function ID: | 243 |
---|---|
Request: | empty payload |
Response: | no response |
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!
Function ID: | 255 |
---|---|
Request: | empty payload |
Response: |
|
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 here.
Function ID: | 24 |
---|---|
Request: |
|
Response: | no response |
Sets the minimum voltage in mV, below which the CALLBACK_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).
Function ID: | 25 |
---|---|
Request: | empty payload |
Response: |
|
Returns the minimum voltage as set by set_minimum_voltage
Function ID: | 29 |
---|---|
Request: | empty payload |
Response: | no response |
Enables the CALLBACK_POSITION_REACHED callback.
Default is disabled.
New in version 2.0.1 (Firmware).
Function ID: | 30 |
---|---|
Request: | empty payload |
Response: | no response |
Disables the CALLBACK_POSITION_REACHED callback.
Default is disabled.
New in version 2.0.1 (Firmware).
Function ID: | 31 |
---|---|
Request: | empty payload |
Response: |
|
Returns true if CALLBACK_POSITION_REACHED callback is enabled, false otherwise.
New in version 2.0.1 (Firmware).
Function ID: | 32 |
---|---|
Request: | empty payload |
Response: | no response |
Enables the CALLBACK_VELOCITY_REACHED callback.
Default is disabled.
New in version 2.0.1 (Firmware).
Function ID: | 33 |
---|---|
Request: | empty payload |
Response: | no response |
Disables the CALLBACK_VELOCITY_REACHED callback.
Default is disabled.
New in version 2.0.1 (Firmware).
Function ID: | 34 |
---|---|
Request: | empty payload |
Response: |
|
Returns true if CALLBACK_VELOCITY_REACHED callback is enabled, false otherwise.
New in version 2.0.1 (Firmware).
Function ID: | 26 |
---|---|
Response: |
|
This callback is triggered when the input voltage drops below the value set by set_minimum_voltage. The response value is the current voltage given in mV.
Function ID: | 27 |
---|---|
Response: |
|
This callback is triggered when a position set by set_position is reached. The response values are the servo and the position that is reached.
You can enable this callback with enable_position_reached_callback.
Note
Since we can't get any feedback from the servo, this only works if the velocity (see set_velocity) is set smaller or equal to the maximum velocity of the servo. Otherwise the servo will lag behind the control value and the callback will be triggered too early.
Function ID: | 28 |
---|---|
Response: |
|
This callback is triggered when a velocity set by set_velocity is reached. The response values are the servo and the velocity that is reached.
You can enable this callback with enable_velocity_reached_callback.
Note
Since we can't get any feedback from the servo, this only works if the acceleration (see set_acceleration) is set smaller or equal to the maximum acceleration of the servo. Otherwise the servo will lag behind the control value and the callback will be triggered too early.