Deutsch
English
Menu
Specifications / TCP/IP Protocol / API / Bricks and Bricklets / Bricks / Silent Stepper Brick

TCP/IP - Silent Stepper Brick

This is the description of the TCP/IP protocol for the Silent Stepper Brick. General information and technical specifications for the Silent Stepper Brick are summarized in its hardware description.

API

A general description of the TCP/IP protocol structure can be found here.

Basic Functions

BrickSilentStepper.set_max_velocity
Function ID:
  • 1
Request:
  • velocity – Type: uint16, Unit: 1 1/s, Range: [0 to 216 - 1]
Response:
  • no response

Sets the maximum velocity of the stepper motor. This function does not start the motor, it merely sets the maximum velocity the stepper motor is accelerated to. To get the motor running use either set_target_position, set_steps, drive_forward or drive_backward.

BrickSilentStepper.get_max_velocity
Function ID:
  • 2
Request:
  • empty payload
Response:
  • velocity – Type: uint16, Unit: 1 1/s, Range: [0 to 216 - 1]

Returns the velocity as set by set_max_velocity.

BrickSilentStepper.get_current_velocity
Function ID:
  • 3
Request:
  • empty payload
Response:
  • velocity – Type: uint16, Unit: 1 1/s, Range: [0 to 216 - 1]

Returns the current velocity of the stepper motor.

BrickSilentStepper.set_speed_ramping
Function ID:
  • 4
Request:
  • acceleration – Type: uint16, Unit: 1 1/s², Range: [0 to 216 - 1], Default: 1000
  • deacceleration – Type: uint16, Unit: 1 1/s², Range: [0 to 216 - 1], Default: 1000
Response:
  • no response

Sets the acceleration and deacceleration of the stepper motor. An acceleration of 1000 means, that every second the velocity is increased by 1000 steps/s.

For example: If the current velocity is 0 and you want to accelerate to a velocity of 8000 steps/s in 10 seconds, you should set an acceleration of 800 steps/s².

An acceleration/deacceleration of 0 means instantaneous acceleration/deacceleration (not recommended)

BrickSilentStepper.get_speed_ramping
Function ID:
  • 5
Request:
  • empty payload
Response:
  • acceleration – Type: uint16, Unit: 1 1/s², Range: [0 to 216 - 1], Default: 1000
  • deacceleration – Type: uint16, Unit: 1 1/s², Range: [0 to 216 - 1], Default: 1000

Returns the acceleration and deacceleration as set by set_speed_ramping.

BrickSilentStepper.full_brake
Function ID:
  • 6
Request:
  • empty payload
Response:
  • no response

Executes an active full brake.

Warning

This function is for emergency purposes, where an immediate brake is necessary. Depending on the current velocity and the strength of the motor, a full brake can be quite violent.

Call stop if you just want to stop the motor.

BrickSilentStepper.set_steps
Function ID:
  • 11
Request:
  • steps – Type: int32, Range: [-231 to 231 - 1]
Response:
  • no response

Sets the number of steps the stepper motor should run. Positive values will drive the motor forward and negative values backward. The velocity, acceleration and deacceleration as set by set_max_velocity and set_speed_ramping will be used.

BrickSilentStepper.get_steps
Function ID:
  • 12
Request:
  • empty payload
Response:
  • steps – Type: int32, Range: [-231 to 231 - 1]

Returns the last steps as set by set_steps.

BrickSilentStepper.get_remaining_steps
Function ID:
  • 13
Request:
  • empty payload
Response:
  • steps – Type: int32, Range: [-231 to 231 - 1]

Returns the remaining steps of the last call of set_steps. For example, if set_steps is called with 2000 and get_remaining_steps is called after the motor has run for 500 steps, it will return 1500.

BrickSilentStepper.drive_forward
Function ID:
  • 16
Request:
  • empty payload
Response:
  • no response

Drives the stepper motor forward until drive_backward or stop is called. The velocity, acceleration and deacceleration as set by set_max_velocity and set_speed_ramping will be used.

BrickSilentStepper.drive_backward
Function ID:
  • 17
Request:
  • empty payload
Response:
  • no response

Drives the stepper motor backward until drive_forward or stop is triggered. The velocity, acceleration and deacceleration as set by set_max_velocity and set_speed_ramping will be used.

BrickSilentStepper.stop
Function ID:
  • 18
Request:
  • empty payload
Response:
  • no response

Stops the stepper motor with the deacceleration as set by set_speed_ramping.

BrickSilentStepper.set_motor_current
Function ID:
  • 22
Request:
  • current – Type: uint16, Unit: 1 mA, Range: [360 to 1640], Default: 800
Response:
  • no response

Sets the current with which the motor will be driven.

Warning

Do not set this value above the specifications of your stepper motor. Otherwise it may damage your motor.

BrickSilentStepper.get_motor_current
Function ID:
  • 23
Request:
  • empty payload
Response:
  • current – Type: uint16, Unit: 1 mA, Range: [360 to 1640], Default: 800

Returns the current as set by set_motor_current.

BrickSilentStepper.enable
Function ID:
  • 24
Request:
  • empty payload
Response:
  • no response

Enables the driver chip. The driver parameters can be configured (maximum velocity, acceleration, etc) before it is enabled.

BrickSilentStepper.disable
Function ID:
  • 25
Request:
  • empty payload
Response:
  • no response

Disables the driver chip. The configurations are kept (maximum velocity, acceleration, etc) but the motor is not driven until it is enabled again.

Warning

Disabling the driver chip while the motor is still turning can damage the driver chip. The motor should be stopped calling stop function before disabling the motor power. The stop function will not wait until the motor is actually stopped. You have to explicitly wait for the appropriate time after calling the stop function before calling the disable function.

BrickSilentStepper.is_enabled
Function ID:
  • 26
Request:
  • empty payload
Response:
  • enabled – Type: bool, Default: false

Returns true if the driver chip is enabled, false otherwise.

BrickSilentStepper.set_basic_configuration
Function ID:
  • 27
Request:
  • standstill_current – Type: uint16, Unit: 1 mA, Range: [0 to 216 - 1], Default: 200
  • motor_run_current – Type: uint16, Unit: 1 mA, Range: [0 to 216 - 1], Default: 800
  • standstill_delay_time – Type: uint16, Unit: 1 ms, Range: [0 to 307], Default: 0
  • power_down_time – Type: uint16, Unit: 1 ms, Range: [0 to 5222], Default: 1000
  • stealth_threshold – Type: uint16, Unit: 1 1/s, Range: [0 to 216 - 1], Default: 500
  • coolstep_threshold – Type: uint16, Unit: 1 1/s, Range: [0 to 216 - 1], Default: 500
  • classic_threshold – Type: uint16, Unit: 1 1/s, Range: [0 to 216 - 1], Default: 1000
  • high_velocity_chopper_mode – Type: bool, Default: false
Response:
  • no response

Sets the basic configuration parameters for the different modes (Stealth, Coolstep, Classic).

  • Standstill Current: This value can be used to lower the current during stand still. This might be reasonable to reduce the heating of the motor and the Brick. When the motor is in standstill the configured motor phase current will be driven until the configured Power Down Time is elapsed. After that the phase current will be reduced to the standstill current. The elapsed time for this reduction can be configured with the Standstill Delay Time. The maximum allowed value is the configured maximum motor current (see set_motor_current).
  • Motor Run Current: The value sets the motor current when the motor is running. Use a value of at least one half of the global maximum motor current for a good microstep performance. The maximum allowed value is the current motor current. The API maps the entered value to 1/32 ... 32/32 of the maximum motor current. This value should be used to change the motor current during motor movement, whereas the global maximum motor current should not be changed while the motor is moving (see set_motor_current).
  • Standstill Delay Time: Controls the duration for motor power down after a motion as soon as standstill is detected and the Power Down Time is expired. A high Standstill Delay Time results in a smooth transition that avoids motor jerk during power down.
  • Power Down Time: Sets the delay time after a stand still.
  • Stealth Threshold: Sets the upper threshold for Stealth mode. If the velocity of the motor goes above this value, Stealth mode is turned off. Otherwise it is turned on. In Stealth mode the torque declines with high speed.
  • Coolstep Threshold: Sets the lower threshold for Coolstep mode. The Coolstep Threshold needs to be above the Stealth Threshold.
  • Classic Threshold: Sets the lower threshold for classic mode. In classic mode the stepper becomes more noisy, but the torque is maximized.
  • High Velocity Chopper Mode: If High Velocity Chopper Mode is enabled, the stepper control is optimized to run the stepper motors at high velocities.

If you want to use all three thresholds make sure that Stealth Threshold < Coolstep Threshold < Classic Threshold.

BrickSilentStepper.get_basic_configuration
Function ID:
  • 28
Request:
  • empty payload
Response:
  • standstill_current – Type: uint16, Unit: 1 mA, Range: [0 to 216 - 1], Default: 200
  • motor_run_current – Type: uint16, Unit: 1 mA, Range: [0 to 216 - 1], Default: 800
  • standstill_delay_time – Type: uint16, Unit: 1 ms, Range: [0 to 307], Default: 0
  • power_down_time – Type: uint16, Unit: 1 ms, Range: [0 to 5222], Default: 1000
  • stealth_threshold – Type: uint16, Unit: 1 1/s, Range: [0 to 216 - 1], Default: 500
  • coolstep_threshold – Type: uint16, Unit: 1 1/s, Range: [0 to 216 - 1], Default: 500
  • classic_threshold – Type: uint16, Unit: 1 1/s, Range: [0 to 216 - 1], Default: 1000
  • high_velocity_chopper_mode – Type: bool, Default: false

Returns the configuration as set by set_basic_configuration.

Advanced Functions

BrickSilentStepper.set_current_position
Function ID:
  • 7
Request:
  • position – Type: int32, Range: [-231 to 231 - 1]
Response:
  • no response

Sets the current steps of the internal step counter. This can be used to set the current position to 0 when some kind of starting position is reached (e.g. when a CNC machine reaches a corner).

BrickSilentStepper.get_current_position
Function ID:
  • 8
Request:
  • empty payload
Response:
  • position – Type: int32, Range: [-231 to 231 - 1]

Returns the current position of the stepper motor in steps. On startup the position is 0. The steps are counted with all possible driving functions (set_target_position, set_steps, drive_forward or drive_backward). It also is possible to reset the steps to 0 or set them to any other desired value with set_current_position.

BrickSilentStepper.set_target_position
Function ID:
  • 9
Request:
  • position – Type: int32, Range: [-231 to 231 - 1]
Response:
  • no response

Sets the target position of the stepper motor in steps. For example, if the current position of the motor is 500 and set_target_position is called with 1000, the stepper motor will drive 500 steps forward. It will use the velocity, acceleration and deacceleration as set by set_max_velocity and set_speed_ramping.

A call of set_target_position with the parameter x is equivalent to a call of set_steps with the parameter (x - get_current_position).

BrickSilentStepper.get_target_position
Function ID:
  • 10
Request:
  • empty payload
Response:
  • position – Type: int32, Range: [-231 to 231 - 1]

Returns the last target position as set by set_target_position.

BrickSilentStepper.set_step_configuration
Function ID:
  • 14
Request:
  • step_resolution – Type: uint8, Range: See meanings, Default: 0
  • interpolation – Type: bool, Default: true
Response:
  • no response

Sets the step resolution from full-step up to 1/256-step.

If interpolation is turned on, the Silent Stepper Brick will always interpolate your step inputs as 1/256-step. If you use full-step mode with interpolation, each step will generate 256 1/256 steps.

For maximum torque use full-step without interpolation. For maximum resolution use 1/256-step. Turn interpolation on to make the Stepper driving less noisy.

If you often change the speed with high acceleration you should turn the interpolation off.

The following meanings are defined for the elements of this function:

For step_resolution:

  • 8 = 1
  • 7 = 2
  • 6 = 4
  • 5 = 8
  • 4 = 16
  • 3 = 32
  • 2 = 64
  • 1 = 128
  • 0 = 256
BrickSilentStepper.get_step_configuration
Function ID:
  • 15
Request:
  • empty payload
Response:
  • step_resolution – Type: uint8, Range: See meanings
  • interpolation – Type: bool, Default: true

Returns the step mode as set by set_step_configuration.

The following meanings are defined for the elements of this function:

For step_resolution:

  • 8 = 1
  • 7 = 2
  • 6 = 4
  • 5 = 8
  • 4 = 16
  • 3 = 32
  • 2 = 64
  • 1 = 128
  • 0 = 256
BrickSilentStepper.get_stack_input_voltage
Function ID:
  • 19
Request:
  • empty payload
Response:
  • voltage – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1]

Returns the stack input voltage. 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.

BrickSilentStepper.get_external_input_voltage
Function ID:
  • 20
Request:
  • empty payload
Response:
  • voltage – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1]

Returns the external input voltage. The external input voltage is given via the black power input connector on the Silent Stepper Brick.

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

Warning

This means, if you have a high stack voltage and a low external voltage, the motor 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

BrickSilentStepper.set_spreadcycle_configuration
Function ID:
  • 29
Request:
  • slow_decay_duration – Type: uint8, Range: [0 to 15], Default: 4
  • enable_random_slow_decay – Type: bool, Default: false
  • fast_decay_duration – Type: uint8, Range: [0 to 15], Default: 0
  • hysteresis_start_value – Type: uint8, Range: [0 to 7], Default: 0
  • hysteresis_end_value – Type: int8, Range: [-3 to 12], Default: 0
  • sine_wave_offset – Type: int8, Range: [-3 to 12], Default: 0
  • chopper_mode – Type: uint8, Range: See meanings, Default: 0
  • comparator_blank_time – Type: uint8, Range: [0 to 3], Default: 1
  • fast_decay_without_comparator – Type: bool, Default: false
Response:
  • no response

Note: If you don't know what any of this means you can very likely keep all of the values as default!

Sets the Spreadcycle configuration parameters. Spreadcycle is a chopper algorithm which actively controls the motor current flow. More information can be found in the TMC2130 datasheet on page 47 (7 spreadCycle and Classic Chopper).

  • Slow Decay Duration: Controls duration of off time setting of slow decay phase. 0 = driver disabled, all bridges off. Use 1 only with Comparator Blank time >= 2.

  • Enable Random Slow Decay: Set to false to fix chopper off time as set by Slow Decay Duration. If you set it to true, Decay Duration is randomly modulated.

  • Fast Decay Duration: Sets the fast decay duration. This parameters is only used if the Chopper Mode is set to Fast Decay.

  • Hysteresis Start Value: Sets the hysteresis start value. This parameter is only used if the Chopper Mode is set to Spread Cycle.

  • Hysteresis End Value: Sets the hysteresis end value. This parameter is only used if the Chopper Mode is set to Spread Cycle.

  • Sine Wave Offset: Sets the sine wave offset. This parameters is only used if the Chopper Mode is set to Fast Decay. 1/512 of the value becomes added to the absolute value of the sine wave.

  • Chopper Mode: 0 = Spread Cycle, 1 = Fast Decay.

  • Comparator Blank Time: Sets the blank time of the comparator. Available values are

    • 0 = 16 clocks,
    • 1 = 24 clocks,
    • 2 = 36 clocks and
    • 3 = 54 clocks.

    A value of 1 or 2 is recommended for most applications.

  • Fast Decay Without Comparator: If set to true the current comparator usage for termination of the fast decay cycle is disabled.

The following meanings are defined for the elements of this function:

For chopper_mode:

  • 0 = Spread Cycle
  • 1 = Fast Decay
BrickSilentStepper.get_spreadcycle_configuration
Function ID:
  • 30
Request:
  • empty payload
Response:
  • slow_decay_duration – Type: uint8, Range: [0 to 15], Default: 4
  • enable_random_slow_decay – Type: bool, Default: false
  • fast_decay_duration – Type: uint8, Range: [0 to 15], Default: 0
  • hysteresis_start_value – Type: uint8, Range: [0 to 7], Default: 0
  • hysteresis_end_value – Type: int8, Range: [-3 to 12], Default: 0
  • sine_wave_offset – Type: int8, Range: [-3 to 12], Default: 0
  • chopper_mode – Type: uint8, Range: See meanings, Default: 0
  • comparator_blank_time – Type: uint8, Range: [0 to 3], Default: 1
  • fast_decay_without_comparator – Type: bool, Default: false

Returns the configuration as set by set_basic_configuration.

The following meanings are defined for the elements of this function:

For chopper_mode:

  • 0 = Spread Cycle
  • 1 = Fast Decay
BrickSilentStepper.set_stealth_configuration
Function ID:
  • 31
Request:
  • enable_stealth – Type: bool, Default: true
  • amplitude – Type: uint8, Range: [0 to 255], Default: 128
  • gradient – Type: uint8, Range: [0 to 255], Default: 4
  • enable_autoscale – Type: bool, Default: true
  • force_symmetric – Type: bool, Default: false
  • freewheel_mode – Type: uint8, Range: See meanings, Default: 0
Response:
  • no response

Note: If you don't know what any of this means you can very likely keep all of the values as default!

Sets the configuration relevant for Stealth mode.

  • Enable Stealth: If set to true the stealth mode is enabled, if set to false the stealth mode is disabled, even if the speed is below the threshold set in set_basic_configuration.
  • Amplitude: If autoscale is disabled, the PWM amplitude is scaled by this value. If autoscale is enabled, this value defines the maximum PWM amplitude change per half wave.
  • Gradient: If autoscale is disabled, the PWM gradient is scaled by this value. If autoscale is enabled, this value defines the maximum PWM gradient. With autoscale a value above 64 is recommended, otherwise the regulation might not be able to measure the current.
  • Enable Autoscale: If set to true, automatic current control is used. Otherwise the user defined amplitude and gradient are used.
  • Force Symmetric: If true, A symmetric PWM cycle is enforced. Otherwise the PWM value may change within each PWM cycle.
  • Freewheel Mode: The freewheel mode defines the behavior in stand still if the Standstill Current (see set_basic_configuration) is set to 0.

The following meanings are defined for the elements of this function:

For freewheel_mode:

  • 0 = Normal
  • 1 = Freewheeling
  • 2 = Coil Short LS
  • 3 = Coil Short HS
BrickSilentStepper.get_stealth_configuration
Function ID:
  • 32
Request:
  • empty payload
Response:
  • enable_stealth – Type: bool, Default: true
  • amplitude – Type: uint8, Range: [0 to 255], Default: 128
  • gradient – Type: uint8, Range: [0 to 255], Default: 4
  • enable_autoscale – Type: bool, Default: true
  • force_symmetric – Type: bool, Default: false
  • freewheel_mode – Type: uint8, Range: See meanings, Default: 0

Returns the configuration as set by set_stealth_configuration.

The following meanings are defined for the elements of this function:

For freewheel_mode:

  • 0 = Normal
  • 1 = Freewheeling
  • 2 = Coil Short LS
  • 3 = Coil Short HS
BrickSilentStepper.set_coolstep_configuration
Function ID:
  • 33
Request:
  • minimum_stallguard_value – Type: uint8, Range: [0 to 15], Default: 2
  • maximum_stallguard_value – Type: uint8, Range: [0 to 15], Default: 10
  • current_up_step_width – Type: uint8, Range: See meanings, Default: 0
  • current_down_step_width – Type: uint8, Range: See meanings, Default: 0
  • minimum_current – Type: uint8, Range: See meanings, Default: 0
  • stallguard_threshold_value – Type: int8, Range: [-64 to 63], Default: 0
  • stallguard_mode – Type: uint8, Range: See meanings, Default: 0
Response:
  • no response

Note: If you don't know what any of this means you can very likely keep all of the values as default!

Sets the configuration relevant for Coolstep.

  • Minimum Stallguard Value: If the Stallguard result falls below this value*32, the motor current is increased to reduce motor load angle. A value of 0 turns Coolstep off.
  • Maximum Stallguard Value: If the Stallguard result goes above (Min Stallguard Value + Max Stallguard Value + 1) * 32, the motor current is decreased to save energy.
  • Current Up Step Width: Sets the up step increment per Stallguard value. The value range is 0-3, corresponding to the increments 1, 2, 4 and 8.
  • Current Down Step Width: Sets the down step decrement per Stallguard value. The value range is 0-3, corresponding to the decrements 1, 2, 8 and 16.
  • Minimum Current: Sets the minimum current for Coolstep current control. You can choose between half and quarter of the run current.
  • Stallguard Threshold Value: Sets the level for stall output (see get_driver_status). A lower value gives a higher sensitivity. You have to find a suitable value for your motor by trial and error, 0 works for most motors.
  • Stallguard Mode: Set to 0 for standard resolution or 1 for filtered mode. In filtered mode the Stallguard signal will be updated every four full-steps.

The following meanings are defined for the elements of this function:

For current_up_step_width:

  • 0 = 1
  • 1 = 2
  • 2 = 4
  • 3 = 8

For current_down_step_width:

  • 0 = 1
  • 1 = 2
  • 2 = 8
  • 3 = 32

For minimum_current:

  • 0 = Half
  • 1 = Quarter

For stallguard_mode:

  • 0 = Standard
  • 1 = Filtered
BrickSilentStepper.get_coolstep_configuration
Function ID:
  • 34
Request:
  • empty payload
Response:
  • minimum_stallguard_value – Type: uint8, Range: [0 to 15], Default: 2
  • maximum_stallguard_value – Type: uint8, Range: [0 to 15], Default: 10
  • current_up_step_width – Type: uint8, Range: See meanings, Default: 0
  • current_down_step_width – Type: uint8, Range: See meanings, Default: 0
  • minimum_current – Type: uint8, Range: See meanings, Default: 0
  • stallguard_threshold_value – Type: int8, Range: [-64 to 63], Default: 0
  • stallguard_mode – Type: uint8, Range: See meanings, Default: 0

Returns the configuration as set by set_coolstep_configuration.

The following meanings are defined for the elements of this function:

For current_up_step_width:

  • 0 = 1
  • 1 = 2
  • 2 = 4
  • 3 = 8

For current_down_step_width:

  • 0 = 1
  • 1 = 2
  • 2 = 8
  • 3 = 32

For minimum_current:

  • 0 = Half
  • 1 = Quarter

For stallguard_mode:

  • 0 = Standard
  • 1 = Filtered
BrickSilentStepper.set_misc_configuration
Function ID:
  • 35
Request:
  • disable_short_to_ground_protection – Type: bool, Default: false
  • synchronize_phase_frequency – Type: uint8, Range: [0 to 15], Default: 0
Response:
  • no response

Note: If you don't know what any of this means you can very likely keep all of the values as default!

Sets miscellaneous configuration parameters.

  • Disable Short To Ground Protection: Set to false to enable short to ground protection, otherwise it is disabled.
  • Synchronize Phase Frequency: With this parameter you can synchronize the chopper for both phases of a two phase motor to avoid the occurrence of a beat. The value range is 0-15. If set to 0, the synchronization is turned off. Otherwise the synchronization is done through the formula f_sync = f_clk/(value*64). In Classic Mode the synchronization is automatically switched off. f_clk is 12.8MHz.
BrickSilentStepper.get_misc_configuration
Function ID:
  • 36
Request:
  • empty payload
Response:
  • disable_short_to_ground_protection – Type: bool, Default: false
  • synchronize_phase_frequency – Type: uint8, Range: [0 to 15], Default: 0

Returns the configuration as set by set_misc_configuration.

BrickSilentStepper.get_driver_status
Function ID:
  • 37
Request:
  • empty payload
Response:
  • open_load – Type: uint8, Range: See meanings
  • short_to_ground – Type: uint8, Range: See meanings
  • over_temperature – Type: uint8, Range: See meanings
  • motor_stalled – Type: bool
  • actual_motor_current – Type: uint8, Range: [0 to 31]
  • full_step_active – Type: bool
  • stallguard_result – Type: uint8, Range: [0 to 255]
  • stealth_voltage_amplitude – Type: uint8, Range: [0 to 255]

Returns the current driver status.

  • Open Load: Indicates if an open load is present on phase A, B or both. This could mean that there is a problem with the wiring of the motor. False detection can occur in fast motion as well as during stand still.
  • Short To Ground: Indicates if a short to ground is present on phase A, B or both. If this is detected the driver automatically becomes disabled and stays disabled until it is enabled again manually.
  • Over Temperature: The over temperature indicator switches to "Warning" if the driver IC warms up. The warning flag is expected during long duration stepper uses. If the temperature limit is reached the indicator switches to "Limit". In this case the driver becomes disabled until it cools down again.
  • Motor Stalled: Is true if a motor stall was detected.
  • Actual Motor Current: Indicates the actual current control scaling as used in Coolstep mode. It represents a multiplier of 1/32 to 32/32 of the Motor Run Current as set by set_basic_configuration. Example: If a Motor Run Current of 1000mA was set and the returned value is 15, the Actual Motor Current is 16/32*1000mA = 500mA.
  • Stallguard Result: Indicates the load of the motor. A lower value signals a higher load. Per trial and error you can find out which value corresponds to a suitable torque for the velocity used in your application. After that you can use this threshold value to find out if a motor stall becomes probable and react on it (e.g. decrease velocity). During stand still this value can not be used for stall detection, it shows the chopper on-time for motor coil A.
  • Stealth Voltage Amplitude: Shows the actual PWM scaling. In Stealth mode it can be used to detect motor load and stall if autoscale is enabled (see set_stealth_configuration).

The following meanings are defined for the elements of this function:

For open_load:

  • 0 = None
  • 1 = Phase A
  • 2 = Phase B
  • 3 = Phase AB

For short_to_ground:

  • 0 = None
  • 1 = Phase A
  • 2 = Phase B
  • 3 = Phase AB

For over_temperature:

  • 0 = None
  • 1 = Warning
  • 2 = Limit
BrickSilentStepper.set_time_base
Function ID:
  • 42
Request:
  • time_base – Type: uint32, Unit: 1 s, Range: [0 to 232 - 1], Default: 1
Response:
  • no response

Sets the time base of the velocity and the acceleration of the Silent Stepper Brick.

For example, if you want to make one step every 1.5 seconds, you can set the time base to 15 and the velocity to 10. Now the velocity is 10steps/15s = 1steps/1.5s.

BrickSilentStepper.get_time_base
Function ID:
  • 43
Request:
  • empty payload
Response:
  • time_base – Type: uint32, Unit: 1 s, Range: [0 to 232 - 1], Default: 1

Returns the time base as set by set_time_base.

BrickSilentStepper.get_all_data
Function ID:
  • 44
Request:
  • empty payload
Response:
  • current_velocity – Type: uint16, Unit: 1 1/s, Range: [0 to 216 - 1]
  • current_position – Type: int32, Range: [-231 to 231 - 1]
  • remaining_steps – Type: int32, Range: [-231 to 231 - 1]
  • stack_voltage – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1]
  • external_voltage – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1]
  • current_consumption – Type: uint16, Unit: 1 mA, Range: [0 to 216 - 1]

Returns the following parameters: The current velocity, the current position, the remaining steps, the stack voltage, the external voltage and the current consumption of the stepper motor.

The current consumption is calculated by multiplying the Actual Motor Current value (see set_basic_configuration) with the Motor Run Current (see get_driver_status). This is an internal calculation of the driver, not an independent external measurement.

The current consumption calculation was broken up to firmware 2.0.1, it is fixed since firmware 2.0.2.

There is also a callback for this function, see CALLBACK_ALL_DATA callback.

BrickSilentStepper.set_spitfp_baudrate_config
Function ID:
  • 231
Request:
  • enable_dynamic_baudrate – Type: bool, Default: true
  • minimum_dynamic_baudrate – Type: uint32, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000
Response:
  • no response

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 exponentially if lots of data is sent/received and decreased linearly if little data is sent/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 set_spitfp_baudrate. If the dynamic baudrate is disabled, the baudrate as set by set_spitfp_baudrate will be used statically.

New in version 2.0.4 (Firmware).

BrickSilentStepper.get_spitfp_baudrate_config
Function ID:
  • 232
Request:
  • empty payload
Response:
  • enable_dynamic_baudrate – Type: bool, Default: true
  • minimum_dynamic_baudrate – Type: uint32, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000

Returns the baudrate config, see set_spitfp_baudrate_config.

New in version 2.0.4 (Firmware).

BrickSilentStepper.get_send_timeout_count
Function ID:
  • 233
Request:
  • communication_method – Type: uint8, Range: See meanings
Response:
  • timeout_count – Type: uint32, Range: [0 to 232 - 1]

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.

The following meanings are defined for the elements of this function:

For communication_method:

  • 0 = None
  • 1 = USB
  • 2 = SPI Stack
  • 3 = Chibi
  • 4 = RS485
  • 5 = WIFI
  • 6 = Ethernet
  • 7 = WIFI V2
BrickSilentStepper.set_spitfp_baudrate
Function ID:
  • 234
Request:
  • bricklet_port – Type: char, Range: ['a' to 'b']
  • baudrate – Type: uint32, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000
Response:
  • no response

Sets the baudrate for a specific Bricklet port.

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 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 set_spitfp_baudrate_config).

Regulatory testing is done with the default baudrate. If CE compatibility or similar is necessary in your applications we recommend to not change the baudrate.

BrickSilentStepper.get_spitfp_baudrate
Function ID:
  • 235
Request:
  • bricklet_port – Type: char, Range: ['a' to 'b']
Response:
  • baudrate – Type: uint32, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000

Returns the baudrate for a given Bricklet port, see set_spitfp_baudrate.

BrickSilentStepper.get_spitfp_error_count
Function ID:
  • 237
Request:
  • bricklet_port – Type: char, Range: ['a' to 'b']
Response:
  • error_count_ack_checksum – Type: uint32, Range: [0 to 232 - 1]
  • error_count_message_checksum – Type: uint32, Range: [0 to 232 - 1]
  • error_count_frame – Type: uint32, Range: [0 to 232 - 1]
  • error_count_overflow – Type: uint32, Range: [0 to 232 - 1]

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing 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.

BrickSilentStepper.enable_status_led
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.

BrickSilentStepper.disable_status_led
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.

BrickSilentStepper.is_status_led_enabled
Function ID:
  • 240
Request:
  • empty payload
Response:
  • enabled – Type: bool, Default: true

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

BrickSilentStepper.get_chip_temperature
Function ID:
  • 242
Request:
  • empty payload
Response:
  • temperature – Type: int16, Unit: 1/10 °C, Range: [-215 to 215 - 1]

Returns the temperature 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.

BrickSilentStepper.reset
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!

BrickSilentStepper.get_identity
Function ID:
  • 255
Request:
  • empty payload
Response:
  • uid – Type: char[8]
  • connected_uid – Type: char[8]
  • position – Type: char, Range: ['0' to '8']
  • hardware_version – Type: uint8[3]
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • firmware_version – Type: uint8[3]
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • device_identifier – Type: uint16, Range: [0 to 216 - 1]

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 is the position in the stack from '0' (bottom) to '8' (top).

The device identifier numbers can be found here. 

Callback Configuration Functions

BrickSilentStepper.set_minimum_voltage
Function ID:
  • 38
Request:
  • voltage – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1], Default: 8000
Response:
  • no response

Sets the minimum voltage, below which the CALLBACK_UNDER_VOLTAGE callback is triggered. The minimum possible value that works with the Silent Stepper Brick is 8V. 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.

BrickSilentStepper.get_minimum_voltage
Function ID:
  • 39
Request:
  • empty payload
Response:
  • voltage – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1], Default: 8000

Returns the minimum voltage as set by set_minimum_voltage.

BrickSilentStepper.set_all_data_period
Function ID:
  • 45
Request:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0
Response:
  • no response

Sets the period with which the CALLBACK_ALL_DATA callback is triggered periodically. A value of 0 turns the callback off.

BrickSilentStepper.get_all_data_period
Function ID:
  • 46
Request:
  • empty payload
Response:
  • period – Type: uint32, Unit: 1 ms, Range: [0 to 232 - 1], Default: 0

Returns the period as set by set_all_data_period.

Callbacks

BrickSilentStepper.CALLBACK_UNDER_VOLTAGE
Function ID:
  • 40
Response:
  • voltage – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1]

This callback is triggered when the input voltage drops below the value set by set_minimum_voltage. The response value is the current voltage.

BrickSilentStepper.CALLBACK_POSITION_REACHED
Function ID:
  • 41
Response:
  • position – Type: int32, Range: [-231 to 231 - 1]

This callback is triggered when a position set by set_steps or set_target_position is reached.

Note

Since we can't get any feedback from the stepper motor, this only works if the acceleration (see set_speed_ramping) is set smaller or equal to the maximum acceleration of the motor. Otherwise the motor will lag behind the control value and the callback will be triggered too early.

BrickSilentStepper.CALLBACK_ALL_DATA
Function ID:
  • 47
Response:
  • current_velocity – Type: uint16, Unit: 1 1/s, Range: [0 to 216 - 1]
  • current_position – Type: int32, Range: [-231 to 231 - 1]
  • remaining_steps – Type: int32, Range: [-231 to 231 - 1]
  • stack_voltage – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1]
  • external_voltage – Type: uint16, Unit: 1 mV, Range: [0 to 216 - 1]
  • current_consumption – Type: uint16, Unit: 1 mA, Range: [0 to 216 - 1]

This callback is triggered periodically with the period that is set by set_all_data_period. The response values are: the current velocity, the current position, the remaining steps, the stack voltage, the external voltage and the current consumption of the stepper motor.

BrickSilentStepper.CALLBACK_NEW_STATE
Function ID:
  • 48
Response:
  • state_new – Type: uint8, Range: See meanings
  • state_previous – Type: uint8, Range: See meanings

This callback is triggered whenever the Silent Stepper Brick enters a new state. It returns the new state as well as the previous state.

The following meanings are defined for the elements of this function:

For state_new:

  • 1 = Stop
  • 2 = Acceleration
  • 3 = Run
  • 4 = Deacceleration
  • 5 = Direction Change To Forward
  • 6 = Direction Change To Backward

For state_previous:

  • 1 = Stop
  • 2 = Acceleration
  • 3 = Run
  • 4 = Deacceleration
  • 5 = Direction Change To Forward
  • 6 = Direction Change To Backward

Internal Functions

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

BrickSilentStepper.get_protocol1_bricklet_name
Function ID:
  • 241
Request:
  • port – Type: char, Range: ['a' to 'b']
Response:
  • protocol_version – Type: uint8, Range: [0 to 255]
  • firmware_version – Type: uint8[3]
    • 0: major – Type: uint8, Range: [0 to 255]
    • 1: minor – Type: uint8, Range: [0 to 255]
    • 2: revision – Type: uint8, Range: [0 to 255]
  • name – Type: char[40]

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.

BrickSilentStepper.write_bricklet_plugin
Function ID:
  • 246
Request:
  • port – Type: char, Range: ['a' to 'b']
  • offset – Type: uint8, Range: [0 to 255]
  • chunk – Type: uint8[32], Range: [0 to 255]
Response:
  • no response

Writes 32 bytes of firmware to the bricklet attached at the given port. The bytes are written to the position offset * 32.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

BrickSilentStepper.read_bricklet_plugin
Function ID:
  • 247
Request:
  • port – Type: char, Range: ['a' to 'b']
  • offset – Type: uint8, Range: [0 to 255]
Response:
  • chunk – Type: uint8[32], Range: [0 to 255]

Reads 32 bytes of firmware from the bricklet attached at the given port. The bytes are read starting at the position offset * 32.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.