Software / API Bindings / MQTT / API Reference and Examples / Bricks (Discontinued) / Stepper Brick

MQTT - Stepper Brick¶

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

An installation guide for the MQTT API bindings is part of their general description.

Examples¶

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

Configuration¶

Download (example-configuration.txt)

# Change XXYYZZ to the UID of your Stepper Brick

setup:
    publish '{"current": 800}' to tinkerforge/request/stepper_brick/XXYYZZ/set_motor_current # 800 mA

    publish '{"mode": "eighth_step"}' to tinkerforge/request/stepper_brick/XXYYZZ/set_step_mode # 1/8 step mode

    publish '{"velocity": 2000}' to tinkerforge/request/stepper_brick/XXYYZZ/set_max_velocity # Velocity 2000 steps/s

    # Slow acceleration (500 steps/s^2),
    # Fast deacceleration (5000 steps/s^2)
    publish '{"acceleration": 500, "deacceleration": 5000}' to tinkerforge/request/stepper_brick/XXYYZZ/set_speed_ramping

    publish '' to tinkerforge/request/stepper_brick/XXYYZZ/enable # Enable motor power

    publish '{"steps": 60000}' to tinkerforge/request/stepper_brick/XXYYZZ/set_steps # Drive 60000 steps forward

cleanup:
    # If you are done, run this to clean up
    # Stop motor before disabling motor power
    publish '' to tinkerforge/request/stepper_brick/XXYYZZ/stop # Request motor stop

    publish '{"acceleration": 500, "deacceleration": 5000}' to tinkerforge/request/stepper_brick/XXYYZZ/set_speed_ramping # Fast deacceleration (5000 steps/s^2) for stopping

    wait for 0.4s # Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s

    publish '' to tinkerforge/request/stepper_brick/XXYYZZ/disable # Disable motor power

Callback¶

Download (example-callback.txt)

# Change XXYYZZ to the UID of your Stepper Brick

setup:
    # Use position reached callback to program random movement
    subscribe to tinkerforge/callback/stepper_brick/XXYYZZ/position_reached
        if a message arives
            # message contains the current position as int
            generate random numbers r,
                                    steps [1000;5000],
                                    vel [200; 2000],
                                    acc [100; 1000] and
                                    dec [100; 1000]

            if r is even
                # Driving forward
            else
                # Driving backward
                set steps to -steps
            endif

            publish '{"acceleration": acc, "deceleration": dec}' to tinkerforge/request/stepper_brick/XXYYZZ/set_speed_ramping
            publish '{"velocity": vel}' to tinkerforge/request/stepper_brick/XXYYZZ/set_max_velocity
            publish '{"steps": steps}' to tinkerforge/request/stepper_brick/XXYYZZ/set_steps
        endif
    endsubscribe

    publish '{"register": true}' to tinkerforge/register/stepper_brick/XXYYZZ/position_reached # Register position_reached callback

    publish '' to tinkerforge/request/stepper_brick/XXYYZZ/enable # Enable motor power

    publish '{"steps": 1}' to tinkerforge/request/stepper_brick/XXYYZZ/set_steps # Drive one step forward to get things going

cleanup:
    # If you are done, run this to clean up
    # Stop motor before disabling motor power
    publish '' to tinkerforge/request/stepper_brick/XXYYZZ/stop # Request motor stop

    publish '{"acceleration": 500, "deacceleration": 5000}' to tinkerforge/request/stepper_brick/XXYYZZ/set_speed_ramping # Fast deacceleration (5000 steps/s^2) for stopping

    wait for 0.4s # Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s

    publish '' to tinkerforge/request/stepper_brick/XXYYZZ/disable # Disable motor power

API¶

All published payloads to and from the MQTT bindings are in JSON format.

If an error occures, the bindings publish a JSON object containing the error message as member _ERROR. It is published on the corresponding response topic: .../response/... for .../request/... and .../callback/... for .../register/....

Basic Functions¶

request/stepper_brick/<UID>/set_max_velocity¶

Request:	velocity – Type: int, Unit: 1 1/s, Range: [0 to 2¹⁶ - 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 request/stepper_brick/<UID>/set_target_position, request/stepper_brick/<UID>/set_steps, request/stepper_brick/<UID>/drive_forward or request/stepper_brick/<UID>/drive_backward.

request/stepper_brick/<UID>/get_max_velocity¶

Request:	empty payload
Response:	velocity – Type: int, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1]

Returns the velocity as set by request/stepper_brick/<UID>/set_max_velocity.

request/stepper_brick/<UID>/get_current_velocity¶

Request:	empty payload
Response:	velocity – Type: int, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1]

Returns the current velocity of the stepper motor.

request/stepper_brick/<UID>/set_speed_ramping¶

Request:	acceleration – Type: int, Unit: 1 1/s², Range: [0 to 2¹⁶ - 1], Default: 1000 deacceleration – Type: int, Unit: 1 1/s², Range: [0 to 2¹⁶ - 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)

request/stepper_brick/<UID>/get_speed_ramping¶

Request:	empty payload
Response:	acceleration – Type: int, Unit: 1 1/s², Range: [0 to 2¹⁶ - 1], Default: 1000 deacceleration – Type: int, Unit: 1 1/s², Range: [0 to 2¹⁶ - 1], Default: 1000

Returns the acceleration and deacceleration as set by request/stepper_brick/<UID>/set_speed_ramping.

request/stepper_brick/<UID>/full_brake¶

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 request/stepper_brick/<UID>/stop if you just want to stop the motor.

request/stepper_brick/<UID>/set_steps¶

Request:	steps – Type: int, Range: [-2³¹ to 2³¹ - 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 request/stepper_brick/<UID>/set_max_velocity and request/stepper_brick/<UID>/set_speed_ramping will be used.

request/stepper_brick/<UID>/get_steps¶

Request:	empty payload
Response:	steps – Type: int, Range: [-2³¹ to 2³¹ - 1]

Returns the last steps as set by request/stepper_brick/<UID>/set_steps.

request/stepper_brick/<UID>/get_remaining_steps¶

Request:	empty payload
Response:	steps – Type: int, Range: [-2³¹ to 2³¹ - 1]

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

request/stepper_brick/<UID>/drive_forward¶

Request:	empty payload
Response:	no response

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

request/stepper_brick/<UID>/drive_backward¶

Request:	empty payload
Response:	no response

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

request/stepper_brick/<UID>/stop¶

Request:	empty payload
Response:	no response

Stops the stepper motor with the deacceleration as set by request/stepper_brick/<UID>/set_speed_ramping.

request/stepper_brick/<UID>/set_motor_current¶

Request:	current – Type: int, Unit: 1 mA, Range: [100 to 2291], 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.

request/stepper_brick/<UID>/get_motor_current¶

Request:	empty payload
Response:	current – Type: int, Unit: 1 mA, Range: [100 to 2291], Default: 800

Returns the current as set by request/stepper_brick/<UID>/set_motor_current.

request/stepper_brick/<UID>/enable¶

Request:	empty payload
Response:	no response

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

request/stepper_brick/<UID>/disable¶

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 request/stepper_brick/<UID>/stop function before disabling the motor power. The request/stepper_brick/<UID>/stop function will not wait until the motor is actually stopped. You have to explicitly wait for the appropriate time after calling the request/stepper_brick/<UID>/stop function before calling the request/stepper_brick/<UID>/disable function.

request/stepper_brick/<UID>/is_enabled¶

Request:	empty payload
Response:	enabled – Type: bool, Default: false

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

Advanced Functions¶

request/stepper_brick/<UID>/set_current_position¶

Request:	position – Type: int, Range: [-2³¹ to 2³¹ - 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).

request/stepper_brick/<UID>/get_current_position¶

Request:	empty payload
Response:	position – Type: int, Range: [-2³¹ to 2³¹ - 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 (request/stepper_brick/<UID>/set_target_position, request/stepper_brick/<UID>/set_steps, request/stepper_brick/<UID>/drive_forward or request/stepper_brick/<UID>/drive_backward). It also is possible to reset the steps to 0 or set them to any other desired value with request/stepper_brick/<UID>/set_current_position.

request/stepper_brick/<UID>/set_target_position¶

Request:	position – Type: int, Range: [-2³¹ to 2³¹ - 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 request/stepper_brick/<UID>/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 request/stepper_brick/<UID>/set_max_velocity and request/stepper_brick/<UID>/set_speed_ramping.

A call of request/stepper_brick/<UID>/set_target_position with the parameter x is equivalent to a call of request/stepper_brick/<UID>/set_steps with the parameter (x - request/stepper_brick/<UID>/get_current_position).

request/stepper_brick/<UID>/get_target_position¶

Request:	empty payload
Response:	position – Type: int, Range: [-2³¹ to 2³¹ - 1]

Returns the last target position as set by request/stepper_brick/<UID>/set_target_position.

request/stepper_brick/<UID>/set_step_mode¶

Request:	mode – Type: int, Range: See symbols, Default: 8
Response:	no response

Sets the step mode of the stepper motor. Possible values are:

Full Step = 1
Half Step = 2
Quarter Step = 4
Eighth Step = 8

A higher value will increase the resolution and decrease the torque of the stepper motor.

The following symbols are available for this function:

For mode:

"full_step" = 1
"half_step" = 2
"quarter_step" = 4
"eighth_step" = 8

request/stepper_brick/<UID>/get_step_mode¶

Request:	empty payload
Response:	mode – Type: int, Range: See symbols, Default: 8

Returns the step mode as set by request/stepper_brick/<UID>/set_step_mode.

The following symbols are available for this function:

For mode:

"full_step" = 1
"half_step" = 2
"quarter_step" = 4
"eighth_step" = 8

request/stepper_brick/<UID>/get_stack_input_voltage¶

Request:	empty payload
Response:	voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 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.

request/stepper_brick/<UID>/get_external_input_voltage¶

Request:	empty payload
Response:	voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]

Returns the external input voltage. The external input voltage is given via the black power input connector on the 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

request/stepper_brick/<UID>/get_current_consumption¶

Request:	empty payload
Response:	current – Type: int, Unit: 1 mA, Range: [0 to 2¹⁶ - 1]

Returns the current consumption of the motor.

request/stepper_brick/<UID>/set_decay¶

Request:	decay – Type: int, Range: [0 to 2¹⁶ - 1], Default: 10000
Response:	no response

Sets the decay mode of the stepper motor. A value of 0 sets the fast decay mode, a value of 65535 sets the slow decay mode and a value in between sets the mixed decay mode.

Changing the decay mode is only possible if synchronous rectification is enabled (see request/stepper_brick/<UID>/set_sync_rect).

For a good explanation of the different decay modes see this blog post by Avayan.

A good decay mode is unfortunately different for every motor. The best way to work out a good decay mode for your stepper motor, if you can't measure the current with an oscilloscope, is to listen to the sound of the motor. If the value is too low, you often hear a high pitched sound and if it is too high you can often hear a humming sound.

Generally, fast decay mode (small value) will be noisier but also allow higher motor speeds.

Note

There is unfortunately no formula to calculate a perfect decay mode for a given stepper motor. If you have problems with loud noises or the maximum motor speed is too slow, you should try to tinker with the decay value

request/stepper_brick/<UID>/get_decay¶

Request:	empty payload
Response:	decay – Type: int, Range: [0 to 2¹⁶ - 1], Default: 10000

Returns the decay mode as set by request/stepper_brick/<UID>/set_decay.

request/stepper_brick/<UID>/set_sync_rect¶

Request:	sync_rect – Type: bool, Default: false
Response:	no response

Turns synchronous rectification on or off (true or false).

With synchronous rectification on, the decay can be changed (see request/stepper_brick/<UID>/set_decay). Without synchronous rectification fast decay is used.

For an explanation of synchronous rectification see here.

Warning

If you want to use high speeds (> 10000 steps/s) for a large stepper motor with a large inductivity we strongly suggest that you disable synchronous rectification. Otherwise the Brick may not be able to cope with the load and overheat.

request/stepper_brick/<UID>/is_sync_rect¶

Request:	empty payload
Response:	sync_rect – Type: bool, Default: false

Returns true if synchronous rectification is enabled, false otherwise.

request/stepper_brick/<UID>/set_time_base¶

Request:	time_base – Type: int, Unit: 1 s, Range: [0 to 2³² - 1], Default: 1
Response:	no response

Sets the time base of the velocity and the acceleration of the 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.

request/stepper_brick/<UID>/get_time_base¶

Request:	empty payload
Response:	time_base – Type: int, Unit: 1 s, Range: [0 to 2³² - 1], Default: 1

Returns the time base as set by request/stepper_brick/<UID>/set_time_base.

request/stepper_brick/<UID>/get_all_data¶

Request:

empty payload

Response:

current_velocity – Type: int, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1]
current_position – Type: int, Range: [-2³¹ to 2³¹ - 1]
remaining_steps – Type: int, Range: [-2³¹ to 2³¹ - 1]
stack_voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]
external_voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]
current_consumption – Type: int, Unit: 1 mA, Range: [0 to 2¹⁶ - 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.

There is also a callback for this function, see register/stepper_brick/<UID>/all_data callback.

request/stepper_brick/<UID>/set_spitfp_baudrate_config¶

Request:	enable_dynamic_baudrate – Type: bool, Default: true minimum_dynamic_baudrate – Type: int, 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 request/stepper_brick/<UID>/set_spitfp_baudrate. If the dynamic baudrate is disabled, the baudrate as set by request/stepper_brick/<UID>/set_spitfp_baudrate will be used statically.

New in version 2.3.6 (Firmware).

request/stepper_brick/<UID>/get_spitfp_baudrate_config¶

Request:	empty payload
Response:	enable_dynamic_baudrate – Type: bool, Default: true minimum_dynamic_baudrate – Type: int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000

Returns the baudrate config, see request/stepper_brick/<UID>/set_spitfp_baudrate_config.

New in version 2.3.6 (Firmware).

request/stepper_brick/<UID>/get_send_timeout_count¶

Request:	communication_method – Type: int, Range: See symbols
Response:	timeout_count – Type: int, Range: [0 to 2³² - 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 symbols are available for this function:

For communication_method:

"none" = 0
"usb" = 1
"spi_stack" = 2
"chibi" = 3
"rs485" = 4
"wifi" = 5
"ethernet" = 6
"wifi_v2" = 7

New in version 2.3.4 (Firmware).

request/stepper_brick/<UID>/set_spitfp_baudrate¶

Request:	bricklet_port – Type: char, Range: ["a" to "b"] baudrate – Type: int, 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 request/stepper_brick/<UID>/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 request/stepper_brick/<UID>/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.

New in version 2.3.3 (Firmware).

request/stepper_brick/<UID>/get_spitfp_baudrate¶

Request:	bricklet_port – Type: char, Range: ["a" to "b"]
Response:	baudrate – Type: int, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000

Returns the baudrate for a given Bricklet port, see request/stepper_brick/<UID>/set_spitfp_baudrate.

New in version 2.3.3 (Firmware).

request/stepper_brick/<UID>/get_spitfp_error_count¶

Request:	bricklet_port – Type: char, Range: ["a" to "b"]
Response:	error_count_ack_checksum – Type: int, Range: [0 to 2³² - 1] error_count_message_checksum – Type: int, Range: [0 to 2³² - 1] error_count_frame – Type: int, Range: [0 to 2³² - 1] error_count_overflow – Type: int, Range: [0 to 2³² - 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.

New in version 2.3.3 (Firmware).

request/stepper_brick/<UID>/enable_status_led¶

Request:	empty payload
Response:	no response

Enables the status LED.

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

The default state is enabled.

New in version 2.3.1 (Firmware).

request/stepper_brick/<UID>/disable_status_led¶

Request:	empty payload
Response:	no response

Disables the status LED.

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

The default state is enabled.

New in version 2.3.1 (Firmware).

request/stepper_brick/<UID>/is_status_led_enabled¶

Request:	empty payload
Response:	enabled – Type: bool, Default: true

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

New in version 2.3.1 (Firmware).

request/stepper_brick/<UID>/get_chip_temperature¶

Request:	empty payload
Response:	temperature – Type: int, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 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.

request/stepper_brick/<UID>/reset¶

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!

request/stepper_brick/<UID>/get_identity¶

Request:

empty payload

Response:

uid – Type: string, Length: up to 8
connected_uid – Type: string, Length: up to 8
position – Type: char, Range: ["0" to "8"]
hardware_version – Type: [int, ...], Length: 3

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

firmware_version – Type: [int, ...], Length: 3

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

device_identifier – Type: int, Range: [0 to 2¹⁶ - 1]
_display_name – Type: string

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. If symbolic output is not disabled, the device identifier is mapped to the corresponding name in the format used in topics.

The display name contains the Stepper's name in a human readable form.

Callback Configuration Functions¶

request/stepper_brick/<UID>/set_minimum_voltage¶

Request:	voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 8000
Response:	no response

Sets the minimum voltage, below which the register/stepper_brick/<UID>/under_voltage callback is triggered. The minimum possible value that works with the 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.

request/stepper_brick/<UID>/get_minimum_voltage¶

Request:	empty payload
Response:	voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1], Default: 8000

Returns the minimum voltage as set by request/stepper_brick/<UID>/set_minimum_voltage.

request/stepper_brick/<UID>/set_all_data_period¶

Request:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0
Response:	no response

Sets the period with which the register/stepper_brick/<UID>/all_data callback is triggered periodically. A value of 0 turns the callback off.

request/stepper_brick/<UID>/get_all_data_period¶

Request:	empty payload
Response:	period – Type: int, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

Returns the period as set by request/stepper_brick/<UID>/set_all_data_period.

Callbacks¶

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding .../register/... topic and an optional suffix. This suffix can be used to deregister the callback later.

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.

register/stepper_brick/<UID>/under_voltage¶

Register Request:	register – Type: bool
Callback Response:	voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]

A callback can be registered for this event by publishing to the .../register/stepper_brick/<UID>/under_voltage[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/stepper_brick/<UID>/under_voltage[/<SUFFIX>] topic for each registered suffix.

This callback is triggered when the input voltage drops below the value set by request/stepper_brick/<UID>/set_minimum_voltage. The callback payload is the current voltage.

register/stepper_brick/<UID>/position_reached¶

Register Request:	register – Type: bool
Callback Response:	position – Type: int, Range: [-2³¹ to 2³¹ - 1]

A callback can be registered for this event by publishing to the .../register/stepper_brick/<UID>/position_reached[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/stepper_brick/<UID>/position_reached[/<SUFFIX>] topic for each registered suffix.

This callback is triggered when a position set by request/stepper_brick/<UID>/set_steps or request/stepper_brick/<UID>/set_target_position is reached.

Note

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

register/stepper_brick/<UID>/all_data¶

register – Type: bool

Callback Response:

current_velocity – Type: int, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1]
current_position – Type: int, Range: [-2³¹ to 2³¹ - 1]
remaining_steps – Type: int, Range: [-2³¹ to 2³¹ - 1]
stack_voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]
external_voltage – Type: int, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]
current_consumption – Type: int, Unit: 1 mA, Range: [0 to 2¹⁶ - 1]

A callback can be registered for this event by publishing to the .../register/stepper_brick/<UID>/all_data[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/stepper_brick/<UID>/all_data[/<SUFFIX>] topic for each registered suffix.

This callback is triggered periodically with the period that is set by request/stepper_brick/<UID>/set_all_data_period. The callback payload members are: the current velocity, the current position, the remaining steps, the stack voltage, the external voltage and the current consumption of the stepper motor.

register/stepper_brick/<UID>/new_state¶

Register Request:	register – Type: bool
Callback Response:	state_new – Type: int, Range: See symbols state_previous – Type: int, Range: See symbols

A callback can be registered for this event by publishing to the .../register/stepper_brick/<UID>/new_state[/<SUFFIX>] topic with the payload "true". An added callback can be removed by publishing to the same topic with the payload "false". To support multiple (de)registrations, e.g. for message filtering, an optional suffix can be used.

If the callback is triggered, a message with it's payload is published under the corresponding .../callback/stepper_brick/<UID>/new_state[/<SUFFIX>] topic for each registered suffix.

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

The following symbols are available for this function:

For state_new:

"stop" = 1
"acceleration" = 2
"run" = 3
"deacceleration" = 4
"direction_change_to_forward" = 5
"direction_change_to_backward" = 6

For state_previous:

"stop" = 1
"acceleration" = 2
"run" = 3
"deacceleration" = 4
"direction_change_to_forward" = 5
"direction_change_to_backward" = 6

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.

request/stepper_brick/<UID>/get_protocol1_bricklet_name¶

Request:	port – Type: char, Range: ["a" to "b"]
Response:	protocol_version – Type: int, Range: [0 to 255] firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] name – Type: string, Length: up to 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.

request/stepper_brick/<UID>/write_bricklet_plugin¶

Request:	port – Type: char, Range: ["a" to "b"] offset – Type: int, Range: [0 to 255] chunk – Type: [int, ...], Length: 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.

request/stepper_brick/<UID>/read_bricklet_plugin¶

Request:	port – Type: char, Range: ["a" to "b"] offset – Type: int, Range: [0 to 255]
Response:	chunk – Type: [int, ...], Length: 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.