Python - Silent Stepper Bricklet 2.0¶

Dies ist die Beschreibung der Python API Bindings für das Silent Stepper Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Silent Stepper Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die Python API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele¶

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Configuration¶

Download (example_configuration.py)

#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Silent Stepper Bricklet 2.0

import time

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_silent_stepper_v2 import BrickletSilentStepperV2

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    ss = BrickletSilentStepperV2(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    ss.set_motor_current(800) # 800 mA
    ss.set_step_configuration(ss.STEP_RESOLUTION_8, True) # 1/8 steps (interpolated)
    ss.set_max_velocity(2000) # Velocity 2000 steps/s

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

    ss.set_enabled(True) # Enable motor power
    ss.set_steps(60000) # Drive 60000 steps forward

    input("Press key to exit\n") # Use raw_input() in Python 2

    # Stop motor before disabling motor power
    ss.stop() # Request motor stop
    ss.set_speed_ramping(500, 5000) # Fast deacceleration (5000 steps/s^2) for stopping
    time.sleep(0.4) # Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s
    ss.set_enabled(False) # Disable motor power

    ipcon.disconnect()

Callback¶

Download (example_callback.py)

#!/usr/bin/env python
# -*- coding: utf-8 -*-

HOST = "localhost"
PORT = 4223
UID = "XYZ" # Change XYZ to the UID of your Silent Stepper Bricklet 2.0

import time
import random

from tinkerforge.ip_connection import IPConnection
from tinkerforge.bricklet_silent_stepper_v2 import BrickletSilentStepperV2

# Use position reached callback to program random movement
def cb_position_reached(position, ss):
    if random.randint(0, 1):
        steps = random.randint(1000, 5000) # steps (forward)
        print("Driving forward: " + str(steps) + " steps")
    else:
        steps = random.randint(-5000, -1000) # steps (backward)
        print("Driving backward: " + str(steps) + " steps")

    vel = random.randint(200, 2000) # steps/s
    acc = random.randint(100, 1000) # steps/s^2
    dec = random.randint(100, 1000) # steps/s^2
    print("Configuration (vel, acc, dec): " + str((vel, acc, dec)))

    ss.set_speed_ramping(acc, dec)
    ss.set_max_velocity(vel)
    ss.set_steps(steps)

if __name__ == "__main__":
    ipcon = IPConnection() # Create IP connection
    ss = BrickletSilentStepperV2(UID, ipcon) # Create device object

    ipcon.connect(HOST, PORT) # Connect to brickd
    # Don't use device before ipcon is connected

    # Register position reached callback to function cb_position_reached
    ss.register_callback(ss.CALLBACK_POSITION_REACHED,
                         lambda x: cb_position_reached(x, ss))

    ss.set_step_configuration(ss.STEP_RESOLUTION_8, True) # 1/8 steps (interpolated)
    ss.set_enabled(True) # Enable motor power
    ss.set_steps(1) # Drive one step forward to get things going

    input("Press key to exit\n") # Use raw_input() in Python 2

    # Stop motor before disabling motor power
    ss.stop() # Request motor stop
    ss.set_speed_ramping(500, 5000) # Fast deacceleration (5000 steps/s^2) for stopping
    time.sleep(0.4) # Wait for motor to actually stop: max velocity (2000 steps/s) / decceleration (5000 steps/s^2) = 0.4 s
    ss.set_enabled(False) # Disable motor power

    ipcon.disconnect()

API¶

Prinzipiell kann jede Funktion der Python Bindings tinkerforge.ip_connection.Error Exception werfen, welche ein value und eine description Property hat. value kann verschiende Werte haben:

Error.TIMEOUT = -1
Error.NOT_ADDED = -6 (seit Python Bindings Version 2.0.0 nicht mehr verwendet)
Error.ALREADY_CONNECTED = -7
Error.NOT_CONNECTED = -8
Error.INVALID_PARAMETER = -9
Error.NOT_SUPPORTED = -10
Error.UNKNOWN_ERROR_CODE = -11
Error.STREAM_OUT_OF_SYNC = -12
Error.INVALID_UID = -13
Error.NON_ASCII_CHAR_IN_SECRET = -14
Error.WRONG_DEVICE_TYPE = -15
Error.DEVICE_REPLACED = -16
Error.WRONG_RESPONSE_LENGTH = -17

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen¶

BrickletSilentStepperV2(uid, ipcon)¶

Parameter:	uid – Typ: str ipcon – Typ: IPConnection
Rückgabe:	silent_stepper_v2 – Typ: BrickletSilentStepperV2

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid:

silent_stepper_v2 = BrickletSilentStepperV2("YOUR_DEVICE_UID", ipcon)

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

BrickletSilentStepperV2.set_max_velocity(velocity)¶

Parameter:	velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1]
Rückgabe:	None

Setzt die maximale Geschwindigkeit des Schrittmotors. Diese Funktion startet nicht den Motor, sondern setzt nur die maximale Geschwindigkeit auf welche der Schrittmotor beschleunigt wird. Um den Motor zu fahren können set_target_position(), set_steps(), drive_forward() oder drive_backward() verwendet werden.

BrickletSilentStepperV2.get_max_velocity()¶

Rückgabe:	velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die Geschwindigkeit zurück, wie von set_max_velocity() gesetzt.

BrickletSilentStepperV2.get_current_velocity()¶

Rückgabe:	velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die aktuelle Geschwindigkeit des Schrittmotors zurück.

BrickletSilentStepperV2.set_speed_ramping(acceleration, deacceleration)¶

Parameter:	acceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000 deacceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000
Rückgabe:	None

Setzt die Beschleunigung und die Verzögerung des Schrittmotors. Eine Beschleunigung von 1000 bedeutet, dass jede Sekunde die Geschwindigkeit um 1000 Schritte/s erhöht wird.

Beispiel: Wenn die aktuelle Geschwindigkeit 0 ist und es soll auf eine Geschwindigkeit von 8000 Schritten/s in 10 Sekunden beschleunigt werden, muss die Beschleunigung auf 800 Schritte/s² gesetzt werden.

Eine Beschleunigung/Verzögerung von 0 bedeutet ein sprunghaftes Beschleunigen/Verzögern (nicht empfohlen).

BrickletSilentStepperV2.get_speed_ramping()¶

Rückgabeobjekt:	acceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000 deacceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000

Gibt die Beschleunigung und Verzögerung zurück, wie von set_speed_ramping() gesetzt.

BrickletSilentStepperV2.full_brake()¶

Rückgabe:	None

Führt eine aktive Vollbremsung aus.

Warnung

Diese Funktion ist für Notsituationen bestimmt, in denen ein unverzüglicher Halt notwendig ist. Abhängig von der aktuellen Geschwindigkeit und der Kraft des Motors kann eine Vollbremsung brachial sein.

Ein Aufruf von stop() stoppt den Motor.

BrickletSilentStepperV2.set_steps(steps)¶

Parameter:	steps – Typ: int, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	None

Setzt die Anzahl der Schritte die der Schrittmotor fahren soll. Positive Werte fahren den Motor vorwärts und negative rückwärts. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit set_max_velocity() und set_speed_ramping() gesetzt, verwendet.

BrickletSilentStepperV2.get_steps()¶

Rückgabe:	steps – Typ: int, Wertebereich: [-2³¹ bis 2³¹ - 1]

Gibt die letzten Schritte zurück, wie von set_steps() gesetzt.

BrickletSilentStepperV2.get_remaining_steps()¶

Rückgabe:	steps – Typ: int, Wertebereich: [-2³¹ bis 2³¹ - 1]

Gibt die verbleibenden Schritte des letzten Aufrufs von set_steps() zurück. Beispiel: Wenn set_steps() mit 2000 aufgerufen wird und get_remaining_steps() aufgerufen wird wenn der Motor 500 Schritte fahren hat, wird 1500 zurückgegeben.

BrickletSilentStepperV2.drive_forward()¶

Rückgabe:	None

Fährt den Schrittmotor vorwärts bis drive_backward() oder stop() aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit set_max_velocity() und set_speed_ramping() gesetzt, verwendet.

BrickletSilentStepperV2.drive_backward()¶

Rückgabe:	None

Fährt den Schrittmotor rückwärts bis drive_forward() oder stop() aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit set_max_velocity() und set_speed_ramping() gesetzt, verwendet.

BrickletSilentStepperV2.stop()¶

Rückgabe:	None

Stoppt den Schrittmotor mit der Verzögerung, wie von set_speed_ramping() gesetzt.

BrickletSilentStepperV2.set_motor_current(current)¶

Parameter:	current – Typ: int, Einheit: 1 mA, Wertebereich: [360 bis 1640], Standardwert: 800
Rückgabe:	None

Setzt den Strom mit welchem der Motor angetrieben wird.

Warnung

Dieser Wert sollte nicht über die Spezifikation des Schrittmotors gesetzt werden. Sonst ist eine Beschädigung des Motors möglich.

BrickletSilentStepperV2.get_motor_current()¶

Rückgabe:	current – Typ: int, Einheit: 1 mA, Wertebereich: [360 bis 1640], Standardwert: 800

Gibt den Strom zurück, wie von set_motor_current() gesetzt.

BrickletSilentStepperV2.set_enabled(enabled)¶

Parameter:	enabled – Typ: bool, Standardwert: False
Rückgabe:	None

Aktiviert/Deaktiviert die Treiberstufe. Die Treiberparameter können vor der Aktivierung konfiguriert werden (maximale Geschwindigkeit, Beschleunigung, etc.).

Warnung

Die Treiberstufe zu deaktivieren während der Motor sich noch dreht kann zur Beschädigung der Treiberstufe führen. Der Motor sollte durch Aufrufen der stop() Funktion gestoppt werden, bevor die Treiberstufe deaktiviert wird. Die stop() Funktion wartet nicht bis der Motor wirklich zum Stillstand gekommen ist. Dazu muss nach dem Aufruf der stop() Funktion eine angemessen Zeit gewartet werden bevor die Funktion set_enabled() mit false aufgerufen wird.

BrickletSilentStepperV2.get_enabled()¶

Rückgabe:	enabled – Typ: bool, Standardwert: False

Gibt zurück ob der Schrittmotortreiber aktiviert ist.

BrickletSilentStepperV2.set_basic_configuration(standstill_current, motor_run_current, standstill_delay_time, power_down_time, stealth_threshold, coolstep_threshold, classic_threshold, high_velocity_chopper_mode)¶

Parameter:

Parameter:	standstill_current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 200 motor_run_current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 800 standstill_delay_time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 307], Standardwert: 0 power_down_time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 5222], Standardwert: 1000 stealth_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 500 coolstep_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 500 classic_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000 high_velocity_chopper_mode – Typ: bool, Standardwert: False
Rückgabe:	None

standstill_current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 200
motor_run_current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 800
standstill_delay_time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 307], Standardwert: 0
power_down_time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 5222], Standardwert: 1000
stealth_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 500
coolstep_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 500
classic_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000
high_velocity_chopper_mode – Typ: bool, Standardwert: False

Rückgabe:

None

Setzt die Basiskonfiguration-Parameter für verschiedene Modi (Stealth, Coolstep, Classic).

Standstill Current: Mit diesem Wert kann der Phasenstrom im Stillstand reduziert werden. Dies ist zum Beispiel sinnvoll um das Aufheizen des Motors zu verringern. Wenn der Motor steht wird dieser mit dem eingestellte Phasenstrom betrieben bis die eingestellte Power Down Time um ist. Danach wird der Phasenstrom schrittweise bis zum Standstill Current reduziert. Die dafür benötigte Zeit wird mittels Power Down Time eingestellt. Der eingestellte Phasenstrom ist das Maximum für diesen Wert (see set_motor_current()).
Motor Run Current: Dieser Wert setzt den Phasenstrom, wenn der Motor sich dreht. Ein Wert von mindestens der Hälfte des maximalen Phasenstrom sollte für gute Ergebnisse im Mikroschrittbetrieb gesetzt werden. Der maximal zulässige Wert ist der maximale Phasenstrom. Der eingegebene Wert wird von der API intern in einen Faktor im Bereich von 1/32 ... 32/32 umgerechnet, mit dem der Phasenstrom begrenzt wird. Der maximale Phasenstrom sollte im laufenden Betrieb nicht geändert werden. Für eine Änderung im laufenden Betrieb ist dieser Wert da (see set_motor_current()).
Standstill Delay Time: Steuert die Zeit für das Verringern des Motorstroms bis zum Standstill Current. Eine hohe Standstill Delay Time führt zu einem ruhigen und ruckelfreien Übergang.
Power Down Time: Setzt die Wartezeit nach dem Stehenbleiben.
Stealth Threshold: Setzt den oberen Grenzwert für den Stealth Modus. Wenn die Geschwindigkeit des Motors über diesem Wert liegt wird der Stealth Modus abgeschaltet. Ansonsten angeschaltet. Im Stealth Modus nimmt das Drehmoment mit steigender Geschwindigkeit ab.
Coolstep Threshold: Setzt den unteren Grenzwert für den Coolstep Modus. Der Coolstep Grenzwert muss über dem Stealth Grenzwert liegen.
Classic Threshold: Sets den unteren Grenzwert für den Classic Modus. Im Classic Modus wird der Schrittmotor geräuschvoll aber das Drehmoment wird maximiert.
High Velocity Chopper Mode: Wenn der High Velocity Chopper Modus aktiviert wird, optimiert der Schrittmotortreiber die Ansteuerung des Motors für hohe Geschwindigkeiten.

Wenn alle drei Grenzwerte (Thresholds) genutzt werden sollen muss sichergestellt werden, dass Stealth Threshold < Coolstep Threshold < Classic Threshold.

BrickletSilentStepperV2.get_basic_configuration()¶

Rückgabeobjekt:

Rückgabeobjekt:	standstill_current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 200 motor_run_current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 800 standstill_delay_time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 307], Standardwert: 0 power_down_time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 5222], Standardwert: 1000 stealth_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 500 coolstep_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 500 classic_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000 high_velocity_chopper_mode – Typ: bool, Standardwert: False

standstill_current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 200
motor_run_current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 800
standstill_delay_time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 307], Standardwert: 0
power_down_time – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 5222], Standardwert: 1000
stealth_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 500
coolstep_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 500
classic_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 1000
high_velocity_chopper_mode – Typ: bool, Standardwert: False

Gibt die Konfiguration zurück, wie von set_basic_configuration() gesetzt.

BrickletSilentStepperV2.set_gpio_configuration(channel, debounce, stop_deceleration)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 200 stop_deceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1
Rückgabe:	None

Setzt die GPIO-Konfiguration für einen Kanal. Es kann ein Debounce und eine Debeschleunigung gesetzt werden. Letzteres wird genutzt wenn die Action auf normal stop konfiguriert ist. Siehe set_gpio_action().

BrickletSilentStepperV2.get_gpio_configuration(channel)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1]
Rückgabeobjekt:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 200 stop_deceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 2¹⁶ - 1

Gibt die GPIO-Konfiguration für einen Kanal zurück, wie von set_gpio_configuration() gesetzt.

BrickletSilentStepperV2.set_gpio_action(channel, action)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1] action – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	None

Setzt die GPIO-Action für einen Kanal.

Die Action kann ein normal stop, ein full brake oder ein callback sein. Jeweils für eine steigende oder fallende Flanke. Die Actions sind eine Bitmaske und sie können simultan verwendet werden. Es ist zum Beispiel möglich einen full brake und callback gleichzeitig zu triggern oder eine auf eine steigende und fallende Flanke gleichzeitig.

Die Debeschleunigung für den normal stop kann über set_gpio_configuration() konfiguriert werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für action:

BrickletSilentStepperV2.GPIO_ACTION_NONE = 0
BrickletSilentStepperV2.GPIO_ACTION_NORMAL_STOP_RISING_EDGE = 1
BrickletSilentStepperV2.GPIO_ACTION_NORMAL_STOP_FALLING_EDGE = 2
BrickletSilentStepperV2.GPIO_ACTION_FULL_BRAKE_RISING_EDGE = 4
BrickletSilentStepperV2.GPIO_ACTION_FULL_BRAKE_FALLING_EDGE = 8
BrickletSilentStepperV2.GPIO_ACTION_CALLBACK_RISING_EDGE = 16
BrickletSilentStepperV2.GPIO_ACTION_CALLBACK_FALLING_EDGE = 32

BrickletSilentStepperV2.get_gpio_action(channel)¶

Parameter:	channel – Typ: int, Wertebereich: [0 bis 1]
Rückgabe:	action – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die GPIO-Action für einen Kanal zurück, wie von set_gpio_action() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für action:

BrickletSilentStepperV2.GPIO_ACTION_NONE = 0
BrickletSilentStepperV2.GPIO_ACTION_NORMAL_STOP_RISING_EDGE = 1
BrickletSilentStepperV2.GPIO_ACTION_NORMAL_STOP_FALLING_EDGE = 2
BrickletSilentStepperV2.GPIO_ACTION_FULL_BRAKE_RISING_EDGE = 4
BrickletSilentStepperV2.GPIO_ACTION_FULL_BRAKE_FALLING_EDGE = 8
BrickletSilentStepperV2.GPIO_ACTION_CALLBACK_RISING_EDGE = 16
BrickletSilentStepperV2.GPIO_ACTION_CALLBACK_FALLING_EDGE = 32

BrickletSilentStepperV2.get_gpio_state()¶

Rückgabe:	gpio_state – Typ: [bool, ...], Länge: 2

Gibt den GPIO-Zustand für beide Kanäle zurück. True wenn der der Zustand high ist und false wenn der Zustand low ist.

Fortgeschrittene Funktionen¶

BrickletSilentStepperV2.set_current_position(position)¶

Parameter:	position – Typ: int, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	None

Setzt den aktuellen Schrittwert des internen Schrittzählers. Dies kann benutzt werden um die aktuelle Position auf 0 zu setzen wenn ein definierter Startpunkt erreicht wurde (z.B. wenn eine CNC Maschine eine Ecke erreicht).

BrickletSilentStepperV2.get_current_position()¶

Rückgabe:	position – Typ: int, Wertebereich: [-2³¹ bis 2³¹ - 1]

Gibt die aktuelle Position des Schrittmotors in Schritten zurück. Nach dem Hochfahren ist die Position 0. Die Schritte werden bei Verwendung aller möglichen Fahrfunktionen gezählt (set_target_position(), set_steps(), drive_forward() der drive_backward()). Es ist auch möglich den Schrittzähler auf 0 oder jeden anderen gewünschten Wert zu setzen mit set_current_position().

BrickletSilentStepperV2.set_target_position(position)¶

Parameter:	position – Typ: int, Wertebereich: [-2³¹ bis 2³¹ - 1]
Rückgabe:	None

Setzt die Zielposition des Schrittmotors in Schritten. Beispiel: Wenn die aktuelle Position des Motors 500 ist und set_target_position() mit 1000 aufgerufen wird, dann verfährt der Schrittmotor 500 Schritte vorwärts. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit set_max_velocity() und set_speed_ramping() gesetzt, verwendet.

Ein Aufruf von set_target_position() mit dem Parameter x ist äquivalent mit einem Aufruf von set_steps() mit dem Parameter (x - get_current_position()).

BrickletSilentStepperV2.get_target_position()¶

Rückgabe:	position – Typ: int, Wertebereich: [-2³¹ bis 2³¹ - 1]

Gibt die letzte Zielposition zurück, wie von set_target_position() gesetzt.

BrickletSilentStepperV2.set_step_configuration(step_resolution, interpolation)¶

Parameter:	step_resolution – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 interpolation – Typ: bool, Standardwert: True
Rückgabe:	None

Setzt die Schrittauflösung von Vollschritt bis zu 1/256 Schritt.

Wenn Interpolation aktiviert ist, führt der Silent Stepper Bricklet 2.0 immer 1/256 interpolierte Schritte aus. Wenn zum Beispiel Vollschritt mit Interpolation genutzt wird, führt jeder Schritt zu 256 1/256 Schritten beim Motor.

Für einen maximalen Drehmoment sollte Vollschritt mit Interpolation genutzt werden. Für maximale Auflösung sollte 1/256 Schritt genutzt werden. Interpolation führt auch dazu, dass der Motor weniger Geräusche erzeugt.

Für den Fall, dass oft die Geschwindigkeit mit sehr hohen Beschleunigungen geändert wird, sollte Interpolation ausgeschaltet werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für step_resolution:

BrickletSilentStepperV2.STEP_RESOLUTION_1 = 8
BrickletSilentStepperV2.STEP_RESOLUTION_2 = 7
BrickletSilentStepperV2.STEP_RESOLUTION_4 = 6
BrickletSilentStepperV2.STEP_RESOLUTION_8 = 5
BrickletSilentStepperV2.STEP_RESOLUTION_16 = 4
BrickletSilentStepperV2.STEP_RESOLUTION_32 = 3
BrickletSilentStepperV2.STEP_RESOLUTION_64 = 2
BrickletSilentStepperV2.STEP_RESOLUTION_128 = 1
BrickletSilentStepperV2.STEP_RESOLUTION_256 = 0

BrickletSilentStepperV2.get_step_configuration()¶

Rückgabeobjekt:	step_resolution – Typ: int, Wertebereich: Siehe Konstanten interpolation – Typ: bool, Standardwert: True

Gibt den Schrittmodus zurück, wie von set_step_configuration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für step_resolution:

BrickletSilentStepperV2.STEP_RESOLUTION_1 = 8
BrickletSilentStepperV2.STEP_RESOLUTION_2 = 7
BrickletSilentStepperV2.STEP_RESOLUTION_4 = 6
BrickletSilentStepperV2.STEP_RESOLUTION_8 = 5
BrickletSilentStepperV2.STEP_RESOLUTION_16 = 4
BrickletSilentStepperV2.STEP_RESOLUTION_32 = 3
BrickletSilentStepperV2.STEP_RESOLUTION_64 = 2
BrickletSilentStepperV2.STEP_RESOLUTION_128 = 1
BrickletSilentStepperV2.STEP_RESOLUTION_256 = 0

BrickletSilentStepperV2.get_input_voltage()¶

Rückgabe:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die externe Eingangsspannung zurück. Die externe Eingangsspannung wird über die schwarze Stromversorgungsbuchse, in den Silent Stepper Bricklet 2.0, eingespeist.

Sobald eine externe Eingangsspannung und die Spannungsversorgung des Stapels anliegt, wird der Motor über die externe Spannung versorgt. Sollte nur die Spannungsversorgung des Stapels verfügbar sein, erfolgt die Versorgung des Motors über diese.

Warnung

Das bedeutet, bei einer hohen Versorgungsspannung des Stapels und einer geringen externen Versorgungsspannung erfolgt die Spannungsversorgung des Motors über die geringere externe Versorgungsspannung. Wenn dann die externe Spannungsversorgung getrennt wird, erfolgt sofort die Versorgung des Motors über die höhere Versorgungsspannung des Stapels.

BrickletSilentStepperV2.set_spreadcycle_configuration(slow_decay_duration, enable_random_slow_decay, fast_decay_duration, hysteresis_start_value, hysteresis_end_value, sine_wave_offset, chopper_mode, comparator_blank_time, fast_decay_without_comparator)¶

Parameter:

Parameter:	slow_decay_duration – Typ: int, Wertebereich: [0 bis 15], Standardwert: 4 enable_random_slow_decay – Typ: bool, Standardwert: False fast_decay_duration – Typ: int, Wertebereich: [0 bis 15], Standardwert: 0 hysteresis_start_value – Typ: int, Wertebereich: [0 bis 7], Standardwert: 0 hysteresis_end_value – Typ: int, Wertebereich: [-3 bis 12], Standardwert: 0 sine_wave_offset – Typ: int, Wertebereich: [-3 bis 12], Standardwert: 0 chopper_mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 comparator_blank_time – Typ: int, Wertebereich: [0 bis 3], Standardwert: 1 fast_decay_without_comparator – Typ: bool, Standardwert: False
Rückgabe:	None

slow_decay_duration – Typ: int, Wertebereich: [0 bis 15], Standardwert: 4
enable_random_slow_decay – Typ: bool, Standardwert: False
fast_decay_duration – Typ: int, Wertebereich: [0 bis 15], Standardwert: 0
hysteresis_start_value – Typ: int, Wertebereich: [0 bis 7], Standardwert: 0
hysteresis_end_value – Typ: int, Wertebereich: [-3 bis 12], Standardwert: 0
sine_wave_offset – Typ: int, Wertebereich: [-3 bis 12], Standardwert: 0
chopper_mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
comparator_blank_time – Typ: int, Wertebereich: [0 bis 3], Standardwert: 1
fast_decay_without_comparator – Typ: bool, Standardwert: False

Rückgabe:

None

Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.

Setzt die Spreadcycle Konfigurationsparameter. Spreadcycle ist ein Chopper-Algorithmus der aktiv den Motorstrom regelt. Weitere Informationen dazu können im TMC2130 Datenblatt auf Seite 47 (7 spreadCycle and Classic Chopper) gefunden werden.

Slow Decay Duration: Steuert die Aus-Zeit (off time) in der Slow Decay Phase. 0 = Treiber deaktiviert, alle Brücken aus. Nur wenn die Comparator Blank Time >=2 ist sollte ein Wert von 1 gesetzt werden.
Enable Random Slow Decay: Muss auf False gesetzt werden um die Aus-Zeit (off time) des Choppers auf die gesetzte Slow Decay Duration zu setzen. Wenn dieser Wert auf True gesetzt wird, wird die Decay Dauer zufällig variiert.
Fast Decay Duration: Setzt die Fast Decay Dauer. Dieser Parameter wird nur benutzt, wenn der Spread Cycle als Chopper Modus genutzt wird.
Hysteresis Start Value: Setzt der Startwert der Hysterese. Dieser Parameter wird nur benutzt, wenn der Spread Cycle als Chopper Modus genutzt wird.
Hysteresis End Value: Setzt den Endwert der Hysterese. Dieser Parameter wird nur benutzt, wenn der Spread Cycle als Chopper Modus genutzt wird.
Sinewave Offset: Setzt den Sinuswellen Offset. Der Wert wird nur benutzt, wenn als Chopper Modus Fast Decay benutzt wird. 1/512 dieses Werts wird zum Absolutwert der Sinuswelle hinzuaddiert.
Chopper Mode: 0 = Spread Cycle, 1 = Fast Decay.
Comperator Blank Time: Setzt die Totzeit von Komparator. Mögliche Werte sind
- 0 = 16 Takte,
- 1 = 24 Takte,
- 2 = 36 Takte und
- 3 = 54 Takte.
Ein Wert von 1 oder 2 wird für die meisten Anwendungen empfohlen.
Fast Decay Without Comperator: Wenn dieser Wert auf True gesetzt wird, dann wird der Strom-Komparator nicht im Fast Decay Modus genutzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für chopper_mode:

BrickletSilentStepperV2.CHOPPER_MODE_SPREAD_CYCLE = 0
BrickletSilentStepperV2.CHOPPER_MODE_FAST_DECAY = 1

BrickletSilentStepperV2.get_spreadcycle_configuration()¶

Rückgabeobjekt:

Rückgabeobjekt:	slow_decay_duration – Typ: int, Wertebereich: [0 bis 15], Standardwert: 4 enable_random_slow_decay – Typ: bool, Standardwert: False fast_decay_duration – Typ: int, Wertebereich: [0 bis 15], Standardwert: 0 hysteresis_start_value – Typ: int, Wertebereich: [0 bis 7], Standardwert: 0 hysteresis_end_value – Typ: int, Wertebereich: [-3 bis 12], Standardwert: 0 sine_wave_offset – Typ: int, Wertebereich: [-3 bis 12], Standardwert: 0 chopper_mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 comparator_blank_time – Typ: int, Wertebereich: [0 bis 3], Standardwert: 1 fast_decay_without_comparator – Typ: bool, Standardwert: False

slow_decay_duration – Typ: int, Wertebereich: [0 bis 15], Standardwert: 4
enable_random_slow_decay – Typ: bool, Standardwert: False
fast_decay_duration – Typ: int, Wertebereich: [0 bis 15], Standardwert: 0
hysteresis_start_value – Typ: int, Wertebereich: [0 bis 7], Standardwert: 0
hysteresis_end_value – Typ: int, Wertebereich: [-3 bis 12], Standardwert: 0
sine_wave_offset – Typ: int, Wertebereich: [-3 bis 12], Standardwert: 0
chopper_mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
comparator_blank_time – Typ: int, Wertebereich: [0 bis 3], Standardwert: 1
fast_decay_without_comparator – Typ: bool, Standardwert: False

Gibt die Konfiguration zurück, wie von set_basic_configuration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für chopper_mode:

BrickletSilentStepperV2.CHOPPER_MODE_SPREAD_CYCLE = 0
BrickletSilentStepperV2.CHOPPER_MODE_FAST_DECAY = 1

BrickletSilentStepperV2.set_stealth_configuration(enable_stealth, amplitude, gradient, enable_autoscale, force_symmetric, freewheel_mode)¶

Parameter:	enable_stealth – Typ: bool, Standardwert: True amplitude – Typ: int, Wertebereich: [0 bis 255], Standardwert: 128 gradient – Typ: int, Wertebereich: [0 bis 255], Standardwert: 4 enable_autoscale – Typ: bool, Standardwert: True force_symmetric – Typ: bool, Standardwert: False freewheel_mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	None

Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.

Setzt die Konfigurationsparameter für den Stealth Modus.

Enable Stealth: Stealth Modus wird aktiviert, wenn dieser Wert auf True gesetzt wird. Ansonsten ist der Modus deaktiviert auch wenn die Geschwindigkeit des Motors unter dem Grenzwert, der mittels set_basic_configuration() gesetzt wurde, liegt.
Amplitude: Wenn Autoscale aktiviert wurde, wird die PWM Amplitude mit diesem Wert skaliert. Wenn autoscale deaktiviert ist, definiert dieser Wert die maximale PWM Amplitudenänderungen pro Halbwelle.
Gradient: Wenn Autoscale deaktiviert wurde, wird der PWM Steigung (Gradient) bei diesem Wert skaliert. Wird Autoscale aktiviert, definiert dieser Wert die maximale PWM Steigung. Mit Autoscale wird ein Wert über 64 empfohlen, ansonsten kann es sein, dass die Regelung den Strom nicht korrekt messen kann.
Enable Autoscale: Die automatische Stromregelung ist aktiviert, wenn dieser Wert auf True gesetzt wird. Ansonsten werden die vom Nutzer definierten Amplituden und Steigungen genutzt.
Force Symmetric: Wenn auf True gesetzt wird, dann wird ein symmetrisches PWM erzwungen. Ansonsten kann sich der PWM Wert innerhalb eines PWM Taktes ändern.
Freewheel Mode: Der Freewheel Modus definiert das Verhalten im Stillstand, wenn der Standstill Current (siehe set_basic_configuration()) auf 0 gesetzt wurde.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für freewheel_mode:

BrickletSilentStepperV2.FREEWHEEL_MODE_NORMAL = 0
BrickletSilentStepperV2.FREEWHEEL_MODE_FREEWHEELING = 1
BrickletSilentStepperV2.FREEWHEEL_MODE_COIL_SHORT_LS = 2
BrickletSilentStepperV2.FREEWHEEL_MODE_COIL_SHORT_HS = 3

BrickletSilentStepperV2.get_stealth_configuration()¶

Rückgabeobjekt:	enable_stealth – Typ: bool, Standardwert: True amplitude – Typ: int, Wertebereich: [0 bis 255], Standardwert: 128 gradient – Typ: int, Wertebereich: [0 bis 255], Standardwert: 4 enable_autoscale – Typ: bool, Standardwert: True force_symmetric – Typ: bool, Standardwert: False freewheel_mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration zurück, wie von set_stealth_configuration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für freewheel_mode:

BrickletSilentStepperV2.FREEWHEEL_MODE_NORMAL = 0
BrickletSilentStepperV2.FREEWHEEL_MODE_FREEWHEELING = 1
BrickletSilentStepperV2.FREEWHEEL_MODE_COIL_SHORT_LS = 2
BrickletSilentStepperV2.FREEWHEEL_MODE_COIL_SHORT_HS = 3

BrickletSilentStepperV2.set_coolstep_configuration(minimum_stallguard_value, maximum_stallguard_value, current_up_step_width, current_down_step_width, minimum_current, stallguard_threshold_value, stallguard_mode)¶

Parameter:

Parameter:	minimum_stallguard_value – Typ: int, Wertebereich: [0 bis 15], Standardwert: 2 maximum_stallguard_value – Typ: int, Wertebereich: [0 bis 15], Standardwert: 10 current_up_step_width – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 current_down_step_width – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 minimum_current – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 stallguard_threshold_value – Typ: int, Wertebereich: [-64 bis 63], Standardwert: 0 stallguard_mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:	None

minimum_stallguard_value – Typ: int, Wertebereich: [0 bis 15], Standardwert: 2
maximum_stallguard_value – Typ: int, Wertebereich: [0 bis 15], Standardwert: 10
current_up_step_width – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
current_down_step_width – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
minimum_current – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
stallguard_threshold_value – Typ: int, Wertebereich: [-64 bis 63], Standardwert: 0
stallguard_mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Rückgabe:

None

Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.

Setzt die Konfigurationsparameter für Coolstep.

Minimum Stallguard Value: Wenn der Stallguard-Wert unter diesem Wert*32 fällt wird der Motorstrom erhöht um den Motorbelastungswinkel (motor load angle) zu reduzieren. Ein Wert von 0 deaktiviert Coolstep.
Maximum Stallguard Value: Wenn der Stallguard-Wert über (Min Stallguard Value + Max Stallguard Value + 1)*32 geht wird der Motorstrom verringert um Energie zu sparen.
Current Up Step Width: Setzt das Inkrement pro Stallguard-Wert. Der Wertebereich ist 0-3, was mit den Inkrementen 1, 2, 4 und 8 korrespondiert.
Current Down Step Width: Setzt das Decrement pro Stallguard-Wert. Der Wertebereich ist 0-3, was mit den Dekrementen 1, 2, 8 und 16 korrespondiert.
Minimum Current: Setzt den minimalen Strom für die Coolstep Stromregelung. Es kann zwischen der Hälfte und einem Viertel des Motorstroms gewählt werden.
Stallguard Threshold Value: Setzt den Grenzwert für die Stall-Ausgabe (Motor blockiert) (siehe get_driver_status()). Ein niedriger Wert führt zu einer höheren Empfindlichkeit. Der korrekte Wert muss typischerweise ausprobiert werden. 0 sollte für die meisten Motoren funktionieren.
Stallguard Mode: Setze 0 für eine Standardauflösung und 1 für Filtered Mode. Im Filtered Modus wird das Stallguard Signal nur alle vier Vollschritte aktualisiert.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für current_up_step_width:

BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_1 = 0
BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_2 = 1
BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_4 = 2
BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_8 = 3

Für current_down_step_width:

BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_1 = 0
BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_2 = 1
BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_8 = 2
BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_32 = 3

Für minimum_current:

BrickletSilentStepperV2.MINIMUM_CURRENT_HALF = 0
BrickletSilentStepperV2.MINIMUM_CURRENT_QUARTER = 1

Für stallguard_mode:

BrickletSilentStepperV2.STALLGUARD_MODE_STANDARD = 0
BrickletSilentStepperV2.STALLGUARD_MODE_FILTERED = 1

BrickletSilentStepperV2.get_coolstep_configuration()¶

Rückgabeobjekt:

Rückgabeobjekt:	minimum_stallguard_value – Typ: int, Wertebereich: [0 bis 15], Standardwert: 2 maximum_stallguard_value – Typ: int, Wertebereich: [0 bis 15], Standardwert: 10 current_up_step_width – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 current_down_step_width – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 minimum_current – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 stallguard_threshold_value – Typ: int, Wertebereich: [-64 bis 63], Standardwert: 0 stallguard_mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

minimum_stallguard_value – Typ: int, Wertebereich: [0 bis 15], Standardwert: 2
maximum_stallguard_value – Typ: int, Wertebereich: [0 bis 15], Standardwert: 10
current_up_step_width – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
current_down_step_width – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
minimum_current – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0
stallguard_threshold_value – Typ: int, Wertebereich: [-64 bis 63], Standardwert: 0
stallguard_mode – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration zurück, wie von set_coolstep_configuration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für current_up_step_width:

BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_1 = 0
BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_2 = 1
BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_4 = 2
BrickletSilentStepperV2.CURRENT_UP_STEP_INCREMENT_8 = 3

Für current_down_step_width:

BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_1 = 0
BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_2 = 1
BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_8 = 2
BrickletSilentStepperV2.CURRENT_DOWN_STEP_DECREMENT_32 = 3

Für minimum_current:

BrickletSilentStepperV2.MINIMUM_CURRENT_HALF = 0
BrickletSilentStepperV2.MINIMUM_CURRENT_QUARTER = 1

Für stallguard_mode:

BrickletSilentStepperV2.STALLGUARD_MODE_STANDARD = 0
BrickletSilentStepperV2.STALLGUARD_MODE_FILTERED = 1

BrickletSilentStepperV2.set_misc_configuration(disable_short_to_ground_protection, synchronize_phase_frequency)¶

Parameter:	disable_short_to_ground_protection – Typ: bool, Standardwert: False synchronize_phase_frequency – Typ: int, Wertebereich: [0 bis 15], Standardwert: 0
Rückgabe:	None

Note: Typischerweise können diese Werte bei ihren Standardwerten gelassen werden. Sie sollten nur geändert werden, wenn man weiß was man tut.

Setzt verschiedene Parametereinstellungen.

Disable Short To Ground Protection: Setze diesen Wert auf False um den Kurzschluss nach Masse Schutz zu aktivieren. Ansonsten ist dieser deaktiviert.
Synchronize Phase Frequency: Mit diesem Parameter kann der Chopper für beide Phasen eines zweiphasen Motors synchronisiert werden. Der Wertebereich ist 0-15. Wenn der Wert auf 0 gesetzt wird ist die Synchronisation abgeschaltet. Ansonsten wird die Synchronisation mit folgender Formel durchgeführt: f_sync = f_clk/(value*64). Im Classic Modus ist die Synchronisation automatisch abgeschaltet. f_clk ist 12.8MHz.

BrickletSilentStepperV2.get_misc_configuration()¶

Rückgabeobjekt:	disable_short_to_ground_protection – Typ: bool, Standardwert: False synchronize_phase_frequency – Typ: int, Wertebereich: [0 bis 15], Standardwert: 0

Gibt die Konfiguration zurück, wie von set_misc_configuration() gesetzt.

BrickletSilentStepperV2.set_error_led_config(config)¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	None

Konfiguriert die Touch-LED. Die LED kann ausgeschaltet, eingeschaltet, im Herzschlagmodus betrieben werden. Zusätzlich gibt es die Option den Fehler-Status anzuzeigen.

Wenn die LED konfiguriert ist um Fehler anzuzeigen gibt es drei unterschiedliche Zustände:

Aus: Es liegt kein Fehler vor.
250ms Intervall-Blinken: Übertemperaturwarnung.
1s Intervall-Blinken: Eingangsspannung zu gering.
Durchgängig rot: Motor deaktiviert auf Grund von Kurzschluss mit Masse in Phase A oder B oder auf Grund von zu hoher Temperatur.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

BrickletSilentStepperV2.ERROR_LED_CONFIG_OFF = 0
BrickletSilentStepperV2.ERROR_LED_CONFIG_ON = 1
BrickletSilentStepperV2.ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletSilentStepperV2.ERROR_LED_CONFIG_SHOW_ERROR = 3

BrickletSilentStepperV2.get_error_led_config()¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von set_error_led_config() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

BrickletSilentStepperV2.ERROR_LED_CONFIG_OFF = 0
BrickletSilentStepperV2.ERROR_LED_CONFIG_ON = 1
BrickletSilentStepperV2.ERROR_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletSilentStepperV2.ERROR_LED_CONFIG_SHOW_ERROR = 3

BrickletSilentStepperV2.get_driver_status()¶

Rückgabeobjekt:

Rückgabeobjekt:	open_load – Typ: int, Wertebereich: Siehe Konstanten short_to_ground – Typ: int, Wertebereich: Siehe Konstanten over_temperature – Typ: int, Wertebereich: Siehe Konstanten motor_stalled – Typ: bool actual_motor_current – Typ: int, Wertebereich: [0 bis 31] full_step_active – Typ: bool stallguard_result – Typ: int, Wertebereich: [0 bis 255] stealth_voltage_amplitude – Typ: int, Wertebereich: [0 bis 255]

open_load – Typ: int, Wertebereich: Siehe Konstanten
short_to_ground – Typ: int, Wertebereich: Siehe Konstanten
over_temperature – Typ: int, Wertebereich: Siehe Konstanten
motor_stalled – Typ: bool
actual_motor_current – Typ: int, Wertebereich: [0 bis 31]
full_step_active – Typ: bool
stallguard_result – Typ: int, Wertebereich: [0 bis 255]
stealth_voltage_amplitude – Typ: int, Wertebereich: [0 bis 255]

Gibt den aktuellen Treiberstatus zurück.

Open Load: Gibt an, dass keine Last an den Phasen A oder B, oder bei beiden vorhanden ist (open load). In dem Fall kann es ein Problem mit der Verkabelung des Motors geben. Es kann aber auch Fehlmeldungen geben, wenn der Motor sich schnell bewegt oder sich im Stillstand befindet.
Short To Ground: Gibt an, dass es einen Kurzschluss zwischen einer Phase (A,B) oder beiden Phasen nach Masse gibt. Wenn dies erkannt wird, wird der Treiber automatisch deaktiviert und muss wieder manuell aktiviert werden.
Over Temperature: Wenn der Treiber sich aufwärmt gibt dieser Status "Warning" aus. Dies ist erwartet, wenn der Motor längere Zeit benutzt wird. Wenn das Temperaturlimit erreicht wird ändert sich der Status zu "Limit". In diesem Fall wird der Treiber automatisch deaktiviert bis er sich wieder abgekühlt hat.
Motor Stalled: Ist True, wenn erkannt wurde, dass der Motor blockiert.
Actual Motor Current: Gibt die aktuelle Motorstromskalierung im Coolstep Modus aus. Er repräsentiert einer Multiplikator von 1/32 bis zu 32/32 vom Motor Run Current, wie von set_basic_configuration() gesetzt. Beispiel: Wenn ein Motor Run Current von 1000mA gesetzt wurde und ein Wert von 15 zurückgegeben wird, entspricht das einem Actual Motor Current von 16/32*1000mA = 500mA.
Stallguard Result: Der Stallguard Wert gibt einen Hinweis auf die Last des Motors. Ein niedriger Wert bedeutet eine höhere Last. Über Ausprobieren kann man mit diesem Wert herausfinden, welcher Wert zu einem geeigneten Drehmoment bei der aktuellen Geschwindigkeit führt. Danach kann über diesen Wert herausgefunden werden, wenn eine Blockierung des Motors wahrscheinlich wird und es kann dementsprechend darauf reagiert werden (z.B. indem die Geschwindigkeit reduziert wird). Im Stillstand kann dieser Wert nicht benutzt werden. Er zeigt dann die Chopper On-Time für Motorspule A.
Stealth Voltage Amplitude: Zeigt das aktuelle PWM Scaling. Im Stealth Modus kann dieser Wert benutzt werden um die Motorlast abzuschätzen und eine Blockierung erkannt werden, wenn autoscale aktiviert wurde (see set_stealth_configuration()).

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für open_load:

BrickletSilentStepperV2.OPEN_LOAD_NONE = 0
BrickletSilentStepperV2.OPEN_LOAD_PHASE_A = 1
BrickletSilentStepperV2.OPEN_LOAD_PHASE_B = 2
BrickletSilentStepperV2.OPEN_LOAD_PHASE_AB = 3

Für short_to_ground:

BrickletSilentStepperV2.SHORT_TO_GROUND_NONE = 0
BrickletSilentStepperV2.SHORT_TO_GROUND_PHASE_A = 1
BrickletSilentStepperV2.SHORT_TO_GROUND_PHASE_B = 2
BrickletSilentStepperV2.SHORT_TO_GROUND_PHASE_AB = 3

Für over_temperature:

BrickletSilentStepperV2.OVER_TEMPERATURE_NONE = 0
BrickletSilentStepperV2.OVER_TEMPERATURE_WARNING = 1
BrickletSilentStepperV2.OVER_TEMPERATURE_LIMIT = 2

BrickletSilentStepperV2.set_time_base(time_base)¶

Parameter:	time_base – Typ: int, Einheit: 1 s, Wertebereich: [0 bis 2³² - 1], Standardwert: 1
Rückgabe:	None

Setzt die Zeitbasis der Geschwindigkeit und Beschleunigung des Silent Stepper Bricklet 2.0.

Beispiel: Wenn aller 1,5 Sekunden ein Schritt gefahren werden soll, kann die Zeitbasis auf 15 und die Geschwindigkeit auf 10 gesetzt werden. Damit ist die Geschwindigkeit 10Schritte/15s = 1Schritt/1,5s.

BrickletSilentStepperV2.get_time_base()¶

Rückgabe:	time_base – Typ: int, Einheit: 1 s, Wertebereich: [0 bis 2³² - 1], Standardwert: 1

Gibt die Zeitbasis zurück, wie von set_time_base() gesetzt.

BrickletSilentStepperV2.get_all_data()¶

Rückgabeobjekt:	current_velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1] current_position – Typ: int, Wertebereich: [-2³¹ bis 2³¹ - 1] remaining_steps – Typ: int, Wertebereich: [-2³¹ bis 2³¹ - 1] input_voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1] current_consumption – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die folgenden Parameter zurück: Die aktuelle Geschwindigkeit, die aktuelle Position, die verbleibenden Schritte, die Spannung des Stapels, die externe Spannung und der aktuelle Stromverbrauch des Schrittmotors.

Der Stromverbrauch des Schrittmotors wird berechnet aus dem Actual Motor Current-Wert (siehe set_basic_configuration()) multipliziert mit dem Motor Run Current (see get_driver_status()). Es handelt sich dabei um eine interne Berechnung des Treibers, nicht um eine externe unabhängige Messung.

Die Stromverbrauchsberechnung war bis Firmware 2.0.1 fehlerhaft, sie funktioniert seit Version 2.0.2 wie beschrieben.

Es existiert auch ein Callback für diese Funktion, siehe CALLBACK_ALL_DATA Callback.

BrickletSilentStepperV2.get_spitfp_error_count()¶

Rückgabeobjekt:	error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_message_checksum – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_frame – Typ: int, Wertebereich: [0 bis 2³² - 1] error_count_overflow – Typ: int, Wertebereich: [0 bis 2³² - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

ACK-Checksummen Fehler,
Message-Checksummen Fehler,
Framing Fehler und
Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

BrickletSilentStepperV2.set_status_led_config(config)¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:	None

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

BrickletSilentStepperV2.STATUS_LED_CONFIG_OFF = 0
BrickletSilentStepperV2.STATUS_LED_CONFIG_ON = 1
BrickletSilentStepperV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletSilentStepperV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletSilentStepperV2.get_status_led_config()¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von set_status_led_config() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für config:

BrickletSilentStepperV2.STATUS_LED_CONFIG_OFF = 0
BrickletSilentStepperV2.STATUS_LED_CONFIG_ON = 1
BrickletSilentStepperV2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
BrickletSilentStepperV2.STATUS_LED_CONFIG_SHOW_STATUS = 3

BrickletSilentStepperV2.get_chip_temperature()¶

Rückgabe:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-2¹⁵ bis 2¹⁵ - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

BrickletSilentStepperV2.reset()¶

Rückgabe:	None

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletSilentStepperV2.get_identity()¶

Rückgabeobjekt:

uid – Typ: str, Länge: bis zu 8
connected_uid – Typ: str, Länge: bis zu 8
position – Typ: chr, Wertebereich: ["a" bis "h", "z"]
hardware_version – Typ: [int, ...], Länge: 3

0: major – Typ: int, Wertebereich: [0 bis 255]
1: minor – Typ: int, Wertebereich: [0 bis 255]
2: revision – Typ: int, Wertebereich: [0 bis 255]

firmware_version – Typ: [int, ...], Länge: 3

0: major – Typ: int, Wertebereich: [0 bis 255]
1: minor – Typ: int, Wertebereich: [0 bis 255]
2: revision – Typ: int, Wertebereich: [0 bis 255]

device_identifier – Typ: int, Wertebereich: [0 bis 2¹⁶ - 1]

Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.

Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

BrickletSilentStepperV2.register_callback(callback_id, function)¶

Parameter:	callback_id – Typ: int function – Typ: callable
Rückgabe:	None

Registriert die function für die gegebene callback_id.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

BrickletSilentStepperV2.set_minimum_voltage(voltage)¶

Parameter:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 8000
Rückgabe:	None

Setzt die minimale Spannung, bei welcher der CALLBACK_UNDER_VOLTAGE Callback ausgelöst wird. Der kleinste mögliche Wert mit dem der Silent Stepper Bricklet 2.0 noch funktioniert, ist 8V. Mit dieser Funktion kann eine Entladung der versorgenden Batterie detektiert werden. Beim Einsatz einer Netzstromversorgung wird diese Funktionalität höchstwahrscheinlich nicht benötigt.

BrickletSilentStepperV2.get_minimum_voltage()¶

Rückgabe:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1], Standardwert: 8000

Gibt die minimale Spannung zurück, wie von set_minimum_voltage() gesetzt.

BrickletSilentStepperV2.set_all_callback_configuration(period)¶

Parameter:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0
Rückgabe:	None

Setzt die Periode mit welcher der CALLBACK_ALL_DATA Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

BrickletSilentStepperV2.get_all_data_callback_configuraton()¶

Rückgabe:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 2³² - 1], Standardwert: 0

Gibt die Periode zurück, wie von set_all_callback_configuration() gesetzt.

BrickletSilentStepperV2.set_motor_stalled_callback_configuration(enabled)¶

Parameter:	enabled – Typ: bool, Standardwert: False
Rückgabe:	None

Setzt die Periode mit welcher der CALLBACK_ALL_DATA Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

BrickletSilentStepperV2.get_motor_stalled_callback_configuraton()¶

Rückgabe:	enabled – Typ: bool

Gibt die Periode zurück, wie von set_all_callback_configuration() gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der Funktion register_callback() des Geräte Objektes durchgeführt werden. Der erste Parameter ist die Callback ID und der zweite Parameter die Callback-Funktion:

def my_callback(param):
    print(param)

silent_stepper_v2.register_callback(BrickletSilentStepperV2.CALLBACK_EXAMPLE, my_callback)

Die verfügbaren IDs mit der dazugehörigen Parameteranzahl und -typen werden weiter unten beschrieben.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

BrickletSilentStepperV2.CALLBACK_UNDER_VOLTAGE¶

Callback-Parameter:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1]

Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels set_minimum_voltage() gesetzten, Schwellwert sinkt. Der Parameter ist die aktuelle Spannung.

BrickletSilentStepperV2.CALLBACK_POSITION_REACHED¶

Callback-Parameter:	position – Typ: int, Wertebereich: [-2³¹ bis 2³¹ - 1]

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Position, wie von set_steps() oder set_target_position() gesetzt, erreicht wird.

Bemerkung

Da es nicht möglich ist eine Rückmeldung vom Schrittmotor zu erhalten, funktioniert dies nur wenn die konfigurierte Beschleunigung (siehe set_speed_ramping()) kleiner oder gleich der maximalen Beschleunigung des Motors ist. Andernfalls wird der Motor hinter dem Vorgabewert zurückbleiben und der Callback wird zu früh ausgelöst.

BrickletSilentStepperV2.CALLBACK_ALL_DATA¶

Callback-Parameter:	current_velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 2¹⁶ - 1] current_position – Typ: int, Wertebereich: [-2³¹ bis 2³¹ - 1] remaining_steps – Typ: int, Wertebereich: [-2³¹ bis 2³¹ - 1] input_voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 2¹⁶ - 1] current_consumption – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 2¹⁶ - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit set_all_callback_configuration(), ausgelöst. Die Parameter sind die aktuelle Geschwindigkeit, die aktuelle Position, die verbleibenden Schritte, die Spannung des Stapels, die externe Spannung und der aktuelle Stromverbrauch des Schrittmotors.

BrickletSilentStepperV2.CALLBACK_NEW_STATE¶

Callback-Parameter:	state_new – Typ: int, Wertebereich: Siehe Konstanten state_previous – Typ: int, Wertebereich: Siehe Konstanten

Dieser Callback wird immer dann ausgelöst, wenn der Silent Stepper Bricklet 2.0 einen neuen Zustand erreicht. Es wird sowohl der neue wie auch der alte Zustand zurückgegeben.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für state_new:

BrickletSilentStepperV2.STATE_STOP = 1
BrickletSilentStepperV2.STATE_ACCELERATION = 2
BrickletSilentStepperV2.STATE_RUN = 3
BrickletSilentStepperV2.STATE_DEACCELERATION = 4
BrickletSilentStepperV2.STATE_DIRECTION_CHANGE_TO_FORWARD = 5
BrickletSilentStepperV2.STATE_DIRECTION_CHANGE_TO_BACKWARD = 6

Für state_previous:

BrickletSilentStepperV2.STATE_STOP = 1
BrickletSilentStepperV2.STATE_ACCELERATION = 2
BrickletSilentStepperV2.STATE_RUN = 3
BrickletSilentStepperV2.STATE_DEACCELERATION = 4
BrickletSilentStepperV2.STATE_DIRECTION_CHANGE_TO_FORWARD = 5
BrickletSilentStepperV2.STATE_DIRECTION_CHANGE_TO_BACKWARD = 6

BrickletSilentStepperV2.CALLBACK_GPIO_STATE¶

Callback-Parameter:	gpio_state – Typ: [bool, ...], Länge: 2

Dieser Callback wird ausgelöst durch GPIO-Änderungen wenn er über set_gpio_action() aktiviert wurde.

BrickletSilentStepperV2.CALLBACK_MOTOR_STALLED¶

Callback-Parameter:	position – Typ: int, Wertebereich: [-2³¹ bis 2³¹ - 1]

Dieser Callback wird immer dann ausgelöst, wenn der Motor-Stalled-Parameter im Status gesetzt wird (Änderung von False auf True). Siehe get_driver_status().

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

BrickletSilentStepperV2.get_api_version()¶

Rückgabeobjekt:	api_version – Typ: [int, ...], Länge: 3 0: major – Typ: int, Wertebereich: [0 bis 255] 1: minor – Typ: int, Wertebereich: [0 bis 255] 2: revision – Typ: int, Wertebereich: [0 bis 255]

Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.

BrickletSilentStepperV2.get_response_expected(function_id)¶

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	response_expected – Typ: bool

Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.

Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt werden, da diese Funktionen immer eine Antwort senden. Für Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber entfernt werden mittels set_response_expected(). Für Setter-Funktionen ist es standardmäßig nicht gesetzt, kann aber gesetzt werden.

Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

BrickletSilentStepperV2.FUNCTION_SET_MAX_VELOCITY = 1
BrickletSilentStepperV2.FUNCTION_SET_SPEED_RAMPING = 4
BrickletSilentStepperV2.FUNCTION_FULL_BRAKE = 6
BrickletSilentStepperV2.FUNCTION_SET_CURRENT_POSITION = 7
BrickletSilentStepperV2.FUNCTION_SET_TARGET_POSITION = 9
BrickletSilentStepperV2.FUNCTION_SET_STEPS = 11
BrickletSilentStepperV2.FUNCTION_SET_STEP_CONFIGURATION = 14
BrickletSilentStepperV2.FUNCTION_DRIVE_FORWARD = 16
BrickletSilentStepperV2.FUNCTION_DRIVE_BACKWARD = 17
BrickletSilentStepperV2.FUNCTION_STOP = 18
BrickletSilentStepperV2.FUNCTION_SET_MOTOR_CURRENT = 22
BrickletSilentStepperV2.FUNCTION_SET_ENABLED = 24
BrickletSilentStepperV2.FUNCTION_SET_BASIC_CONFIGURATION = 26
BrickletSilentStepperV2.FUNCTION_SET_SPREADCYCLE_CONFIGURATION = 28
BrickletSilentStepperV2.FUNCTION_SET_STEALTH_CONFIGURATION = 30
BrickletSilentStepperV2.FUNCTION_SET_COOLSTEP_CONFIGURATION = 32
BrickletSilentStepperV2.FUNCTION_SET_MISC_CONFIGURATION = 34
BrickletSilentStepperV2.FUNCTION_SET_ERROR_LED_CONFIG = 36
BrickletSilentStepperV2.FUNCTION_SET_MINIMUM_VOLTAGE = 39
BrickletSilentStepperV2.FUNCTION_SET_TIME_BASE = 43
BrickletSilentStepperV2.FUNCTION_SET_ALL_CALLBACK_CONFIGURATION = 46
BrickletSilentStepperV2.FUNCTION_SET_GPIO_CONFIGURATION = 48
BrickletSilentStepperV2.FUNCTION_SET_GPIO_ACTION = 50
BrickletSilentStepperV2.FUNCTION_SET_MOTOR_STALLED_CALLBACK_CONFIGURATION = 56
BrickletSilentStepperV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletSilentStepperV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletSilentStepperV2.FUNCTION_RESET = 243
BrickletSilentStepperV2.FUNCTION_WRITE_UID = 248

BrickletSilentStepperV2.set_response_expected(function_id, response_expected)¶

Parameter:	function_id – Typ: int, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	None

Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für function_id:

BrickletSilentStepperV2.FUNCTION_SET_MAX_VELOCITY = 1
BrickletSilentStepperV2.FUNCTION_SET_SPEED_RAMPING = 4
BrickletSilentStepperV2.FUNCTION_FULL_BRAKE = 6
BrickletSilentStepperV2.FUNCTION_SET_CURRENT_POSITION = 7
BrickletSilentStepperV2.FUNCTION_SET_TARGET_POSITION = 9
BrickletSilentStepperV2.FUNCTION_SET_STEPS = 11
BrickletSilentStepperV2.FUNCTION_SET_STEP_CONFIGURATION = 14
BrickletSilentStepperV2.FUNCTION_DRIVE_FORWARD = 16
BrickletSilentStepperV2.FUNCTION_DRIVE_BACKWARD = 17
BrickletSilentStepperV2.FUNCTION_STOP = 18
BrickletSilentStepperV2.FUNCTION_SET_MOTOR_CURRENT = 22
BrickletSilentStepperV2.FUNCTION_SET_ENABLED = 24
BrickletSilentStepperV2.FUNCTION_SET_BASIC_CONFIGURATION = 26
BrickletSilentStepperV2.FUNCTION_SET_SPREADCYCLE_CONFIGURATION = 28
BrickletSilentStepperV2.FUNCTION_SET_STEALTH_CONFIGURATION = 30
BrickletSilentStepperV2.FUNCTION_SET_COOLSTEP_CONFIGURATION = 32
BrickletSilentStepperV2.FUNCTION_SET_MISC_CONFIGURATION = 34
BrickletSilentStepperV2.FUNCTION_SET_ERROR_LED_CONFIG = 36
BrickletSilentStepperV2.FUNCTION_SET_MINIMUM_VOLTAGE = 39
BrickletSilentStepperV2.FUNCTION_SET_TIME_BASE = 43
BrickletSilentStepperV2.FUNCTION_SET_ALL_CALLBACK_CONFIGURATION = 46
BrickletSilentStepperV2.FUNCTION_SET_GPIO_CONFIGURATION = 48
BrickletSilentStepperV2.FUNCTION_SET_GPIO_ACTION = 50
BrickletSilentStepperV2.FUNCTION_SET_MOTOR_STALLED_CALLBACK_CONFIGURATION = 56
BrickletSilentStepperV2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
BrickletSilentStepperV2.FUNCTION_SET_STATUS_LED_CONFIG = 239
BrickletSilentStepperV2.FUNCTION_RESET = 243
BrickletSilentStepperV2.FUNCTION_WRITE_UID = 248

BrickletSilentStepperV2.set_response_expected_all(response_expected)¶

Parameter:	response_expected – Typ: bool
Rückgabe:	None

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

BrickletSilentStepperV2.set_bootloader_mode(mode)¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

BrickletSilentStepperV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletSilentStepperV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletSilentStepperV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletSilentStepperV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletSilentStepperV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

BrickletSilentStepperV2.BOOTLOADER_STATUS_OK = 0
BrickletSilentStepperV2.BOOTLOADER_STATUS_INVALID_MODE = 1
BrickletSilentStepperV2.BOOTLOADER_STATUS_NO_CHANGE = 2
BrickletSilentStepperV2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
BrickletSilentStepperV2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
BrickletSilentStepperV2.BOOTLOADER_STATUS_CRC_MISMATCH = 5

BrickletSilentStepperV2.get_bootloader_mode()¶

Rückgabe:	mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe set_bootloader_mode().

Die folgenden Konstanten sind für diese Funktion verfügbar:

Für mode:

BrickletSilentStepperV2.BOOTLOADER_MODE_BOOTLOADER = 0
BrickletSilentStepperV2.BOOTLOADER_MODE_FIRMWARE = 1
BrickletSilentStepperV2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
BrickletSilentStepperV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
BrickletSilentStepperV2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

BrickletSilentStepperV2.set_write_firmware_pointer(pointer)¶

Parameter:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	None

Setzt den Firmware-Pointer für write_firmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletSilentStepperV2.write_firmware(data)¶

Parameter:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von set_write_firmware_pointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

BrickletSilentStepperV2.write_uid(uid)¶

Parameter:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]
Rückgabe:	None

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

BrickletSilentStepperV2.read_uid()¶

Rückgabe:	uid – Typ: int, Wertebereich: [0 bis 2³² - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

BrickletSilentStepperV2.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Silent Stepper Bricklet 2.0 zu identifizieren.

Die get_identity() Funktion und der IPConnection.CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

BrickletSilentStepperV2.DEVICE_DISPLAY_NAME¶: Diese Konstante stellt den Anzeigenamen eines Silent Stepper Bricklet 2.0 dar.