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

Rust - Stepper Brick¶

This is the description of the Rust 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 Rust API bindings is part of their general description. Additional documentation can be found on docs.rs.

Examples¶

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

Configuration¶

Download (example_configuration.rs)

use std::{error::Error, io, thread, time::Duration};
use tinkerforge::{ip_connection::IpConnection, stepper_brick::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XXYYZZ"; // Change XXYYZZ to the UID of your Stepper Brick.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let stepper = StepperBrick::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    stepper.set_motor_current(800).recv()?; // 800 mA
    stepper.set_step_mode(8).recv()?; // 1/8 step mode
    stepper.set_max_velocity(2000).recv()?; // Velocity 2000 steps/s

    // Slow acceleration (500 steps/s^2),
    // Fast deacceleration (5000 steps/s^2)
    stepper.set_speed_ramping(500, 5000).recv()?;

    stepper.enable().recv()?; // Enable motor power
    stepper.set_steps(60000).recv()?; // Drive 60000 steps forward

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;

    // Stop motor before disabling motor power
    stepper.stop().recv()?; // Request motor stop
    stepper.set_speed_ramping(500, 5000).recv()?; // Fast deacceleration (5000 steps/s^2) for stopping
    thread::sleep(Duration::from_millis(400)); // Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s
    stepper.disable().recv()?; // Disable motor power

    ipcon.disconnect();
    Ok(())
}

Callback¶

Download (example_callback.rs)

use rand::{thread_rng, Rng};
use std::{error::Error, io, thread, time::Duration};
use tinkerforge::{ip_connection::IpConnection, stepper_brick::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XXYYZZ"; // Change XXYYZZ to the UID of your Stepper Brick.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let stepper = StepperBrick::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    let position_reached_receiver = stepper.get_position_reached_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `stepper` object
    // is dropped, so there is no need for manual cleanup.
    let stepper_copy = stepper.clone(); //Device objects don't implement Sync, so they can't be shared between threads (by reference). So clone the device and move the copy.
    thread::spawn(move || {
        let mut rng = thread_rng();
        for _position_reached in position_reached_receiver {
            let steps = if rng.gen() {
                let steps = rng.gen_range(1000..5001); // steps (forward)
                println!("Driving forward: {} steps", steps);
                steps
            } else {
                let steps = rng.gen_range(-5000..-999); // steps (backward)
                println!("Driving backward: {} steps", steps);
                steps
            };

            let acc = rng.gen_range(100..1001); // steps/s^2
            let dec = rng.gen_range(100..1001); // steps/s^2
            let vel = rng.gen_range(200..2001); // steps/s

            println!("Configuration (vel, acc, dec): ({}, {}, {})", vel, acc, dec);

            stepper_copy.set_speed_ramping(acc, dec);
            stepper_copy.set_max_velocity(vel);
            stepper_copy.set_steps(steps);
        }
    });

    stepper.enable(); // Enable motor power
    stepper.set_steps(1); // Drive one step forward to get things going

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;

    // Stop motor before disabling motor power
    stepper.stop(); // Request motor stop
    stepper.set_speed_ramping(500, 5000).recv()?; // Fast deacceleration (5000 steps/s^2) for stopping; use recv()? to block until the command is sent to the brick.
    thread::sleep(Duration::from_millis(400)); // Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s
    stepper.disable(); // Disable motor power

    ipcon.disconnect();
    Ok(())
}

API¶

To allow non-blocking usage, nearly every function of the Rust bindings returns a wrapper around a mpsc::Receiver. To block until the function has finished and get your result, call one of the receiver's recv variants. Those return either the result sent by the device, or any error occurred.

Functions returning a result directly will block until the device has finished processing the request.

All functions listed below are thread-safe, those which return a receiver are lock-free.

Basic Functions¶

pub fn StepperBrick::new(uid: &str, ip_connection: &IpConnection) → StepperBrick¶

Parameters:	uid – Type: &str ip_connection – Type: &IPConnection
Returns:	stepper – Type: StepperBrick

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

let stepper = StepperBrick::new("YOUR_DEVICE_UID", &ip_connection);

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

pub fn StepperBrick::set_max_velocity(&self, velocity: u16) → ConvertingReceiver<()>¶

Parameters:	velocity – Type: u16, Unit: 1 1/s, Range: [0 to 2¹⁶ - 1]

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 StepperBrick::set_target_position, StepperBrick::set_steps, StepperBrick::drive_forward or StepperBrick::drive_backward.

pub fn StepperBrick::get_max_velocity(&self) → ConvertingReceiver<u16>¶

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

Returns the velocity as set by StepperBrick::set_max_velocity.

pub fn StepperBrick::get_current_velocity(&self) → ConvertingReceiver<u16>¶

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

Returns the current velocity of the stepper motor.

pub fn StepperBrick::set_speed_ramping(&self, acceleration: u16, deacceleration: u16) → ConvertingReceiver<()>¶

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

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)

pub fn StepperBrick::get_speed_ramping(&self) → ConvertingReceiver<SpeedRamping>¶

Return Object:	acceleration – Type: u16, Unit: 1 1/s², Range: [0 to 2¹⁶ - 1], Default: 1000 deacceleration – Type: u16, Unit: 1 1/s², Range: [0 to 2¹⁶ - 1], Default: 1000

Returns the acceleration and deacceleration as set by StepperBrick::set_speed_ramping.

pub fn StepperBrick::full_brake(&self) → ConvertingReceiver<()>¶

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 StepperBrick::stop if you just want to stop the motor.

pub fn StepperBrick::set_steps(&self, steps: i32) → ConvertingReceiver<()>¶

Parameters:	steps – Type: i32, Range: [-2³¹ to 2³¹ - 1]

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 StepperBrick::set_max_velocity and StepperBrick::set_speed_ramping will be used.

pub fn StepperBrick::get_steps(&self) → ConvertingReceiver<i32>¶

Returns:	steps – Type: i32, Range: [-2³¹ to 2³¹ - 1]

Returns the last steps as set by StepperBrick::set_steps.

pub fn StepperBrick::get_remaining_steps(&self) → ConvertingReceiver<i32>¶

Returns:	steps – Type: i32, Range: [-2³¹ to 2³¹ - 1]

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

pub fn StepperBrick::drive_forward(&self) → ConvertingReceiver<()>¶: Drives the stepper motor forward until StepperBrick::drive_backward or StepperBrick::stop is called. The velocity, acceleration and deacceleration as set by StepperBrick::set_max_velocity and StepperBrick::set_speed_ramping will be used.

pub fn StepperBrick::drive_backward(&self) → ConvertingReceiver<()>¶: Drives the stepper motor backward until StepperBrick::drive_forward or StepperBrick::stop is triggered. The velocity, acceleration and deacceleration as set by StepperBrick::set_max_velocity and StepperBrick::set_speed_ramping will be used.

pub fn StepperBrick::stop(&self) → ConvertingReceiver<()>¶: Stops the stepper motor with the deacceleration as set by StepperBrick::set_speed_ramping.

pub fn StepperBrick::set_motor_current(&self, current: u16) → ConvertingReceiver<()>¶

Parameters:	current – Type: u16, Unit: 1 mA, Range: [100 to 2291], Default: 800

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.

pub fn StepperBrick::get_motor_current(&self) → ConvertingReceiver<u16>¶

Returns:	current – Type: u16, Unit: 1 mA, Range: [100 to 2291], Default: 800

Returns the current as set by StepperBrick::set_motor_current.

pub fn StepperBrick::enable(&self) → ConvertingReceiver<()>¶: Enables the driver chip. The driver parameters can be configured (maximum velocity, acceleration, etc) before it is enabled.

pub fn StepperBrick::disable(&self) → ConvertingReceiver<()>¶: 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 StepperBrick::stop function before disabling the motor power. The StepperBrick::stop function will not wait until the motor is actually stopped. You have to explicitly wait for the appropriate time after calling the StepperBrick::stop function before calling the StepperBrick::disable function.

pub fn StepperBrick::is_enabled(&self) → ConvertingReceiver<bool>¶

Returns:	enabled – Type: bool, Default: false

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

Advanced Functions¶

pub fn StepperBrick::set_current_position(&self, position: i32) → ConvertingReceiver<()>¶

Parameters:	position – Type: i32, Range: [-2³¹ to 2³¹ - 1]

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

pub fn StepperBrick::get_current_position(&self) → ConvertingReceiver<i32>¶

Returns:	position – Type: i32, 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 (StepperBrick::set_target_position, StepperBrick::set_steps, StepperBrick::drive_forward or StepperBrick::drive_backward). It also is possible to reset the steps to 0 or set them to any other desired value with StepperBrick::set_current_position.

pub fn StepperBrick::set_target_position(&self, position: i32) → ConvertingReceiver<()>¶

Parameters:	position – Type: i32, Range: [-2³¹ to 2³¹ - 1]

Sets the target position of the stepper motor in steps. For example, if the current position of the motor is 500 and StepperBrick::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 StepperBrick::set_max_velocity and StepperBrick::set_speed_ramping.

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

pub fn StepperBrick::get_target_position(&self) → ConvertingReceiver<i32>¶

Returns:	position – Type: i32, Range: [-2³¹ to 2³¹ - 1]

Returns the last target position as set by StepperBrick::set_target_position.

pub fn StepperBrick::set_step_mode(&self, mode: u8) → ConvertingReceiver<()>¶

Parameters:	mode – Type: u8, Range: See constants, Default: 8

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

For mode:

STEPPER_BRICK_STEP_MODE_FULL_STEP = 1
STEPPER_BRICK_STEP_MODE_HALF_STEP = 2
STEPPER_BRICK_STEP_MODE_QUARTER_STEP = 4
STEPPER_BRICK_STEP_MODE_EIGHTH_STEP = 8

pub fn StepperBrick::get_step_mode(&self) → ConvertingReceiver<u8>¶

Returns:	mode – Type: u8, Range: See constants, Default: 8

Returns the step mode as set by StepperBrick::set_step_mode.

The following constants are available for this function:

For mode:

STEPPER_BRICK_STEP_MODE_FULL_STEP = 1
STEPPER_BRICK_STEP_MODE_HALF_STEP = 2
STEPPER_BRICK_STEP_MODE_QUARTER_STEP = 4
STEPPER_BRICK_STEP_MODE_EIGHTH_STEP = 8

pub fn StepperBrick::get_stack_input_voltage(&self) → ConvertingReceiver<u16>¶

Returns:	voltage – Type: u16, 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.

pub fn StepperBrick::get_external_input_voltage(&self) → ConvertingReceiver<u16>¶

Returns:	voltage – Type: u16, 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

pub fn StepperBrick::get_current_consumption(&self) → ConvertingReceiver<u16>¶

Returns:	current – Type: u16, Unit: 1 mA, Range: [0 to 2¹⁶ - 1]

Returns the current consumption of the motor.

pub fn StepperBrick::set_decay(&self, decay: u16) → ConvertingReceiver<()>¶

Parameters:	decay – Type: u16, Range: [0 to 2¹⁶ - 1], Default: 10000

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 StepperBrick::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

pub fn StepperBrick::get_decay(&self) → ConvertingReceiver<u16>¶

Returns:	decay – Type: u16, Range: [0 to 2¹⁶ - 1], Default: 10000

Returns the decay mode as set by StepperBrick::set_decay.

pub fn StepperBrick::set_sync_rect(&self, sync_rect: bool) → ConvertingReceiver<()>¶

Parameters:	sync_rect – Type: bool, Default: false

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

With synchronous rectification on, the decay can be changed (see StepperBrick::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.

pub fn StepperBrick::is_sync_rect(&self) → ConvertingReceiver<bool>¶

Returns:	sync_rect – Type: bool, Default: false

Returns true if synchronous rectification is enabled, false otherwise.

pub fn StepperBrick::set_time_base(&self, time_base: u32) → ConvertingReceiver<()>¶

Parameters:	time_base – Type: u32, Unit: 1 s, Range: [0 to 2³² - 1], Default: 1

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.

pub fn StepperBrick::get_time_base(&self) → ConvertingReceiver<u32>¶

Returns:	time_base – Type: u32, Unit: 1 s, Range: [0 to 2³² - 1], Default: 1

Returns the time base as set by StepperBrick::set_time_base.

pub fn StepperBrick::get_all_data(&self) → ConvertingReceiver<AllData>¶

Return Object:

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

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

pub fn StepperBrick::set_spitfp_baudrate_config(&self, enable_dynamic_baudrate: bool, minimum_dynamic_baudrate: u32) → ConvertingReceiver<()>¶

Parameters:	enable_dynamic_baudrate – Type: bool, Default: true minimum_dynamic_baudrate – Type: u32, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000

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 StepperBrick::set_spitfp_baudrate. If the dynamic baudrate is disabled, the baudrate as set by StepperBrick::set_spitfp_baudrate will be used statically.

New in version 2.3.6 (Firmware).

pub fn StepperBrick::get_spitfp_baudrate_config(&self) → ConvertingReceiver<SpitfpBaudrateConfig>¶

Return Object:	enable_dynamic_baudrate – Type: bool, Default: true minimum_dynamic_baudrate – Type: u32, Unit: 1 Bd, Range: [400000 to 2000000], Default: 400000

Returns the baudrate config, see StepperBrick::set_spitfp_baudrate_config.

New in version 2.3.6 (Firmware).

pub fn StepperBrick::get_send_timeout_count(&self, communication_method: u8) → ConvertingReceiver<u32>¶

Parameters:	communication_method – Type: u8, Range: See constants
Returns:	timeout_count – Type: u32, 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 constants are available for this function:

For communication_method:

STEPPER_BRICK_COMMUNICATION_METHOD_NONE = 0
STEPPER_BRICK_COMMUNICATION_METHOD_USB = 1
STEPPER_BRICK_COMMUNICATION_METHOD_SPI_STACK = 2
STEPPER_BRICK_COMMUNICATION_METHOD_CHIBI = 3
STEPPER_BRICK_COMMUNICATION_METHOD_RS485 = 4
STEPPER_BRICK_COMMUNICATION_METHOD_WIFI = 5
STEPPER_BRICK_COMMUNICATION_METHOD_ETHERNET = 6
STEPPER_BRICK_COMMUNICATION_METHOD_WIFI_V2 = 7

New in version 2.3.4 (Firmware).

pub fn StepperBrick::set_spitfp_baudrate(&self, bricklet_port: char, baudrate: u32) → ConvertingReceiver<()>¶

Parameters:	bricklet_port – Type: char, Range: ['a' to 'b'] baudrate – Type: u32, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000

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

pub fn StepperBrick::get_spitfp_baudrate(&self, bricklet_port: char) → ConvertingReceiver<u32>¶

Parameters:	bricklet_port – Type: char, Range: ['a' to 'b']
Returns:	baudrate – Type: u32, Unit: 1 Bd, Range: [400000 to 2000000], Default: 1400000

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

New in version 2.3.3 (Firmware).

pub fn StepperBrick::get_spitfp_error_count(&self, bricklet_port: char) → ConvertingReceiver<SpitfpErrorCount>¶

Parameters:	bricklet_port – Type: char, Range: ['a' to 'b']
Return Object:	error_count_ack_checksum – Type: u32, Range: [0 to 2³² - 1] error_count_message_checksum – Type: u32, Range: [0 to 2³² - 1] error_count_frame – Type: u32, Range: [0 to 2³² - 1] error_count_overflow – Type: u32, 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).

pub fn StepperBrick::enable_status_led(&self) → ConvertingReceiver<()>¶

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

pub fn StepperBrick::disable_status_led(&self) → ConvertingReceiver<()>¶

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

pub fn StepperBrick::is_status_led_enabled(&self) → ConvertingReceiver<bool>¶

Returns:	enabled – Type: bool, Default: true

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

New in version 2.3.1 (Firmware).

pub fn StepperBrick::get_chip_temperature(&self) → ConvertingReceiver<i16>¶

Returns:	temperature – Type: i16, 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.

pub fn StepperBrick::reset(&self) → ConvertingReceiver<()>¶

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!

pub fn StepperBrick::get_identity(&self) → ConvertingReceiver<Identity>¶

Return Object:

Return Object:	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: [u8; 3] 0: major – Type: u8, Range: [0 to 255] 1: minor – Type: u8, Range: [0 to 255] 2: revision – Type: u8, Range: [0 to 255] firmware_version – Type: [u8; 3] 0: major – Type: u8, Range: [0 to 255] 1: minor – Type: u8, Range: [0 to 255] 2: revision – Type: u8, Range: [0 to 255] device_identifier – Type: u16, Range: [0 to 2¹⁶ - 1]

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: [u8; 3]

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

firmware_version – Type: [u8; 3]

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

device_identifier – Type: u16, Range: [0 to 2¹⁶ - 1]

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

The position is the position in the stack from '0' (bottom) to '8' (top).

The device identifier numbers can be found here. There is also a constant for the device identifier of this Brick.

Callback Configuration Functions¶

pub fn StepperBrick::set_minimum_voltage(&self, voltage: u16) → ConvertingReceiver<()>¶

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

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

pub fn StepperBrick::get_minimum_voltage(&self) → ConvertingReceiver<u16>¶

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

Returns the minimum voltage as set by StepperBrick::set_minimum_voltage.

pub fn StepperBrick::set_all_data_period(&self, period: u32) → ConvertingReceiver<()>¶

Parameters:	period – Type: u32, Unit: 1 ms, Range: [0 to 2³² - 1], Default: 0

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

pub fn StepperBrick::get_all_data_period(&self) → ConvertingReceiver<u32>¶

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

Returns the period as set by StepperBrick::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 get_*_callback_receiver function, which returns a receiver for callback events.

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.

pub fn StepperBrick::get_under_voltage_callback_receiver(&self) → ConvertingCallbackReceiver<u16>¶

Event:	voltage – Type: u16, Unit: 1 mV, Range: [0 to 2¹⁶ - 1]

Receivers created with this function receive Under Voltage events.

This callback is triggered when the input voltage drops below the value set by StepperBrick::set_minimum_voltage. The received variable is the current voltage.

pub fn StepperBrick::get_position_reached_callback_receiver(&self) → ConvertingCallbackReceiver<i32>¶

Event:	position – Type: i32, Range: [-2³¹ to 2³¹ - 1]

Receivers created with this function receive Position Reached events.

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

Note

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

pub fn StepperBrick::get_all_data_callback_receiver(&self) → ConvertingCallbackReceiver<AllDataEvent>¶

Event Object:

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

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

Receivers created with this function receive All Data events.

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

pub fn StepperBrick::get_new_state_callback_receiver(&self) → ConvertingCallbackReceiver<NewStateEvent>¶

Event Object:	state_new – Type: u8, Range: See constants state_previous – Type: u8, Range: See constants

Receivers created with this function receive New State events.

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

For state_new:

STEPPER_BRICK_STATE_STOP = 1
STEPPER_BRICK_STATE_ACCELERATION = 2
STEPPER_BRICK_STATE_RUN = 3
STEPPER_BRICK_STATE_DEACCELERATION = 4
STEPPER_BRICK_STATE_DIRECTION_CHANGE_TO_FORWARD = 5
STEPPER_BRICK_STATE_DIRECTION_CHANGE_TO_BACKWARD = 6

For state_previous:

STEPPER_BRICK_STATE_STOP = 1
STEPPER_BRICK_STATE_ACCELERATION = 2
STEPPER_BRICK_STATE_RUN = 3
STEPPER_BRICK_STATE_DEACCELERATION = 4
STEPPER_BRICK_STATE_DIRECTION_CHANGE_TO_FORWARD = 5
STEPPER_BRICK_STATE_DIRECTION_CHANGE_TO_BACKWARD = 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.

pub fn StepperBrick::get_api_version(&self) → [u8; 3]¶

Return Object:	api_version – Type: [u8; 3] 0: major – Type: u8, Range: [0 to 255] 1: minor – Type: u8, Range: [0 to 255] 2: revision – Type: u8, Range: [0 to 255]

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.

pub fn StepperBrick::get_response_expected(&mut self, function_id: u8) → bool¶

Parameters:	function_id – Type: u8, Range: See constants
Returns:	response_expected – Type: bool

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 StepperBrick::set_response_expected. 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 function_id:

STEPPER_BRICK_FUNCTION_SET_MAX_VELOCITY = 1
STEPPER_BRICK_FUNCTION_SET_SPEED_RAMPING = 4
STEPPER_BRICK_FUNCTION_FULL_BRAKE = 6
STEPPER_BRICK_FUNCTION_SET_CURRENT_POSITION = 7
STEPPER_BRICK_FUNCTION_SET_TARGET_POSITION = 9
STEPPER_BRICK_FUNCTION_SET_STEPS = 11
STEPPER_BRICK_FUNCTION_SET_STEP_MODE = 14
STEPPER_BRICK_FUNCTION_DRIVE_FORWARD = 16
STEPPER_BRICK_FUNCTION_DRIVE_BACKWARD = 17
STEPPER_BRICK_FUNCTION_STOP = 18
STEPPER_BRICK_FUNCTION_SET_MOTOR_CURRENT = 22
STEPPER_BRICK_FUNCTION_ENABLE = 24
STEPPER_BRICK_FUNCTION_DISABLE = 25
STEPPER_BRICK_FUNCTION_SET_DECAY = 27
STEPPER_BRICK_FUNCTION_SET_MINIMUM_VOLTAGE = 29
STEPPER_BRICK_FUNCTION_SET_SYNC_RECT = 33
STEPPER_BRICK_FUNCTION_SET_TIME_BASE = 35
STEPPER_BRICK_FUNCTION_SET_ALL_DATA_PERIOD = 38
STEPPER_BRICK_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
STEPPER_BRICK_FUNCTION_SET_SPITFP_BAUDRATE = 234
STEPPER_BRICK_FUNCTION_ENABLE_STATUS_LED = 238
STEPPER_BRICK_FUNCTION_DISABLE_STATUS_LED = 239
STEPPER_BRICK_FUNCTION_RESET = 243
STEPPER_BRICK_FUNCTION_WRITE_BRICKLET_PLUGIN = 246

pub fn StepperBrick::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()¶

Parameters:	function_id – Type: u8, Range: See constants response_expected – Type: bool

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 function_id:

STEPPER_BRICK_FUNCTION_SET_MAX_VELOCITY = 1
STEPPER_BRICK_FUNCTION_SET_SPEED_RAMPING = 4
STEPPER_BRICK_FUNCTION_FULL_BRAKE = 6
STEPPER_BRICK_FUNCTION_SET_CURRENT_POSITION = 7
STEPPER_BRICK_FUNCTION_SET_TARGET_POSITION = 9
STEPPER_BRICK_FUNCTION_SET_STEPS = 11
STEPPER_BRICK_FUNCTION_SET_STEP_MODE = 14
STEPPER_BRICK_FUNCTION_DRIVE_FORWARD = 16
STEPPER_BRICK_FUNCTION_DRIVE_BACKWARD = 17
STEPPER_BRICK_FUNCTION_STOP = 18
STEPPER_BRICK_FUNCTION_SET_MOTOR_CURRENT = 22
STEPPER_BRICK_FUNCTION_ENABLE = 24
STEPPER_BRICK_FUNCTION_DISABLE = 25
STEPPER_BRICK_FUNCTION_SET_DECAY = 27
STEPPER_BRICK_FUNCTION_SET_MINIMUM_VOLTAGE = 29
STEPPER_BRICK_FUNCTION_SET_SYNC_RECT = 33
STEPPER_BRICK_FUNCTION_SET_TIME_BASE = 35
STEPPER_BRICK_FUNCTION_SET_ALL_DATA_PERIOD = 38
STEPPER_BRICK_FUNCTION_SET_SPITFP_BAUDRATE_CONFIG = 231
STEPPER_BRICK_FUNCTION_SET_SPITFP_BAUDRATE = 234
STEPPER_BRICK_FUNCTION_ENABLE_STATUS_LED = 238
STEPPER_BRICK_FUNCTION_DISABLE_STATUS_LED = 239
STEPPER_BRICK_FUNCTION_RESET = 243
STEPPER_BRICK_FUNCTION_WRITE_BRICKLET_PLUGIN = 246

pub fn StepperBrick::set_response_expected_all(&mut self, response_expected: bool) → ()¶

Parameters:	response_expected – Type: bool

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.

pub fn StepperBrick::get_protocol1_bricklet_name(&self, port: char) → ConvertingReceiver<Protocol1BrickletName>¶

Parameters:	port – Type: char, Range: ['a' to 'b']
Return Object:	protocol_version – Type: u8, Range: [0 to 255] firmware_version – Type: [u8; 3] 0: major – Type: u8, Range: [0 to 255] 1: minor – Type: u8, Range: [0 to 255] 2: revision – Type: u8, 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.

pub fn StepperBrick::write_bricklet_plugin(&self, port: char, offset: u8, chunk: [u8; 32]) → ConvertingReceiver<()>¶

Parameters:	port – Type: char, Range: ['a' to 'b'] offset – Type: u8, Range: [0 to 255] chunk – Type: [u8; 32], Range: [0 to 255]

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.

pub fn StepperBrick::read_bricklet_plugin(&self, port: char, offset: u8) → ConvertingReceiver<[u8; 32]>¶

Parameters:	port – Type: char, Range: ['a' to 'b'] offset – Type: u8, Range: [0 to 255]
Returns:	chunk – Type: [u8; 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.

Constants¶

pub const StepperBrick::DEVICE_IDENTIFIER¶

This constant is used to identify a Stepper Brick.

The StepperBrick::get_identity function and the IpConnection::get_enumerate_callback_receiver callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

pub const StepperBrick::DEVICE_DISPLAY_NAME¶: This constant represents the human readable name of a Stepper Brick.