MQTT - Silent Stepper Bricklet 2.0¶

Configuration¶

Download (example-configuration.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# Change XYZ to the UID of your Silent Stepper Bricklet 2.0

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

    publish '{"step_resolution": "8", "interpolation": true}' to tinkerforge/request/silent_stepper_v2_bricklet/XYZ/set_step_configuration # 1/8 steps (interpolated)

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

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

    publish '{"enabled": true}' to tinkerforge/request/silent_stepper_v2_bricklet/XYZ/set_enabled # Enable motor power

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

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

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

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

    publish '{"enabled": false}' to tinkerforge/request/silent_stepper_v2_bricklet/XYZ/set_enabled # Disable motor power

Callback¶

Download (example-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

# Change XYZ to the UID of your Silent Stepper Bricklet 2.0

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

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

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

    publish '{"register": true}' to tinkerforge/register/silent_stepper_v2_bricklet/XYZ/position_reached # Register position_reached callback

    publish '{"step_resolution": "8", "interpolation": true}' to tinkerforge/request/silent_stepper_v2_bricklet/XYZ/set_step_configuration # 1/8 steps (interpolated)

    publish '{"enabled": true}' to tinkerforge/request/silent_stepper_v2_bricklet/XYZ/set_enabled # Enable motor power

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

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

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

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

    publish '{"enabled": false}' to tinkerforge/request/silent_stepper_v2_bricklet/XYZ/set_enabled # Disable motor power

Grundfunktionen¶

request/silent_stepper_v2_bricklet/<UID>/set_max_velocity¶

Anfrage:	velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]
Antwort:	keine Antwort

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 request/silent_stepper_v2_bricklet/<UID>/set_target_position, request/silent_stepper_v2_bricklet/<UID>/set_steps, request/silent_stepper_v2_bricklet/<UID>/drive_forward oder request/silent_stepper_v2_bricklet/<UID>/drive_backward verwendet werden.

request/silent_stepper_v2_bricklet/<UID>/get_max_velocity¶

Anfrage:	keine Nutzdaten
Antwort:	velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]

Gibt die Geschwindigkeit zurück, wie von request/silent_stepper_v2_bricklet/<UID>/set_max_velocity gesetzt.

request/silent_stepper_v2_bricklet/<UID>/get_current_velocity¶

Anfrage:	keine Nutzdaten
Antwort:	velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1]

Gibt die aktuelle Geschwindigkeit des Schrittmotors zurück.

request/silent_stepper_v2_bricklet/<UID>/set_speed_ramping¶

Anfrage:	acceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000 deacceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000
Antwort:	keine Antwort

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

request/silent_stepper_v2_bricklet/<UID>/get_speed_ramping¶

Anfrage:	keine Nutzdaten
Antwort:	acceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000 deacceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 1000

Gibt die Beschleunigung und Verzögerung zurück, wie von request/silent_stepper_v2_bricklet/<UID>/set_speed_ramping gesetzt.

request/silent_stepper_v2_bricklet/<UID>/full_brake¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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 request/silent_stepper_v2_bricklet/<UID>/stop stoppt den Motor.

request/silent_stepper_v2_bricklet/<UID>/set_steps¶

Anfrage:	steps – Typ: int, Wertebereich: [-231 bis 231 - 1]
Antwort:	keine Antwort

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 request/silent_stepper_v2_bricklet/<UID>/set_max_velocity und request/silent_stepper_v2_bricklet/<UID>/set_speed_ramping gesetzt, verwendet.

request/silent_stepper_v2_bricklet/<UID>/get_steps¶

Anfrage:	keine Nutzdaten
Antwort:	steps – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt die letzten Schritte zurück, wie von request/silent_stepper_v2_bricklet/<UID>/set_steps gesetzt.

request/silent_stepper_v2_bricklet/<UID>/get_remaining_steps¶

Anfrage:	keine Nutzdaten
Antwort:	steps – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt die verbleibenden Schritte des letzten Aufrufs von request/silent_stepper_v2_bricklet/<UID>/set_steps zurück. Beispiel: Wenn request/silent_stepper_v2_bricklet/<UID>/set_steps mit 2000 aufgerufen wird und request/silent_stepper_v2_bricklet/<UID>/get_remaining_steps aufgerufen wird wenn der Motor 500 Schritte fahren hat, wird 1500 zurückgegeben.

request/silent_stepper_v2_bricklet/<UID>/drive_forward¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Fährt den Schrittmotor vorwärts bis request/silent_stepper_v2_bricklet/<UID>/drive_backward oder request/silent_stepper_v2_bricklet/<UID>/stop aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit request/silent_stepper_v2_bricklet/<UID>/set_max_velocity und request/silent_stepper_v2_bricklet/<UID>/set_speed_ramping gesetzt, verwendet.

request/silent_stepper_v2_bricklet/<UID>/drive_backward¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Fährt den Schrittmotor rückwärts bis request/silent_stepper_v2_bricklet/<UID>/drive_forward oder request/silent_stepper_v2_bricklet/<UID>/stop aufgerufen wird. Dabei wird die Geschwindigkeit, Beschleunigung und Verzögerung, wie mit request/silent_stepper_v2_bricklet/<UID>/set_max_velocity und request/silent_stepper_v2_bricklet/<UID>/set_speed_ramping gesetzt, verwendet.

request/silent_stepper_v2_bricklet/<UID>/stop¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Stoppt den Schrittmotor mit der Verzögerung, wie von request/silent_stepper_v2_bricklet/<UID>/set_speed_ramping gesetzt.

request/silent_stepper_v2_bricklet/<UID>/set_motor_current¶

Anfrage:	current – Typ: int, Einheit: 1 mA, Wertebereich: [360 bis 1640], Standardwert: 800
Antwort:	keine Antwort

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.

request/silent_stepper_v2_bricklet/<UID>/get_motor_current¶

Anfrage:	keine Nutzdaten
Antwort:	current – Typ: int, Einheit: 1 mA, Wertebereich: [360 bis 1640], Standardwert: 800

Gibt den Strom zurück, wie von request/silent_stepper_v2_bricklet/<UID>/set_motor_current gesetzt.

request/silent_stepper_v2_bricklet/<UID>/set_enabled¶

Anfrage:	enabled – Typ: bool, Standardwert: false
Antwort:	keine Antwort

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 request/silent_stepper_v2_bricklet/<UID>/stop Funktion gestoppt werden, bevor die Treiberstufe deaktiviert wird. Die request/silent_stepper_v2_bricklet/<UID>/stop Funktion wartet nicht bis der Motor wirklich zum Stillstand gekommen ist. Dazu muss nach dem Aufruf der request/silent_stepper_v2_bricklet/<UID>/stop Funktion eine angemessen Zeit gewartet werden bevor die Funktion request/silent_stepper_v2_bricklet/<UID>/set_enabled mit false aufgerufen wird.

request/silent_stepper_v2_bricklet/<UID>/get_enabled¶

Anfrage:	keine Nutzdaten
Antwort:	enabled – Typ: bool, Standardwert: false

Gibt zurück ob der Schrittmotortreiber aktiviert ist.

request/silent_stepper_v2_bricklet/<UID>/set_basic_configuration¶

Anfrage:

standstill_current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 200 motor_run_current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 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 216 - 1], Standardwert: 500 coolstep_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 500 classic_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 1000 high_velocity_chopper_mode – Typ: bool, Standardwert: false

Antwort:

keine Antwort

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 request/silent_stepper_v2_bricklet/<UID>/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 request/silent_stepper_v2_bricklet/<UID>/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.

request/silent_stepper_v2_bricklet/<UID>/get_basic_configuration¶

Anfrage:

keine Nutzdaten

Antwort:

standstill_current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1], Standardwert: 200 motor_run_current – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 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 216 - 1], Standardwert: 500 coolstep_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 500 classic_threshold – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1], Standardwert: 1000 high_velocity_chopper_mode – Typ: bool, Standardwert: false

Gibt die Konfiguration zurück, wie von request/silent_stepper_v2_bricklet/<UID>/set_basic_configuration gesetzt.

request/silent_stepper_v2_bricklet/<UID>/set_gpio_configuration¶

Anfrage:	channel – Typ: int, Wertebereich: [0 bis 1] debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 200 stop_deceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1
Antwort:	keine Antwort

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 request/silent_stepper_v2_bricklet/<UID>/set_gpio_action.

request/silent_stepper_v2_bricklet/<UID>/get_gpio_configuration¶

Anfrage:	channel – Typ: int, Wertebereich: [0 bis 1]
Antwort:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1], Standardwert: 200 stop_deceleration – Typ: int, Einheit: 1 1/s², Wertebereich: [0 bis 216 - 1], Standardwert: 216 - 1

Gibt die GPIO-Konfiguration für einen Kanal zurück, wie von request/silent_stepper_v2_bricklet/<UID>/set_gpio_configuration gesetzt.

request/silent_stepper_v2_bricklet/<UID>/set_gpio_action¶

Anfrage:	channel – Typ: int, Wertebereich: [0 bis 1] action – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
Antwort:	keine Antwort

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 request/silent_stepper_v2_bricklet/<UID>/set_gpio_configuration konfiguriert werden.

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

Für action:

• "none" = 0
• "normal_stop_rising_edge" = 1
• "normal_stop_falling_edge" = 2
• "full_brake_rising_edge" = 4
• "full_brake_falling_edge" = 8
• "callback_rising_edge" = 16
• "callback_falling_edge" = 32

request/silent_stepper_v2_bricklet/<UID>/get_gpio_action¶

Anfrage:	channel – Typ: int, Wertebereich: [0 bis 1]
Antwort:	action – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die GPIO-Action für einen Kanal zurück, wie von request/silent_stepper_v2_bricklet/<UID>/set_gpio_action gesetzt.

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

Für action:

• "none" = 0
• "normal_stop_rising_edge" = 1
• "normal_stop_falling_edge" = 2
• "full_brake_rising_edge" = 4
• "full_brake_falling_edge" = 8
• "callback_rising_edge" = 16
• "callback_falling_edge" = 32

request/silent_stepper_v2_bricklet/<UID>/get_gpio_state¶

Anfrage:	keine Nutzdaten
Antwort:	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¶

request/silent_stepper_v2_bricklet/<UID>/set_current_position¶

Anfrage:	position – Typ: int, Wertebereich: [-231 bis 231 - 1]
Antwort:	keine Antwort

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

request/silent_stepper_v2_bricklet/<UID>/get_current_position¶

Anfrage:	keine Nutzdaten
Antwort:	position – Typ: int, Wertebereich: [-231 bis 231 - 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 (request/silent_stepper_v2_bricklet/<UID>/set_target_position, request/silent_stepper_v2_bricklet/<UID>/set_steps, request/silent_stepper_v2_bricklet/<UID>/drive_forward der request/silent_stepper_v2_bricklet/<UID>/drive_backward). Es ist auch möglich den Schrittzähler auf 0 oder jeden anderen gewünschten Wert zu setzen mit request/silent_stepper_v2_bricklet/<UID>/set_current_position.

request/silent_stepper_v2_bricklet/<UID>/set_target_position¶

Anfrage:	position – Typ: int, Wertebereich: [-231 bis 231 - 1]
Antwort:	keine Antwort

Setzt die Zielposition des Schrittmotors in Schritten. Beispiel: Wenn die aktuelle Position des Motors 500 ist und request/silent_stepper_v2_bricklet/<UID>/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 request/silent_stepper_v2_bricklet/<UID>/set_max_velocity und request/silent_stepper_v2_bricklet/<UID>/set_speed_ramping gesetzt, verwendet.

Ein Aufruf von request/silent_stepper_v2_bricklet/<UID>/set_target_position mit dem Parameter x ist äquivalent mit einem Aufruf von request/silent_stepper_v2_bricklet/<UID>/set_steps mit dem Parameter (x - request/silent_stepper_v2_bricklet/<UID>/get_current_position).

request/silent_stepper_v2_bricklet/<UID>/get_target_position¶

Anfrage:	keine Nutzdaten
Antwort:	position – Typ: int, Wertebereich: [-231 bis 231 - 1]

Gibt die letzte Zielposition zurück, wie von request/silent_stepper_v2_bricklet/<UID>/set_target_position gesetzt.

request/silent_stepper_v2_bricklet/<UID>/set_step_configuration¶

Anfrage:	step_resolution – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0 interpolation – Typ: bool, Standardwert: true
Antwort:	keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für step_resolution:

• "1" = 8
• "2" = 7
• "4" = 6
• "8" = 5
• "16" = 4
• "32" = 3
• "64" = 2
• "128" = 1
• "256" = 0

request/silent_stepper_v2_bricklet/<UID>/get_step_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	step_resolution – Typ: int, Wertebereich: Siehe Symbole interpolation – Typ: bool, Standardwert: true

Gibt den Schrittmodus zurück, wie von request/silent_stepper_v2_bricklet/<UID>/set_step_configuration gesetzt.

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

Für step_resolution:

• "1" = 8
• "2" = 7
• "4" = 6
• "8" = 5
• "16" = 4
• "32" = 3
• "64" = 2
• "128" = 1
• "256" = 0

request/silent_stepper_v2_bricklet/<UID>/get_input_voltage¶

Anfrage:	keine Nutzdaten
Antwort:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 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.

request/silent_stepper_v2_bricklet/<UID>/set_spreadcycle_configuration¶

Anfrage:

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 Symbole, Standardwert: 0 comparator_blank_time – Typ: int, Wertebereich: [0 bis 3], Standardwert: 1 fast_decay_without_comparator – Typ: bool, Standardwert: false

Antwort:

keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für chopper_mode:

• "spread_cycle" = 0
• "fast_decay" = 1

request/silent_stepper_v2_bricklet/<UID>/get_spreadcycle_configuration¶

Anfrage:

keine Nutzdaten

Antwort:

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 Symbole, 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 request/silent_stepper_v2_bricklet/<UID>/set_basic_configuration gesetzt.

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

Für chopper_mode:

• "spread_cycle" = 0
• "fast_decay" = 1

request/silent_stepper_v2_bricklet/<UID>/set_stealth_configuration¶

Anfrage:	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 Symbole, Standardwert: 0
Antwort:	keine Antwort

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 request/silent_stepper_v2_bricklet/<UID>/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 request/silent_stepper_v2_bricklet/<UID>/set_basic_configuration) auf 0 gesetzt wurde.

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

Für freewheel_mode:

• "normal" = 0
• "freewheeling" = 1
• "coil_short_ls" = 2
• "coil_short_hs" = 3

request/silent_stepper_v2_bricklet/<UID>/get_stealth_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	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 Symbole, Standardwert: 0

Gibt die Konfiguration zurück, wie von request/silent_stepper_v2_bricklet/<UID>/set_stealth_configuration gesetzt.

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

Für freewheel_mode:

• "normal" = 0
• "freewheeling" = 1
• "coil_short_ls" = 2
• "coil_short_hs" = 3

request/silent_stepper_v2_bricklet/<UID>/set_coolstep_configuration¶

Anfrage:

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 Symbole, Standardwert: 0 current_down_step_width – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0 minimum_current – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0 stallguard_threshold_value – Typ: int, Wertebereich: [-64 bis 63], Standardwert: 0 stallguard_mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Antwort:

keine Antwort

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 request/silent_stepper_v2_bricklet/<UID>/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 Symbole sind für diese Funktion verfügbar:

Für current_up_step_width:

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

Für current_down_step_width:

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

Für minimum_current:

• "half" = 0
• "quarter" = 1

Für stallguard_mode:

• "standard" = 0
• "filtered" = 1

request/silent_stepper_v2_bricklet/<UID>/get_coolstep_configuration¶

Anfrage:

keine Nutzdaten

Antwort:

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 Symbole, Standardwert: 0 current_down_step_width – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0 minimum_current – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0 stallguard_threshold_value – Typ: int, Wertebereich: [-64 bis 63], Standardwert: 0 stallguard_mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die Konfiguration zurück, wie von request/silent_stepper_v2_bricklet/<UID>/set_coolstep_configuration gesetzt.

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

Für current_up_step_width:

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

Für current_down_step_width:

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

Für minimum_current:

• "half" = 0
• "quarter" = 1

Für stallguard_mode:

• "standard" = 0
• "filtered" = 1

request/silent_stepper_v2_bricklet/<UID>/set_misc_configuration¶

Anfrage:	disable_short_to_ground_protection – Typ: bool, Standardwert: false synchronize_phase_frequency – Typ: int, Wertebereich: [0 bis 15], Standardwert: 0
Antwort:	keine Antwort

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.

request/silent_stepper_v2_bricklet/<UID>/get_misc_configuration¶

Anfrage:	keine Nutzdaten
Antwort:	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 request/silent_stepper_v2_bricklet/<UID>/set_misc_configuration gesetzt.

request/silent_stepper_v2_bricklet/<UID>/set_error_led_config¶

Anfrage:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:	keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_error" = 3

request/silent_stepper_v2_bricklet/<UID>/get_error_led_config¶

Anfrage:	keine Nutzdaten
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die LED-Konfiguration zurück, wie von request/silent_stepper_v2_bricklet/<UID>/set_error_led_config gesetzt.

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

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_error" = 3

request/silent_stepper_v2_bricklet/<UID>/get_driver_status¶

Anfrage:	keine Nutzdaten
Antwort:	open_load – Typ: int, Wertebereich: Siehe Symbole short_to_ground – Typ: int, Wertebereich: Siehe Symbole over_temperature – Typ: int, Wertebereich: Siehe Symbole 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 request/silent_stepper_v2_bricklet/<UID>/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 request/silent_stepper_v2_bricklet/<UID>/set_stealth_configuration).

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

Für open_load:

• "none" = 0
• "phase_a" = 1
• "phase_b" = 2
• "phase_ab" = 3

Für short_to_ground:

• "none" = 0
• "phase_a" = 1
• "phase_b" = 2
• "phase_ab" = 3

Für over_temperature:

• "none" = 0
• "warning" = 1
• "limit" = 2

request/silent_stepper_v2_bricklet/<UID>/set_time_base¶

Anfrage:	time_base – Typ: int, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1
Antwort:	keine Antwort

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.

request/silent_stepper_v2_bricklet/<UID>/get_time_base¶

Anfrage:	keine Nutzdaten
Antwort:	time_base – Typ: int, Einheit: 1 s, Wertebereich: [0 bis 232 - 1], Standardwert: 1

Gibt die Zeitbasis zurück, wie von request/silent_stepper_v2_bricklet/<UID>/set_time_base gesetzt.

request/silent_stepper_v2_bricklet/<UID>/get_all_data¶

Anfrage:	keine Nutzdaten
Antwort:	current_velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1] current_position – Typ: int, Wertebereich: [-231 bis 231 - 1] remaining_steps – Typ: int, Wertebereich: [-231 bis 231 - 1] input_voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1] current_consumption – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 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 request/silent_stepper_v2_bricklet/<UID>/set_basic_configuration) multipliziert mit dem Motor Run Current (see request/silent_stepper_v2_bricklet/<UID>/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 register/silent_stepper_v2_bricklet/<UID>/all_data Callback.

request/silent_stepper_v2_bricklet/<UID>/get_spitfp_error_count¶

Anfrage:	keine Nutzdaten
Antwort:	error_count_ack_checksum – Typ: int, Wertebereich: [0 bis 232 - 1] error_count_message_checksum – Typ: int, Wertebereich: [0 bis 232 - 1] error_count_frame – Typ: int, Wertebereich: [0 bis 232 - 1] error_count_overflow – Typ: int, Wertebereich: [0 bis 232 - 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.

request/silent_stepper_v2_bricklet/<UID>/set_status_led_config¶

Anfrage:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3
Antwort:	keine Antwort

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 Symbole sind für diese Funktion verfügbar:

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_status" = 3

request/silent_stepper_v2_bricklet/<UID>/get_status_led_config¶

Anfrage:	keine Nutzdaten
Antwort:	config – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 3

Gibt die Konfiguration zurück, wie von request/silent_stepper_v2_bricklet/<UID>/set_status_led_config gesetzt.

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

Für config:

• "off" = 0
• "on" = 1
• "show_heartbeat" = 2
• "show_status" = 3

request/silent_stepper_v2_bricklet/<UID>/get_chip_temperature¶

Anfrage:	keine Nutzdaten
Antwort:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 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.

request/silent_stepper_v2_bricklet/<UID>/reset¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

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.

request/silent_stepper_v2_bricklet/<UID>/get_identity¶

Anfrage:

keine Nutzdaten

Antwort:

uid – Typ: string, Länge: bis zu 8 connected_uid – Typ: string, Länge: bis zu 8 position – Typ: char, 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 216 - 1] _display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Silent Stepper 2.0.

Konfigurationsfunktionen für Callbacks¶

request/silent_stepper_v2_bricklet/<UID>/set_minimum_voltage¶

Anfrage:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 8000
Antwort:	keine Antwort

Setzt die minimale Spannung, bei welcher der register/silent_stepper_v2_bricklet/<UID>/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.

request/silent_stepper_v2_bricklet/<UID>/get_minimum_voltage¶

Anfrage:	keine Nutzdaten
Antwort:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 8000

Gibt die minimale Spannung zurück, wie von request/silent_stepper_v2_bricklet/<UID>/set_minimum_voltage gesetzt.

request/silent_stepper_v2_bricklet/<UID>/set_all_callback_configuration¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der register/silent_stepper_v2_bricklet/<UID>/all_data Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

request/silent_stepper_v2_bricklet/<UID>/get_all_data_callback_configuraton¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/silent_stepper_v2_bricklet/<UID>/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 dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

register/silent_stepper_v2_bricklet/<UID>/under_voltage¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/silent_stepper_v2_bricklet/<UID>/under_voltage[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/silent_stepper_v2_bricklet/<UID>/under_voltage[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn die Eingangsspannung unter den, mittels request/silent_stepper_v2_bricklet/<UID>/set_minimum_voltage gesetzten, Schwellwert sinkt. Der Payload des Callbacks ist die aktuelle Spannung.

register/silent_stepper_v2_bricklet/<UID>/position_reached¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	position – Typ: int, Wertebereich: [-231 bis 231 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/silent_stepper_v2_bricklet/<UID>/position_reached[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/silent_stepper_v2_bricklet/<UID>/position_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst immer wenn eine konfigurierte Position, wie von request/silent_stepper_v2_bricklet/<UID>/set_steps oder request/silent_stepper_v2_bricklet/<UID>/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 request/silent_stepper_v2_bricklet/<UID>/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.

register/silent_stepper_v2_bricklet/<UID>/all_data¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	current_velocity – Typ: int, Einheit: 1 1/s, Wertebereich: [0 bis 216 - 1] current_position – Typ: int, Wertebereich: [-231 bis 231 - 1] remaining_steps – Typ: int, Wertebereich: [-231 bis 231 - 1] input_voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1] current_consumption – Typ: int, Einheit: 1 mA, Wertebereich: [0 bis 216 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/silent_stepper_v2_bricklet/<UID>/all_data[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/silent_stepper_v2_bricklet/<UID>/all_data[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/silent_stepper_v2_bricklet/<UID>/set_all_callback_configuration, ausgelöst. Die Payload-Member des Callbacks sind die aktuelle Geschwindigkeit, die aktuelle Position, die verbleibenden Schritte, die Spannung des Stapels, die externe Spannung und der aktuelle Stromverbrauch des Schrittmotors.

register/silent_stepper_v2_bricklet/<UID>/new_state¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	state_new – Typ: int, Wertebereich: Siehe Symbole state_previous – Typ: int, Wertebereich: Siehe Symbole

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/silent_stepper_v2_bricklet/<UID>/new_state[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/silent_stepper_v2_bricklet/<UID>/new_state[/<SUFFIX>]-Topic veröffentlicht.

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 Symbole sind für diese Funktion verfügbar:

Für state_new:

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

Für state_previous:

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

register/silent_stepper_v2_bricklet/<UID>/gpio_state¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	gpio_state – Typ: [bool, ...], Länge: 2

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/silent_stepper_v2_bricklet/<UID>/gpio_state[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/silent_stepper_v2_bricklet/<UID>/gpio_state[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst durch GPIO-Änderungen wenn er über request/silent_stepper_v2_bricklet/<UID>/set_gpio_action aktiviert wurde.

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.

request/silent_stepper_v2_bricklet/<UID>/set_bootloader_mode¶

Anfrage:	mode – Typ: int, Wertebereich: Siehe Symbole
Antwort:	status – Typ: int, Wertebereich: Siehe Symbole

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 Symbole sind für diese Funktion verfügbar:

Für mode:

• "bootloader" = 0
• "firmware" = 1
• "bootloader_wait_for_reboot" = 2
• "firmware_wait_for_reboot" = 3
• "firmware_wait_for_erase_and_reboot" = 4

Für status:

• "ok" = 0
• "invalid_mode" = 1
• "no_change" = 2
• "entry_function_not_present" = 3
• "device_identifier_incorrect" = 4
• "crc_mismatch" = 5

request/silent_stepper_v2_bricklet/<UID>/get_bootloader_mode¶

Anfrage:	keine Nutzdaten
Antwort:	mode – Typ: int, Wertebereich: Siehe Symbole

Gibt den aktuellen Bootloader-Modus zurück, siehe request/silent_stepper_v2_bricklet/<UID>/set_bootloader_mode.

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

Für mode:

• "bootloader" = 0
• "firmware" = 1
• "bootloader_wait_for_reboot" = 2
• "firmware_wait_for_reboot" = 3
• "firmware_wait_for_erase_and_reboot" = 4

request/silent_stepper_v2_bricklet/<UID>/set_write_firmware_pointer¶

Anfrage:	pointer – Typ: int, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Antwort:	keine Antwort

Setzt den Firmware-Pointer für request/silent_stepper_v2_bricklet/<UID>/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.

request/silent_stepper_v2_bricklet/<UID>/write_firmware¶

Anfrage:	data – Typ: [int, ...], Länge: 64, Wertebereich: [0 bis 255]
Antwort:	status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von request/silent_stepper_v2_bricklet/<UID>/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.

request/silent_stepper_v2_bricklet/<UID>/write_uid¶

Anfrage:	uid – Typ: int, Wertebereich: [0 bis 232 - 1]
Antwort:	keine Antwort

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.

request/silent_stepper_v2_bricklet/<UID>/read_uid¶

Anfrage:	keine Nutzdaten
Antwort:	uid – Typ: int, Wertebereich: [0 bis 232 - 1]

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