Software / API Bindings / Go / API Reference and Examples / Bricks / Silent Stepper Brick

Go - Silent Stepper Brick¶

This is the description of the Go API bindings for the Silent Stepper Brick. General information and technical specifications for the Silent Stepper Brick are summarized in its hardware description.

An installation guide for the Go API bindings is part of their general description. Additional documentation can be found on godoc.org.

Examples¶

The example code below is Public Domain (CC0 1.0).

Configuration¶

Download (example_configuration.go)

package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/silent_stepper_brick"
    "time"
)

const ADDR string = "localhost:4223"
const UID string = "XXYYZZ" // Change XXYYZZ to the UID of your Silent Stepper Brick.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    ss, _ := silent_stepper_brick.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    ss.SetMotorCurrent(800) // 800 mA
    ss.SetStepConfiguration(silent_stepper_brick.StepResolution8,
        true) // 1/8 steps (interpolated)
    ss.SetMaxVelocity(2000) // Velocity 2000 steps/s

    // Slow acceleration (500 steps/s^2),
    // Fast deacceleration (5000 steps/s^2)
    ss.SetSpeedRamping(500, 5000)

    ss.Enable()        // Enable motor power
    ss.SetSteps(60000) // Drive 60000 steps forward

    fmt.Print("Press enter to exit.")
    fmt.Scanln()

    // Stop motor before disabling motor power
    ss.Stop()                          // Request motor stop
    ss.SetSpeedRamping(500, 5000)      // Fast deacceleration (5000 steps/s^2) for stopping
    time.Sleep(400 * time.Millisecond) // Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s
    ss.Disable()                       // Disable motor power
}

Callback¶

Download (example_callback.go)

package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/silent_stepper_brick"
    "math/rand"
    "time"
)

const ADDR string = "localhost:4223"
const UID string = "XXYYZZ" // Change XXYYZZ to the UID of your Silent Stepper Brick.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    ss, _ := silent_stepper_brick.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    rng := rand.New(rand.NewSource(time.Now().UnixNano()))

    ss.RegisterPositionReachedCallback(func(position int32) {
        steps := int32(0)
        if rng.Int31()%2 == 0 {
            steps = rng.Int31n(4001) + 1000
            fmt.Printf("Driving forward: %d steps\n", steps)
        } else {
            steps = -(rng.Int31n(4001) + 1000)
            fmt.Printf("Driving backward: %d steps\n", steps)
        }

        vel := uint16(rng.Int31n(1800) + 200)
        acc := uint16(rng.Int31n(900) + 100)
        dec := uint16(rng.Int31n(900) + 100)

        fmt.Printf("Configuration: (vel, acc, dec): (%d, %d, %d)\n", vel, acc, dec)
        ss.SetSpeedRamping(acc, dec)
        ss.SetMaxVelocity(vel)
        ss.SetSteps(steps)
    })

    ss.SetStepConfiguration(silent_stepper_brick.StepResolution8,
        true) // 1/8 steps (interpolated)
    ss.Enable()    // Enable motor power
    ss.SetSteps(1) // Drive one step forward to get things going

    fmt.Print("Press enter to exit.")
    fmt.Scanln()

    // Stop motor before disabling motor power
    ss.Stop()                          // Request motor stop
    ss.SetSpeedRamping(500, 5000)      // Fast deacceleration (5000 steps/s^2) for stopping
    time.Sleep(400 * time.Millisecond) // Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s
    ss.Disable()                       // Disable motor power
}

API¶

The Silent Stepper Brick API is defined in the package github.com/Tinkerforge/go-api-bindings/silent_stepper_brick

Nearly every function of the Go bindings can return an ipconnection.DeviceError, implementing the error interface. The error can have one of the following values:

ipconnection.DeviceErrorSuccess = 0
ipconnection.DeviceErrorInvalidParameter = 1
ipconnection.DeviceErrorFunctionNotSupported = 2
ipconnection.DeviceErrorUnknownError = 3

which correspond to the values returned from Bricks and Bricklets.

All functions listed below are thread-safe.

Basic Functions¶

func silent_stepper_brick.New(uid string, ipcon *IPConnection) (device SilentStepperBrick, err error)¶

Parameters:	uid – Type: string ipcon – Type: *IPConnection
Returns:	device – Type: SilentStepperBrick err – Type: error

Creates a new SilentStepperBrick object with the unique device ID uid and adds it to the IPConnection ipcon:

device, err := silent_stepper_brick.New("YOUR_DEVICE_UID", &ipcon)

This device object can be used after the IPConnection has been connected.

func (*SilentStepperBrick) SetMaxVelocity(velocity uint16) (err error)¶

Parameters:	velocity – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1]
Returns:	err – Type: error

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 SetTargetPosition(), SetSteps(), DriveForward() or DriveBackward().

func (*SilentStepperBrick) GetMaxVelocity() (velocity uint16, err error)¶

Returns:	velocity – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1] err – Type: error

Returns the velocity as set by SetMaxVelocity().

func (*SilentStepperBrick) GetCurrentVelocity() (velocity uint16, err error)¶

Returns:	velocity – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1] err – Type: error

Returns the current velocity of the stepper motor.

func (*SilentStepperBrick) SetSpeedRamping(acceleration uint16, deacceleration uint16) (err error)¶

Parameters:	acceleration – Type: uint16, Unit: 1 1/s², Range: [0 to 2¹⁶ - 1], Default: 1000 deacceleration – Type: uint16, Unit: 1 1/s², Range: [0 to 2¹⁶ - 1], Default: 1000
Returns:	err – Type: error

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)

func (*SilentStepperBrick) GetSpeedRamping() (acceleration uint16, deacceleration uint16, err error)¶

Returns:	acceleration – Type: uint16, Unit: 1 1/s², Range: [0 to 2¹⁶ - 1], Default: 1000 deacceleration – Type: uint16, Unit: 1 1/s², Range: [0 to 2¹⁶ - 1], Default: 1000 err – Type: error

Returns the acceleration and deacceleration as set by SetSpeedRamping().

func (*SilentStepperBrick) FullBrake() (err error)¶

Returns:	err – Type: error

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.

func (*SilentStepperBrick) SetSteps(steps int32) (err error)¶

Parameters:	steps – Type: int32, Range: [-2³¹ to 2³¹ - 1]
Returns:	err – Type: error

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 SetMaxVelocity() and SetSpeedRamping() will be used.

func (*SilentStepperBrick) GetSteps() (steps int32, err error)¶

Returns:	steps – Type: int32, Range: [-2³¹ to 2³¹ - 1] err – Type: error

Returns the last steps as set by SetSteps().

func (*SilentStepperBrick) GetRemainingSteps() (steps int32, err error)¶

Returns:	steps – Type: int32, Range: [-2³¹ to 2³¹ - 1] err – Type: error

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

func (*SilentStepperBrick) DriveForward() (err error)¶

Returns:	err – Type: error

Drives the stepper motor forward until DriveBackward() or Stop() is called. The velocity, acceleration and deacceleration as set by SetMaxVelocity() and SetSpeedRamping() will be used.

func (*SilentStepperBrick) DriveBackward() (err error)¶

Returns:	err – Type: error

Drives the stepper motor backward until DriveForward() or Stop() is triggered. The velocity, acceleration and deacceleration as set by SetMaxVelocity() and SetSpeedRamping() will be used.

func (*SilentStepperBrick) Stop() (err error)¶

Returns:	err – Type: error

Stops the stepper motor with the deacceleration as set by SetSpeedRamping().

func (*SilentStepperBrick) SetMotorCurrent(current uint16) (err error)¶

Parameters:	current – Type: uint16, Unit: 1 mA, Range: [360 to 1640], Default: 800
Returns:	err – Type: error

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.

func (*SilentStepperBrick) GetMotorCurrent() (current uint16, err error)¶

Returns:	current – Type: uint16, Unit: 1 mA, Range: [360 to 1640], Default: 800 err – Type: error

Returns the current as set by SetMotorCurrent().

func (*SilentStepperBrick) Enable() (err error)¶

Returns:	err – Type: error

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

func (*SilentStepperBrick) Disable() (err error)¶

Returns:	err – Type: error

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.

func (*SilentStepperBrick) IsEnabled() (enabled bool, err error)¶

Returns:	enabled – Type: bool, Default: false err – Type: error

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

func (*SilentStepperBrick) SetBasicConfiguration(standstillCurrent uint16, motorRunCurrent uint16, standstillDelayTime uint16, powerDownTime uint16, stealthThreshold uint16, coolstepThreshold uint16, classicThreshold uint16, highVelocityChopperMode bool) (err error)¶

Parameters:

Parameters:	standstillCurrent – Type: uint16, Unit: 1 mA, Range: [0 to 2¹⁶ - 1], Default: 200 motorRunCurrent – Type: uint16, Unit: 1 mA, Range: [0 to 2¹⁶ - 1], Default: 800 standstillDelayTime – Type: uint16, Unit: 1 ms, Range: [0 to 307], Default: 0 powerDownTime – Type: uint16, Unit: 1 ms, Range: [0 to 5222], Default: 1000 stealthThreshold – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1], Default: 500 coolstepThreshold – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1], Default: 500 classicThreshold – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1], Default: 1000 highVelocityChopperMode – Type: bool, Default: false
Returns:	err – Type: error

standstillCurrent – Type: uint16, Unit: 1 mA, Range: [0 to 2¹⁶ - 1], Default: 200
motorRunCurrent – Type: uint16, Unit: 1 mA, Range: [0 to 2¹⁶ - 1], Default: 800
standstillDelayTime – Type: uint16, Unit: 1 ms, Range: [0 to 307], Default: 0
powerDownTime – Type: uint16, Unit: 1 ms, Range: [0 to 5222], Default: 1000
stealthThreshold – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1], Default: 500
coolstepThreshold – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1], Default: 500
classicThreshold – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1], Default: 1000
highVelocityChopperMode – Type: bool, Default: false

Returns:

err – Type: error

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 SetMotorCurrent()).
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 SetMotorCurrent()).
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.

func (*SilentStepperBrick) GetBasicConfiguration() (standstillCurrent uint16, motorRunCurrent uint16, standstillDelayTime uint16, powerDownTime uint16, stealthThreshold uint16, coolstepThreshold uint16, classicThreshold uint16, highVelocityChopperMode bool, err error)¶

Returns:

Returns:	standstillCurrent – Type: uint16, Unit: 1 mA, Range: [0 to 2¹⁶ - 1], Default: 200 motorRunCurrent – Type: uint16, Unit: 1 mA, Range: [0 to 2¹⁶ - 1], Default: 800 standstillDelayTime – Type: uint16, Unit: 1 ms, Range: [0 to 307], Default: 0 powerDownTime – Type: uint16, Unit: 1 ms, Range: [0 to 5222], Default: 1000 stealthThreshold – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1], Default: 500 coolstepThreshold – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1], Default: 500 classicThreshold – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1], Default: 1000 highVelocityChopperMode – Type: bool, Default: false err – Type: error

standstillCurrent – Type: uint16, Unit: 1 mA, Range: [0 to 2¹⁶ - 1], Default: 200
motorRunCurrent – Type: uint16, Unit: 1 mA, Range: [0 to 2¹⁶ - 1], Default: 800
standstillDelayTime – Type: uint16, Unit: 1 ms, Range: [0 to 307], Default: 0
powerDownTime – Type: uint16, Unit: 1 ms, Range: [0 to 5222], Default: 1000
stealthThreshold – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1], Default: 500
coolstepThreshold – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1], Default: 500
classicThreshold – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1], Default: 1000
highVelocityChopperMode – Type: bool, Default: false
err – Type: error

Returns the configuration as set by SetBasicConfiguration().

Advanced Functions¶

func (*SilentStepperBrick) SetCurrentPosition(position int32) (err error)¶

Parameters:	position – Type: int32, Range: [-2³¹ to 2³¹ - 1]
Returns:	err – Type: error

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

func (*SilentStepperBrick) GetCurrentPosition() (position int32, err error)¶

Returns:	position – Type: int32, Range: [-2³¹ to 2³¹ - 1] err – Type: error

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 (SetTargetPosition(), SetSteps(), DriveForward() or DriveBackward()). It also is possible to reset the steps to 0 or set them to any other desired value with SetCurrentPosition().

func (*SilentStepperBrick) SetTargetPosition(position int32) (err error)¶

Parameters:	position – Type: int32, Range: [-2³¹ to 2³¹ - 1]
Returns:	err – Type: error

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

A call of SetTargetPosition() with the parameter x is equivalent to a call of SetSteps() with the parameter (x - GetCurrentPosition()).

func (*SilentStepperBrick) GetTargetPosition() (position int32, err error)¶

Returns:	position – Type: int32, Range: [-2³¹ to 2³¹ - 1] err – Type: error

Returns the last target position as set by SetTargetPosition().

func (*SilentStepperBrick) SetStepConfiguration(stepResolution uint8, interpolation bool) (err error)¶

Parameters:	stepResolution – Type: uint8, Range: See constants, Default: 0 interpolation – Type: bool, Default: true
Returns:	err – Type: error

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 constants are available for this function:

For stepResolution:

silent_stepper_brick.StepResolution1 = 8
silent_stepper_brick.StepResolution2 = 7
silent_stepper_brick.StepResolution4 = 6
silent_stepper_brick.StepResolution8 = 5
silent_stepper_brick.StepResolution16 = 4
silent_stepper_brick.StepResolution32 = 3
silent_stepper_brick.StepResolution64 = 2
silent_stepper_brick.StepResolution128 = 1
silent_stepper_brick.StepResolution256 = 0

func (*SilentStepperBrick) GetStepConfiguration() (stepResolution uint8, interpolation bool, err error)¶

Returns:	stepResolution – Type: uint8, Range: See constants interpolation – Type: bool, Default: true err – Type: error

Returns the step mode as set by SetStepConfiguration().

The following constants are available for this function:

For stepResolution:

silent_stepper_brick.StepResolution1 = 8
silent_stepper_brick.StepResolution2 = 7
silent_stepper_brick.StepResolution4 = 6
silent_stepper_brick.StepResolution8 = 5
silent_stepper_brick.StepResolution16 = 4
silent_stepper_brick.StepResolution32 = 3
silent_stepper_brick.StepResolution64 = 2
silent_stepper_brick.StepResolution128 = 1
silent_stepper_brick.StepResolution256 = 0

func (*SilentStepperBrick) GetStackInputVoltage() (voltage uint16, err error)¶

Returns:	voltage – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1] err – Type: error

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.

func (*SilentStepperBrick) GetExternalInputVoltage() (voltage uint16, err error)¶

Returns:	voltage – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1] err – Type: error

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

func (*SilentStepperBrick) SetSpreadcycleConfiguration(slowDecayDuration uint8, enableRandomSlowDecay bool, fastDecayDuration uint8, hysteresisStartValue uint8, hysteresisEndValue int8, sineWaveOffset int8, chopperMode uint8, comparatorBlankTime uint8, fastDecayWithoutComparator bool) (err error)¶

Parameters:

Parameters:	slowDecayDuration – Type: uint8, Range: [0 to 15], Default: 4 enableRandomSlowDecay – Type: bool, Default: false fastDecayDuration – Type: uint8, Range: [0 to 15], Default: 0 hysteresisStartValue – Type: uint8, Range: [0 to 7], Default: 0 hysteresisEndValue – Type: int8, Range: [-3 to 12], Default: 0 sineWaveOffset – Type: int8, Range: [-3 to 12], Default: 0 chopperMode – Type: uint8, Range: See constants, Default: 0 comparatorBlankTime – Type: uint8, Range: [0 to 3], Default: 1 fastDecayWithoutComparator – Type: bool, Default: false
Returns:	err – Type: error

slowDecayDuration – Type: uint8, Range: [0 to 15], Default: 4
enableRandomSlowDecay – Type: bool, Default: false
fastDecayDuration – Type: uint8, Range: [0 to 15], Default: 0
hysteresisStartValue – Type: uint8, Range: [0 to 7], Default: 0
hysteresisEndValue – Type: int8, Range: [-3 to 12], Default: 0
sineWaveOffset – Type: int8, Range: [-3 to 12], Default: 0
chopperMode – Type: uint8, Range: See constants, Default: 0
comparatorBlankTime – Type: uint8, Range: [0 to 3], Default: 1
fastDecayWithoutComparator – Type: bool, Default: false

Returns:

err – Type: error

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 constants are available for this function:

For chopperMode:

silent_stepper_brick.ChopperModeSpreadCycle = 0
silent_stepper_brick.ChopperModeFastDecay = 1

func (*SilentStepperBrick) GetSpreadcycleConfiguration() (slowDecayDuration uint8, enableRandomSlowDecay bool, fastDecayDuration uint8, hysteresisStartValue uint8, hysteresisEndValue int8, sineWaveOffset int8, chopperMode uint8, comparatorBlankTime uint8, fastDecayWithoutComparator bool, err error)¶

Returns:

Returns:	slowDecayDuration – Type: uint8, Range: [0 to 15], Default: 4 enableRandomSlowDecay – Type: bool, Default: false fastDecayDuration – Type: uint8, Range: [0 to 15], Default: 0 hysteresisStartValue – Type: uint8, Range: [0 to 7], Default: 0 hysteresisEndValue – Type: int8, Range: [-3 to 12], Default: 0 sineWaveOffset – Type: int8, Range: [-3 to 12], Default: 0 chopperMode – Type: uint8, Range: See constants, Default: 0 comparatorBlankTime – Type: uint8, Range: [0 to 3], Default: 1 fastDecayWithoutComparator – Type: bool, Default: false err – Type: error

slowDecayDuration – Type: uint8, Range: [0 to 15], Default: 4
enableRandomSlowDecay – Type: bool, Default: false
fastDecayDuration – Type: uint8, Range: [0 to 15], Default: 0
hysteresisStartValue – Type: uint8, Range: [0 to 7], Default: 0
hysteresisEndValue – Type: int8, Range: [-3 to 12], Default: 0
sineWaveOffset – Type: int8, Range: [-3 to 12], Default: 0
chopperMode – Type: uint8, Range: See constants, Default: 0
comparatorBlankTime – Type: uint8, Range: [0 to 3], Default: 1
fastDecayWithoutComparator – Type: bool, Default: false
err – Type: error

Returns the configuration as set by SetBasicConfiguration().

The following constants are available for this function:

For chopperMode:

silent_stepper_brick.ChopperModeSpreadCycle = 0
silent_stepper_brick.ChopperModeFastDecay = 1

func (*SilentStepperBrick) SetStealthConfiguration(enableStealth bool, amplitude uint8, gradient uint8, enableAutoscale bool, forceSymmetric bool, freewheelMode uint8) (err error)¶

Parameters:	enableStealth – Type: bool, Default: true amplitude – Type: uint8, Range: [0 to 255], Default: 128 gradient – Type: uint8, Range: [0 to 255], Default: 4 enableAutoscale – Type: bool, Default: true forceSymmetric – Type: bool, Default: false freewheelMode – Type: uint8, Range: See constants, Default: 0
Returns:	err – Type: error

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 SetBasicConfiguration().
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 SetBasicConfiguration()) is set to 0.

The following constants are available for this function:

For freewheelMode:

silent_stepper_brick.FreewheelModeNormal = 0
silent_stepper_brick.FreewheelModeFreewheeling = 1
silent_stepper_brick.FreewheelModeCoilShortLS = 2
silent_stepper_brick.FreewheelModeCoilShortHS = 3

func (*SilentStepperBrick) GetStealthConfiguration() (enableStealth bool, amplitude uint8, gradient uint8, enableAutoscale bool, forceSymmetric bool, freewheelMode uint8, err error)¶

Returns:	enableStealth – Type: bool, Default: true amplitude – Type: uint8, Range: [0 to 255], Default: 128 gradient – Type: uint8, Range: [0 to 255], Default: 4 enableAutoscale – Type: bool, Default: true forceSymmetric – Type: bool, Default: false freewheelMode – Type: uint8, Range: See constants, Default: 0 err – Type: error

Returns the configuration as set by SetStealthConfiguration().

The following constants are available for this function:

For freewheelMode:

silent_stepper_brick.FreewheelModeNormal = 0
silent_stepper_brick.FreewheelModeFreewheeling = 1
silent_stepper_brick.FreewheelModeCoilShortLS = 2
silent_stepper_brick.FreewheelModeCoilShortHS = 3

func (*SilentStepperBrick) SetCoolstepConfiguration(minimumStallguardValue uint8, maximumStallguardValue uint8, currentUpStepWidth uint8, currentDownStepWidth uint8, minimumCurrent uint8, stallguardThresholdValue int8, stallguardMode uint8) (err error)¶

Parameters:

Parameters:	minimumStallguardValue – Type: uint8, Range: [0 to 15], Default: 2 maximumStallguardValue – Type: uint8, Range: [0 to 15], Default: 10 currentUpStepWidth – Type: uint8, Range: See constants, Default: 0 currentDownStepWidth – Type: uint8, Range: See constants, Default: 0 minimumCurrent – Type: uint8, Range: See constants, Default: 0 stallguardThresholdValue – Type: int8, Range: [-64 to 63], Default: 0 stallguardMode – Type: uint8, Range: See constants, Default: 0
Returns:	err – Type: error

minimumStallguardValue – Type: uint8, Range: [0 to 15], Default: 2
maximumStallguardValue – Type: uint8, Range: [0 to 15], Default: 10
currentUpStepWidth – Type: uint8, Range: See constants, Default: 0
currentDownStepWidth – Type: uint8, Range: See constants, Default: 0
minimumCurrent – Type: uint8, Range: See constants, Default: 0
stallguardThresholdValue – Type: int8, Range: [-64 to 63], Default: 0
stallguardMode – Type: uint8, Range: See constants, Default: 0

Returns:

err – Type: error

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 GetDriverStatus()). 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 constants are available for this function:

For currentUpStepWidth:

silent_stepper_brick.CurrentUpStepIncrement1 = 0
silent_stepper_brick.CurrentUpStepIncrement2 = 1
silent_stepper_brick.CurrentUpStepIncrement4 = 2
silent_stepper_brick.CurrentUpStepIncrement8 = 3

For currentDownStepWidth:

silent_stepper_brick.CurrentDownStepDecrement1 = 0
silent_stepper_brick.CurrentDownStepDecrement2 = 1
silent_stepper_brick.CurrentDownStepDecrement8 = 2
silent_stepper_brick.CurrentDownStepDecrement32 = 3

For minimumCurrent:

silent_stepper_brick.MinimumCurrentHalf = 0
silent_stepper_brick.MinimumCurrentQuarter = 1

For stallguardMode:

silent_stepper_brick.StallguardModeStandard = 0
silent_stepper_brick.StallguardModeFiltered = 1

func (*SilentStepperBrick) GetCoolstepConfiguration() (minimumStallguardValue uint8, maximumStallguardValue uint8, currentUpStepWidth uint8, currentDownStepWidth uint8, minimumCurrent uint8, stallguardThresholdValue int8, stallguardMode uint8, err error)¶

Returns:

Returns:	minimumStallguardValue – Type: uint8, Range: [0 to 15], Default: 2 maximumStallguardValue – Type: uint8, Range: [0 to 15], Default: 10 currentUpStepWidth – Type: uint8, Range: See constants, Default: 0 currentDownStepWidth – Type: uint8, Range: See constants, Default: 0 minimumCurrent – Type: uint8, Range: See constants, Default: 0 stallguardThresholdValue – Type: int8, Range: [-64 to 63], Default: 0 stallguardMode – Type: uint8, Range: See constants, Default: 0 err – Type: error

minimumStallguardValue – Type: uint8, Range: [0 to 15], Default: 2
maximumStallguardValue – Type: uint8, Range: [0 to 15], Default: 10
currentUpStepWidth – Type: uint8, Range: See constants, Default: 0
currentDownStepWidth – Type: uint8, Range: See constants, Default: 0
minimumCurrent – Type: uint8, Range: See constants, Default: 0
stallguardThresholdValue – Type: int8, Range: [-64 to 63], Default: 0
stallguardMode – Type: uint8, Range: See constants, Default: 0
err – Type: error

Returns the configuration as set by SetCoolstepConfiguration().

The following constants are available for this function:

For currentUpStepWidth:

silent_stepper_brick.CurrentUpStepIncrement1 = 0
silent_stepper_brick.CurrentUpStepIncrement2 = 1
silent_stepper_brick.CurrentUpStepIncrement4 = 2
silent_stepper_brick.CurrentUpStepIncrement8 = 3

For currentDownStepWidth:

silent_stepper_brick.CurrentDownStepDecrement1 = 0
silent_stepper_brick.CurrentDownStepDecrement2 = 1
silent_stepper_brick.CurrentDownStepDecrement8 = 2
silent_stepper_brick.CurrentDownStepDecrement32 = 3

For minimumCurrent:

silent_stepper_brick.MinimumCurrentHalf = 0
silent_stepper_brick.MinimumCurrentQuarter = 1

For stallguardMode:

silent_stepper_brick.StallguardModeStandard = 0
silent_stepper_brick.StallguardModeFiltered = 1

func (*SilentStepperBrick) SetMiscConfiguration(disableShortToGroundProtection bool, synchronizePhaseFrequency uint8) (err error)¶

Parameters:	disableShortToGroundProtection – Type: bool, Default: false synchronizePhaseFrequency – Type: uint8, Range: [0 to 15], Default: 0
Returns:	err – Type: error

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.

func (*SilentStepperBrick) GetMiscConfiguration() (disableShortToGroundProtection bool, synchronizePhaseFrequency uint8, err error)¶

Returns:	disableShortToGroundProtection – Type: bool, Default: false synchronizePhaseFrequency – Type: uint8, Range: [0 to 15], Default: 0 err – Type: error

Returns the configuration as set by SetMiscConfiguration().

func (*SilentStepperBrick) GetDriverStatus() (openLoad uint8, shortToGround uint8, overTemperature uint8, motorStalled bool, actualMotorCurrent uint8, fullStepActive bool, stallguardResult uint8, stealthVoltageAmplitude uint8, err error)¶

Returns:

Returns:	openLoad – Type: uint8, Range: See constants shortToGround – Type: uint8, Range: See constants overTemperature – Type: uint8, Range: See constants motorStalled – Type: bool actualMotorCurrent – Type: uint8, Range: [0 to 31] fullStepActive – Type: bool stallguardResult – Type: uint8, Range: [0 to 255] stealthVoltageAmplitude – Type: uint8, Range: [0 to 255] err – Type: error

openLoad – Type: uint8, Range: See constants
shortToGround – Type: uint8, Range: See constants
overTemperature – Type: uint8, Range: See constants
motorStalled – Type: bool
actualMotorCurrent – Type: uint8, Range: [0 to 31]
fullStepActive – Type: bool
stallguardResult – Type: uint8, Range: [0 to 255]
stealthVoltageAmplitude – Type: uint8, Range: [0 to 255]
err – Type: error

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 SetBasicConfiguration(). 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 SetStealthConfiguration()).

The following constants are available for this function:

For openLoad:

silent_stepper_brick.OpenLoadNone = 0
silent_stepper_brick.OpenLoadPhaseA = 1
silent_stepper_brick.OpenLoadPhaseB = 2
silent_stepper_brick.OpenLoadPhaseAB = 3

For shortToGround:

silent_stepper_brick.ShortToGroundNone = 0
silent_stepper_brick.ShortToGroundPhaseA = 1
silent_stepper_brick.ShortToGroundPhaseB = 2
silent_stepper_brick.ShortToGroundPhaseAB = 3

For overTemperature:

silent_stepper_brick.OverTemperatureNone = 0
silent_stepper_brick.OverTemperatureWarning = 1
silent_stepper_brick.OverTemperatureLimit = 2

func (*SilentStepperBrick) SetTimeBase(timeBase uint32) (err error)¶

Parameters:	timeBase – Type: uint32, Unit: 1 s, Range: [0 to 2³² - 1], Default: 1
Returns:	err – Type: error

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.

func (*SilentStepperBrick) GetTimeBase() (timeBase uint32, err error)¶

Returns:	timeBase – Type: uint32, Unit: 1 s, Range: [0 to 2³² - 1], Default: 1 err – Type: error

Returns the time base as set by SetTimeBase().

func (*SilentStepperBrick) GetAllData() (currentVelocity uint16, currentPosition int32, remainingSteps int32, stackVoltage uint16, externalVoltage uint16, currentConsumption uint16, err error)¶

Returns:

Returns:	currentVelocity – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1] currentPosition – Type: int32, Range: [-2³¹ to 2³¹ - 1] remainingSteps – Type: int32, Range: [-2³¹ to 2³¹ - 1] stackVoltage – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1] externalVoltage – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1] currentConsumption – Type: uint16, Unit: 1 mA, Range: [0 to 2¹⁶ - 1] err – Type: error

currentVelocity – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1]
currentPosition – Type: int32, Range: [-2³¹ to 2³¹ - 1]
remainingSteps – Type: int32, Range: [-2³¹ to 2³¹ - 1]
stackVoltage – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]
externalVoltage – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]
currentConsumption – Type: uint16, Unit: 1 mA, Range: [0 to 2¹⁶ - 1]
err – Type: error

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 SetBasicConfiguration()) with the Motor Run Current (see GetDriverStatus()). 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 AllDataCallback callback.

func (*SilentStepperBrick) SetSPITFPBaudrateConfig(enableDynamicBaudrate bool, minimumDynamicBaudrate uint32) (err error)¶

Parameters:	enableDynamicBaudrate – Type: bool, Default: true minimumDynamicBaudrate – Type: uint32, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000
Returns:	err – Type: error

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 SetSPITFPBaudrate(). If the dynamic baudrate is disabled, the baudrate as set by SetSPITFPBaudrate() will be used statically.

New in version 2.0.4 (Firmware).

func (*SilentStepperBrick) GetSPITFPBaudrateConfig() (enableDynamicBaudrate bool, minimumDynamicBaudrate uint32, err error)¶

Returns:	enableDynamicBaudrate – Type: bool, Default: true minimumDynamicBaudrate – Type: uint32, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000 err – Type: error

Returns the baudrate config, see SetSPITFPBaudrateConfig().

New in version 2.0.4 (Firmware).

func (*SilentStepperBrick) GetSendTimeoutCount(communicationMethod uint8) (timeoutCount uint32, err error)¶

Parameters:	communicationMethod – Type: uint8, Range: See constants
Returns:	timeoutCount – Type: uint32, Range: [0 to 2³² - 1] err – Type: error

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 constants are available for this function:

For communicationMethod:

silent_stepper_brick.CommunicationMethodNone = 0
silent_stepper_brick.CommunicationMethodUSB = 1
silent_stepper_brick.CommunicationMethodSPIStack = 2
silent_stepper_brick.CommunicationMethodChibi = 3
silent_stepper_brick.CommunicationMethodRS485 = 4
silent_stepper_brick.CommunicationMethodWIFI = 5
silent_stepper_brick.CommunicationMethodEthernet = 6
silent_stepper_brick.CommunicationMethodWIFIV2 = 7

func (*SilentStepperBrick) SetSPITFPBaudrate(brickletPort rune, baudrate uint32) (err error)¶

Parameters:	brickletPort – Type: rune, Range: ['a' to 'b'] baudrate – Type: uint32, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000
Returns:	err – Type: error

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 GetSPITFPErrorCount()) you can decrease the baudrate.

If the dynamic baudrate feature is enabled, the baudrate set by this function corresponds to the maximum baudrate (see SetSPITFPBaudrateConfig()).

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.

func (*SilentStepperBrick) GetSPITFPBaudrate(brickletPort rune) (baudrate uint32, err error)¶

Parameters:	brickletPort – Type: rune, Range: ['a' to 'b']
Returns:	baudrate – Type: uint32, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000 err – Type: error

Returns the baudrate for a given Bricklet port, see SetSPITFPBaudrate().

func (*SilentStepperBrick) GetSPITFPErrorCount(brickletPort rune) (errorCountACKChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)¶

Parameters:	brickletPort – Type: rune, Range: ['a' to 'b']
Returns:	errorCountACKChecksum – Type: uint32, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: uint32, Range: [0 to 2³² - 1] errorCountFrame – Type: uint32, Range: [0 to 2³² - 1] errorCountOverflow – Type: uint32, Range: [0 to 2³² - 1] err – Type: error

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.

func (*SilentStepperBrick) EnableStatusLED() (err error)¶

Returns:	err – Type: error

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.

func (*SilentStepperBrick) DisableStatusLED() (err error)¶

Returns:	err – Type: error

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.

func (*SilentStepperBrick) IsStatusLEDEnabled() (enabled bool, err error)¶

Returns:	enabled – Type: bool, Default: true err – Type: error

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

func (*SilentStepperBrick) GetChipTemperature() (temperature int16, err error)¶

Returns:	temperature – Type: int16, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1] err – Type: error

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.

func (*SilentStepperBrick) Reset() (err error)¶

Returns:	err – Type: error

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!

func (*SilentStepperBrick) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶

Returns:

uid – Type: string, Length: up to 8
connectedUid – Type: string, Length: up to 8
position – Type: rune, Range: ['0' to '8']
hardwareVersion – Type: [3]uint8

0: major – Type: uint8, Range: [0 to 255]
1: minor – Type: uint8, Range: [0 to 255]
2: revision – Type: uint8, Range: [0 to 255]

firmwareVersion – Type: [3]uint8

0: major – Type: uint8, Range: [0 to 255]
1: minor – Type: uint8, Range: [0 to 255]
2: revision – Type: uint8, Range: [0 to 255]

deviceIdentifier – Type: uint16, Range: [0 to 2¹⁶ - 1]
err – Type: error

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. There is also a constant for the device identifier of this Brick.

Callback Configuration Functions¶

func (*SilentStepperBrick) SetMinimumVoltage(voltage uint16) (err error)¶

Parameters:	voltage – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 8000
Returns:	err – Type: error

Sets the minimum voltage, below which the UnderVoltageCallback 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.

func (*SilentStepperBrick) GetMinimumVoltage() (voltage uint16, err error)¶

Returns:	voltage – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 8000 err – Type: error

Returns the minimum voltage as set by SetMinimumVoltage().

func (*SilentStepperBrick) SetAllDataPeriod(period uint32) (err error)¶

Parameters:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
Returns:	err – Type: error

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

func (*SilentStepperBrick) GetAllDataPeriod() (period uint32, err error)¶

Returns:	period – Type: uint32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0 err – Type: error

Returns the period as set by SetAllDataPeriod().

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding Register*Callback function, which returns a unique callback ID. This ID can be used to deregister the callback later with the corresponding Deregister*Callback function.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

func (*SilentStepperBrick) RegisterUnderVoltageCallback(func(voltage uint16)) (registrationId uint64)¶

Callback Parameters:	voltage – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]
Returns:	registrationId – Type: uint64

This callback is triggered when the input voltage drops below the value set by SetMinimumVoltage(). The callback parameter is the current voltage.

func (*SilentStepperBrick) RegisterPositionReachedCallback(func(position int32)) (registrationId uint64)¶

Callback Parameters:	position – Type: int32, Range: [-2³¹ to 2³¹ - 1]
Returns:	registrationId – Type: uint64

This callback is triggered when a position set by SetSteps() or SetTargetPosition() is reached.

Note

Since we can't get any feedback from the stepper motor, this only works if the acceleration (see SetSpeedRamping()) 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.

func (*SilentStepperBrick) RegisterAllDataCallback(func(currentVelocity uint16, currentPosition int32, remainingSteps int32, stackVoltage uint16, externalVoltage uint16, currentConsumption uint16)) (registrationId uint64)¶

Callback Parameters:

currentVelocity – Type: uint16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1]
currentPosition – Type: int32, Range: [-2³¹ to 2³¹ - 1]
remainingSteps – Type: int32, Range: [-2³¹ to 2³¹ - 1]
stackVoltage – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]
externalVoltage – Type: uint16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]
currentConsumption – Type: uint16, Unit: 1 mA, Range: [0 to 2¹⁶ - 1]

Returns:

registrationId – Type: uint64

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

func (*SilentStepperBrick) RegisterNewStateCallback(func(stateNew uint8, statePrevious uint8)) (registrationId uint64)¶

Callback Parameters:	stateNew – Type: uint8, Range: See constants statePrevious – Type: uint8, Range: See constants
Returns:	registrationId – Type: uint64

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 constants are available for this function:

For stateNew:

silent_stepper_brick.StateStop = 1
silent_stepper_brick.StateAcceleration = 2
silent_stepper_brick.StateRun = 3
silent_stepper_brick.StateDeacceleration = 4
silent_stepper_brick.StateDirectionChangeToForward = 5
silent_stepper_brick.StateDirectionChangeToBackward = 6

For statePrevious:

silent_stepper_brick.StateStop = 1
silent_stepper_brick.StateAcceleration = 2
silent_stepper_brick.StateRun = 3
silent_stepper_brick.StateDeacceleration = 4
silent_stepper_brick.StateDirectionChangeToForward = 5
silent_stepper_brick.StateDirectionChangeToBackward = 6

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

func (*SilentStepperBrick) GetAPIVersion() (apiVersion [3]uint8, err error)¶

Returns:	apiVersion – Type: [3]uint8 0: major – Type: uint8, Range: [0 to 255] 1: minor – Type: uint8, Range: [0 to 255] 2: revision – Type: uint8, Range: [0 to 255] err – Type: error

Returns the version of the API definition implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

func (*SilentStepperBrick) GetResponseExpected(functionId uint8) (responseExpected bool, err error)¶

Parameters:	functionId – Type: uint8, Range: See constants
Returns:	responseExpected – Type: bool err – Type: error

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected(). For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For functionId:

silent_stepper_brick.FunctionSetMaxVelocity = 1
silent_stepper_brick.FunctionSetSpeedRamping = 4
silent_stepper_brick.FunctionFullBrake = 6
silent_stepper_brick.FunctionSetCurrentPosition = 7
silent_stepper_brick.FunctionSetTargetPosition = 9
silent_stepper_brick.FunctionSetSteps = 11
silent_stepper_brick.FunctionSetStepConfiguration = 14
silent_stepper_brick.FunctionDriveForward = 16
silent_stepper_brick.FunctionDriveBackward = 17
silent_stepper_brick.FunctionStop = 18
silent_stepper_brick.FunctionSetMotorCurrent = 22
silent_stepper_brick.FunctionEnable = 24
silent_stepper_brick.FunctionDisable = 25
silent_stepper_brick.FunctionSetBasicConfiguration = 27
silent_stepper_brick.FunctionSetSpreadcycleConfiguration = 29
silent_stepper_brick.FunctionSetStealthConfiguration = 31
silent_stepper_brick.FunctionSetCoolstepConfiguration = 33
silent_stepper_brick.FunctionSetMiscConfiguration = 35
silent_stepper_brick.FunctionSetMinimumVoltage = 38
silent_stepper_brick.FunctionSetTimeBase = 42
silent_stepper_brick.FunctionSetAllDataPeriod = 45
silent_stepper_brick.FunctionSetSPITFPBaudrateConfig = 231
silent_stepper_brick.FunctionSetSPITFPBaudrate = 234
silent_stepper_brick.FunctionEnableStatusLED = 238
silent_stepper_brick.FunctionDisableStatusLED = 239
silent_stepper_brick.FunctionReset = 243
silent_stepper_brick.FunctionWriteBrickletPlugin = 246

func (*SilentStepperBrick) SetResponseExpected(functionId uint8, responseExpected bool) (err error)¶

Parameters:	functionId – Type: uint8, Range: See constants responseExpected – Type: bool
Returns:	err – Type: error

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

The following constants are available for this function:

For functionId:

silent_stepper_brick.FunctionSetMaxVelocity = 1
silent_stepper_brick.FunctionSetSpeedRamping = 4
silent_stepper_brick.FunctionFullBrake = 6
silent_stepper_brick.FunctionSetCurrentPosition = 7
silent_stepper_brick.FunctionSetTargetPosition = 9
silent_stepper_brick.FunctionSetSteps = 11
silent_stepper_brick.FunctionSetStepConfiguration = 14
silent_stepper_brick.FunctionDriveForward = 16
silent_stepper_brick.FunctionDriveBackward = 17
silent_stepper_brick.FunctionStop = 18
silent_stepper_brick.FunctionSetMotorCurrent = 22
silent_stepper_brick.FunctionEnable = 24
silent_stepper_brick.FunctionDisable = 25
silent_stepper_brick.FunctionSetBasicConfiguration = 27
silent_stepper_brick.FunctionSetSpreadcycleConfiguration = 29
silent_stepper_brick.FunctionSetStealthConfiguration = 31
silent_stepper_brick.FunctionSetCoolstepConfiguration = 33
silent_stepper_brick.FunctionSetMiscConfiguration = 35
silent_stepper_brick.FunctionSetMinimumVoltage = 38
silent_stepper_brick.FunctionSetTimeBase = 42
silent_stepper_brick.FunctionSetAllDataPeriod = 45
silent_stepper_brick.FunctionSetSPITFPBaudrateConfig = 231
silent_stepper_brick.FunctionSetSPITFPBaudrate = 234
silent_stepper_brick.FunctionEnableStatusLED = 238
silent_stepper_brick.FunctionDisableStatusLED = 239
silent_stepper_brick.FunctionReset = 243
silent_stepper_brick.FunctionWriteBrickletPlugin = 246

func (*SilentStepperBrick) SetResponseExpectedAll(responseExpected bool) (err error)¶

Parameters:	responseExpected – Type: bool
Returns:	err – Type: error

Changes the response expected flag for all setter and callback configuration functions of this device at once.

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.

func (*SilentStepperBrick) GetProtocol1BrickletName(port rune) (protocolVersion uint8, firmwareVersion [3]uint8, name string, err error)¶

Parameters:	port – Type: rune, Range: ['a' to 'b']
Returns:	protocolVersion – Type: uint8, Range: [0 to 255] firmwareVersion – Type: [3]uint8 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: string, Length: up to 40 err – Type: error

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.

func (*SilentStepperBrick) WriteBrickletPlugin(port rune, offset uint8, chunk [32]uint8) (err error)¶

Parameters:	port – Type: rune, Range: ['a' to 'b'] offset – Type: uint8, Range: [0 to 255] chunk – Type: [32]uint8, Range: [0 to 255]
Returns:	err – Type: error

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.

func (*SilentStepperBrick) ReadBrickletPlugin(port rune, offset uint8) (chunk [32]uint8, err error)¶

Parameters:	port – Type: rune, Range: ['a' to 'b'] offset – Type: uint8, Range: [0 to 255]
Returns:	chunk – Type: [32]uint8, Range: [0 to 255] err – Type: error

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.

Constants¶

silent_stepper_brick.DeviceIdentifier¶

This constant is used to identify a Silent Stepper Brick.

The GetIdentity() function and the (*IPConnection) RegisterEnumerateCallback callback of the IPConnection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

silent_stepper_brick.DeviceDisplayName¶: This constant represents the human readable name of a Silent Stepper Brick.